summaryrefslogtreecommitdiff
path: root/website/validation-agent/protocol.mdwn
diff options
context:
space:
mode:
authorMatthew James Goins <mjgoins@openflows.com>2010-03-14 17:40:46 -0400
committerMatthew James Goins <mjgoins@openflows.com>2010-03-14 17:40:46 -0400
commitdd71f5ec4a69c58f894f4f6961ca3786a192bc62 (patch)
tree1e5bb5331837afcf9f77187daaaebf15c93606d7 /website/validation-agent/protocol.mdwn
parent970c7500631f46b5aa6279bf607c7d11ede7549e (diff)
parent3d46f5954da2bc9a2dd8d2ce35713136149c2983 (diff)
Merge remote branch 'dkg/master'
Diffstat (limited to 'website/validation-agent/protocol.mdwn')
-rw-r--r--website/validation-agent/protocol.mdwn24
1 files changed, 24 insertions, 0 deletions
diff --git a/website/validation-agent/protocol.mdwn b/website/validation-agent/protocol.mdwn
new file mode 100644
index 0000000..4e6811a
--- /dev/null
+++ b/website/validation-agent/protocol.mdwn
@@ -0,0 +1,24 @@
+[[!meta title="Validation Agent Protocol"]]
+
+# Validation Agent Protocol #
+
+In its current form, the
+[Monkeysphere Validation Agent](/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)
+ (returns: protoversion, server, available)
+
+ POST /reviewcert -- request validation of a certificate
+ (query parameters: uid, context, pkc)
+ (returns: valid, message)
+
+Query parameters are posted as a JSON blob (*not* as
+www-form-encoded).
+
+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 refers to the setting in which the certificate is offered. For example, "https" means: "this certificate was offered by an HTTPS server"