diff options
author | Dennis Neufeld <dennis.neufeld@students.bfh.ch> | 2020-10-28 13:52:51 +0100 |
---|---|---|
committer | Dennis Neufeld <dennis.neufeld@students.bfh.ch> | 2020-10-28 13:52:51 +0100 |
commit | a85ae5e93c4f3587b32e72c909115a328019f857 (patch) | |
tree | 1c47c9b96d725c2ebe962dbd2b883ba64627ab4f | |
parent | 00416a79f21f0d9b910dcf508a856a45562119d2 (diff) | |
download | docs-a85ae5e93c4f3587b32e72c909115a328019f857.tar.gz docs-a85ae5e93c4f3587b32e72c909115a328019f857.tar.bz2 docs-a85ae5e93c4f3587b32e72c909115a328019f857.zip |
mod anastasis reducer api
-rw-r--r-- | anastasis.rst | 142 |
1 files changed, 142 insertions, 0 deletions
diff --git a/anastasis.rst b/anastasis.rst index 74d5160d..1e59a6b1 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -899,6 +899,84 @@ Backup Reducer The illustration above shows the different states the reducer can have during a backup process. +In the following, the individual transitions in the backup process will be specified in more detail. + +**select_continent:** + +Arguments (example): +:: + + { + "continent": "Europe" + } + + +**select_country:** + +Arguments (example): +:: + + { + "country": "Germany", + "country_code": "de", + "currency": "EUR" + } + + +**enter_user_attributes:** + +Arguments (example): +:: + + { + "identity_attributes": { + "full_name": "Max Musterman", + "social_security_number": "123456789", + "birth_year": "2000", + "birth_month": "01", + "birth_day": "01" + } + } + + +**add_policy:** + +Arguments (example): +:: + + { + "policy": [1, 3] //index of authentication method + } + + +**del_policy:** + +Arguments (example): +:: + + { + "policy": [1, 3] //index of authentication method + } + + +**enter_secret:** + +Arguments (example): +:: + + { + "secret": "someverysecretsecret", + "type": "password" + } + +- 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) + + +**next**, **back**, **pay:** + +No Arguments needed. + Recovery Reducer ^^^^^^^^^^^^^^^^ @@ -913,6 +991,70 @@ Recovery Reducer The illustration above shows the different states the reducer can have during a recovery process. +In the following, the individual transitions in the backup process will be specified in more detail. + +**select_continent:** + +Arguments (example): +:: + + { + "continent": "Europe" + } + + +**select_country:** + +Arguments (example): +:: + + { + "country": "Germany", + "country_code": "de", + "currency": "EUR" + } + + +**enter_user_attributes:** + +Arguments (example): +:: + + { + "identity_attributes": { + "full_name": "Max Musterman", + "social_security_number": "123456789", + "birth_year": "2000", + "birth_month": "01", + "birth_day": "01" + } + } + + +**select_challenge:** + +Arguments (example): +:: + + { + "challenge_index": 1 + } + + +**solve_challenge:** + +Arguments (example): +:: + + { + "challenge_index": 1, + "solution": "answer to secure question" + } + + +**back**, **pay:** + +No Arguments needed. .. _anastasis-auth-methods: |