WIP NEW COMM

[secnet.git] / README

diff --git a/README b/README
index 96114f080a54ecba791f3734e0e628c8d5893015..12a8469fdfd33e3ee792cd7e1d906918cd1283f1 100644 (file)
--- a/README
+++ b/README
@@ -201,9 +201,18 @@ Defines:
 udp: dict argument
   address (string): IP address to listen and send on
   port (integer): UDP port to listen and send on
+  resolver (resolver closure)
   buffer (buffer closure): buffer for incoming packets
   authbind (string): optional, path to authbind-helper program
 
+ udp looks up the following keys in its calling closure (usually, this
+ is a site closure) when a peer needs to be found:
+
+  address (string): optional, DNS name used to find our peer
+  port (integer): mandatory if 'address' is specified: the port used
+    to contact our peer
+
+
 ** log
 
 Defines:
@@ -270,13 +279,12 @@ site: dict argument
   local-name (string): this site's name for itself
   name (string): the name of the site's peer
   link (netlink closure)
-  comm (comm closure)
-  resolver (resolver closure)
+  comm (one or more comm closures): if there is more than one, the
+   first one will be used for any key setups initiated by us using the
+   configured address.  Others are only used if our peer talks to
+   them.
   random (randomsrc closure)
   local-key (rsaprivkey closure)
-  address (string): optional, DNS name used to find our peer
-  port (integer): mandatory if 'address' is specified: the port used
-    to contact our peer
   key (rsapubkey closure): our peer's public key
   transform (transform closure): how to mangle packets sent between sites
   dh (dh closure)
@@ -331,6 +339,7 @@ site: dict argument
     check that there are no links both ends of which are allegedly
     mobile (which is not supported, so those links are ignored) and
     to change some of the tuning parameter defaults. [false]
+  Plus further keys depending on the first comm.
 
 Links involving mobile peers have some different tuning parameter
 default values, which are generally more aggressive about retrying key