diff options
author | Christian Grothoff <christian@grothoff.org> | 2024-04-15 11:10:50 +0200 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2024-04-15 11:10:50 +0200 |
commit | d42bdf0462531aca3f4bcf5f17f7bb94b5245789 (patch) | |
tree | b149e9370166cbf81b55fb96ab6467f148e90097 | |
parent | fb9074339821ecdf2e127ca08c406df37f2e0aa3 (diff) | |
download | docs-d42bdf0462531aca3f4bcf5f17f7bb94b5245789.tar.gz docs-d42bdf0462531aca3f4bcf5f17f7bb94b5245789.tar.bz2 docs-d42bdf0462531aca3f4bcf5f17f7bb94b5245789.zip |
vSPA is now protocol v1
-rw-r--r-- | core/api-challenger.rst | 74 |
1 files changed, 37 insertions, 37 deletions
diff --git a/core/api-challenger.rst b/core/api-challenger.rst index 25c84d3e..f8631977 100644 --- a/core/api-challenger.rst +++ b/core/api-challenger.rst @@ -1,6 +1,6 @@ .. This file is part of GNU TALER. - Copyright (C) 2023 Taler Systems SA + Copyright (C) 2023, 2024 Taler Systems SA TALER is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software @@ -99,7 +99,7 @@ Receiving Configuration .. http:get:: /config Obtain the key configuration settings of the storage service. - This specification corresponds to ``current`` protocol being version **0**. + This specification corresponds to ``current`` protocol being version **1**. **Response:** @@ -190,28 +190,28 @@ Login :http:statuscode:`200 OK`: If the request ask for application/json then the response is - a `ChallengeStatus`. Since protocol **vSPA**. + a `ChallengeStatus`. Since protocol **v1**. Otherwise, the body contains a form to be submitted by the user-agent using the template :ref:`enter-$ADDRESS_TYPE-form <challenger_enter-address_type-form>`. The form will ask the user to specify their address. - :http:statuscode:`406 Not Acceptable`: - The client ask for "text/html" and the backend installation does - not include the required HTML templates. :http:statuscode:`400 Bad Request`: The request does not follow the spec. If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. + code, hint and detail. Since protocol **v1**. Otherwise, the body contains information using the template :ref:`invalid-request <challenger_invalid-request>`. - :http:statuscode:`500 Internal Server Error`: - Server is not able to respond due to internal problems. - If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. - Otherwise, the body contains information using the template :ref:`internal-error <challenger_internal-error>`. :http:statuscode:`404 Not found`: The service is unaware of a matching challenge. If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. + code, hint and detail. Since protocol **v1**. Otherwise, the body contains information using the template :ref:`validation-unknown <challenger_validation-unknown>`. + :http:statuscode:`406 Not Acceptable`: + The client ask for "text/html" and the backend installation does + not include the required HTML templates. + :http:statuscode:`500 Internal Server Error`: + Server is not able to respond due to internal problems. + If the request ask for application/json the response will include error + code, hint and detail. Since protocol **v1**. + Otherwise, the body contains information using the template :ref:`internal-error <challenger_internal-error>`. .. ts:def:: ChallengeStatus @@ -259,10 +259,20 @@ Challenge **Response:** :http:statuscode:`200 OK`: - If the request ask for application/json the response is `ChallengeCreateResponse`. Since protocol **vSPA**. + If the request ask for application/json the response is `ChallengeCreateResponse`. Since protocol **v1**. Otherwise, the body contains a form asking for the answer to the challenge to be entered by the user using the template :ref:`enter-tan-form <challenger_enter-tan-form>`. + :http:statuscode:`400 Bad Request`: + The request does not follow the spec. + If the request ask for application/json the response will include error + code, hint and detail. Since protocol **v1**. + Otherwise, the body contains information using the template :ref:`invalid-request <challenger_invalid-request>`. + :http:statuscode:`404 Not Found`: + The service is unaware of a matching challenge. + If the request ask for application/json the response will include error + code, hint and detail. Since protocol **v1**. + Otherwise, the body contains information using the template :ref:`validation-unknown <challenger_validation-unknown>`. :http:statuscode:`406 Not Acceptable`: The client ask for "text/html" and the backend installation does not include the required HTML templates. @@ -271,21 +281,11 @@ Challenge transmissions for this $NONCE. The user-agent should wait and (eventually) request a fresh nonce to be set up by the client. - :http:statuscode:`400 Bad Request`: - The request does not follow the spec. - If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. - Otherwise, the body contains information using the template :ref:`invalid-request <challenger_invalid-request>`. :http:statuscode:`500 Internal Server Error`: Server is not able to respond due to internal problems. If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. + code, hint and detail. Since protocol **v1**. Otherwise, the body contains information using the template :ref:`internal-error <challenger_internal-error>`. - :http:statuscode:`404 Not found`: - The service is unaware of a matching challenge. - If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. - Otherwise, the body contains information using the template :ref:`validation-unknown <challenger_validation-unknown>`. .. ts:def:: ChallengeCreateResponse @@ -336,29 +336,29 @@ Solve by the client (during registration and again upon ``/authorize``), plus a ``code`` argument with the authorization code, and the ``state`` argument from the ``/authorize`` endpoint. + :http:statuscode:`400 Bad Request`: + The request does not follow the spec. + If the request ask for application/json the response will include error + code, hint and detail. Since protocol **v1**. + Otherwise, the body contains information using the template :ref:`invalid-request <challenger_invalid-request>`. :http:statuscode:`403 Forbidden`: - If the request ask for application/json the response is `InvalidPinResponse`. Since protocol **vSPA**. + If the request ask for application/json the response is `InvalidPinResponse`. Since protocol **v1**. Otherwise, the body contains information using the template :ref:`invalid-pin <challenger_invalid-pin>`. + :http:statuscode:`404 Not found`: + The service is unaware of a matching challenge. + If the request ask for application/json the response will include error + code, hint and detail. Since protocol **v1**. + Otherwise, the body contains information using the template :ref:`validation-unknown <challenger_validation-unknown>`. :http:statuscode:`429 Too Many Requests`: There have been too many attempts to solve the challenge for this address (and $NONCE). The user-agent should either try a different address (or wait and (eventually) request a fresh nonce to be set up by the client). - :http:statuscode:`400 Bad Request`: - The request does not follow the spec. - If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. - Otherwise, the body contains information using the template :ref:`invalid-request <challenger_invalid-request>`. :http:statuscode:`500 Internal Server Error`: Server is not able to respond due to internal problems. If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. + code, hint and detail. Since protocol **v1**. Otherwise, the body contains information using the template :ref:`internal-error <challenger_internal-error>`. - :http:statuscode:`404 Not found`: - The service is unaware of a matching challenge. - If the request ask for application/json the response will include error - code, hint and detail. Since protocol **vSPA**. - Otherwise, the body contains information using the template :ref:`validation-unknown <challenger_validation-unknown>`. .. ts:def:: InvalidPinResponse |