summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDennis Neufeld <dennis.neufeld@students.bfh.ch>2020-11-07 17:34:46 +0100
committerDennis Neufeld <dennis.neufeld@students.bfh.ch>2020-11-07 17:35:03 +0100
commit448c9435963f7ab055be777689af2ac274a80bbe (patch)
treecce2f654348bb607e9d6244b7e32a0f6317f5857
parent2fe50aacb2e17131a631ec5586f41b8debf3c701 (diff)
downloaddocs-448c9435963f7ab055be777689af2ac274a80bbe.tar.gz
docs-448c9435963f7ab055be777689af2ac274a80bbe.tar.bz2
docs-448c9435963f7ab055be777689af2ac274a80bbe.zip
mod anastasis reducer documentation - enter_secret, pay
-rw-r--r--anastasis.rst296
1 files changed, 294 insertions, 2 deletions
diff --git a/anastasis.rst b/anastasis.rst
index 37722fde..3bf2f1bf 100644
--- a/anastasis.rst
+++ b/anastasis.rst
@@ -1293,11 +1293,24 @@ No Arguments needed, but the **pay** transition may have optional arguments:
**pay:**
-Optional arguments (example):
+Optional arguments to try uploading just specific truths (example):
::
{
- //FIXME
+ "truth_index": [
+ 1,
+ 2
+ ]
+ }
+
+Optional arguments to try uploading recovery document to specific providers (example):
+::
+
+ {
+ "provider_id": [
+ "anastasis_01",
+ "anastasis_03"
+ ]
}
@@ -2267,6 +2280,285 @@ Arguments (example):
- type: *password* (secret is a password or passphrase)
- type: *data* (secret must be a Crockford-Base32 encoded string of some data, e.g. a private key)
+Expected new state:
+::
+
+ {
+ "backup_state": "POLICIES_REVIEWING",
+ "continents": [
+ "Europe",
+ "North_America"
+ ],
+ "selected_continent": "Europe",
+ "countries": [
+ {
+ "code": "ch",
+ "name": "Switzerland",
+ "continent": "Europe",
+ "name_i18n": {
+ "de_DE": "Schweiz",
+ "de_CH": "Schwiiz",
+ "fr": "Suisse",
+ "en": "Swiss"
+ },
+ "currency": "CHF"
+ },
+ {
+ "code": "de",
+ "name": "Germany",
+ "continent": "Europe",
+ "continent_i18n": {
+ "de": "Europa"
+ },
+ "name_i18n": {
+ "de_DE": "Deutschland",
+ "de_CH": "Deutschland",
+ "fr": "Allemagne",
+ "en": "Germany"
+ },
+ "currency": "EUR"
+ }
+ ],
+ "selected_country": "de",
+ "currency": "EUR",
+ "required_attributes": [
+ {
+ "type": "string",
+ "name": "full_name",
+ "label": "Full name",
+ "label_i18n": {
+ "de_DE": "Vollstaendiger Name",
+ "de_CH": "Vollstaendiger Name",
+ "fr": "Nom complet",
+ "en": "Full name"
+ },
+ "widget": "anastasis_gtk_ia_full_name"
+ },
+ {
+ "type": "date",
+ "name": "birthdate",
+ "label": "Birthdate",
+ "label_i18n": {
+ "de_DE": "Geburtsdatum",
+ "de_CH": "Geburtsdatum",
+ "fr": "Date de naissance",
+ "en": "Birthdate"
+ },
+ "widget": "anastasis_gtk_ia_birthdate"
+ },
+ {
+ "type": "string",
+ "name": "social_security_number",
+ "label": "Social security number",
+ "label_i18n": {
+ "de_DE": "Sozialversicherungsnummer",
+ "de_CH": "Sozialversicherungsnummer",
+ "fr": "Numéro de sécurité sociale",
+ "en": "Social security number"
+ },
+ "widget": "anastasis_gtk_ia_ssn"
+ }
+ ],
+ "authentication_providers": {
+ "question": [
+ {
+ "anastasis_04": {
+ "method_cost": "EUR:0",
+ "annual_cost": "EUR:4.99",
+ "insurance": "EUR:1",
+ "provider_url": "localhost:8089/",
+ "provider_name": "Anastasis 4",
+ "provider_salt": "CXAPCKSH9D3MYJTS9536RHJHCW"
+ }
+ },
+ {
+ "anastasis_03": {
+ "method_cost": "EUR:0",
+ "annual_cost": "EUR:4.99",
+ "insurance": "EUR:1",
+ "provider_url": "localhost:8088/",
+ "provider_name": "Anastasis 3",
+ "provider_salt": "CXAPCKSH9D3MYJTS9536RHJHCW"
+ }
+ },
+ {
+ "anastasis_02": {
+ "method_cost": "EUR:0",
+ "annual_cost": "EUR:1.99",
+ "insurance": "EUR:1",
+ "provider_url": "localhost:8087/",
+ "provider_name": "Anastasis 2",
+ "provider_salt": "CXAPCKSH9D3MYJTS9536RHJHCW"
+ }
+ },
+ {
+ "anastasis_01": {
+ "method_cost": "EUR:0",
+ "annual_cost": "EUR:4.99",
+ "insurance": "EUR:1",
+ "provider_url": "localhost:8086/",
+ "provider_name": "Anastasis 1",
+ "provider_salt": "CXAPCKSH9D3MYJTS9536RHJHCW"
+ }
+ }
+ ],
+ "sms": [
+ {
+ "anastasis_04": {
+ "method_cost": "EUR:0",
+ "annual_cost": "EUR:4.99",
+ "insurance": "EUR:1",
+ "provider_url": "localhost:8089/",
+ "provider_name": "Anastasis 4",
+ "provider_salt": "CXAPCKSH9D3MYJTS9536RHJHCW"
+ }
+ },
+ {
+ "anastasis_03": {
+ "method_cost": "EUR:0",
+ "annual_cost": "EUR:4.99",
+ "insurance": "EUR:1",
+ "provider_url": "localhost:8088/",
+ "provider_name": "Anastasis 3",
+ "provider_salt": "CXAPCKSH9D3MYJTS9536RHJHCW"
+ }
+ }
+ ],
+ "email": [
+ {
+ "anastasis_04": {
+ "method_cost": "EUR:0",
+ "annual_cost": "EUR:4.99",
+ "insurance": "EUR:1",
+ "provider_url": "localhost:8089/",
+ "provider_name": "Anastasis 4",
+ "provider_salt": "CXAPCKSH9D3MYJTS9536RHJHCW"
+ }
+ },
+ {
+ "anastasis_03": {
+ "method_cost": "EUR:0",
+ "annual_cost": "EUR:4.99",
+ "insurance": "EUR:1",
+ "provider_url": "localhost:8088/",
+ "provider_name": "Anastasis 3",
+ "provider_salt": "CXAPCKSH9D3MYJTS9536RHJHCW"
+ }
+ }
+ ]
+ },
+ "identity_attributes": {
+ "full_name": "Max Musterman",
+ "social_security_number": "123456789",
+ "birth_year": "2000",
+ "birth_month": "01",
+ "birth_day": "01"
+ },
+ "authentication_methods": [
+ {
+ "method": "question",
+ "data": {
+ "question": "Whats the name of your grandmother?",
+ "answer": "Trudi"
+ }
+ },
+ {
+ "method": "question",
+ "data": {
+ "question": "Whats the name of your grandfather?",
+ "answer": "Fredi"
+ }
+ },
+ {
+ "method": "question",
+ "data": {
+ "question": "Whats your name?",
+ "answer": "Hans"
+ }
+ }
+ ],
+ "policies": [
+ {
+ "recovery_cost": "EUR:0",
+ "methods": [
+ {
+ "authentication_method": 0,
+ "provider": "anastasis_02"
+ },
+ {
+ "authentication_method": 1,
+ "provider": "anastasis_01"
+ }
+ ]
+ },
+ {
+ "recovery_cost": "EUR:0",
+ "methods": [
+ {
+ "authentication_method": 0,
+ "provider": "anastasis_02"
+ },
+ {
+ "authentication_method": 2,
+ "provider": "anastasis_01"
+ }
+ ]
+ },
+ {
+ "recovery_cost": "EUR:0",
+ "methods": [
+ {
+ "authentication_method": 1,
+ "provider": "anastasis_02"
+ },
+ {
+ "authentication_method": 2,
+ "provider": "anastasis_01"
+ }
+ ]
+ }
+ ],
+ "core_secret": {
+ "secret": "someverysecretsecret",
+ "type": "password"
+ },
+ "truths": [
+ {
+ "authentication_method": 0,
+ "provider": "anastasis_02"
+ },
+ {
+ "authentication_method": 1,
+ "provider": "anastasis_01"
+ },
+ {
+ "authentication_method": 2,
+ "provider": "anastasis_01"
+ },
+ {
+ "authentication_method": 1,
+ "provider": "anastasis_02"
+ }
+ ],
+ "truth_uploads": [
+ {
+ "truth_index": 0,
+ "https_status": 204
+ },
+ {
+ "truth_index": 1,
+ "https_status": 402
+ },
+ {
+ "truth_index": 2,
+ "https_status": 402
+ },
+ {
+ "truth_index": 3,
+ "https_status": 204
+ },
+ ]
+ }
Recovery transitions
""""""""""""""""""""