4e6811aaa06c3ff4b6d384343b4d2fd15caf29f0
[monkeysphere.git] / website / validation-agent / protocol.mdwn
1 [[!meta title="Validation Agent Protocol"]]
2
3 # Validation Agent Protocol #
4
5 In its current form, the
6 [Monkeysphere Validation Agent](/validation-agent) is conceived of as
7 a minimalistic HTTP server that accepts two different requests:
8
9  GET /  -- initial contact query, protocol version compatibility.
10   (no query parameters)
11   (returns: protoversion, server, available)
12
13  POST /reviewcert  -- request validation of a certificate
14   (query parameters: uid, context, pkc)
15   (returns: valid, message)
16
17 Query parameters are posted as a JSON blob (*not* as
18 www-form-encoded).
19
20 The variables that are returned are application/json as well.
21
22 * PKC means: public key carrier: raw key, OpenPGP cert, or X.509 cert
23 * UID means: User ID (like in OpenPGP)
24 * context refers to the setting in which the certificate is offered.  For example, "https" means: "this certificate was offered by an HTTPS server"