more readme updates
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Tue, 9 Mar 2010 04:33:58 +0000 (23:33 -0500)
committerDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Tue, 9 Mar 2010 04:34:28 +0000 (23:34 -0500)
msva.protocol.README [moved from README with 67% similarity]

similarity index 67%
rename from README
rename to msva.protocol.README
index d0c54cfa5a0e7dc5195424fd65aceae3a3251914..5e699d292f37e13f9ac609ac05678dc48c310df4 100644 (file)
--- a/README
@@ -6,8 +6,8 @@ msva is the Monkeysphere Validation Agent.
 Its goal is to simplify bindings between cryptographic tokens and the
 real-world entities that humans actually care about.
 
-In its current technical conception, the validation agent is a minimal
-HTTP server that accepts two different requests:
+In its current form, the validation agent is conceived of as a
+minimalistic HTTP server that accepts two different requests:
 
 GET /  -- initial contact query, protocol version compatibility.
   (no query parameters)
@@ -17,14 +17,19 @@ POST /reviewcert  -- request validation of a certificate
  (query parameters: uid, context, pkc)
  (returns: valid, message)
 
-query parameters are posted as a JSON string (*not* as www-form-encoded).
+Query parameters are posted as a JSON blob (*not* as
+www-form-encoded).
 
-the variables that are returned are application/json as well.
+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))
 (context means: (this is too vague right now) something like "this certificate was used to try to identify an HTTPS server")
 
+
+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