website/validation-agent/protocol.mdwn

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