Merge branch 'master' into debian
[monkeysphere-validation-agent.git] / msva.protocol.README
1 2010-01-05 18:21:59-0500
2 ------------------------
3
4 msva is the Monkeysphere Validation Agent.
5
6 Its goal is to simplify bindings between cryptographic tokens and the
7 real-world entities that humans actually care about.
8
9 In its current form, the validation agent is conceived of as a
10 minimalistic HTTP server that accepts two different requests:
11
12 GET /  -- initial contact query, protocol version compatibility.
13   (no query parameters)
14   (returns: protoversion, server, available)
15
16 POST /reviewcert  -- request validation of a certificate
17  (query parameters: uid, context, pkc)
18  (returns: valid, message)
19
20 Query parameters are posted as a JSON blob (*not* as
21 www-form-encoded).
22
23 The variables that are returned are application/json as well.
24
25 (PKC means: public key carrier: raw key, OpenPGP cert, or X.509 cert)
26 (UID means: User ID (like in OpenPGP))
27 (context means: (this is too vague right now) something like "this certificate was used to try to identify an HTTPS server")
28
29
30 Full details on the Monkeysphere Validation Agent protocol should be
31 available at http://web.monkeysphere.info/validation-agent/protocol
32
33 Authors: Daniel Kahn Gillmor <dkg@fifthhorseman.net>
34          Matthew James Goins
35          Jameson Rollins