[GNUnet-SVN] [taler-anastasis] 05/05: Added EscrowChallenge and states to truth api.

[gnunet]

This is an automated email from the git hooks/post-receive script.

dennis-neufeld pushed a commit to branch master
in repository anastasis.

commit 25c293d974afba23ec17f19bd9a0fc95727560b1
Author: Dennis Neufeld <address@hidden>
AuthorDate: Thu Aug 29 12:49:42 2019 +0200

    Added EscrowChallenge and states to truth api.
---
 src/api/api-anastasis.rst | 45 +++++++++++++++++++++++++++++++++++----------
 1 file changed, 35 insertions(+), 10 deletions(-)

diff --git a/src/api/api-anastasis.rst b/src/api/api-anastasis.rst
index c58871f..2d4ec23 100644
--- a/src/api/api-anastasis.rst
+++ b/src/api/api-anastasis.rst
@@ -74,7 +74,7 @@ The client is identified and authorized by $ACCOUNT_PUB, 
which should be kept se
 EdDSA public key. 
 
 
-.. http:get:: /escrow/$ACCOUNT_PUB[?version=$NUMBER]
+.. http:get:: /escrow/$ACCOUNT_PUB[?version=$NUMBER&uuid=$UUID]
 
   Get the customer's policy and encrypted master key share data.  The
   response must begin with an ephemeral ECDHE public key and continue
@@ -82,8 +82,7 @@ EdDSA public key.
   policy, the encrypted master public key and the encrypted key-share. 
 
   :status 200 OK:
-    The escrow provider responds with an `EncryptedRecoveryDocument`_ object. 
This request should
-    virtually always be successful, if the account exists.
+    The escrow provider responds with an `EncryptedRecoveryDocument`_ object.
   :status 302 Found:
     The Provider redirects for authentication (i.e. video 
identification/WebRTC).
   :status 303 See Other:
@@ -93,10 +92,15 @@ EdDSA public key.
   :status 402 Payment Required:
     Payment Reequired.
   :status 404 Not Found:
-    The requested Ressource was not found.
+    The requested resource was not found.
 
-  X-Anastasis-Version: $NUMBER --- return actual version number in header;
-  (if not specified in request, return latest).
+  *X-Anastasis-Version*: $NUMBER --- return actual version number in header;
+  (if not specified in request, return EscrowChallenge_ according to specified 
&UUID or return
+  EscrowChallenge_ according to the latest version. If status 200 OK: Return 
EncryptedRecoveryDocument_ 
+  according to specified version respectively the latest the version).
+
+  *X-Anastasis-UUID*: $UUID --- return actual uuid in header;
+  (if not specified in request, return EscrowChallenge_ according to specified 
version &NUMBER respectively the latest version).
     
   **Details:**
  
@@ -195,6 +199,19 @@ EdDSA public key.
 
     }
 
+  .. _EscrowChallenge:
+  .. code-block:: tsref
+
+    interface EscrowChallenge {
+      // ground truth, i.e. challenge question,
+      // phone number, e-mail address, picture, fingerprint, ...
+      truth: byte[];
+
+      // mime type of truth, i.e. text/ascii, image/jpeg, etc.
+      truth_mime: string;
+    
+    }
+
 
 .. http:post:: /escrow/$ACCOUNT_PUB
 
@@ -215,11 +232,19 @@ This API is used by the Anastasis client to deposit or 
request the truth with th
 The client is identified and authorized by $ACCOUNT_PUB, which should be kept 
secret from third parties. $ACCOUNT_PUB should be an
 EdDSA public key. 
 
-.. http:post:: /truth/$ACCOUNT_PUB[?uuid=$UUID]
-
-  X-Anastasis-UUID: $UUID --- return actual uuid in header;
-  (if not specified in request, return latest entry).
+.. http:post:: /truth/$ACCOUNT_PUB/$UUID
     
+  :status 200 OK:
+    Key share stored successfully.
+  :status 400 Bad Request:
+    Request wasn’t built properly.
+  :status 402 Payment Required:
+    Payment Reequired.
+  :status 412 Precondition Failed:
+    The selected authentication Method is not supported on this provider.
+  :status 503 Service Unavailable:
+    Server is out of Service.
+
   **Details:**
 
   .. _Truth:

-- 
To stop receiving notification emails like this one, please contact
address@hidden.