updated README
authorDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Tue, 9 Mar 2010 04:27:45 +0000 (23:27 -0500)
committerDaniel Kahn Gillmor <dkg@fifthhorseman.net>
Tue, 9 Mar 2010 04:27:45 +0000 (23:27 -0500)
README

diff --git a/README b/README
index e85b1c1a91d01368aae103efd2bd57b0b28c0b9d..d0c54cfa5a0e7dc5195424fd65aceae3a3251914 100644 (file)
--- a/README
+++ b/README
@@ -6,13 +6,18 @@ 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, is a minimal HTTP server that
-accepts two requests:
+In its current technical conception, the validation agent is a minimal
+HTTP server that accepts two different requests:
 
-POST /reviewcert (vars: uid, context, pkc)
-POST /extracerts (vars: certificates)
+GET /  -- initial contact query, protocol version compatibility.
+  (no query parameters)
+  (returns: protoversion, server, available)
 
-the variables that are posted are posted in a JSON string (*not* as www-form-encoded).
+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).
 
 the variables that are returned are application/json as well.
 
@@ -20,7 +25,6 @@ the variables that are returned are application/json as well.
 (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")
 
-
 Authors: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
          Matthew James Goins
          Jameson Rollins