summaryrefslogtreecommitdiff
path: root/doc/sphinx/rest.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-12-31 18:26:49 +0100
committerChristian Grothoff <christian@grothoff.org>2021-12-31 18:26:49 +0100
commit0919fe8b52588bd8f3adb83817158abc9434ac5b (patch)
tree4380e205a4e7dc49543c03c312eb332c5b92160b /doc/sphinx/rest.rst
parent33152ae6d820ccf638498ddf264e011540e419a7 (diff)
downloadanastasis-0919fe8b52588bd8f3adb83817158abc9434ac5b.tar.gz
anastasis-0919fe8b52588bd8f3adb83817158abc9434ac5b.tar.bz2
anastasis-0919fe8b52588bd8f3adb83817158abc9434ac5b.zip
document and shorten default payment timeout (fixes #7073)
Diffstat (limited to 'doc/sphinx/rest.rst')
-rw-r--r--doc/sphinx/rest.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/sphinx/rest.rst b/doc/sphinx/rest.rst
index 9127354..605fc9f 100644
--- a/doc/sphinx/rest.rst
+++ b/doc/sphinx/rest.rst
@@ -216,7 +216,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_.
:query timeout_ms=NUMBER: *Optional.* If specified, the Anastasis server will
wait up to ``timeout_ms`` milliseconds for completion of the payment before
sending the HTTP response. A client must never rely on this behavior, as the
- backend may return a response immediately.
+ backend may return a response immediately. If a ``timeout_ms`` is not given, the Anastasis server may apply a default timeout (usually 30s) when talking to the merchant backend.
*If-None-Match*: This header MUST be present and set to the SHA512 hash (Etag) of the body by the client.
The client SHOULD also set the ``Expect: 100-Continue`` header and wait for ``100 continue``
@@ -227,7 +227,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_.
*Anastasis-Policy-Signature*: The client must provide Base-32 encoded EdDSA signature over hash of body with ``$ACCOUNT_PRIV``, affirming desire to upload an encrypted recovery document.
- *Payment-Identifier*: Base-32 encoded 32-byte payment identifier that was included in a previous payment (see ``402`` status code). Used to allow the server to check that the client paid for the upload (to protect the server against DoS attacks) and that the client knows a real secret of financial value (as the **kdf_id** might be known to an attacker). If this header is missing in the client's request (or the associated payment has exceeded the upload limit), the server must return a ``402`` response. When making payments, the server must include a fresh, randomly-generated payment-identifier in the payment request.
+ *Payment-Identifier*: Base-32 encoded 32-byte payment identifier that was included in a previous payment (see ``402`` status code). Used to allow the server to check that the client paid for the upload (to protect the server against DoS attacks) and that the client knows a real secret of financial value (as the **kdf_id** might be known to an attacker). If this header is missing in the client's request (or the associated payment has exceeded the upload limit), the server must return a ``402`` response. When making payments, the server must include a fresh, randomly-generated payment-identifier in the payment request. If a payment identifier is given, the Anastasis backend may block for the payment to be confirmed by Taler as specified by the ``timeout_ms`` argument.
**Response**: