From: Ian Jackson <ijackson@chiark.greenend.org.uk>
Date: Wed, 27 Nov 2019 13:49:46 +0000 (+0000)
Subject: README: Document new semantics for `hash'
X-Git-Tag: v0.6.0~133
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=secnet.git;a=commitdiff_plain;h=f546af4512e558a8b1fcfd240819fcef12fe09a5

README: Document new semantics for `hash'

Since 13b8fbf4548f3457b02afd36e9284d39839d6f85
  sig: Move hashing into algorithm
new public key internal APIs use this rather differently.

So far the difference has been nugatory, because there's only rsa1.
But we should change the documentation.

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
---

diff --git a/README b/README
index 05b073f..e83b66d 100644
--- a/README
+++ b/README
@@ -403,7 +403,8 @@ site: dict argument
   key (rsapubkey closure): our peer's public key (obsolete)
   transform (transform closure): how to mangle packets sent between sites
   dh (dh closure)
-  hash (hash closure)
+  hash (hash closure): used for keys whose algorithm (or public
+    or private key file) does not imply the hash function
   key-lifetime (integer): max lifetime of a session key, in ms
     [one hour; mobile: 2 days]
   setup-retries (integer): max number of times to transmit a key negotiation