summaryrefslogtreecommitdiff
path: root/anastasis.rst
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2021-02-24 22:41:06 +0100
committerChristian Grothoff <christian@grothoff.org>2021-02-24 22:41:06 +0100
commit25ff2e7b82dcdaffd673260f462c891884cd375a (patch)
tree877e25553a55a16cc40b81a341175447964b8320 /anastasis.rst
parent011582ab8b3556eca8e90b2d14c689e14814f33a (diff)
downloaddocs-25ff2e7b82dcdaffd673260f462c891884cd375a.tar.gz
docs-25ff2e7b82dcdaffd673260f462c891884cd375a.tar.bz2
docs-25ff2e7b82dcdaffd673260f462c891884cd375a.zip
use type instead of method/name
Diffstat (limited to 'anastasis.rst')
-rw-r--r--anastasis.rst117
1 files changed, 61 insertions, 56 deletions
diff --git a/anastasis.rst b/anastasis.rst
index 9746fd8c..3d0bc1ff 100644
--- a/anastasis.rst
+++ b/anastasis.rst
@@ -405,10 +405,10 @@ Receiving Configuration
interface AuthorizationMethodConfig {
// name of the authorization method
- name: string;
+ type: string;
// Fee for accessing key share using this method
- usage_fee: Amount;
+ cost: Amount;
}
@@ -608,8 +608,8 @@ In the following, UUID is always defined and used according to `RFC 4122`_.
// URL of the escrow provider (including possibly this Anastasis server)
provider_url : string;
- // Name of the escrow method (e.g. security question, SMS etc.)
- escrow_method: string;
+ // Type of the escrow method (e.g. security question, SMS etc.)
+ escrow_type: string;
// UUID of the escrow method (see /truth/ API below).
uuid: string;
@@ -701,7 +701,7 @@ charge per truth operation using GNU Taler.
key_share_data: []; //bytearray
// Key share method, i.e. "security question", "SMS", "e-mail", ...
- method: string;
+ type: string;
// Nonce used to compute the (iv,key) pair for encryption of the
// encrypted_truth.
@@ -1008,12 +1008,16 @@ Expected new state:
**select_country:**
+Selects the country (via the country code) and specifies the currency.
+The latter is needed as some countries have more than one currency,
+and some use-cases may also involve users insisting on paying with
+foreign currency.
+
Arguments (example):
.. code-block:: json
{
- "country": "Germany",
"country_code": "de",
"currency": "EUR"
}
@@ -1033,7 +1037,7 @@ Expected new state:
"label": "Full name",
"label_i18n": {
"de_DE": "Vollstaendiger Name",
- "de_CH": "Vollstaendiger Name",
+ "de_CH": "Vollstaendiger. Name",
"fr": "Nom complet",
"en": "Full name"
},
@@ -1067,9 +1071,9 @@ Expected new state:
"authentication_providers": {
"http://localhost:8089/": {
"methods": [
- { "name" : "question",
+ { "type" : "question",
"usage_fee" : "EUR:0.0" },
- { "name" : "sms",
+ { "type" : "sms",
"usage_fee" : "EUR:0.5" }
],
"annual_fee": "EUR:4.99",
@@ -1083,9 +1087,9 @@ Expected new state:
},
"http://localhost:8088/": {
"methods": [
- { "name" : "question",
+ { "type" : "question",
"usage_fee" : "EUR:0.01" },
- { "name" : "sms",
+ { "type" : "sms",
"usage_fee" : "EUR:0.55" }
],
"annual_fee": "EUR:0.99",
@@ -1100,45 +1104,10 @@ Expected new state:
}
}
-Backup transitions
-""""""""""""""""""
-
-**enter_user_attributes:**
-
-Arguments (example):
-
-.. code-block:: json
-
- {
- "identity_attributes": {
- "full_name": "Max Musterman",
- "social_security_number": "123456789",
- "birth_year": 2000,
- "birth_month": 1,
- "birth_day": 1
- }
- }
-
-Expected new state:
-
-.. code-block:: json
-
- {
- "backup_state": "AUTHENTICATIONS_EDITING",
- "identity_attributes": {
- "full_name": "Max Musterman",
- "social_security_number": "123456789",
- "birth_year": 2000,
- "birth_month": 1,
- "birth_day": 1
- }
- }
-
-
**add_provider**:
-This operation can be performed in state "AUTHENTICATIONS_EDITING".
+This operation can be performed in state "USER_ATTRIBUTES_COLLECTING".
Arguments (example):
@@ -1158,7 +1127,7 @@ unreachable, service on port 8088 was previously known, and service on port
.. code-block:: json
{
- "backup_state": "AUTHENTICATIONS_EDITING",
+ "backup_state": "USER_ATTRIBUTES_COLLECTING",
"authentication_providers": {
"http://localhost:8089/": {
"error_code": 11,
@@ -1166,9 +1135,9 @@ unreachable, service on port 8088 was previously known, and service on port
},
"http://localhost:8088/": {
"methods": [
- { "name" : "question",
+ { "type" : "question",
"usage_fee" : "EUR:0.01" },
- { "name" : "sms",
+ { "type" : "sms",
"usage_fee" : "EUR:0.55" }
],
"annual_fee": "EUR:0.99",
@@ -1182,9 +1151,9 @@ unreachable, service on port 8088 was previously known, and service on port
}
"http://localhost:8888/": {
"methods": [
- { "name" : "question",
+ { "type" : "question",
"usage_fee" : "EUR:0.01" },
- { "name" : "sms",
+ { "type" : "sms",
"usage_fee" : "EUR:0.55" }
],
"annual_fee": "EUR:0.99",
@@ -1200,6 +1169,42 @@ unreachable, service on port 8088 was previously known, and service on port
}
+
+Backup transitions
+""""""""""""""""""
+
+**enter_user_attributes:**
+
+Arguments (example):
+
+.. code-block:: json
+
+ {
+ "identity_attributes": {
+ "full_name": "Max Musterman",
+ "social_security_number": "123456789",
+ "birth_year": 2000,
+ "birth_month": 1,
+ "birth_day": 1
+ }
+ }
+
+Expected new state:
+
+.. code-block:: json
+
+ {
+ "backup_state": "AUTHENTICATIONS_EDITING",
+ "identity_attributes": {
+ "full_name": "Max Musterman",
+ "social_security_number": "123456789",
+ "birth_year": 2000,
+ "birth_month": 1,
+ "birth_day": 1
+ }
+ }
+
+
**add_authentication**:
Arguments (example):
@@ -1209,7 +1214,7 @@ Arguments (example):
{
"authentication_method":
{
- "method": "question",
+ "type": "question",
"mime_type" : "text/plain",
"instructions" : "What is your favorite GNU package?",
"challenge" : "gdb",
@@ -1224,13 +1229,13 @@ Expected new state:
"backup_state": "AUTHENTICATIONS_EDITING",
"authentication_methods": [
{
- "method": "question",
+ "type": "question",
"mime_type" : "text/plain",
"instructions" : "What is your favorite GNU package?",
"challenge" : "gdb",
},
{
- "method": "email",
+ "type": "email",
"challenge": "max@musterman.de"
}
]
@@ -1255,7 +1260,7 @@ Expected new state:
"backup_state": "AUTHENTICATIONS_EDITING",
"authentication_methods": [
{
- "method": "question",
+ "type": "question",
"mime_type" : "text/plain",
"instructions" : "What is your favorite GNU package?",
"challenge" : "gdb",