expose version of MSVA.pm publicly

[monkeysphere-validation-agent.git] / msva.protocol.README

diff --git a/msva.protocol.README b/msva.protocol.README
index 5e699d292f37e13f9ac609ac05678dc48c310df4..0d7fd51fbf0bf665be4d991422d1466e00f8a840 100644 (file)
--- a/msva.protocol.README
+++ b/msva.protocol.README
@@ -14,7 +14,8 @@ GET /  -- initial contact query, protocol version compatibility.
   (returns: protoversion, server, available)
 
 POST /reviewcert  -- request validation of a certificate
- (query parameters: uid, context, pkc)
+ (required query parameters: uid, context, pkc)
+ (optional query parameters: keyserverpolicy)
  (returns: valid, message)
 
 Query parameters are posted as a JSON blob (*not* as
@@ -23,13 +24,13 @@ www-form-encoded).
 The variables that are returned are application/json as well.
 
 (PKC means: public key carrier: raw key, OpenPGP cert, or X.509 cert)
-(UID means: User ID (like in OpenPGP))
+(UID means: User ID (similar to OpenPGP))
 (context means: (this is too vague right now) something like "this certificate was used to try to identify an HTTPS server")
-
+(keyserverpolicy is optional; it states an advisory preference for how/whether the agent should contact the keyserver network for information about the key.  The options are `always`, `never`, and `unlessvalid` (see the `msva-perl(1)` man page section about the `KEYSERVER_POLICY` environment variable for more details). Be aware that the agent may disregard, override, or simply not implement this preference.)
 
 Full details on the Monkeysphere Validation Agent protocol should be
 available at http://web.monkeysphere.info/validation-agent/protocol
 
 Authors: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
          Matthew James Goins
-         Jameson Rollins
+         Jameson Rollins <jrollins@finestructure.net>