From 7188d2b17aa5971fe7f3928fda6fa4541fe7b9bb Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:13:45 -0400 Subject: change markup for Anastasis-Account-Signature from " to `` --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index a8ed7a4..17ce4d4 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -101,7 +101,7 @@ compute the account key pair. The public account key is Crockford base32-encoded in the URI to identify the account, and used to sign requests. These signatures are also provided in base32-encoding and transmitted using the HTTP header -"Anastasis-Account-Signature". +``Anastasis-Account-Signature``. When confidential data is uploaded to an Anastasis server, the respective payload is encrypted using AES-GCM with a symmetric key and initialization -- cgit v1.2.3 From c8f07b0d743a8cbc065c4672e83b1e6c43c0249c Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:20:24 -0400 Subject: add comma --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 17ce4d4..8d6b2fb 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -165,7 +165,7 @@ Verification For users to authorize "policy" operations we need an EdDSA key pair. As we cannot assure that the corresponding private key is truly secret, such policy operations must never be destructive: Should an adversary learn the private -key, they could access (and with the **kdf_id** decrypt) the user's policy (but +key, they could access (and with the **kdf_id**, decrypt) the user's policy (but not the core secret), or upload a new version of the **encrypted recovery document** (but not delete an existing version). -- cgit v1.2.3 From 6977f86915dc9d8250e17aa14b902d6f7ea3c97c Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:22:46 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98kdf=5Fid=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 8d6b2fb..3658f46 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -189,7 +189,7 @@ HKDF to ensure that the result differs from other cases where we hash **key_size**: Size of the output, here 32 bytes. -**ver_secret**: Derived key from the kdf_id, serves as intermediate step for the generation of the private key. +**ver_secret**: Derived key from the ``kdf_id``, serves as intermediate step for the generation of the private key. **eddsa_d_to_a()**: Function which converts the ver_key to a valid EdDSA private key. Specifically, assuming the value eddsa_priv is in a 32-byte array "digest", the function clears and sets certain bits as follows: -- cgit v1.2.3 From 20b80e416df263bb6bda13485e0eef4f0c338066 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:23:13 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98eddsa=5Fpriv=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 3658f46..33c2982 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -191,7 +191,7 @@ HKDF to ensure that the result differs from other cases where we hash **ver_secret**: Derived key from the ``kdf_id``, serves as intermediate step for the generation of the private key. -**eddsa_d_to_a()**: Function which converts the ver_key to a valid EdDSA private key. Specifically, assuming the value eddsa_priv is in a 32-byte array "digest", the function clears and sets certain bits as follows: +**eddsa_d_to_a()**: Function which converts the ver_key to a valid EdDSA private key. Specifically, assuming the value ``eddsa_priv`` is in a 32-byte array "digest", the function clears and sets certain bits as follows: .. code-block:: none -- cgit v1.2.3 From cbc54b03655ed5eeab7f4f847b71651beed71ad8 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:24:05 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98nonce=E2=80=99=20and=20=E2=80=98kd?= =?UTF-8?q?f=5Fid=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 33c2982..868b3a5 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -209,7 +209,7 @@ Encryption For symmetric encryption of data we use AES256-GCM. For this we need a symmetric key and an initialization vector (IV). To ensure that the symmetric key changes for each encryption operation, we compute the -key material using an HKDF over a nonce and the kdf_id. +key material using an HKDF over a ``nonce`` and the ``kdf_id``. .. code-block:: none -- cgit v1.2.3 From 6962adadb78a80cb1e531a24fc2c94affb0d05ab Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:25:27 -0400 Subject: add comma --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 868b3a5..4faffea 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -249,7 +249,7 @@ From this the symmetric key is computed as described above. We use AES256-GCM for the encryption of the **recovery document** and the **key_share**. To ensure that the key derivation for the encryption of the **recovery document** differs fundamentally from that of an -individual **key share**, we use different salts ("erd" and "eks" respectively). +individual **key share**, we use different salts ("erd" and "eks", respectively). .. code-block:: none -- cgit v1.2.3 From 2a95bdaa271991c621896b763ac2a5555c030533 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:26:24 -0400 Subject: =?UTF-8?q?change=20=E2=80=98code-block=E2=80=99=20type=20from=20?= =?UTF-8?q?=E2=80=98none=E2=80=99=20to=20=E2=80=98c=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4faffea..86f7246 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -193,7 +193,7 @@ HKDF to ensure that the result differs from other cases where we hash **eddsa_d_to_a()**: Function which converts the ver_key to a valid EdDSA private key. Specifically, assuming the value ``eddsa_priv`` is in a 32-byte array "digest", the function clears and sets certain bits as follows: -.. code-block:: none +.. code-block:: c digest[0] = (digest[0] & 0x7f) | 0x40; digest[31] &= 0xf8; -- cgit v1.2.3 From e8213178ad640c7fb0e22e9516754bcc1a55efb2 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:27:02 -0400 Subject: =?UTF-8?q?use=20=E2=80=98:=3D=E2=80=99=20instead=20of=20=E2=80=98?= =?UTF-8?q?=3D=E2=80=99=20in=20pseudocode=20code-block=20(four=20instances?= =?UTF-8?q?)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 86f7246..a2d1249 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -253,10 +253,10 @@ individual **key share**, we use different salts ("erd" and "eks", respectively) .. code-block:: none - (iv0, key0) = HKDF(key_id, nonce0, "erd", keysize + ivsize) - (encrypted_recovery_document, aes_gcm_tag) = AES256_GCM(recovery_document, key0, iv0) - (iv_i, key_i) = HKDF(key_id, nonce_i, "eks", [optional data], keysize + ivsize) - (encrypted_key_share_i, aes_gcm_tag_i) = AES256_GCM(key_share_i, key_i, iv_i) + (iv0, key0) := HKDF(key_id, nonce0, "erd", keysize + ivsize) + (encrypted_recovery_document, aes_gcm_tag) := AES256_GCM(recovery_document, key0, iv0) + (iv_i, key_i) := HKDF(key_id, nonce_i, "eks", [optional data], keysize + ivsize) + (encrypted_key_share_i, aes_gcm_tag_i) := AES256_GCM(key_share_i, key_i, iv_i) **encrypted_recovery_document**: The encrypted **recovery document** which contains the escrow methods, policies and the encrypted **core secret**. -- cgit v1.2.3 From 9b288441114500cb3cff9cf329175b1de90245b3 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:29:25 -0400 Subject: =?UTF-8?q?use=20=E2=80=98:=3D=E2=80=99=20instead=20of=20=E2=80=98?= =?UTF-8?q?=3D=E2=80=99=20in=20pseudocode=20code-block=20(three=20instance?= =?UTF-8?q?s)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index a2d1249..b447f33 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -280,11 +280,11 @@ inaccessible to those who do not have the answer: .. code-block:: none - powh = POW_HASH (qsalt, answer) - ekss = HKDF("Anastasis-secure-question-uuid-salting", - powh, - uuid); - (iv_i, key_i) = HKDF(key_id, nonce_i, ekss, [optional data], keysize + ivsize) + powh := POW_HASH (qsalt, answer) + ekss := HKDF("Anastasis-secure-question-uuid-salting", + powh, + uuid); + (iv_i, key_i) := HKDF(key_id, nonce_i, ekss, [optional data], keysize + ivsize) **qsalt**: salt value used to hash answer to satisfy the challenge to prevent the provider from determining the answer via guessing. -- cgit v1.2.3 From d8c404485d98dc7ceebf347a71648bbcb0dba953 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:30:15 -0400 Subject: capitalize first word in sentence (three instances) --- anastasis.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index b447f33..b41e0d5 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -287,11 +287,11 @@ inaccessible to those who do not have the answer: (iv_i, key_i) := HKDF(key_id, nonce_i, ekss, [optional data], keysize + ivsize) -**qsalt**: salt value used to hash answer to satisfy the challenge to prevent the provider from determining the answer via guessing. +**qsalt**: Salt value used to hash answer to satisfy the challenge to prevent the provider from determining the answer via guessing. -**answer**: answer to the security question, in UTF-8, as entered by the user. +**answer**: Answer to the security question, in UTF-8, as entered by the user. -**powh**: result of the (expensive, proof-of-work) hash algorithm. +**powh**: Result of the (expensive, proof-of-work) hash algorithm. **uuid**: UUID of the challenge associated with the security question and the encrypted key share. -- cgit v1.2.3 From 56bd30a554fb9af2d06318b26c709c4e5b18f5c6 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:30:55 -0400 Subject: =?UTF-8?q?use=20=E2=80=98:=3D=E2=80=99=20instead=20of=20=E2=80=98?= =?UTF-8?q?=3D=E2=80=99=20in=20pseudocode=20code-block=20(two=20instances)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index b41e0d5..a07c031 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -307,8 +307,8 @@ algorithm is equivalent for **Anastasis-Policy-Signature**. .. code-block:: none - (anastasis-account-signature) = eddsa_sign(h_body, eddsa_priv) - ver_res = eddsa_verifiy(h_body, anastasis-account-signature, eddsa_pub) + (anastasis-account-signature) := eddsa_sign(h_body, eddsa_priv) + ver_res := eddsa_verifiy(h_body, anastasis-account-signature, eddsa_pub) **anastasis-account-signature**: Signature over the SHA-512 hash of the body using the purpose code ``TALER_SIGNATURE_ANASTASIS_POLICY_UPLOAD`` (1400) (see GNUnet EdDSA signature API for the use of purpose). -- cgit v1.2.3 From 5ac931e2c5b8f3c07c8537f6251422ca4ba43dbd Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:31:52 -0400 Subject: =?UTF-8?q?use=20=E2=80=98:=3D=E2=80=99=20instead=20of=20=E2=80=98?= =?UTF-8?q?=3D=E2=80=99=20in=20pseudocode=20code-block=20(two=20instances)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index a07c031..c6a0f0f 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -321,8 +321,8 @@ When requesting policy downloads, the client must also provide a signature: .. code-block:: none - (anastasis-account-signature) = eddsa_sign(version, eddsa_priv) - ver_res = eddsa_verifiy(version, anastasis-account-signature, eddsa_pub) + (anastasis-account-signature) := eddsa_sign(version, eddsa_priv) + ver_res := eddsa_verifiy(version, anastasis-account-signature, eddsa_pub) **anastasis-account-signature**: Signature over the SHA-512 hash of the body using the purpose code ``TALER_SIGNATURE_ANASTASIS_POLICY_DOWNLOAD`` (1401) (see GNUnet EdDSA signature API for the use of purpose). -- cgit v1.2.3 From 229f7c94da157208c6a282e690dc79e81eeeb05b Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:34:23 -0400 Subject: fix typo: s/and/an/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index c6a0f0f..2116cd8 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -356,7 +356,7 @@ leaves a strong adversary with the option of uploading many policies to exhaust the Anastasis server's capacity. We limit this attack by requiring a policy upload to include a reference to a **payment identifier** from a payment made by the user. Thus, a policy upload requires both knowledge of the -**identity** and making a payment. This effectively prevents and adversary +**identity** and making a payment. This effectively prevents an adversary from using the append-only policy storage from exhausting Anastasis server capacity. -- cgit v1.2.3 From 122ac9584210f16fcb6b1ef1d24e59e8cdefa1ac Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:35:37 -0400 Subject: capitalize first word in sentence; add period at end of sentence (two instances) --- anastasis.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 2116cd8..35f6526 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -397,10 +397,10 @@ Receiving Configuration // Currency in which this provider processes payments. currency: string; - // supported authorization methods + // Supported authorization methods. methods: AuthorizationMethodConfig[]; - // maximum policy upload size supported + // Maximum policy upload size supported. storage_limit_in_megabytes: number; // Payment required to maintain an account to store policy documents for a year. -- cgit v1.2.3 From f7d01c03f3397b3210d7508d21a12343d1f9e68c Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:36:20 -0400 Subject: capitalize first word in sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 35f6526..4ac4d12 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -410,7 +410,7 @@ Receiving Configuration // Payment required to upload truth. To be paid per upload. truth_upload_fee: Amount; - // how long until the service expires deposited truth + // How long until the service expires deposited truth // (unless refreshed via another POST)? truth_lifetime: RelativeTime; -- cgit v1.2.3 From 6b60dc35abd449742499727ed94c3d6fe6e0770b Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:36:43 -0400 Subject: capitalize first word in sentence; add period at end of sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4ac4d12..a9d2f88 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -418,7 +418,7 @@ Receiving Configuration // respect to the services provided. liability_limit: Amount; - // salt value with 128 bits of entropy + // Salt value with 128 bits of entropy. // Different providers // will use different high-entropy salt values. The resulting // **provider salt** is then used in various operations to ensure -- cgit v1.2.3 From 051bf8db4417406f2d8c221ab406b20ab8a75ab1 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:36:57 -0400 Subject: capitalize first word in sentence; add period at end of sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index a9d2f88..4ba2382 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -432,7 +432,7 @@ Receiving Configuration .. ts:def:: AuthorizationMethodConfig interface AuthorizationMethodConfig { - // name of the authorization method + // Name of the authorization method. type: string; // Fee for accessing key share using this method -- cgit v1.2.3 From cf0e9710c3b85de68e45bbf880a177cb5b769067 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:37:06 -0400 Subject: add period at end of sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4ba2382..1ee05c2 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -435,7 +435,7 @@ Receiving Configuration // Name of the authorization method. type: string; - // Fee for accessing key share using this method + // Fee for accessing key share using this method. cost: Amount; } -- cgit v1.2.3 From 134b1ca27b513f634fb7f46cb0bb91f95a2b7d19 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:37:38 -0400 Subject: fix typo: s/poliy/policy/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 1ee05c2..f2cf99d 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -456,7 +456,7 @@ Receiving Terms of Service .. http:get:: /privacy - Obtain the privacy poliy of the service provided by the escrow provider. + Obtain the privacy policy of the service provided by the escrow provider. **Response:** -- cgit v1.2.3 From 968a305807f59ca6bdadeab5ddee1057f6f6613c Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:41:23 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98version=E2=80=99=20from?= =?UTF-8?q?=20"=20to=20``=20(three=20instances)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index f2cf99d..bce9809 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -485,10 +485,10 @@ In the following, UUID is always defined and used according to `RFC 4122`_. .. http:get:: /policy/$ACCOUNT_PUB[?version=$NUMBER] - Get the customer's encrypted recovery document. If "version" + Get the customer's encrypted recovery document. If ``version`` is not specified, the server returns the latest available version. If - "version" is specified, returns the policy with the respective - "version". The response must begin with the nonce and + ``version`` is specified, returns the policy with the respective + ``version``. The response must begin with the nonce and an AES-GCM tag and continue with the ciphertext. Once decrypted, the plaintext is expected to contain: -- cgit v1.2.3 From 5e000bdb3e2245ef3ba6a26195a9f1e434d256f5 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:42:23 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98If-None-Match=E2=80=99?= =?UTF-8?q?=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index bce9809..4822f6e 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -500,7 +500,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. The policy does provide sufficient information for the client to determine how to authorize requests for **truth**. - The client MAY provide an "If-None-Match" header with an Etag. + The client MAY provide an ``If-None-Match`` header with an Etag. In that case, the server MUST additionally respond with an "304" status code in case the resource matches the provided Etag. -- cgit v1.2.3 From 2d9b698947a9b72f37de57bf7876b636ec7c52ca Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:42:35 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98304=E2=80=99=20from=20"?= =?UTF-8?q?=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4822f6e..6de985d 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -501,7 +501,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. how to authorize requests for **truth**. The client MAY provide an ``If-None-Match`` header with an Etag. - In that case, the server MUST additionally respond with an "304" status + In that case, the server MUST additionally respond with an ``304`` status code in case the resource matches the provided Etag. **Response**: -- cgit v1.2.3 From e0ff50b339c1635d2a0779406e865324e0ea1041 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:42:59 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98$ACCOUNT=5FPUB=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 6de985d..cabf1fb 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -511,7 +511,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. :http:statuscode:`304 Not modified`: The client requested the same resource it already knows. :http:statuscode:`400 Bad request`: - The $ACCOUNT_PUB is not an EdDSA public key. + The ``$ACCOUNT_PUB`` is not an EdDSA public key. :http:statuscode:`402 Payment Required`: The account's balance is too low for the specified operation. See the Taler payment protocol specification for how to pay. -- cgit v1.2.3 From 66033d5ba6affd02abc2e81138b6a7cdb6184c46 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:44:25 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98200=20OK=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index cabf1fb..41ff3be 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -524,7 +524,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. If the client specified a version number in the header of the request, the server must return that version. If the client did not specify a version in the request, the server returns latest version of the EncryptedRecoveryDocument_. - *Etag*: Set by the server to the Base32-encoded SHA512 hash of the body. Used for caching and to prevent redundancies. The server MUST send the Etag if the status code is 200 OK. + *Etag*: Set by the server to the Base32-encoded SHA512 hash of the body. Used for caching and to prevent redundancies. The server MUST send the Etag if the status code is ``200 OK``. *If-None-Match*: If this is not the very first request of the client, this contains the Etag-value which the client has received before from the server. The client SHOULD send this header with every request (except for the first request) to avoid unnecessary downloads. -- cgit v1.2.3 From 336995e5714c27b45ea6f9289de305a4dead92d3 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:46:57 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98Expect:=20100-Continue?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 41ff3be..22361ea 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -563,7 +563,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. backend may return a response immediately. *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" + The client SHOULD also set the ``Expect: 100-Continue`` header and wait for "100 continue" before uploading the body. The server MUST use the Etag to check whether it already knows the encrypted recovery document that is about to be uploaded. The server MUST refuse the upload with a "304" status code if the Etag matches -- cgit v1.2.3 From 65accd86a35ce1f509e45a99e12fbd7e0c720f2e Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:47:16 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98100=20continue=E2=80=99?= =?UTF-8?q?=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 22361ea..71bbaa6 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -563,7 +563,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. backend may return a response immediately. *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" + The client SHOULD also set the ``Expect: 100-Continue`` header and wait for ``100 continue`` before uploading the body. The server MUST use the Etag to check whether it already knows the encrypted recovery document that is about to be uploaded. The server MUST refuse the upload with a "304" status code if the Etag matches -- cgit v1.2.3 From 95af36b957800dd50e6e587711dcf9347ad9976d Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:47:34 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98304=E2=80=99=20from=20"?= =?UTF-8?q?=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 71bbaa6..f1efa2e 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -566,7 +566,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. The client SHOULD also set the ``Expect: 100-Continue`` header and wait for ``100 continue`` before uploading the body. The server MUST use the Etag to check whether it already knows the encrypted recovery document that is about to be uploaded. - The server MUST refuse the upload with a "304" status code if the Etag matches + The server MUST refuse the upload with a ``304`` status code if the Etag matches the latest version already known to the server. *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. -- cgit v1.2.3 From 65168843798b7f4d18b7850f7ff69b69cb9509ed Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:49:03 -0400 Subject: =?UTF-8?q?mark=20up=20of=20=E2=80=98402=E2=80=99=20(two=20instanc?= =?UTF-8?q?es)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index f1efa2e..f6d92af 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -571,7 +571,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. **Response**: -- cgit v1.2.3 From 95fe935a2b47550b2be468f621fe89ab1ab113d8 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:50:08 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98Anastasis-Version?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index f6d92af..b85293a 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -576,7 +576,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. **Response**: :http:statuscode:`204 No content`: - The encrypted recovery document was accepted and stored. "Anastasis-Version" and "Anastasis-UUID" headers + The encrypted recovery document was accepted and stored. ``Anastasis-Version`` and "Anastasis-UUID" headers indicate what version and UUID was assigned to this encrypted recovery document upload by the server. :http:statuscode:`304 Not modified`: The same encrypted recovery document was previously accepted and stored. "Anastasis-Version" header -- cgit v1.2.3 From 891e607051f576a05aa99af310cb57af8bcc697d Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:50:30 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98Anastasis-UUID=E2=80=99?= =?UTF-8?q?=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index b85293a..b19f89e 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -576,7 +576,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. **Response**: :http:statuscode:`204 No content`: - The encrypted recovery document was accepted and stored. ``Anastasis-Version`` and "Anastasis-UUID" headers + The encrypted recovery document was accepted and stored. ``Anastasis-Version`` and ``Anastasis-UUID`` headers indicate what version and UUID was assigned to this encrypted recovery document upload by the server. :http:statuscode:`304 Not modified`: The same encrypted recovery document was previously accepted and stored. "Anastasis-Version" header -- cgit v1.2.3 From 696865476d27b40a0e097455c0894d072aae25a7 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:51:08 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98Anastasis-Version?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index b19f89e..1ae1c6e 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -579,7 +579,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. The encrypted recovery document was accepted and stored. ``Anastasis-Version`` and ``Anastasis-UUID`` headers indicate what version and UUID was assigned to this encrypted recovery document upload by the server. :http:statuscode:`304 Not modified`: - The same encrypted recovery document was previously accepted and stored. "Anastasis-Version" header + The same encrypted recovery document was previously accepted and stored. ``Anastasis-Version`` header indicates what version was previously assigned to this encrypted recovery document. :http:statuscode:`400 Bad request`: The ``$ACCOUNT_PUB`` is not an EdDSA public key or mandatory headers are missing. -- cgit v1.2.3 From 8f3d08a77db044579aaea1bd608f14f3cea5c2d5 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:52:08 -0400 Subject: add period at end of sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 1ae1c6e..2f7e7e9 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -603,7 +603,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. // encrypted_compressed_recovery_document. nonce: [32]; //bytearray - // Authentication tag + // Authentication tag. aes_gcm_tag: [16]; //bytearray // Variable-size encrypted recovery document. After decryption, -- cgit v1.2.3 From 5a54c66cfd97be49614c250543af3c60a76657ca Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:53:47 -0400 Subject: add period at end of sentence (two instances) --- anastasis.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 2f7e7e9..b9b79b2 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -625,10 +625,10 @@ In the following, UUID is always defined and used according to `RFC 4122`_. // to the details of how this is ultimately encoded. backup_account: []; //bytearray of undefined length - // List of escrow providers and selected authentication method + // List of escrow providers and selected authentication method. methods: EscrowMethod[]; - // List of possible decryption policies + // List of possible decryption policies. policy: DecryptionPolicy[]; } -- cgit v1.2.3 From a5d13b8e4f1a8ccd2c248b9a13b3fed909f8d2d6 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:54:11 -0400 Subject: add period at end of sentence (two instances) --- anastasis.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index b9b79b2..a4b7c4d 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -637,10 +637,10 @@ In the following, UUID is always defined and used according to `RFC 4122`_. .. ts:def:: EscrowMethod interface EscrowMethod { - // URL of the escrow provider (including possibly this Anastasis server) + // URL of the escrow provider (including possibly this Anastasis server). provider_url : string; - // Type of the escrow method (e.g. security question, SMS etc.) + // Type of the escrow method (e.g. security question, SMS etc.). escrow_type: string; // UUID of the escrow method (see /truth/ API below). -- cgit v1.2.3 From b7ccaf185a927cd437b92ac38a3089051d3595f0 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:54:45 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98/truth/=E2=80=99;=20add=20period?= =?UTF-8?q?=20at=20end=20of=20sentence?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index a4b7c4d..5f8b854 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -647,7 +647,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. uuid: string; // Key used to encrypt the `Truth` this `EscrowMethod` is related to. - // Client has to provide this key to the server when using /truth/ + // Client has to provide this key to the server when using ``/truth/``. truth_encryption_key: [32]; //bytearray // Salt used to encrypt the truth on the Anastasis server. -- cgit v1.2.3 From 35ceaa34e8e60a4c01262c243d5c32d388051355 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:55:57 -0400 Subject: fix typo: s/uuid/UUID/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 5f8b854..8be3cf2 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -679,7 +679,7 @@ In the following, UUID is always defined and used according to `RFC 4122`_. // escrow methods identified by UUID. encrypted_master_key: [32]; //bytearray - // List of escrow methods identified by their uuid. + // List of escrow methods identified by their UUID. uuid: string[]; } -- cgit v1.2.3 From dbd395fa11012503b363d651d284cf28edd27e4f Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:57:56 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98TruthUploadRequest=E2=80=99=20and?= =?UTF-8?q?=20=E2=80=98RecoveryDocument=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 8be3cf2..e3057b0 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -702,7 +702,7 @@ charge per truth operation using GNU Taler. .. http:post:: /truth/$UUID - Upload a TruthUploadRequest_-Object according to the policy the client created before (see RecoveryDocument_). + Upload a `TruthUploadRequest`_-Object according to the policy the client created before (see `RecoveryDocument`_). If request has been seen before, the server should do nothing, and otherwise store the new object. **Request:** -- cgit v1.2.3 From 98eec827479c1ae2c3a7604c78313fdb960da512 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 03:59:44 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98encrypted=5Ftruth=E2=80=99;=20add?= =?UTF-8?q?=20period=20at=20end=20of=20sentence?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index e3057b0..4268c9b 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -748,7 +748,7 @@ charge per truth operation using GNU Taler. // encrypted_truth. nonce: [32]; //bytearray - // Authentication tag of encrypted_truth + // Authentication tag of ``encrypted_truth``. aes_gcm_tag: [16]; //bytearray // Variable-size truth. After decryption, -- cgit v1.2.3 From 8d79088ebea05339ad090b3bad1ebef1c1a94a85 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:00:25 -0400 Subject: fix typo: s/mime/MIME/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4268c9b..43e261c 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -760,7 +760,7 @@ charge per truth operation using GNU Taler. // string "ECT". encrypted_truth: [80]; //bytearray - // mime type of truth, i.e. text/ascii, image/jpeg, etc. + // MIME type of truth, i.e. text/ascii, image/jpeg, etc. truth_mime: string; } -- cgit v1.2.3 From 5d3512ce0927d6af81fbf247ab60bd9752d87d3c Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:01:01 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98TruthUploadRequest=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 43e261c..23e5942 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -768,7 +768,7 @@ charge per truth operation using GNU Taler. .. http:get:: /truth/$UUID[?response=$H_RESPONSE] Get the stored encrypted key share. If ``$H_RESPONSE`` is specified by the client, the server checks - if ``$H_RESPONSE`` matches the expected response specified before within the TruthUploadRequest_ (see encrypted_truth). + if ``$H_RESPONSE`` matches the expected response specified before within the `TruthUploadRequest`_ (see encrypted_truth). Also, the user has to provide the correct *truth_encryption_key* with every get request (see below). When ``$H_RESPONSE`` is correct, the server responds with the encrypted key share. The encrypted key share is returned simply as a byte array and not in JSON format. -- cgit v1.2.3 From 02bbcb92e7df261f1c33cfd6d74ba35c872008cb Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:01:15 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98encrypted=5Ftruth=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 23e5942..bdc0e49 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -768,7 +768,7 @@ charge per truth operation using GNU Taler. .. http:get:: /truth/$UUID[?response=$H_RESPONSE] Get the stored encrypted key share. If ``$H_RESPONSE`` is specified by the client, the server checks - if ``$H_RESPONSE`` matches the expected response specified before within the `TruthUploadRequest`_ (see encrypted_truth). + if ``$H_RESPONSE`` matches the expected response specified before within the `TruthUploadRequest`_ (see ``encrypted_truth``). Also, the user has to provide the correct *truth_encryption_key* with every get request (see below). When ``$H_RESPONSE`` is correct, the server responds with the encrypted key share. The encrypted key share is returned simply as a byte array and not in JSON format. -- cgit v1.2.3 From 82ca68230feac364b75f39aedfe72455a5042239 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:01:32 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98EncryptedKeyShare=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index bdc0e49..682a65c 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -776,7 +776,7 @@ charge per truth operation using GNU Taler. **Response**: :http:statuscode:`200 OK`: - EncryptedKeyShare_ is returned in body (in binary). + `EncryptedKeyShare`_ is returned in body (in binary). :http:statuscode:`202 Accepted`: The escrow provider will respond out-of-band (i.e. SMS). The body may contain human-readable instructions on next steps. -- cgit v1.2.3 From 67a203f4a5afc1d3d91c814c5c1b289484ef31ee Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:02:13 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98Location=E2=80=99=20fro?= =?UTF-8?q?m=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 682a65c..a4c7428 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -786,7 +786,7 @@ charge per truth operation using GNU Taler. :http:statuscode:`303 See other`: The provider redirects for authentication (i.e. video identification/WebRTC). If the client is not a browser, it should launch a browser at the URL - given in the "Location" header and allow the user to re-try the operation + given in the ``Location`` header and allow the user to re-try the operation after successful authorization. :http:statuscode:`402 Payment required`: The service requires payment for access to truth. -- cgit v1.2.3 From ad77076e69f8afca507bf0cc8a3f39e725a537a1 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:03:03 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98truth=E2=80=99=20from?= =?UTF-8?q?=20'=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index a4c7428..3efe34a 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -800,7 +800,7 @@ charge per truth operation using GNU Taler. The server has not (recently) issued a challenge under the given UUID, but a reply was provided. (This does not apply for secure question.) :http:statuscode:`417 Expectation Failed`: - The decrypted 'truth' does not match the expectations of the authentication + The decrypted ``truth`` does not match the expectations of the authentication backend, i.e. a phone number for sending an SMS is not a number, or an e-mail address for sending an E-mail is not a valid e-mail address. :http:statuscode:`503 Service Unavailable`: -- cgit v1.2.3 From 29bc97af53f605746ffb98d5a9fb2ea94d379a01 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:05:42 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98TruthUploadRequest=E2=80=99=20(two?= =?UTF-8?q?=20instances)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 3efe34a..46f6e4f 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -806,8 +806,8 @@ charge per truth operation using GNU Taler. :http:statuscode:`503 Service Unavailable`: Server is out of Service. - *Truth-Decryption-Key*: Key used to encrypt the **truth** (see encrypted_truth within TruthUploadRequest_) and which has to provided by the user. The key is stored with - the according EscrowMethod_. The server needs this key to get the info out of TruthUploadRequest_ needed to verify the ``$RESPONSE``. + *Truth-Decryption-Key*: Key used to encrypt the **truth** (see encrypted_truth within `TruthUploadRequest`_) and which has to provided by the user. The key is stored with + the according EscrowMethod_. The server needs this key to get the info out of `TruthUploadRequest`_ needed to verify the ``$RESPONSE``. **Details:** -- cgit v1.2.3 From 78cb6dad33f5adc886a23cc0631130a6e2111f7d Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:05:54 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98EscrowMethod=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 46f6e4f..9f29f46 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -807,7 +807,7 @@ charge per truth operation using GNU Taler. Server is out of Service. *Truth-Decryption-Key*: Key used to encrypt the **truth** (see encrypted_truth within `TruthUploadRequest`_) and which has to provided by the user. The key is stored with - the according EscrowMethod_. The server needs this key to get the info out of `TruthUploadRequest`_ needed to verify the ``$RESPONSE``. + the according `EscrowMethod`_. The server needs this key to get the info out of `TruthUploadRequest`_ needed to verify the ``$RESPONSE``. **Details:** -- cgit v1.2.3 From 420d110b7ed87819cd5a462a6f80ad469653833b Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:06:12 -0400 Subject: add period at end of sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 9f29f46..63707e0 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -818,7 +818,7 @@ charge per truth operation using GNU Taler. // Nonce used to compute the decryption (iv,key) pair. nonce_i: [32]; //bytearray - // Authentication tag + // Authentication tag. aes_gcm_tag_i: [16]; //bytearray // Encrypted key-share in base32 encoding. -- cgit v1.2.3 From c5bf3d4435c58b95a69213d2d4514b495d5c0f59 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:06:43 -0400 Subject: add period at end of sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 63707e0..8cc7ea8 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -831,7 +831,7 @@ charge per truth operation using GNU Taler. // Depending on the method, // the HKDF may additionally include // bits from the response (i.e. some hash over the - // answer to the security question) + // answer to the security question). encrypted_key_share_i: [32]; //bytearray } -- cgit v1.2.3 From 7411727d207e9fe0716f252e61719874b12db5ae Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:07:05 -0400 Subject: fix typo: s/uuid/UUID/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 8cc7ea8..2cf9190 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -844,7 +844,7 @@ charge per truth operation using GNU Taler. // the key to decrypt the master key. key_share: [32]; //bytearray - // Signature over method, uuid, and key_share. + // Signature over method, UUID, and key_share. account_sig: EddsaSignature; } -- cgit v1.2.3 From 5659ed216073b30ff222d2b551acb29ef0a27a0b Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:07:26 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98key=5Fshare=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 2cf9190..b080104 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -844,7 +844,7 @@ charge per truth operation using GNU Taler. // the key to decrypt the master key. key_share: [32]; //bytearray - // Signature over method, UUID, and key_share. + // Signature over method, UUID, and ``key_share``. account_sig: EddsaSignature; } -- cgit v1.2.3 From f5558ed2ff8dd2aa97432f791779a49c01314552 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:09:20 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98select=5Fcontinent?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index b080104..92256de 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -880,7 +880,7 @@ arguments given to the reducer. A **transition argument** also is a statement in } The new state returned by the reducer with the state and transition argument defined -above would look like following for the transition action_ "select_continent": +above would look like following for the transition action_ ``select_continent``: .. code-block:: json -- cgit v1.2.3 From 32a6e02ffca80ab0c3e57cc8bbc5e033422ec54c Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:10:54 -0400 Subject: fix typo: s/lead/led/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 92256de..21e7ea9 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -927,7 +927,7 @@ States Overall, the reducer knows the following states: - - **ERROR**: The transition lead to an error. No further transitions are possible from + - **ERROR**: The transition led to an error. No further transitions are possible from this state, but the client may want to continue from a previous state. - **CONTINENT_SELECTING**: The user should specify the continent where they are living, so that we can show a list of countries to choose from. -- cgit v1.2.3 From 613e53b968f640ea7e8ef224b8ffaaa2a40b8792 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:15:49 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98continents=5Fi18n?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 21e7ea9..aca5d1a 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1034,7 +1034,7 @@ continents which contain countries for which Anastasis could function (based on having providers that are known to operate and rules being provided for user attributes from those countries). -For internationalization, another field "continents_i18n" may be present. +For internationalization, another field ``continents_i18n`` may be present. This field would be a map of language names to arrays of translated continent names: -- cgit v1.2.3 From a8ec79b54587beca2f4bb13a6cb6ed0fd6959d64 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:16:27 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98continents=E2=80=99=20f?= =?UTF-8?q?rom=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index aca5d1a..60ff1c2 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1075,7 +1075,7 @@ Here the user specifies the continent they live on. Arguments (example): "continent": "Europe" } -The continent must be given using the English name from the "continents" array. +The continent must be given using the English name from the ``continents`` array. Using a translated continent name is invalid and may result in failure. The reducer returns an updated state with a list of countries to choose from, -- cgit v1.2.3 From d8ff3486ce05ad391b024ac8083919e06df72f68 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:17:16 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98countries=E2=80=99=20fr?= =?UTF-8?q?om=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 60ff1c2..6be4a85 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1117,7 +1117,7 @@ for example: ] } -Here "countries" is an array of countries on the "selected_continent". For +Here ``countries`` is an array of countries on the "selected_continent". For each country, the "code" is the ISO 3166-1 alpha-2 country code. The "continent" is only present because some countries span continents, the information is redundant and will always match "selected_continent". The -- cgit v1.2.3 From 51e17476c216827b0c90164bcd585d09371f2ee9 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:17:30 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98selected=5Fcontinent?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 6be4a85..45774b8 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1117,7 +1117,7 @@ for example: ] } -Here ``countries`` is an array of countries on the "selected_continent". For +Here ``countries`` is an array of countries on the ``selected_continent``. For each country, the "code" is the ISO 3166-1 alpha-2 country code. The "continent" is only present because some countries span continents, the information is redundant and will always match "selected_continent". The -- cgit v1.2.3 From c930df6e0703bfee9fab6bbffad4306f741f3c3d Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:17:42 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98code=E2=80=99=20from=20?= =?UTF-8?q?"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 45774b8..49ab9d7 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1118,7 +1118,7 @@ for example: } Here ``countries`` is an array of countries on the ``selected_continent``. For -each country, the "code" is the ISO 3166-1 alpha-2 country code. The +each country, the ``code`` is the ISO 3166-1 alpha-2 country code. The "continent" is only present because some countries span continents, the information is redundant and will always match "selected_continent". The "name" is the name of the country in English, internationalizations of the -- cgit v1.2.3 From e73729dcc59705a7c25234a6b2584f175ec384e0 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:18:15 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98continent=E2=80=99=20fr?= =?UTF-8?q?om=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 49ab9d7..77e5b94 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1119,7 +1119,7 @@ for example: Here ``countries`` is an array of countries on the ``selected_continent``. For each country, the ``code`` is the ISO 3166-1 alpha-2 country code. The -"continent" is only present because some countries span continents, the +``continent`` is only present because some countries span continents, the information is redundant and will always match "selected_continent". The "name" is the name of the country in English, internationalizations of the name may be provided in "name_i18n". The "currency" is **an** official -- cgit v1.2.3 From 023ff3891c95b72d81f26cbcfada3de0760e282f Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:18:32 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98selected=5Fcontinent?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 77e5b94..e821776 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1120,7 +1120,7 @@ for example: Here ``countries`` is an array of countries on the ``selected_continent``. For each country, the ``code`` is the ISO 3166-1 alpha-2 country code. The ``continent`` is only present because some countries span continents, the -information is redundant and will always match "selected_continent". The +information is redundant and will always match ``selected_continent``. The "name" is the name of the country in English, internationalizations of the name may be provided in "name_i18n". The "currency" is **an** official currency of the country, if a country has multiple currencies, it may appear -- cgit v1.2.3 From 10b3084747fe88ea57f74601c9cb90dea6c351a8 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:18:51 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98name=E2=80=99=20from=20?= =?UTF-8?q?"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index e821776..4bd1809 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1121,7 +1121,7 @@ Here ``countries`` is an array of countries on the ``selected_continent``. For each country, the ``code`` is the ISO 3166-1 alpha-2 country code. The ``continent`` is only present because some countries span continents, the information is redundant and will always match ``selected_continent``. The -"name" is the name of the country in English, internationalizations of the +``name`` is the name of the country in English, internationalizations of the name may be provided in "name_i18n". The "currency" is **an** official currency of the country, if a country has multiple currencies, it may appear multiple times in the list. In this case, the user should select the entry -- cgit v1.2.3 From 9b0b7add954a292086bcd04f81e28d5a89f41a36 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:19:05 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98name=5Fi18n=E2=80=99=20?= =?UTF-8?q?from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4bd1809..49828af 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1122,7 +1122,7 @@ each country, the ``code`` is the ISO 3166-1 alpha-2 country code. The ``continent`` is only present because some countries span continents, the information is redundant and will always match ``selected_continent``. The ``name`` is the name of the country in English, internationalizations of the -name may be provided in "name_i18n". The "currency" is **an** official +name may be provided in ``name_i18n``. The "currency" is **an** official currency of the country, if a country has multiple currencies, it may appear multiple times in the list. In this case, the user should select the entry with the currency they intend to pay with. It is also possible for users -- cgit v1.2.3 From f18ece15d3682a5a61bc9124a8c8166b58b74cda Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:19:22 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98currency=E2=80=99=20fro?= =?UTF-8?q?m=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 49828af..ee385ac 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1122,7 +1122,7 @@ each country, the ``code`` is the ISO 3166-1 alpha-2 country code. The ``continent`` is only present because some countries span continents, the information is redundant and will always match ``selected_continent``. The ``name`` is the name of the country in English, internationalizations of the -name may be provided in ``name_i18n``. The "currency" is **an** official +name may be provided in ``name_i18n``. The ``currency`` is **an** official currency of the country, if a country has multiple currencies, it may appear multiple times in the list. In this case, the user should select the entry with the currency they intend to pay with. It is also possible for users -- cgit v1.2.3 From e5bdc8a68cfd89a09aca1f0ffa38769a55308356 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:20:20 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98country=5Fcode=E2=80=99?= =?UTF-8?q?=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index ee385ac..552a4fa 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1146,7 +1146,7 @@ Arguments (example): "currency": "EUR" } -The "country_code" must be an ISO 3166-1 alpha-2 country code from +The ``country_code`` must be an ISO 3166-1 alpha-2 country code from the array of "countries" of the reducer's state. The "currency" field must be a valid currency accepted by the Taler payment system. -- cgit v1.2.3 From 10be927697eb7e96d773e0e38e91dffab0a05638 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:20:34 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98countries=E2=80=99=20fr?= =?UTF-8?q?om=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 552a4fa..e667138 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1147,7 +1147,7 @@ Arguments (example): } The ``country_code`` must be an ISO 3166-1 alpha-2 country code from -the array of "countries" of the reducer's state. The "currency" +the array of ``countries`` of the reducer's state. The "currency" field must be a valid currency accepted by the Taler payment system. The reducer returns a new state with the list of attributes the -- cgit v1.2.3 From 594b5482cb61c1d1d49c7973a5606fbd9db13627 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:20:43 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98currency=E2=80=99=20fro?= =?UTF-8?q?m=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index e667138..351cb52 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1147,7 +1147,7 @@ Arguments (example): } The ``country_code`` must be an ISO 3166-1 alpha-2 country code from -the array of ``countries`` of the reducer's state. The "currency" +the array of ``countries`` of the reducer's state. The ``currency`` field must be a valid currency accepted by the Taler payment system. The reducer returns a new state with the list of attributes the -- cgit v1.2.3 From 067c7df0ec0114eb953d9df5be37c7cfd6e16395 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:21:37 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98required=5Fattributes?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 351cb52..6e9d132 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1255,7 +1255,7 @@ providers that accept payments in the selected currency: } } -The array of "required_attributes" contains attributes about the user +The array of ``required_attributes`` contains attributes about the user that must be provided includes: - **type**: the type of the attribute, for now only 'string' and 'date' are -- cgit v1.2.3 From 5da2ca9ba926decf011b9bd8166bfa070ada0810 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:22:48 -0400 Subject: capitalize first word in sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 6e9d132..e6527d7 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1258,7 +1258,7 @@ providers that accept payments in the selected currency: The array of ``required_attributes`` contains attributes about the user that must be provided includes: - - **type**: the type of the attribute, for now only 'string' and 'date' are + - **type**: The type of the attribute, for now only 'string' and 'date' are supported - **name**: the name of the attribute, this is the key under which the attribute value must be provided later. The name must be unique per response. -- cgit v1.2.3 From 50da2463791b13b7a0909a9a6109ad12a11449a2 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:23:09 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98string=E2=80=99,=20?= =?UTF-8?q?=E2=80=98date=E2=80=99=20from=20'=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index e6527d7..735ab5f 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1258,7 +1258,7 @@ providers that accept payments in the selected currency: The array of ``required_attributes`` contains attributes about the user that must be provided includes: - - **type**: The type of the attribute, for now only 'string' and 'date' are + - **type**: The type of the attribute, for now only ``string`` and ``date`` are supported - **name**: the name of the attribute, this is the key under which the attribute value must be provided later. The name must be unique per response. -- cgit v1.2.3 From 4806f63d9b0807011cb45ecae19c7a05d8abff38 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:23:18 -0400 Subject: add period at end of sentence --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 735ab5f..caa491d 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1259,7 +1259,7 @@ The array of ``required_attributes`` contains attributes about the user that must be provided includes: - **type**: The type of the attribute, for now only ``string`` and ``date`` are - supported + supported. - **name**: the name of the attribute, this is the key under which the attribute value must be provided later. The name must be unique per response. - **label**: a human-readable description of the attribute in English. -- cgit v1.2.3 From fd3457d2857976b302d91d90d6e38e07afe26ea1 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:24:36 -0400 Subject: capitalize first word in sentence (seven instances) --- anastasis.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index caa491d..94a0d18 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1260,27 +1260,27 @@ that must be provided includes: - **type**: The type of the attribute, for now only ``string`` and ``date`` are supported. - - **name**: the name of the attribute, this is the key under which the + - **name**: The name of the attribute, this is the key under which the attribute value must be provided later. The name must be unique per response. - - **label**: a human-readable description of the attribute in English. + - **label**: A human-readable description of the attribute in English. Translated descriptions may be provided under **label_i18n**. - - **uuid**: a UUID that uniquely identifies identical attributes across + - **uuid**: A UUID that uniquely identifies identical attributes across different countries. Useful to preserve values should the user enter some attributes, and then switch to another country. Note that attributes must not be preserved if they merely have the same **name**, only the **uuid** will be identical if the semantics is identicial. - - **widget**: an optional name of a widget that is known to nicely render + - **widget**: An optional name of a widget that is known to nicely render the attribute entry in user interfaces where named widgets are supported. - - **validation-regex**: an optional extended POSIX regular expression + - **validation-regex**: An optional extended POSIX regular expression that is to be used to validate (string) inputs to ensure they are well-formed. - - **validation-logic**: optional name of a function that should be called + - **validation-logic**: Optional name of a function that should be called to validate the input. If the function is not known to the particular client, the respective validation can be skipped (at the expense of typos by users not being detected, possibly rendering secrets irrecoverable). - - **optional**: optional boolean field that, if ``true``, indicates that + - **optional**: Optional boolean field that, if ``true``, indicates that this attribute is not actually required but optional and users MAY leave it blank in case they do not have the requested information. Used for common fields that apply to some large part of the population but are -- cgit v1.2.3 From 4f005a2f8ec287d3b5ed27be15c315e0f327b117 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:25:12 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98200=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 94a0d18..d23faf0 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1290,7 +1290,7 @@ The authentication providers are listed under a key that is the base URL of the service. For each provider, the following information is provided if the provider was successfully contacted: - - **http_status**: HTTP status code, always 200 on success. + - **http_status**: HTTP status code, always ``200`` on success. - **methods**: array of authentication methods supported by this provider. Includes the **type** of the authentication method and the **usage_fee** (how much the user must pay for authorization -- cgit v1.2.3 From 71698f16b9a73fee0ecb1dc35590997cdbf7ccd4 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:26:14 -0400 Subject: capitalize first word in sentence (eight instances) --- anastasis.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index d23faf0..318f3c2 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1291,24 +1291,24 @@ base URL of the service. For each provider, the following information is provided if the provider was successfully contacted: - **http_status**: HTTP status code, always ``200`` on success. - - **methods**: array of authentication methods supported by this + - **methods**: Array of authentication methods supported by this provider. Includes the **type** of the authentication method and the **usage_fee** (how much the user must pay for authorization using this method during recovery). - - **annual_fee**: fee the provider charges to store the recovery + - **annual_fee**: Fee the provider charges to store the recovery policy for one year. - - **truth_upload_fee**: fee the provider charges to store a key share. + - **truth_upload_fee**: Fee the provider charges to store a key share. - **truth_lifetime**: Taler-style relative time that specifies how long the provider will store truth data (key shares) after an upload. - - **liability_limit**: amount the provider can be held liable for in + - **liability_limit**: Amount the provider can be held liable for in case a key share or recovery document cannot be recovered due to provider failures. - - **currency**: currency in which the provider wants to be paid, + - **currency**: Currency in which the provider wants to be paid, will match all of the fees. - - **storage_limit_in_megabytes**: maximum size of an upload (for + - **storage_limit_in_megabytes**: Maximum size of an upload (for both recovery document and truth data) in megabytes. - - **provider_name**: human-readable name of the provider's business. - - **salt**: salt value used by the provider, used to derive the + - **provider_name**: Human-readable name of the provider's business. + - **salt**: Salt value used by the provider, used to derive the user's identity at this provider. Should be unique per provider, and must never change for a given provider. The salt is base32 encoded. -- cgit v1.2.3 From d0ab21ac76cf19650e508de8d3dc80daecdf51c2 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:26:51 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98USER=5FATTRIBUTES=5FCOL?= =?UTF-8?q?LECTING=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 318f3c2..1e54b17 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1322,7 +1322,7 @@ If contacting the provider failed, the information returned is: **add_provider**: -This operation can be performed in state "USER_ATTRIBUTES_COLLECTING". It +This operation can be performed in state ``USER_ATTRIBUTES_COLLECTING``. It adds one or more Anastasis providers to the list of providers the reducer should henceforth consider. Note that removing providers is not possible at this time. -- cgit v1.2.3 From a95ab3b3091d0070844a280f164ce31a000262bd Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:29:22 -0400 Subject: add comma --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 1e54b17..0c3b2a7 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1434,7 +1434,7 @@ to it: } If required attributes are missing, do not match the required regular -expression or fail the custom validation logic, the reducer SHOULD transition +expression, or fail the custom validation logic, the reducer SHOULD transition to an error state indicating what was wrong about the input. A reducer that does not support some specific validation logic MAY accept the invalid input and proceed anyway. The error state will include a Taler error code that -- cgit v1.2.3 From dc506f36a768b366c0ad419c9638c5558f31de07 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:30:11 -0400 Subject: fix typo: s/statisfy/satisfy/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 0c3b2a7..1656c0c 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1450,7 +1450,7 @@ is specific to the failure, and optional details. Example: } Clients may safely repeat this transition to validate the user's inputs -until they statisfy all of the constraints. This way, the user interface +until they satisfy all of the constraints. This way, the user interface does not have to perform the input validation directly. -- cgit v1.2.3 From 5d0778fb48e3e343f1dd5fee823ef7504fd3d654 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:32:30 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98ERROR=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 1656c0c..9b7affc 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1537,7 +1537,7 @@ response: } If the index is invalid, the reducer will instead -transition into an ERROR state. +transition into an ``ERROR`` state. **next** (from "AUTHENTICATIONS_EDITING"): -- cgit v1.2.3 From 4ff5cec4bdac47648ac4ef67f425f04f81f88267 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:32:48 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98AUTHENTICATIONS=5FEDITI?= =?UTF-8?q?NG=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 9b7affc..d5a0e4b 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1540,7 +1540,7 @@ If the index is invalid, the reducer will instead transition into an ``ERROR`` state. -**next** (from "AUTHENTICATIONS_EDITING"): +**next** (from ``AUTHENTICATIONS_EDITING``): This transition confirms that the user has finished adding (or removing) authentication methods, and that the system should now automatically compute -- cgit v1.2.3 From 161bfec9171130305a29d022e10b253f0f3ebbef Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:35:01 -0400 Subject: add link to bug #6760 --- anastasis.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index d5a0e4b..535e4c3 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1561,7 +1561,8 @@ providers: ..note:: - This is currently not supported (#6760), the current implementation of the + This is currently not supported (see `bug 6760 `_), + the current implementation of the reducer ignores this optional argument. The resulting state provides the suggested recovery policies in a way suitable -- cgit v1.2.3 From 6553f66e7ec0b08c8b744b7d9c18d8d6d3ce1827 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:35:38 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98ERROR=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 535e4c3..4506121 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1615,7 +1615,7 @@ policy. The ``methods`` array specifies the index of the the provider that was selected to supervise this authentication. If no authentication method was provided, the reducer will transition into an -ERROR state instead of suggesting policies. +``ERROR`` state instead of suggesting policies. **add_policy**: -- cgit v1.2.3 From 56e1197cb56550e814904c480b7817e65ffe6f45 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:36:44 -0400 Subject: fix typo: s/add/adds/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4506121..f5008d9 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1700,7 +1700,7 @@ the "policies" array, returning an updated state: ] } -If the new policy is invalid, for example because it add an unknown +If the new policy is invalid, for example because it adds an unknown authentication method or the selected provider does not support the type of authentication, the reducer will transition into an ERROR state instead of adding the new policy. -- cgit v1.2.3 From 76850a68bb06a56e08fe89d47ed5e6859c7ab289 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:36:54 -0400 Subject: add comma --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index f5008d9..7c0baae 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1701,7 +1701,7 @@ the "policies" array, returning an updated state: } If the new policy is invalid, for example because it adds an unknown -authentication method or the selected provider does not support the type of +authentication method, or the selected provider does not support the type of authentication, the reducer will transition into an ERROR state instead of adding the new policy. -- cgit v1.2.3 From 5adc9e36b206527b6612d7ad67780d51ba775e66 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:37:03 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98ERROR=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 7c0baae..99715b5 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1702,7 +1702,7 @@ the "policies" array, returning an updated state: If the new policy is invalid, for example because it adds an unknown authentication method, or the selected provider does not support the type of -authentication, the reducer will transition into an ERROR state instead of +authentication, the reducer will transition into an ``ERROR`` state instead of adding the new policy. -- cgit v1.2.3 From 10a7583033a9f122e01ce19f56cec2beb0e1e440 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:37:37 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98ERROR=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 99715b5..1edac80 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1764,7 +1764,7 @@ be: ] } -If the index given is invalid, the reducer will transition into an ERROR state +If the index given is invalid, the reducer will transition into an ``ERROR`` state instead of deleting a policy. -- cgit v1.2.3 From 1ee7fb21890ccec76673bcaa2b5cc8d4f2cba382 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:38:00 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98POLICIES=5FREVIEWING?= =?UTF-8?q?=E2=80=99=20from=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 1edac80..5d98849 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1768,7 +1768,7 @@ If the index given is invalid, the reducer will transition into an ``ERROR`` sta instead of deleting a policy. -**next** (from "POLICIES_REVIEWING"): +**next** (from ``POLICIES_REVIEWING``): Using this transition, the user confirms that the policies in the current state are acceptable. The transition does not take any arguments. -- cgit v1.2.3 From 681ca291d2f8a45a85fb99eba63b454074980667 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:39:01 -0400 Subject: =?UTF-8?q?mark=20up=20=E2=80=98ERROR=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 5d98849..96844bc 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1783,7 +1783,7 @@ The reducer will simply transition to the ``SECRET_EDITING`` state: If the array of ``policies`` is currently empty, the reducer will transition -into an ERROR state instead of allowing the user to continue. +into an ``ERROR`` state instead of allowing the user to continue. **enter_secret:** -- cgit v1.2.3 From 0b1deab5fa4b081bc27738dbc6c31e94a82c95ff Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:39:42 -0400 Subject: add missing close-brace --- anastasis.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 96844bc..9770fa9 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1799,6 +1799,7 @@ for example: "secret": { "value": "EDJP6WK5EG50", "mime" : "text/plain" + } } If the application is unaware of the format, it set the ``mime`` field to ``null`. -- cgit v1.2.3 From 8dee9f11b12608754f0c54b778d8a6c520c66fe5 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:40:14 -0400 Subject: fix typo: add backtick --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 9770fa9..001a375 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1802,7 +1802,7 @@ for example: } } -If the application is unaware of the format, it set the ``mime`` field to ``null`. +If the application is unaware of the format, it set the ``mime`` field to ``null``. After adding a secret, the reducer may transition into different states depending on whether payment(s) are necessary. If payments are needed, the -- cgit v1.2.3 From cbe88832e8ef47093c73a6dc06de482d53fe8948 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:42:55 -0400 Subject: add period at end of sentence (three instances) --- anastasis.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 001a375..99b073e 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1882,9 +1882,9 @@ final error state would be: Here, the fields have the following meaning: - - **http_status** is the HTTP status returned by the Anastasis provider - - **upload_status** is the Taler error code return by the provider - - **provider_url** is the base URL of the failing provider + - **http_status** is the HTTP status returned by the Anastasis provider. + - **upload_status** is the Taler error code return by the provider. + - **provider_url** is the base URL of the failing provider. In the above example, 52 would thus imply that the Anastasis provider failed to store information into its database. -- cgit v1.2.3 From c307288901cbf5f0e671e35119c5261c67f8a139 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:43:52 -0400 Subject: fix typo: use ** instead of __ to end markup --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 99b073e..6750831 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1899,7 +1899,7 @@ This transition provides the user's personal attributes. The specific set of attributes required depends on the country of residence of the user. Some attributes may be optional, in which case they should be omitted entirely (that is, not simply be set to ``null`` or an empty string). The -arguments are identical to the **enter_user_attributes__ transition from +arguments are identical to the **enter_user_attributes** transition from the backup process. Example arguments would thus be: .. code-block:: json -- cgit v1.2.3 From 7b49f061f570691dada16b6f11399eb8c610ee89 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:45:51 -0400 Subject: capitalize first word in sentence (four instances) --- anastasis.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 6750831..4101362 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1966,15 +1966,15 @@ to be recovered. The ``provider_url`` from where the recovery document was obtained and its ``version`` are also provided. Each challenge comes with four mandatory fields: - - **uuid**: a unique identifier of the challenge; this is what the + - **uuid**: A unique identifier of the challenge; this is what the UUIDs in the policies array refer to, but also this UUID may be included in messages sent to the user. They allow the user to distinguish different PIN/TANs should say the same phone number be used for SMS-authentication with different providers. - - **cost**: this is the amount the Anastasis provider will charge + - **cost**: This is the amount the Anastasis provider will charge to allow the user to pass the challenge. - - **type**: this is the type of the challenge, as a string. - - **instructions**: contains additional important hints for the user + - **type**: This is the type of the challenge, as a string. + - **instructions**: Contains additional important hints for the user to allow the user to satisfy the challenge. It typically includes an abbreviated form of the contact information or the security question. Details depend on ``type``. -- cgit v1.2.3 From f2d2f39726fc6b7325dc1a1fa53123356082e489 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:46:07 -0400 Subject: add comma --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4101362..5e401ed 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1980,7 +1980,7 @@ four mandatory fields: question. Details depend on ``type``. If a recovery document was not found, either the user never performed -a backup, entered incorrect attributes or used a provider not yet in +a backup, entered incorrect attributes, or used a provider not yet in the list of Anastasis providers. Hence, the user must now either select a different provider, or go ``back`` and update the identity attributes. In the case a recovery document was not found, the -- cgit v1.2.3 From 99940bd88bff9f1635d1cd101c7b7c3f559f69c1 Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:47:10 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98anastasis=E2=80=99=20fr?= =?UTF-8?q?om=20"=20to=20``?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 5e401ed..4cda3a4 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1999,7 +1999,7 @@ Here, the ``error_code`` is from the ``enum ANASTASIS_RecoveryStatus`` and describes precisely what failed about the download, while the ``error_message`` is a human-readable (English) explanation of the code. Applications may want to translate the message using GNU gettext; -translations should be available in the "anastasis" text domain. +translations should be available in the ``anastasis`` text domain. However, in general it should be sufficient to display the slightly more generic Taler error code that is returned with the new state. -- cgit v1.2.3 From a641188cb98a1bdc96160ebaa2555aa69bc3a55a Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:48:04 -0400 Subject: =?UTF-8?q?change=20markup=20of=20=E2=80=98the=20latest=20version?= =?UTF-8?q?=E2=80=99=20from=20``=20to=20"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4cda3a4..4aa83cf 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -2020,7 +2020,7 @@ which takes a provider URL and policy version as arguments: "version": 2 } -Note that using a version of 0 implies fetching ``the latest version``. The +Note that using a version of 0 implies fetching "the latest version". The resulting states are the same as those of the ``enter_user_attributes`` transition, except that the recovery document version is not necessarily the latest available version at the provider. -- cgit v1.2.3 From 2062174a8bee6de787ec16a1ef0101ce0491cded Mon Sep 17 00:00:00 2001 From: Thien-Thi Nguyen Date: Wed, 7 Apr 2021 04:56:58 -0400 Subject: diction: s/information about per/personal information/ --- anastasis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'anastasis.rst') diff --git a/anastasis.rst b/anastasis.rst index 4aa83cf..7adeb0b 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -2341,7 +2341,7 @@ Video identification (vid) Requires the user to identify via video-call. In the video-call, the user is told the code (prefixed with ``A-``) needed to authenticate. -The user is expected to delete all metadata revealing information about per +The user is expected to delete all metadata revealing personal information from the images before uploading them. Since the respective images must be passed on to the video identification service in the event of password recovery, it should be ensured that no further information about the user can -- cgit v1.2.3