diff options
Diffstat (limited to 'doc/anastasis.texi')
| -rw-r--r-- | doc/anastasis.texi | 1893 |
1 files changed, 1415 insertions, 478 deletions
diff --git a/doc/anastasis.texi b/doc/anastasis.texi index d0f281a..8ac8263 100644 --- a/doc/anastasis.texi +++ b/doc/anastasis.texi @@ -3,7 +3,7 @@ @setfilename anastasis.info @documentencoding UTF-8 @ifinfo -@*Generated by Sphinx 3.4.3.@* +@*Generated by Sphinx 4.3.2.@* @end ifinfo @settitle Anastasis Manual @defindex ge @@ -21,7 +21,7 @@ @copying @quotation -Anastasis 0.0.0pre0, Aug 14, 2021 +Anastasis 0.0.0pre0, Aug 12, 2023 Anastasis SARL @@ -64,7 +64,7 @@ Copyright @copyright{} 2020-2021 Anastasis SARL (AGPLv3+ or GFDL 1.3+) @c @c @author Christian Grothoff -Anastasis is Free Software protocol and implementation that allows +Anastasis is a Free Software protocol and implementation that allows users to securely deposit @strong{core secrets} with an open set of escrow providers and to recover these secrets if their original copies are lost. @@ -148,6 +148,16 @@ Configuration * Configuration format:: * Using anastasis-config:: +* Terms of Service:: +* Privacy Policy:: +* Legal policies directory layout:: +* Generating the Legal Terms:: +* Adding translations:: +* Updating legal documents:: + +Legal policies directory layout + +* Example:: Cryptography @@ -170,6 +180,10 @@ REST API * HTTP Request and Response:: * Protocol Version Ranges:: * Common encodings:: +* Receiving Configuration:: +* Receiving Terms of Service:: +* Managing policy:: +* Managing truth:: Common encodings @@ -185,10 +199,6 @@ Common encodings * Time:: * Cryptographic primitives:: * Signatures: Signatures<3>. -* Receiving Configuration:: -* Receiving Terms of Service:: -* Manage policy:: -* Managing truth:: Reducer API @@ -229,7 +239,10 @@ Anastasis-gtk (git://git.taler.net/anastasis-gtk) Man Pages * anastasis-config(1): anastasis-config 1. +* anastasis-dbconfig(1): anastasis-dbconfig 1. +* anastasis-dbinit(1): anastasis-dbinit 1. * anastasis-gtk(1): anastasis-gtk 1. +* anastasis-helper-authorization-iban(1): anastasis-helper-authorization-iban 1. * anastasis-httpd(1): anastasis-httpd 1. * anastasis-reducer(1): anastasis-reducer 1. * anastasis.conf(5): anastasis conf 5. @@ -241,40 +254,69 @@ anastasis-config(1) * See Also:: * Bugs:: -anastasis-gtk(1) +anastasis-dbconfig(1) * Synopsis: Synopsis<2>. * Description: Description<2>. * See Also: See Also<2>. * Bugs: Bugs<2>. -anastasis-httpd(1) +anastasis-dbinit(1) * Synopsis: Synopsis<3>. * Description: Description<3>. -* Signals:: -* See also:: +* See Also: See Also<3>. * Bugs: Bugs<3>. -anastasis-reducer(1) +anastasis-gtk(1) * Synopsis: Synopsis<4>. * Description: Description<4>. -* See Also: See Also<3>. +* See Also: See Also<4>. * Bugs: Bugs<4>. -anastasis.conf(5) +anastasis-helper-authorization-iban(1) +* Synopsis: Synopsis<5>. * Description: Description<5>. +* See Also: See Also<5>. +* Bugs: Bugs<5>. + +anastasis-httpd(1) + +* Synopsis: Synopsis<6>. +* Description: Description<6>. +* Signals:: +* See also:: +* Bugs: Bugs<6>. + +anastasis-reducer(1) + +* Synopsis: Synopsis<7>. +* Description: Description<7>. +* See Also: See Also<6>. +* Bugs: Bugs<7>. + +anastasis.conf(5) + +* Description: Description<8>. * SEE ALSO:: * BUGS:: Description * GLOBAL OPTIONS:: +* Backend options:: * Authorization options:: * Postgres database configuration:: +Authorization options + +* SMS Authorization options:: +* Email Authorization options:: +* Post Authorization options:: +* IBAN Authorization options:: + GNU Free Documentation License * 0. PREAMBLE: 0 PREAMBLE. @@ -430,6 +472,20 @@ network traffic). @section Installation +@cartouche +@quotation Note +Currently, GNU Anastasis is released as alpha-quality software. +When testing Anastasis, please choose @code{demoland} as +your country of residence! +@strong{It is not yet production ready! You cannot rely on it to keep +your secrets recoverable today!} In particular, we need to +still review the various country-specific questions used to create +unique user identifiers at the beginning of the backup and +recovery process. Community feedback on those inputs would be +particularly welcome! +@end quotation +@end cartouche + Please install the following packages before proceeding with the exchange compilation. @@ -712,47 +768,14 @@ find the installed libraries and launching anastasis-gtk would then fail. To install the GNU Taler Debian packages, first ensure that you have the right Debian distribution. At this time, the packages are built for -Sid, which means you should use a system which at least includes -unstable packages in its source list. We recommend using APT pinning -to limit unstable packages to those explicitly requested. To do this, -set your @code{/etc/apt/preferences} as follows: +Bullseye. -@example -Package: * -Pin: release a=stable -Pin-Priority: 700 - -Package: * -Pin: release a=testing -Pin-Priority: 650 - -Package: * -Pin: release a=unstable -Pin-Priority: 600 - -Package: * -Pin: release l=Debian-Security -Pin-Priority: 1000 -@end example - -A typical @code{/etc/apt/sources.list} file for this setup -which combines Debian stable with more recent packages -from testing and unstable would look like this: - -@example -deb http://ftp.ch.debian.org/debian/ buster main -deb http://security.debian.org/debian-security buster/updates main -deb http://ftp.ch.debian.org/debian/ testing main -deb http://ftp.ch.debian.org/debian/ unstable main -@end example - -Naturally, you may want to use different mirrors depending on your region. -Additionally, you must add a file to import the GNU Taler packages. Typically, +You need to add a file to import the GNU Taler packages. Typically, this is done by adding a file @code{/etc/apt/sources.list.d/taler.list} that looks like this: @example -deb https://deb.taler.net/apt/debian sid main +deb https://deb.taler.net/apt/debian bullseye main @end example Next, you must import the Taler Systems SA public package signing key @@ -944,6 +967,12 @@ configuration format. @menu * Configuration format:: * Using anastasis-config:: +* Terms of Service:: +* Privacy Policy:: +* Legal policies directory layout:: +* Generating the Legal Terms:: +* Adding translations:: +* Updating legal documents:: @end menu @@ -1010,19 +1039,10 @@ Note that, in this stage of development, the file component. For example, both an exchange and a bank can read values from it. -The repository @code{git://taler.net/deployment} contains examples of +The repository @code{git://git.taler.net/deployment} contains examples of configuration file used in our demos. See under @code{deployment/config}. -@quotation - -@strong{Note} - -Expectably, some components will not work just by using default -values, as their work is often interdependent. For example, a -merchant needs to know an exchange URL, or a database name. -@end quotation - -@node Using anastasis-config,,Configuration format,Configuration +@node Using anastasis-config,Terms of Service,Configuration format,Configuration @anchor{configuration using-anastasis-config}@anchor{1a} @subsection Using anastasis-config @@ -1075,6 +1095,240 @@ While the configuration file is typically located at to @code{taler-merchant-httpd} and @code{anastasis-config} using the @code{-c} option. +@c This file is part of GNU TALER. +@c +@c Copyright (C) 2014-2023 Taler Systems SA +@c +@c TALER is free software; you can redistribute it and/or modify it under the +@c terms of the GNU Affero General Public License as published by the Free Software +@c Foundation; either version 2.1, or (at your option) any later version. +@c +@c TALER is distributed in the hope that it will be useful, but WITHOUT ANY +@c WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR +@c A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. +@c +@c You should have received a copy of the GNU Affero General Public License along with +@c TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> +@c +@c @author Christian Grothoff + +The service has well-known API endpoints to return its legal conditions to the +user in various languages and various formats. This section describes how to +setup and configure the legal conditions. + +@node Terms of Service,Privacy Policy,Using anastasis-config,Configuration +@anchor{configuration terms-of-service}@anchor{1b} +@subsection Terms of Service + + +The service has an endpoint “/terms” to return the terms of service (in legal +language) of the service operator. Client software show these terms of +service to the user when the user is first interacting with the service. +Terms of service are optional for experimental deployments, if none are +configured, the service will return a simple statement saying that there are +no terms of service available. + +To configure the terms of service response, there are two options +in the configuration file for the service: + + +@itemize - + +@item +@code{TERMS_ETAG}: The current “Etag” to return for the terms of service. +This value must be changed whenever the terms of service are +updated. A common value to use would be a version number. +Note that if you change the @code{TERMS_ETAG}, you MUST also provide +the respective files in @code{TERMS_DIR} (see below). + +@item +@code{TERMS_DIR}: The directory that contains the terms of service. +The files in the directory must be readable to the service +process. +@end itemize + +@node Privacy Policy,Legal policies directory layout,Terms of Service,Configuration +@anchor{configuration privacy-policy}@anchor{1c} +@subsection Privacy Policy + + +The service has an endpoint “/pp” to return the terms privacy policy (in legal +language) of the service operator. Clients should show the privacy policy to +the user when the user explicitly asks for it, but it should not be shown by +default. Privacy policies are optional for experimental deployments, if none +are configured, the service will return a simple statement saying that there +is no privacy policy available. + +To configure the privacy policy response, there are two options +in the configuration file for the service: + + +@itemize - + +@item +@code{PRIVACY_ETAG}: The current “Etag” to return for the privacy policy. +This value must be changed whenever the privacy policy is +updated. A common value to use would be a version number. +Note that if you change the @code{PRIVACY_ETAG}, you MUST also provide +the respective files in @code{PRIVACY_DIR} (see below). + +@item +@code{PRIVACY_DIR}: The directory that contains the privacy policy. +The files in the directory must be readable to the service +process. +@end itemize + +@node Legal policies directory layout,Generating the Legal Terms,Privacy Policy,Configuration +@anchor{configuration legal-policies-directory-layout}@anchor{1d} +@subsection Legal policies directory layout + + +The @code{TERMS_DIR} and @code{PRIVACY_DIR} directory structures must follow a +particular layout. You may use the same directory for both the terms of +service and the privacy policy, as long as you use different ETAGs. Inside of +the directory, there should be sub-directories using two-letter language codes +like “en”, “de”, or “jp”. Each of these directories would then hold +translations of the current terms of service into the respective language. +Empty directories are permitted in case translations are not available. + +Then, inside each language directory, files with the name of the value set as +the @code{TERMS_ETAG} or @code{PRIVACY_ETAG} must be provided. The extension of each +of the files should be typical for the respective mime type. The set of +supported mime types is currently hard-coded in the service, and includes +“.epub”, “.html”, “.md”, “.pdf” and “.txt” files. If other files are present, +the service may show a warning on startup. + +@menu +* Example:: + +@end menu + +@node Example,,,Legal policies directory layout +@anchor{configuration example}@anchor{1e} +@subsubsection Example + + +A sample file structure for a @code{TERMS_ETAG} of “tos-v0” would be: + + +@itemize - + +@item +TERMS_DIR/en/tos-v0.txt + +@item +TERMS_DIR/en/tos-v0.html + +@item +TERMS_DIR/en/tos-v0.pdf + +@item +TERMS_DIR/en/tos-v0.epub + +@item +TERMS_DIR/en/tos-v0.md + +@item +TERMS_DIR/de/tos-v0.txt + +@item +TERMS_DIR/de/tos-v0.html + +@item +TERMS_DIR/de/tos-v0.pdf + +@item +TERMS_DIR/de/tos-v0.epub + +@item +TERMS_DIR/de/tos-v0.md +@end itemize + +If the user requests an HTML format with language preferences “fr” followed by +“en”, the service would return @code{TERMS_DIR/en/tos-v0.html} lacking a version in +French. + +@node Generating the Legal Terms,Adding translations,Legal policies directory layout,Configuration +@anchor{configuration generating-the-legal-terms}@anchor{1f} +@subsection Generating the Legal Terms + + +The @code{taler-terms-generator} script can be used to generate directories with +terms of service and privacy policies in multiple languages and all required +data formats from a single source file in @code{.rst} format and GNU gettext +translations in @code{.po} format. + +To use the tool, you need to first write your legal conditions in English in +reStructuredText (rst). You should find a templates in +@code{$PREFIX/share/terms/*.rst} where @code{$PREFIX} is the location where you +installed the service to. Whenever you make substantive changes to the legal +terms, you must use a fresh filename and change the respective @code{ETAG}. The +resulting file must be called @code{$ETAG.rst} and the first line of the file should be the title of the document. + +Once you have written the @code{$ETAG.rst} file in English, you can +generate the first set of outputs: + +@example +$ taler-terms-generator -i $ETAG +@end example + +Afterwards, you should find the terms in various formats for all configured +languages (initially only English) in @code{$PREFIX/share/terms/}. The generator +has a few options which are documented in its man page. + +@node Adding translations,Updating legal documents,Generating the Legal Terms,Configuration +@anchor{configuration adding-translations}@anchor{20} +@subsection Adding translations + + +Translations must be available in subdirectories +@code{locale/$LANGUAGE/LC_MESSAGES/$ETAG.po}. +To start translating, you first need to add a new +language: + +@example +$ taler-terms-generator -i $ETAG -l $LANGUAGE +@end example + +Here, @code{$LANGUAGE} should be a two-letter language +code like @code{de} or @code{fr}. The command will generate +a file @code{locale/$LANGUAGE/LC_MESSAGES/$ETAG.po} +which contains each English sentence or paragraph +in the original document and an initially empty +translation. Translators should update the @code{.po} +file. Afterwards, simply re-run + +@example +$ taler-terms-generator -i $ETAG +@end example + +to make the current translation(s) available to the +service. + +@cartouche +@quotation Note +You must restart the service whenever adding or updating legal documents or their translations. +@end quotation +@end cartouche + +@node Updating legal documents,,Adding translations,Configuration +@anchor{configuration updating-legal-documents}@anchor{21} +@subsection Updating legal documents + + +When making minor changes without legal implications, edit the @code{.rst} file, +then re-run the step to add a new language for each existing translation to +produce an updated @code{.po} file. Translate the sentences that have changed and +finally run the generator (without @code{-l}) on the ETAG (@code{-i $ETAG}) to +create the final files. + +When making major changes with legal implications, you should first rename (or +copy) the existing @code{.rst} file and the associated translation files to a new +unique name. Afterwards, make the major changes, update the @code{.po} files, +complete the translations and re-create the final files. Finally, do not +forget to update the @code{ETAG} configuration option to the new name and to +restart the service. + @c This file is part of Anastasis @c Copyright (C) 2019-2021 Anastasis SARL @c @@ -1094,7 +1348,7 @@ option. @c @author Dennis Neufeld @node Cryptography,REST API,Configuration,Documentation Overview -@anchor{cryptography doc}@anchor{1b}@anchor{cryptography cryptography}@anchor{1c} +@anchor{cryptography doc}@anchor{22}@anchor{cryptography cryptography}@anchor{23} @section Cryptography @@ -1141,7 +1395,7 @@ encrypted @strong{core secret}, a set of escrow methods and a set of policies. @end menu @node Key derivations,Key Usage,,Cryptography -@anchor{cryptography key-derivations}@anchor{1d} +@anchor{cryptography key-derivations}@anchor{24} @subsection Key derivations @@ -1184,7 +1438,7 @@ kdf_id := Argon2( identifier, server_salt, keysize ) @end menu @node Verification,Encryption,,Key derivations -@anchor{cryptography verification}@anchor{1e} +@anchor{cryptography verification}@anchor{25} @subsubsection Verification @@ -1204,7 +1458,7 @@ HKDF to ensure that the result differs from other cases where we hash @example ver_secret := HKDF(kdf_id, "ver", keysize) -eddsa_priv := eddsa_d_to_a(ver_secret) +eddsa_priv := ver_secret eddsa_pub := get_EdDSA_Pub(eddsa_priv) @end example @@ -1216,19 +1470,12 @@ eddsa_pub := get_EdDSA_Pub(eddsa_priv) @strong{ver_secret}: Derived key from the @code{kdf_id}, serves as intermediate step for the generation of the private key. -@strong{eddsa_d_to_a()}: Function which converts the ver_key to a valid EdDSA private key. Specifically, assuming the value @code{eddsa_priv} is in a 32-byte array “digest”, the function clears and sets certain bits as follows: - -@example -digest[0] = (digest[0] & 0x7f) | 0x40; -digest[31] &= 0xf8; -@end example - @strong{eddsa_priv}: The generated EdDSA private key. @strong{eddsa_pub}: The generated EdDSA public key. @node Encryption,,Verification,Key derivations -@anchor{cryptography encryption}@anchor{1f} +@anchor{cryptography encryption}@anchor{26} @subsubsection Encryption @@ -1259,7 +1506,7 @@ avoid key reuse. So, we have to use different nonces to get different keys and I @strong{iv}: IV which will be used for AES-GCM. @node Key Usage,Availability Considerations,Key derivations,Cryptography -@anchor{cryptography key-usage}@anchor{20} +@anchor{cryptography key-usage}@anchor{27} @subsection Key Usage @@ -1273,7 +1520,7 @@ the @strong{key_share} of the user. @end menu @node Encryption<2>,Signatures,,Key Usage -@anchor{cryptography id1}@anchor{21} +@anchor{cryptography id1}@anchor{28} @subsubsection Encryption @@ -1295,7 +1542,7 @@ individual @strong{key share}, we use different salts (“erd” and “eks”, and the encrypted @strong{core secret}. @strong{nonce0}: Nonce which is used to generate @emph{key0} and @emph{iv0} which are used for the encryption of the @emph{recovery document}. -Nonce must contain the string “ERD”. +This key derivation must be done using the salt “erd”. @strong{optional data}: Key material that optionally is contributed from the authentication method to further obfuscate the key share from the escrow provider. @@ -1304,7 +1551,8 @@ Here, @strong{i} must be a positive number used to iterate over the various @str at the various providers. @strong{nonce_i}: Nonce which is used to generate @emph{key_i} and @emph{iv_i} which are used for the encryption of the @strong{key share}. @strong{i} must be -the same number as specified above for @emph{encrypted_key_share_i}. Nonce must contain the string “EKS” plus the according @emph{i}. +the same number as specified above for @emph{encrypted_key_share_i}. +Key derivation must be done using the salt “eks”. As a special rule, when a @strong{security question} is used to authorize access to an @strong{encrypted_key_share_i}, then the salt “eks” is replaced with an (expensive) hash @@ -1330,12 +1578,14 @@ ekss := HKDF("Anastasis-secure-question-uuid-salting", @strong{ekss}: Replacement salt to be used instead of “eks” when deriving the key to encrypt/decrypt the key share. @node Signatures,,Encryption<2>,Key Usage -@anchor{cryptography signatures}@anchor{22} +@anchor{cryptography signatures}@anchor{29} @subsubsection Signatures The EdDSA keys are used to sign the data sent from the client to the -server. Everything the client sends to server is signed. The following +server. This signature ensures that an adversary that observes the upload is not +able to upload a new version of the policy without knowing the user’s identity attributes. +The signature is made over a hash of the request body. The following algorithm is equivalent for @strong{Anastasis-Policy-Signature}. @example @@ -1349,21 +1599,8 @@ ver_res := eddsa_verifiy(h_body, anastasis-account-signature, eddsa_pub) @strong{ver_res}: A boolean value. True: Signature verification passed, False: Signature verification failed. -When requesting policy downloads, the client must also provide a signature: - -@example -(anastasis-account-signature) := eddsa_sign(version, eddsa_priv) -ver_res := eddsa_verifiy(version, anastasis-account-signature, eddsa_pub) -@end example - -@strong{anastasis-account-signature}: Signature over the SHA-512 hash of the body using the purpose code @code{TALER_SIGNATURE_ANASTASIS_POLICY_DOWNLOAD} (1401) (see GNUnet EdDSA signature API for the use of purpose). - -@strong{version}: The version requested as a 64-bit integer, 2^64-1 for the “latest version”. - -@strong{ver_res}: A boolean value. True: Signature verification passed, False: Signature verification failed. - @node Availability Considerations,,Key Usage,Cryptography -@anchor{cryptography availability-considerations}@anchor{23} +@anchor{cryptography availability-considerations}@anchor{2a} @subsection Availability Considerations @@ -1393,7 +1630,7 @@ from using the append-only policy storage from exhausting Anastasis server capacity. @c This file is part of Anastasis -@c Copyright (C) 2019-2021 Anastasis SARL +@c Copyright (C) 2019-2022 Anastasis SARL @c @c Anastasis is free software; you can redistribute it and/or modify it under the @c terms of the GNU Affero General Public License as published by the Free Software @@ -1411,7 +1648,7 @@ capacity. @c @author Dennis Neufeld @node REST API,Reducer API,Cryptography,Documentation Overview -@anchor{rest doc}@anchor{24}@anchor{rest rest-api}@anchor{25} +@anchor{rest doc}@anchor{2b}@anchor{rest rest-api}@anchor{2c} @section REST API @@ -1436,11 +1673,15 @@ capacity. * HTTP Request and Response:: * Protocol Version Ranges:: * Common encodings:: +* Receiving Configuration:: +* Receiving Terms of Service:: +* Managing policy:: +* Managing truth:: @end menu @node HTTP Request and Response,Protocol Version Ranges,,REST API -@anchor{rest http-common}@anchor{26}@anchor{rest http-request-and-response}@anchor{27} +@anchor{rest http-common}@anchor{2d}@anchor{rest http-request-and-response}@anchor{2e} @subsection HTTP Request and Response @@ -1450,7 +1691,7 @@ theoretically fail to receive any response. In this case, the client should verify that the Internet connection is working properly, and then proceed to handle the error as if an internal error (500) had been returned. -@anchor{rest any--*}@anchor{28} +@anchor{rest any--*}@anchor{2f} @deffn {HTTP Any} ANY /* @strong{Request:} @@ -1505,7 +1746,7 @@ within 24h. @end table Unless specified otherwise, all error status codes (4xx and 5xx) have a message -body with an @ref{29,,ErrorDetail} JSON object. +body with an @ref{30,,ErrorDetail} JSON object. @strong{Details:} @@ -1525,7 +1766,7 @@ interface ErrorDetail @{ @end deffn @node Protocol Version Ranges,Common encodings,HTTP Request and Response,REST API -@anchor{rest protocol-version-ranges}@anchor{2a} +@anchor{rest protocol-version-ranges}@anchor{31} @subsection Protocol Version Ranges @@ -1609,8 +1850,8 @@ to decide whether it will talk to the service. @end quotation @end cartouche -@node Common encodings,,Protocol Version Ranges,REST API -@anchor{rest common-encodings}@anchor{2b}@anchor{rest encodings-ref}@anchor{2c} +@node Common encodings,Receiving Configuration,Protocol Version Ranges,REST API +@anchor{rest common-encodings}@anchor{32}@anchor{rest encodings-ref}@anchor{33} @subsection Common encodings @@ -1629,15 +1870,11 @@ This section describes how certain types of values are represented throughout th * Time:: * Cryptographic primitives:: * Signatures: Signatures<3>. -* Receiving Configuration:: -* Receiving Terms of Service:: -* Manage policy:: -* Managing truth:: @end menu @node Binary Data,Hash codes,,Common encodings -@anchor{rest base32}@anchor{2d}@anchor{rest binary-data}@anchor{2e} +@anchor{rest base32}@anchor{34}@anchor{rest binary-data}@anchor{35} @subsubsection Binary Data @@ -1652,12 +1889,12 @@ type “base32” and the term “Crockford Base32” in the text to refer to th resulting encoding. @node Hash codes,Large numbers,Binary Data,Common encodings -@anchor{rest hash-codes}@anchor{2f} +@anchor{rest hash-codes}@anchor{36} @subsubsection Hash codes Hash codes are strings representing base32 encoding of the respective -hashed data. See @ref{2d,,base32}. +hashed data. See @ref{34,,base32}. @example // 64-byte hash code. @@ -1670,7 +1907,7 @@ type ShortHashCode = string; @end example @node Large numbers,Timestamps,Hash codes,Common encodings -@anchor{rest large-numbers}@anchor{30} +@anchor{rest large-numbers}@anchor{37} @subsubsection Large numbers @@ -1678,7 +1915,7 @@ Large numbers such as 256 bit keys, are transmitted as other binary data in Crockford Base32 encoding. @node Timestamps,Integers,Large numbers,Common encodings -@anchor{rest timestamps}@anchor{31} +@anchor{rest timestamps}@anchor{38} @subsubsection Timestamps @@ -1702,7 +1939,7 @@ interface Duration @{ @end example @node Integers,Objects,Timestamps,Common encodings -@anchor{rest integers}@anchor{32}@anchor{rest publickey}@anchor{33} +@anchor{rest integers}@anchor{39}@anchor{rest publickey}@anchor{3a} @subsubsection Integers @@ -1712,7 +1949,7 @@ type Integer = number; @end example @node Objects,Keys,Integers,Common encodings -@anchor{rest objects}@anchor{34} +@anchor{rest objects}@anchor{3b} @subsubsection Objects @@ -1722,7 +1959,7 @@ type Object = object; @end example @node Keys,Signatures<2>,Objects,Common encodings -@anchor{rest keys}@anchor{35} +@anchor{rest keys}@anchor{3c} @subsubsection Keys @@ -1741,7 +1978,7 @@ type EddsaPrivateKey = string; @end example @node Signatures<2>,Amounts,Keys,Common encodings -@anchor{rest signature}@anchor{36}@anchor{rest signatures}@anchor{37} +@anchor{rest signature}@anchor{3d}@anchor{rest signatures}@anchor{3e} @subsubsection Signatures @@ -1752,7 +1989,7 @@ type EddsaSignature = string; @end example @node Amounts,Time,Signatures<2>,Common encodings -@anchor{rest amount}@anchor{38}@anchor{rest amounts}@anchor{39} +@anchor{rest amount}@anchor{3f}@anchor{rest amounts}@anchor{40} @subsubsection Amounts @@ -1791,7 +2028,7 @@ An amount that is prefixed with a @code{+} or @code{-} character is also used in When no sign is present, the amount is assumed to be positive. @node Time,Cryptographic primitives,Amounts,Common encodings -@anchor{rest time}@anchor{3a} +@anchor{rest time}@anchor{41} @subsubsection Time @@ -1805,10 +2042,18 @@ struct GNUNET_TIME_Absolute @{ struct GNUNET_TIME_AbsoluteNBO @{ uint64_t abs_value_us__; // in network byte order @}; +struct GNUNET_TIME_Timestamp @{ + // must be round value (multiple of seconds) + struct GNUNET_TIME_Absolute abs_time; +@}; +struct GNUNET_TIME_TimestampNBO @{ + // must be round value (multiple of seconds) + struct GNUNET_TIME_AbsoluteNBO abs_time; +@}; @end example @node Cryptographic primitives,Signatures<3>,Time,Common encodings -@anchor{rest cryptographic-primitives}@anchor{3b} +@anchor{rest cryptographic-primitives}@anchor{42} @subsubsection Cryptographic primitives @@ -1821,12 +2066,18 @@ struct GNUNET_HashCode @{ uint8_t hash[64]; // usually SHA-512 @}; @end example -@anchor{rest taler-ecdhephemeralpublickeyp}@anchor{3c} +@anchor{rest taler-ecdhephemeralpublickeyp}@anchor{43} @example struct TALER_EcdhEphemeralPublicKeyP @{ uint8_t ecdh_pub[32]; @}; @end example +@anchor{rest anastasis-truthkeyp}@anchor{44} +@example +struct ANASTASIS_TruthKeyP @{ + struct GNUNET_HashCode key; +@}; +@end example @example struct UUID @{ @@ -1834,8 +2085,8 @@ struct UUID @{ @}; @end example -@node Signatures<3>,Receiving Configuration,Cryptographic primitives,Common encodings -@anchor{rest id1}@anchor{3d}@anchor{rest id2}@anchor{3e} +@node Signatures<3>,,Cryptographic primitives,Common encodings +@anchor{rest id1}@anchor{45}@anchor{rest id2}@anchor{46} @subsubsection Signatures @@ -1869,21 +2120,21 @@ struct GNUNET_CRYPTO_EccSignaturePurpose @{ uint32_t size; @}; @end example -@anchor{rest salt}@anchor{3f} -@node Receiving Configuration,Receiving Terms of Service,Signatures<3>,Common encodings -@anchor{rest config}@anchor{40}@anchor{rest receiving-configuration}@anchor{41} -@subsubsection Receiving Configuration +@anchor{rest salt}@anchor{47} +@node Receiving Configuration,Receiving Terms of Service,Common encodings,REST API +@anchor{rest config}@anchor{48}@anchor{rest receiving-configuration}@anchor{49} +@subsection Receiving Configuration -@anchor{rest get--config}@anchor{42} +@anchor{rest get--config}@anchor{4a} @deffn {HTTP Get} GET /config Obtain the configuration details of the escrow provider. @strong{Response:} -Returns an @ref{43,,EscrowConfigurationResponse}. -@anchor{rest escrowconfigurationresponse}@anchor{43} +Returns an @ref{4b,,EscrowConfigurationResponse}. +@anchor{rest escrowconfigurationresponse}@anchor{4b} @example interface EscrowConfigurationResponse @{ @@ -1921,11 +2172,11 @@ interface EscrowConfigurationResponse @{ // **provider salt** is then used in various operations to ensure // cryptographic operations differ by provider. A provider must // never change its salt value. - server_salt: string; + provider_salt: string; @} @end example -@anchor{rest authorizationmethodconfig}@anchor{44} +@anchor{rest authorizationmethodconfig}@anchor{4c} @example interface AuthorizationMethodConfig @{ // Name of the authorization method. @@ -1938,12 +2189,12 @@ interface AuthorizationMethodConfig @{ @end example @end deffn -@node Receiving Terms of Service,Manage policy,Receiving Configuration,Common encodings -@anchor{rest receiving-terms-of-service}@anchor{45}@anchor{rest terms}@anchor{46} -@subsubsection Receiving Terms of Service +@node Receiving Terms of Service,Managing policy,Receiving Configuration,REST API +@anchor{rest receiving-terms-of-service}@anchor{4d}@anchor{rest terms}@anchor{4e} +@subsection Receiving Terms of Service -@anchor{rest get--terms}@anchor{47} +@anchor{rest get--terms}@anchor{4f} @deffn {HTTP Get} GET /terms Obtain the terms of service provided by the escrow provider. @@ -1954,7 +2205,7 @@ Returns the terms of service of the provider, in the best language and format available based on the client’s request. @end deffn -@anchor{rest get--privacy}@anchor{48} +@anchor{rest get--privacy}@anchor{50} @deffn {HTTP Get} GET /privacy Obtain the privacy policy of the service provided by the escrow provider. @@ -1965,9 +2216,9 @@ Returns the privacy policy of the provider, in the best language and format available based on the client’s request. @end deffn -@node Manage policy,Managing truth,Receiving Terms of Service,Common encodings -@anchor{rest id3}@anchor{49}@anchor{rest manage-policy}@anchor{4a} -@subsubsection Manage policy +@node Managing policy,Managing truth,Receiving Terms of Service,REST API +@anchor{rest manage-policy}@anchor{51}@anchor{rest managing-policy}@anchor{52} +@subsection Managing policy This API is used by the Anastasis client to deposit or request encrypted @@ -1981,7 +2232,59 @@ public key using the Crockford base32-encoding. In the following, UUID is always defined and used according to RFC 4122@footnote{https://tools.ietf.org/html/rfc4122}. -@anchor{rest get--policy-$ACCOUNT_PUB[?version=$NUMBER]}@anchor{4b} +@anchor{rest get--policy-$ACCOUNT_PUB-meta[?max_version=$NUMBER]}@anchor{53} +@deffn {HTTP Get} GET /policy/$ACCOUNT_PUB/meta[?max_version=$NUMBER] + +Get meta data about a customer’s encrypted recovery documents. +If @code{max_version} is specified, only return results up to the +given version number. The response may not contain meta data +for all versions if there are way too many. In this case, +@code{max_version} must be used to incrementally fetch more versions. + +@strong{Response}: + + +@table @asis + +@item 200 OK@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1}: + +The escrow provider responds with a @ref{54,,RecoveryMetaSummary} object. + +@item 400 Bad request@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1}: + +The @code{$ACCOUNT_PUB} is not an EdDSA public key. + +@item 402 Payment Required@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3}: + +The account’s balance is too low for the specified operation. +See the Taler payment protocol specification for how to pay. + +@item 404 Not found@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5}: + +The requested resource was not found. +@end table + +@strong{Details:} +@anchor{rest recoverymetasummary}@anchor{54} +@example +interface RecoveryMetaSummary @{ + // Version numbers as a string (!) are used as keys. + "$VERSION": MetaData; +@} + +interface MetaData @{ + // The meta value can be NULL if the document + // exists but no meta data was provided. + meta: string; + + // Server-time indicative of when the recovery + // document was uploaded. + upload_time: Timestamp; +@} +@end example +@end deffn + +@anchor{rest get--policy-$ACCOUNT_PUB[?version=$NUMBER]}@anchor{55} @deffn {HTTP Get} GET /policy/$ACCOUNT_PUB[?version=$NUMBER] Get the customer’s encrypted recovery document. If @code{version} @@ -2017,7 +2320,7 @@ code in case the resource matches the provided Etag. @item 200 OK@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1}: -The escrow provider responds with an @ref{4c,,EncryptedRecoveryDocument} object. +The escrow provider responds with an @ref{56,,EncryptedRecoveryDocument} object. @item 304 Not modified@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.5}: @@ -2032,10 +2335,6 @@ The @code{$ACCOUNT_PUB} is not an EdDSA public key. The account’s balance is too low for the specified operation. See the Taler payment protocol specification for how to pay. -@item 403 Forbidden@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4}: - -The required account signature was invalid. - @item 404 Not found@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5}: The requested resource was not found. @@ -2043,17 +2342,15 @@ The requested resource was not found. @emph{Anastasis-Version}: $NUMBER — The server must return actual version of the encrypted recovery document via this header. 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 @ref{4c,,EncryptedRecoveryDocument}. +did not specify a version in the request, the server returns latest version of the @ref{56,,EncryptedRecoveryDocument}. @emph{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 @code{200 OK}. @emph{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. - -@emph{Anastasis-Account-Signature}: The client must provide Base-32 encoded EdDSA signature over hash of body with @code{$ACCOUNT_PRIV}, affirming desire to download the requested encrypted recovery document. The purpose used MUST be @code{TALER_SIGNATURE_ANASTASIS_POLICY_DOWNLOAD} (1401). @end deffn -@anchor{rest post--policy-$ACCOUNT_PUB}@anchor{4d} +@anchor{rest post--policy-$ACCOUNT_PUB}@anchor{57} @deffn {HTTP Post} POST /policy/$ACCOUNT_PUB Upload a new version of the customer’s encrypted recovery document. @@ -2088,7 +2385,7 @@ case. @code{timeout_ms=NUMBER} – @emph{Optional.} If specified, the Anastasis server will wait up to @code{timeout_ms} milliseconds for completion of the payment before sending the HTTP response. A client must never rely on this behavior, as the -backend may return a response immediately. +backend may return a response immediately. If a @code{timeout_ms} is not given, the Anastasis server may apply a default timeout (usually 30s) when talking to the merchant backend. @end itemize @@ -2099,9 +2396,11 @@ use the Etag to check whether it already knows the encrypted recovery document t The server MUST refuse the upload with a @code{304} status code if the Etag matches the latest version already known to the server. +@emph{Anastasis-Policy-Meta-Data}: Encrypted meta data to be stored by the server and returned with the respective endpoint to provide an overview of the available policies. Encrypted using a random nonce and a key derived from the user ID using the salt “rmd”. The plaintext metadata must consist of the policy hash (for deduplication) and the (human readable) secret name. + @emph{Anastasis-Policy-Signature}: The client must provide Base-32 encoded EdDSA signature over hash of body with @code{$ACCOUNT_PRIV}, affirming desire to upload an encrypted recovery document. -@emph{Payment-Identifier}: Base-32 encoded 32-byte payment identifier that was included in a previous payment (see @code{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 @strong{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 @code{402} response. When making payments, the server must include a fresh, randomly-generated payment-identifier in the payment request. +@emph{Payment-Identifier}: Base-32 encoded 32-byte payment identifier that was included in a previous payment (see @code{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 @strong{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 @code{402} response. When making payments, the server must include a fresh, randomly-generated payment-identifier in the payment request. If a payment identifier is given, the Anastasis backend may block for the payment to be confirmed by Taler as specified by the @code{timeout_ms} argument. @strong{Response}: @@ -2110,8 +2409,10 @@ the latest version already known to the server. @item 204 No content@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5}: -The encrypted recovery document was accepted and stored. @code{Anastasis-Version} and @code{Anastasis-UUID} headers -indicate what version and UUID was assigned to this encrypted recovery document upload by the server. +The encrypted recovery document was accepted and stored. @code{Anastasis-Version} +indicates what version was assigned to this encrypted recovery document upload by the server. +@code{Anastasis-Policy-Expiration} indicates the time until the server promises to store the policy, +in seconds since epoch. @item 304 Not modified@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.5}: @@ -2139,7 +2440,7 @@ The upload is too large @emph{or} too small. The response body may elaborate on @end table @strong{Details:} -@anchor{rest encryptedrecoverydocument}@anchor{4c} +@anchor{rest encryptedrecoverydocument}@anchor{56} @example interface EncryptedRecoveryDocument @{ // Nonce used to compute the (iv,key) pair for encryption of the @@ -2151,35 +2452,34 @@ interface EncryptedRecoveryDocument @{ // Variable-size encrypted recovery document. After decryption, // this contains a gzip compressed JSON-encoded `RecoveryDocument`. - // The nonce of the HKDF for this encryption must include the - // string "ERD". + // The salt of the HKDF for this encryption must include the + // string "erd". encrypted_compressed_recovery_document: []; //bytearray of undefined length @} @end example -@anchor{rest recoverydocument}@anchor{4e} +@anchor{rest recoverydocument}@anchor{58} @example interface RecoveryDocument @{ - // Account identifier at backup provider, AES-encrypted with - // the (symmetric) master_key, i.e. an URL - // https://sync.taler.net/$BACKUP_ID and - // a private key to decrypt the backup. Anastasis is oblivious - // to the details of how this is ultimately encoded. - backup_account: []; //bytearray of undefined length + // Human-readable name of the secret + secret_name?: string; + + // Encrypted core secret. + encrypted_core_secret: string; // bytearray of undefined length // List of escrow providers and selected authentication method. - methods: EscrowMethod[]; + escrow_methods: EscrowMethod[]; // List of possible decryption policies. - policy: DecryptionPolicy[]; + policies: DecryptionPolicy[]; @} @end example -@anchor{rest escrowmethod}@anchor{4f} +@anchor{rest escrowmethod}@anchor{59} @example interface EscrowMethod @{ // URL of the escrow provider (including possibly this Anastasis server). - provider_url : string; + url : string; // Type of the escrow method (e.g. security question, SMS etc.). escrow_type: string; @@ -2189,46 +2489,48 @@ interface EscrowMethod @{ // Key used to encrypt the `Truth` this `EscrowMethod` is related to. // Client has to provide this key to the server when using `@w{`}/truth/`@w{`}. - truth_encryption_key: [32]; //bytearray + truth_key: [32]; //bytearray - // Salt used to encrypt the truth on the Anastasis server. - truth_salt: [32]; //bytearray + // Salt used to hash the security answer if appliccable. + question_salt: [32]; //bytearray - // The challenge to give to the user (i.e. the security question + // Salt from the provider to derive the user ID + // at this provider. + provider_salt: [32]; //bytearray + + // The instructions to give to the user (i.e. the security question // if this is challenge-response). // (Q: as string in base32 encoding?) // (Q: what is the mime-type of this value?) // - // For some methods, this value may be absent. - // // The plaintext challenge is not revealed to the // Anastasis server. - challenge: []; //bytearray of undefined length + instructions: string; @} @end example -@anchor{rest decryptionpolicy}@anchor{50} +@anchor{rest decryptionpolicy}@anchor{5a} @example interface DecryptionPolicy @{ // Salt included to encrypt master key share when // using this decryption policy. - policy_salt: [32]; //bytearray + master_salt: [32]; //bytearray // Master key, AES-encrypted with key derived from // salt and keyshares revealed by the following list of // escrow methods identified by UUID. - encrypted_master_key: [32]; //bytearray + master_key: [32]; //bytearray // List of escrow methods identified by their UUID. - uuid: string[]; + uuids: string[]; @} @end example @end deffn -@node Managing truth,,Manage policy,Common encodings -@anchor{rest managing-truth}@anchor{51}@anchor{rest truth}@anchor{52} -@subsubsection Managing truth +@node Managing truth,,Managing policy,REST API +@anchor{rest managing-truth}@anchor{5b}@anchor{rest truth}@anchor{5c} +@subsection Managing truth Truth always consists of an encrypted key share and encrypted @@ -2249,14 +2551,14 @@ data required for such a respective escrow method. An Anastasis-server may store truth for free for a certain time period, or charge per truth operation using GNU Taler. -@anchor{rest post--truth-$UUID}@anchor{53} +@anchor{rest post--truth-$UUID}@anchor{5d} @deffn {HTTP Post} POST /truth/$UUID -Upload a @ref{54,,TruthUploadRequest}-Object according to the policy the client created before (see @ref{4e,,RecoveryDocument}). -If request has been seen before, the server should do nothing, and otherwise store the new object. - @strong{Request:} +Upload a @ref{5e,,TruthUploadRequest}-Object according to the policy the client created before (see @ref{58,,RecoveryDocument}). +If request has been seen before, the server should do nothing, and otherwise store the new object. + @*Query Parameters: @itemize * @@ -2301,7 +2603,7 @@ The selected authentication method is not supported on this provider. @end table @strong{Details:} -@anchor{rest truthuploadrequest}@anchor{54} +@anchor{rest truthuploadrequest}@anchor{5e} @example interface TruthUploadRequest @{ // Contains the information of an interface `EncryptedKeyShare`, but simply @@ -2325,38 +2627,32 @@ interface TruthUploadRequest @{ // For how many years from now would the client like us to // store the truth? - storage_duration_years: Integer; + storage_duration_years: number; @} @end example -@end deffn -@anchor{rest get--truth-$UUID}@anchor{55} -@deffn {HTTP Get} GET /truth/$UUID +@anchor{rest post--truth-$UUID-solve}@anchor{5f} +@deffn {HTTP Post} POST /truth/$UUID/solve +@end deffn -Get the stored encrypted key share. -Also, the user has to provide the correct @emph{truth_encryption_key} with every get request (see below). +Solve the challenge and get the stored encrypted key share. +Also, the user has to provide the correct @emph{truth_encryption_key} with the request (see below). The encrypted key share is returned simply as a byte array and not in JSON format. -@*Query Parameters: +@strong{Request}: -@itemize * +@quotation -@item -@code{response=H_RESPONSE} – @emph{Optional.} If @code{$H_RESPONSE} is specified by the client, -the server checks if @code{$H_RESPONSE} matches the expected response. This can be the -hash of the security question (as specified before by the client -within the @ref{54,,TruthUploadRequest} (see @code{encrypted_truth})), or the hash of the -PIN code sent via SMS, E-mail or postal communication channels. -When @code{$H_RESPONSE} is correct, the server responds with the encrypted key share. +Upload a @ref{60,,TruthSolutionRequest}-Object. -@item -@code{timeout_ms=NUMBER} – @emph{Optional.} If specified, the Anastasis server will +@*query timeout_ms=NUMBER: +@emph{Optional.} If specified, the Anastasis server will wait up to @code{timeout_ms} milliseconds for completion of the payment or the challenge before sending the HTTP response. A client must never rely on this behavior, as the backend may return a response immediately. -@end itemize +@end quotation @strong{Response}: @@ -2365,24 +2661,7 @@ behavior, as the backend may return a response immediately. @item 200 OK@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1}: -@ref{56,,EncryptedKeyShare} is returned in body (in binary). - -@item 202 Accepted@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.3}: - -The escrow provider will respond out-of-band (i.e. SMS). -The body may contain human-readable instructions on next steps. - -@item >>208 Already Reported<<: - -An authentication challenge was recently send, client should -simply respond to the pending challenge. - -@item 303 See other@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.4}: - -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 @code{Location} header and allow the user to re-try the operation -after successful authorization. +@ref{61,,EncryptedKeyShare} is returned in body (in binary). @item 402 Payment required@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3}: @@ -2392,39 +2671,50 @@ The response body MAY provide alternative means for payment. @item 403 Forbidden@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4}: -The server requires a valid “response” to the challenge associated with the UUID. +The h_response provided is not a good response to the challenge associated +with the UUID, or at least the answer is not valid yet. A generic +response is provided with an error code. @item 404 Not found@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5}: The server does not know any truth under the given UUID. -@item 408 Request Timeout@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.9}: - -Accessing this truth requires satisfying an external authentication challenge -(and not merely passing a response in the request) and this has not happened -before the timeout was reached. - -@item 410 Gone@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11}: +@item 429 Too Many Requests@footnote{http://tools.ietf.org/html/rfc6585#section-4}: -The server has not (recently) issued a challenge under the given UUID, -but a reply was provided. (This does not apply for secure question.) - -@item 417 Expectation Failed@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.18}: - -The decrypted @code{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. +The client exceeded the number of allowed attempts at providing +a valid response for the given time interval. +The response format is given by @ref{62,,RateLimitedMessage}. @item 503 Service Unavailable@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4}: Server is out of Service. @end table -@emph{Truth-Decryption-Key}: Key used to encrypt the @strong{truth} (see encrypted_truth within @ref{54,,TruthUploadRequest}) and which has to provided by the user. The key is stored with -the according @ref{4f,,EscrowMethod}. The server needs this key to get the info out of @ref{54,,TruthUploadRequest} needed to verify the @code{$RESPONSE}. - @strong{Details:} -@anchor{rest encryptedkeyshare}@anchor{56} +@anchor{rest truthsolutionrequest}@anchor{60} +@example +interface TruthSolutionRequest @{ + + // Hash over the response that solves the challenge + // issued for this truth. This can be the + // hash of the security question (as specified before by the client + // within the `TruthUploadRequest`_ (see `@w{`}encrypted_truth`@w{`})), or the hash of the + // PIN code sent via SMS, E-mail or postal communication channels. + // Only when `@w{`}$H_RESPONSE`@w{`} is correct, the server responds with the encrypted key share. + h_response: HashCode; + + // Key that was 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`_ to verify the `@w{`}h_response`@w{`}. + truth_decryption_key: ANASTASIS_TruthKeyP; + + // Reference to a payment made by the client to + // pay for this request. Optional. + payment_secret?: ANASTASIS_PaymentSecretP; +@} +@end example +@anchor{rest encryptedkeyshare}@anchor{61} @example interface EncryptedKeyShare @{ // Nonce used to compute the decryption (iv,key) pair. @@ -2447,23 +2737,161 @@ interface EncryptedKeyShare @{ encrypted_key_share_i: [32]; //bytearray @} -@end example -@anchor{rest keyshare}@anchor{57} -@example + + interface KeyShare @{ - // Key material to concatenate with policy_salt and KDF to derive - // the key to decrypt the master key. + // Key material to derive the key to decrypt the master key. key_share: [32]; //bytearray +@} +@end example +@anchor{rest ratelimitedmessage}@anchor{62} +@example +interface RateLimitedMessage @{ - // Signature over method, UUID, and `@w{`}key_share`@w{`}. - account_sig: EddsaSignature; + // Taler error code, TALER_EC_ANASTASIS_TRUTH_RATE_LIMITED. + code: number; + + // How many attempts are allowed per challenge? + request_limit: number; + + // At what frequency are new challenges issued? + request_frequency: RelativeTime; + + // The error message. + hint: string; + +@} +@end example + +@anchor{rest post--truth-$UUID-challenge}@anchor{63} +@deffn {HTTP Post} POST /truth/$UUID/challenge +@end deffn + +NEW API (#7064): + +Initiate process to solve challenge associated with the given truth object. + +@strong{Request}: + +@quotation + +Upload a @ref{64,,TruthChallengeRequest}-Object. +@end quotation + +@strong{Response}: + + +@table @asis + +@item 200 Ok@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1}: + +The escrow provider will respond out-of-band (i.e. SMS). +The body may contain human- or machine-readable instructions on next steps. +In case the response is in JSON, the format is given +by @ref{65,,ChallengeInstructionMessage}. + +@item 402 Payment required@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3}: + +The service requires payment to issue a challenge. +See the Taler payment protocol specification for how to pay. +The response body MAY provide alternative means for payment. + +@item 403 Forbidden@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4}: + +This type of truth does not permit requests to trigger a challenge. +This is the case for security questions and TOTP methods. + +@item 404 Not found@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5}: + +The server does not know any truth under the given UUID. + +@item 424 Failed Dependency@footnote{http://tools.ietf.org/html/rfc4918#section-11.4}: + +The decrypted @code{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. + +@item 503 Service Unavailable@footnote{http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4}: + +Server is out of Service. +@end table + +@strong{Details:} +@anchor{rest truthchallengerequest}@anchor{64} +@example +interface TruthChallengeRequest @{ + + // Key that was 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`_ to verify the `@w{`}h_response`@w{`}. + truth_decryption_key: ANASTASIS_TruthKeyP; + + // Reference to a payment made by the client to + // pay for this request. Optional. + payment_secret?: ANASTASIS_PaymentSecretP; +@} +@end example +@anchor{rest challengeinstructionmessage}@anchor{65} +@example +type ChallengeInstructionMessage = + | FileChallengeInstructionMessage + | IbanChallengeInstructionMessage + | PinChallengeInstructionMessage; + +interface IbanChallengeInstructionMessage @{ + + // What kind of challenge is this? + method: "IBAN_WIRE"; + + // How much should be wired? + amount: Amount; + + // What is the target IBAN? + credit_iban: string; + + // What is the receiver name? + business_name: string; + + // What is the expected wire transfer subject? + wire_transfer_subject: string; + + // What is the numeric code (also part of the + // wire transfer subject) to be hashed when + // solving the challenge? + answer_code: number; + + // Hint about the origin account that must be used. + debit_account_hint: string; + +@} + +interface PinChallengeInstructionMessage @{ + + // What kind of challenge is this? + method: "TAN_SENT"; + + // Where was the PIN code sent? Note that this + // address will most likely have been obscured + // to improve privacy. + tan_address_hint: string; + +@} + +interface FileChallengeInstructionMessage @{ + + // What kind of challenge is this? + method: "FILE_WRITTEN"; + + // Name of the file where the PIN code was written. + filename: string; @} @end example @end deffn @c This file is part of Anastasis -@c Copyright (C) 2019-2021 Anastasis SARL +@c Copyright (C) 2019-2022 Anastasis SARL @c @c Anastasis is free software; you can redistribute it and/or modify it under the @c terms of the GNU Affero General Public License as published by the Free Software @@ -2481,13 +2909,13 @@ interface KeyShare @{ @c @author Dennis Neufeld @node Reducer API,Authentication Methods,REST API,Documentation Overview -@anchor{reducer doc}@anchor{58}@anchor{reducer reducer-api}@anchor{59} +@anchor{reducer doc}@anchor{66}@anchor{reducer reducer-api}@anchor{67} @section Reducer API This section describes the Anastasis Reducer API which is used by client applications to store or load the different states the client application can have. -The reducer takes a @ref{5a,,state} in JSON syntax and returns the new state in JSON syntax. +The reducer takes a @ref{68,,state} in JSON syntax and returns the new state in JSON syntax. For example a @strong{state} may take the following structure: @@ -2501,7 +2929,7 @@ For example a @strong{state} may take the following structure: @} @end example -The new state depends on the previous one and on the transition @ref{5b,,action} with its +The new state depends on the previous one and on the transition @ref{69,,action} with its arguments given to the reducer. A @strong{transition argument} also is a statement in JSON syntax: @example @@ -2511,7 +2939,7 @@ arguments given to the reducer. A @strong{transition argument} also is a stateme @end example The new state returned by the reducer with the state and transition argument defined -above would look like following for the transition @ref{5b,,action} @code{select_continent}: +above would look like following for the transition @ref{69,,action} @code{select_continent}: @example @{ @@ -2553,6 +2981,18 @@ above would look like following for the transition @ref{5b,,action} @code{select @} @end example +An action may also result into an @emph{error response} instead of a new state. +Clients should then render this error response to the user and allow the user +to continue from the old state. An error response looks like this: + +@example +@{ + "code": 123, + "hint": "something went wrong", + "details": "parameter foo failed to frobnify" +@} +@end example + @menu * States:: * Backup Reducer:: @@ -2562,7 +3002,7 @@ above would look like following for the transition @ref{5b,,action} @code{select @end menu @node States,Backup Reducer,,Reducer API -@anchor{reducer states}@anchor{5c} +@anchor{reducer states}@anchor{6a} @subsection States @@ -2577,15 +3017,6 @@ Overall, the reducer knows the following states: @table @asis -@item @strong{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. -@end table - -@item - -@table @asis - @item @strong{CONTINENT_SELECTING}: The user should specify the continent where they are living, so that we can show a list of countries to choose from. @@ -2697,10 +3128,10 @@ in FINISHED-states, the operation has definitively concluded. @end quotation @node Backup Reducer,Recovery Reducer,States,Reducer API -@anchor{reducer backup-reducer}@anchor{5d} +@anchor{reducer backup-reducer}@anchor{6b} @subsection Backup Reducer -@anchor{reducer state}@anchor{5a}@anchor{reducer action}@anchor{5b} +@anchor{reducer state}@anchor{68}@anchor{reducer action}@anchor{69} @float Figure @@ -2715,7 +3146,7 @@ The illustration above shows the different states the reducer can have during a process. @node Recovery Reducer,Reducer transitions,Backup Reducer,Reducer API -@anchor{reducer recovery-reducer}@anchor{5e} +@anchor{reducer recovery-reducer}@anchor{6c} @subsection Recovery Reducer @@ -2733,7 +3164,7 @@ The illustration above shows the different states the reducer can have during a process. @node Reducer transitions,,Recovery Reducer,Reducer API -@anchor{reducer reducer-transitions}@anchor{5f} +@anchor{reducer reducer-transitions}@anchor{6d} @subsection Reducer transitions @@ -2750,7 +3181,7 @@ state is preserved to enable “back” transitions to function smoothly. @end menu @node Initial state,Common transitions,,Reducer transitions -@anchor{reducer initial-state}@anchor{60} +@anchor{reducer initial-state}@anchor{6e} @subsubsection Initial state @@ -2813,7 +3244,7 @@ continent names: Translations must be given in the same order as the main English array. @node Common transitions,Backup transitions,Initial state,Reducer transitions -@anchor{reducer common-transitions}@anchor{61} +@anchor{reducer common-transitions}@anchor{6f} @subsubsection Common transitions @@ -2939,7 +3370,7 @@ providers that accept payments in the selected currency: @}, @{ "type": "string", - "name": "tax_number", + "name": "tax_number", "label": "Taxpayer identification number", "label_i18n":@{ "de_DE": "Steuerliche Identifikationsnummer", @@ -2947,7 +3378,7 @@ providers that accept payments in the selected currency: "en": "German taxpayer identification number" @}, "widget": "anastasis_gtk_ia_tax_de", - "uuid": "dae48f85-e3ff-47a4-a4a3-ed981ed8c3c6", + "uuid": "dae48f85-e3ff-47a4-a4a3-ed981ed8c3c6", "validation-regex": "^[0-9]@{11@}$", "validation-logic": "DE_TIN_check" @}, @@ -2962,8 +3393,8 @@ providers that accept payments in the selected currency: "en": "Social security number" @}, "widget": "anastasis_gtk_ia_ssn", - "validation-regex": "^[0-9]@{8@}[[:upper:]][0-9]@{3@}$", - "validation-logic": "DE_SVN_check" + "validation-regex": "^[0-9]@{8@}[[:upper:]][0-9]@{3@}$", + "validation-logic": "DE_SVN_check" "optional" : true @} ], @@ -3126,37 +3557,44 @@ we did not even obtain an HTTP response). @strong{add_provider}: -This operation can be performed in state @code{USER_ATTRIBUTES_COLLECTING}. It +This operation can be performed in state @code{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. -Here, the client must provide an array with the base URLs of the -providers to add, for example: +Here, the client must provide an object with the base URLs of the +providers to add or disable. The object maps the +URLs to status information about the provider to +use. For example: @example @{ - "urls": [ - "http://localhost:8888/", - "http://localhost:8089/" - ] + "http://localhost:8088/" : @{ "disabled" : false @}, + "http://localhost:8089/" : @{ "disabled" : false @}, + "http://localhost:8090/" : @{ "disabled" : true @} @} @end example -Note that existing providers will remain in the state. The following is an +Note that existing providers will remain in the state they were in. The following is an example for an expected new state where the service on port 8089 is -unreachable, the service on port 8088 was previously known, and service on -port 8888 was now added: +unreachable, the services on port 8088 and 8888 were previously known, and service on +port 8088 was now added, and on 8090 is disabled: @example @{ "backup_state": "USER_ATTRIBUTES_COLLECTING", "authentication_providers": @{ "http://localhost:8089/": @{ + "disabled": false, "error_code": 11, "http_status": 0 @}, + "http://localhost:8090/": @{ + "disabled": true + @}, "http://localhost:8088/": @{ + "disabled": false, "http_status": 200, "methods": [ @{ "type" : "question", @@ -3194,7 +3632,7 @@ port 8888 was now added: @end example @node Backup transitions,Recovery transitions,Common transitions,Reducer transitions -@anchor{reducer backup-transitions}@anchor{62} +@anchor{reducer backup-transitions}@anchor{70} @subsubsection Backup transitions @@ -3238,15 +3676,17 @@ to it: @end example If required attributes are missing, do not match the required regular -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 -is specific to the failure, and optional details. Example: +expression, or fail the custom validation logic, the reducer SHOULD return an +error response indicating that the transition has failed and what is wrong about +the input and not transition to a new state. 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 is specific to the +failure, and optional details. + +Example: @example @{ - "backup_state": "ERROR", "code": 8404, "hint": "An input did not match the regular expression.", "detail": "social_security_number" @@ -3338,8 +3778,8 @@ response: @} @end example -If the index is invalid, the reducer will instead -transition into an @code{ERROR} state. +If the index is invalid, the reducer will return an error +response instead of making a transition. @strong{next} (from @code{AUTHENTICATIONS_EDITING}): @@ -3413,8 +3853,8 @@ policy. The @code{methods} array specifies the index of the @code{authentication_method} in the @code{authentication_methods} array, as well as the provider that was selected to supervise this authentication. -If no authentication method was provided, the reducer will transition into an -@code{ERROR} state instead of suggesting policies. +If no authentication method was provided, the reducer will +return an error response instead of making a transition. @strong{add_policy}: @@ -3500,7 +3940,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 @code{ERROR} state instead of +authentication, the reducer return an error response instead of adding the new policy. @strong{update_policy}: @@ -3530,7 +3970,7 @@ An example for a possible argument would thus be: 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 @code{ERROR} state instead of +authentication, the reducer will return an error response instead of modifying the policy. @strong{delete_policy:} @@ -3591,7 +4031,7 @@ be: @} @end example -If the index given is invalid, the reducer will transition into an @code{ERROR} state +If the index given is invalid, the reducer will return an error response instead of deleting a policy. @strong{delete_challenge:} @@ -3651,7 +4091,7 @@ be: @} @end example -If the index given is invalid, the reducer will transition into an @code{ERROR} state +If the index given is invalid, the reducer will return an error response instead of deleting a challenge. @strong{next} (from @code{POLICIES_REVIEWING}): @@ -3664,7 +4104,7 @@ The reducer will simply transition to the @code{SECRET_EDITING} state: @example @{ "backup_state": "SECRET_EDITING", - "upload_fees" : [ "KUDOS:42" ], + "upload_fees" : [ @{ "fee": "KUDOS:42" @} ], "expiration" : @{ "t_ms" : 1245362362 @} @} @end example @@ -3674,8 +4114,8 @@ given policy expiration time. This is an array because fees could be in different currencies. The final cost may be lower if the user already paid for some of the time. -If the array of @code{policies} is currently empty, the reducer will transition -into an @code{ERROR} state instead of allowing the user to continue. +If the array of @code{policies} is currently empty, the reducer will +return an error response instead of allowing the user to continue. @strong{enter_secret:} @@ -3709,7 +4149,7 @@ be updated. "mime" : "text/plain" @}, "expiration" : @{ "t_ms" : 1245362362 @}, - "upload_fees" : [ "KUDOS:42" ] + "upload_fees" : [ @{ "fee": "KUDOS:42" @} ] @} @end example @@ -3775,8 +4215,8 @@ Using this transition, the user confirms that the secret and expiration settings in the current state are acceptable. The transition does not take any arguments. -If the secret is currently empty, the reducer will transition into an -@code{ERROR} state instead of allowing the user to continue. +If the secret is currently empty, the reducer will return an +error response instead of allowing the user to continue. After adding a secret, the reducer may transition into different states depending on whether payment(s) are necessary. If payments are needed, the @@ -3852,13 +4292,12 @@ will wait this long before giving up. If no timeout is given, the check is done as quickly as possible without additional delays. The reducer will continue to either an updated state with the remaining payment requests, to the @code{BACKUP_FINISHED} state (if all payments have been completed and the backup -finished), or into an @code{ERROR} state in case there was an irrecoverable error, +finished), or return an error response in case there was an irrecoverable error, indicating the specific provider and how it failed. An example for this final error state would be: @example @{ - "backup_state": "ERROR", "http_status" : 500, "upload_status" : 52, "provider_url" : "https://bad.example.com/", @@ -3887,7 +4326,7 @@ In the above example, 52 would thus imply that the Anastasis provider failed to store information into its database. @node Recovery transitions,,Backup transitions,Reducer transitions -@anchor{reducer recovery-transitions}@anchor{63} +@anchor{reducer recovery-transitions}@anchor{71} @subsubsection Recovery transitions @@ -3911,11 +4350,71 @@ the backup process. Example arguments would thus be: @} @end example -However, in contrast to the backup process, the reducer will attempt to -retrieve the latest recovery document from all known providers for the -selected currency given the above inputs. If a recovery document was found -by any provider, the reducer will attempt to load it and transition to -a state where the user can choose which challenges to satisfy: +Afterwards, the reducer transitions into the @code{SECRET_SELECTING} state: + +@example +@{ + "recovery_state": "SECRET_SELECTING", + "identity_attributes": @{ + "full_name": "Max Musterman", + "social_security_number": "123456789", + "birthdate": "2000-01-01", + "birthplace": "Earth" + @} +@} +@end example + +Typically, the special policy discovery process (outside of the state +machine) is expected to be run in this state. The discovery process +will use the state (and in particular the identity attributes and the +list of active providers) to discover a set of possible recovery +documents with their respective provider URLs, policy version and +identity attribute mask. An identity attribute mask is a bitmask that +describes which of the optional attributes from the identity +attributes should be omitted to recover this backup. Once the user +has selected a backup providing this triplet, it is possible to +proceed using @code{next}. + +Especially if the discovered policies are inadequate, it is again +possible to add providers using @code{add_provider}. + +@strong{add_provider}: + +This operation can be performed in state @code{SECRET_SELECTING}. It +adds one additional Anastasis provider to the list of providers that +the discovery process should henceforth consider. Note that removing +providers is not possible at this time. + +Here, the client must provide an object with the base URL of the +providers to add, for example: + +@example +@{ + "provider_url" : "http://localhost:8088/" +@} +@end example + +@strong{select_version}: + +Using the @code{select_version} transition in the @code{SECRET_SELECTING} state, +it is possible to trigger the download and decryption of a recovery +policy document. Here, the arguments specify which provider, version +and mask should be used to download the document: + +@example +@{ + "providers" : [ @{ + "url": "https://localhost:8088/", + "version": 0 + @} ], + "attribute_mask": 0 +@} +@end example + +The reducer will attempt to retrieve the specified recovery document +from that provider. If a recovery document was found, the reducer +will attempt to load it and transition to a state where the user can +choose which challenges to satisfy: @example @{ @@ -3924,13 +4423,13 @@ a state where the user can choose which challenges to satisfy: "challenges": [ @{ "uuid": "MW2R3RCBZPHNC78AW8AKWRCHF9KV3Y82EN62T831ZP54S3K5599G", - "cost": "TESTKUDOS:0", + "uuid-display": "MW2R3RC", "type": "question", "instructions": "q1" @}, @{ "uuid": "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0", - "cost": "TESTKUDOS:0", + "uuid-display": "TXYKGE", "type": "email", "instructions": "e-mail address m?il@@f*.bar" @}, @@ -3971,14 +4470,13 @@ four mandatory fields: @item @strong{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. +UUIDs in the policies array refer to. @item -@strong{cost}: This is the amount the Anastasis provider will charge -to allow the user to pass the challenge. +@strong{uuid-display}: Shortened idenfier which is included in messages +send to the user. Allows the user to +distinguish different PIN/TANs should say the same phone number be +used for SMS-authentication with different providers. @item @strong{type}: This is the type of the challenge, as a string. @@ -4001,7 +4499,6 @@ message together with a transition failure: @example @{ - "recovery_state": "ERROR", "error_message": "account unknown to Anastasis server", "error_code": 9, @} @@ -4015,26 +4512,33 @@ translations should be available in the @code{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. -@strong{change_version:} +@strong{sync_providers} + +The downloaded policy may include secrets from providers for which +we do not (yet) have the cost structure or even the salt. So here +an application can use the @code{sync_providers} request to download +@code{/config} from providers that are in the challenge list but not +yet known with their salt and other attributes in the provider list. -Even if a recovery document was found, it is possible that the user -intended to recover a different version, or recover a backup where -the recovery document is stored at a different provider. Thus, the -reducer allows the user to explicitly switch to a different provider -or recovery document version using the @code{change_version} transition, -which takes a provider URL and policy version as arguments: +The transition fails if all providers relevant for the selected +policy are already downloaded. Applications may either internally +check the state for this, or call @code{sync_providers} until it fails +with this error: @example @{ - "provider_url": "https://localhost:8080/", - "version": 2 + "detail": "already in sync", + "code": 8400, + "hint": "The given action is invalid for the current state of the reducer." @} @end example -Note that using a version of 0 implies fetching “the latest version”. The -resulting states are the same as those of the @code{enter_user_attributes} -transition, except that the recovery document version is not necessarily the -latest available version at the provider. +As providers may fail to respond, this action may need to be called +repeatedly. The action will block until progress is made on any provider. +As some providers may never respond, the application should disable +challenge buttons for challenges where providers are down. However, +users should be able to solve challenges where the provider is up while +the reducer is polling for @code{/config} in the background. @strong{select_challenge:} @@ -4089,8 +4593,6 @@ information about attempted challenges, with the final state being @code{solved} Challenges feedback for a challenge can have many different @code{state} values that applications must all handle. States other than @code{solved} are: -@quotation - @itemize - @@ -4111,12 +4613,6 @@ that applications must all handle. States other than @code{solved} are: @} @} @end example -@end itemize - -@quotation - - -@itemize - @item @strong{body}: Here, the server provided an HTTP reply for @@ -4173,7 +4669,7 @@ related to solving the challenge: @{ "recovery_state": "CHALLENGE_SOLVING", "recovery_information": @{ - "...": "..." + "...": "..." @} "selected_challenge_uuid": "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0", "challenge_feedback": @{ @@ -4189,25 +4685,16 @@ related to solving the challenge: @} @} @end example -@end itemize - -@quotation - - -@itemize - @item @strong{redirect}: To solve the challenge, the user must visit the indicated Web site at @code{redirect_url}, for example to perform video authentication: -@end itemize - -@quotation @example @{ "recovery_state": "CHALLENGE_SOLVING", "recovery_information": @{ - "...": "..." + "...": "..." @} "selected_challenge_uuid": "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0", "challenge_feedback": @{ @@ -4220,26 +4707,22 @@ Web site at @code{redirect_url}, for example to perform video authentication: @} @end example - -@itemize - - @item @strong{server-failure}: This indicates that the Anastasis provider encountered a failure and recovery using this challenge cannot proceed at this time. Examples for failures might be that the provider is unable to send SMS messages at this time due to an outage. The body includes details about the failure. The user may try again later or continue with other challenges. -@end itemize @example -@{ - "recovery_state": "CHALLENGE_SELECTING", - "recovery_information": @{ - "...": "..." - @} - "selected_challenge_uuid": "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0", - "challenge_feedback": @{ - "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0": @{ + @{ + "recovery_state": "CHALLENGE_SELECTING", + "recovery_information": @{ + "...": "..." + @} + "selected_challenge_uuid": "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0", + "challenge_feedback": @{ + "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0": @{ "state": "server-failure", "http_status": "500", "error_code": 52 @@ -4248,14 +4731,10 @@ the failure. The user may try again later or continue with other challenges. @} @end example - -@itemize - - @item @strong{truth-unknown}: This indicates that the Anastasis provider is unaware of the specified challenge. This is typically a permanent failure, and user interfaces should not allow users to re-try this challenge. -@end itemize @example @{ @@ -4273,12 +4752,8 @@ interfaces should not allow users to re-try this challenge. @} @end example - -@itemize - - @item -@strong{rate-limit-exceeded}: -@end itemize +@strong{rate-limit-exceeded}: This indicates that the user has made too many invalid attempts in too short an amount of time. @example @{ @@ -4295,10 +4770,88 @@ interfaces should not allow users to re-try this challenge. @} @} @end example -@end quotation -@end quotation -@end quotation -@end quotation + +@item +@strong{authentication-timeout}: This indicates that the challenge is awaiting for some external authentication process to complete. The application should @code{poll} for it to complete, or proceed with selecting other challenges. + +@example +@{ + "recovery_state": "CHALLENGE_SELECTING", + "recovery_information": @{ + "...": "..." + @} + "selected_challenge_uuid": "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0", + "challenge_feedback": @{ + "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0": @{ + "state": "authentication-timeout", + "error_code": 8122 + @} + @} +@} +@end example + +@item +@strong{external-instructions}: This indicates that the challenge requires the user to perform some authentication method-specific actions. Details about what the user should do are provided. + +@example +@{ + "recovery_state": "CHALLENGE_SELECTING", + "recovery_information": @{ + "...": "..." + @} + "selected_challenge_uuid": "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0", + "challenge_feedback": @{ + "TXYKGE1SJZHJ4M2FKSV1P2RZVNTHZFB9E3A79QE956D3SCAWXPK0": @{ + "state": "external-instructions", + "method": "iban", + "async": true, // optional + "answer_code": 987654321, // optional + "details": @{ + "...": "..." + @} + @} + @} +@} +@end example + +If “async” is “true”, then the client should +poll for the challenge being satisfied using +the “answer_code” that has been provided. + +The specific instructions on how to satisfy +the challenge depend on the @code{method}. +They include: + + +@itemize - + +@item +@strong{iban}: The user must perform a wire transfer from their account to the Anastasis provider. + +@example +@{ + "challenge_amount": "EUR:1", + "credit_iban": "DE12345789000", + "business_name": "Data Loss Incorporated", + "wire_transfer_subject": "Anastasis 987654321" +@} +@end example + +Note that the actual wire transfer subject must contain both +the numeric @code{answer_code} as well as +the string @code{Anastasis}. +@end itemize +@end itemize + +@strong{poll:} + +With a @code{poll} transition, the application indicates that it wants to wait longer for one or more of the challenges that are awaiting some external authentication (state @code{external-instructions}) or experienced some kind of timeout (state @code{authentication-timeout}) to possibly complete. While technically optional, the @code{timeout} argument should really be provided to enable long-polling, for example: + +@example +@{ + "timeout" : @{ "d_ms" : 5000 @}, +@} +@end example @strong{pay:} @@ -4364,7 +4917,7 @@ formats are: @c @author Dennis Neufeld @node Authentication Methods,DB Schema,Reducer API,Documentation Overview -@anchor{authentication doc}@anchor{64}@anchor{authentication anastasis-auth-methods}@anchor{65}@anchor{authentication authentication-methods}@anchor{66} +@anchor{authentication doc}@anchor{72}@anchor{authentication anastasis-auth-methods}@anchor{73}@anchor{authentication authentication-methods}@anchor{74} @section Authentication Methods @@ -4392,29 +4945,29 @@ maximum permissible frequency. @end menu @node SMS sms,Email verification email,,Authentication Methods -@anchor{authentication sms-sms}@anchor{67} +@anchor{authentication sms-sms}@anchor{75} @subsection SMS (sms) Sends an SMS with a code (prefixed with @code{A-}) to the user’s phone, including a UUID which identifies the challenge the code is for. The user must send -this code back with his request (see @code{$RESPONSE} under @ref{52,,Managing truth}). +this code back with his request (see @code{$RESPONSE} under @ref{5c,,Managing truth}). If the transmitted code is correct, the server responses with the requested encrypted key share. @node Email verification email,Video identification vid,SMS sms,Authentication Methods -@anchor{authentication email-verification-email}@anchor{68} +@anchor{authentication email-verification-email}@anchor{76} @subsection Email verification (email) Sends an email with a code (prefixed with @code{A-}) to the user’s mail address, including a UUID which identifies the challenge the code is for. The user -must send this code back with his request (see @code{$RESPONSE} under @ref{52,,Managing truth}). +must send this code back with his request (see @code{$RESPONSE} under @ref{5c,,Managing truth}). If the transmitted code is correct, the server responses with the requested encrypted key share. @node Video identification vid,Security question qa,Email verification email,Authentication Methods -@anchor{authentication video-identification-vid}@anchor{69} +@anchor{authentication video-identification-vid}@anchor{77} @subsection Video identification (vid) @@ -4432,7 +4985,7 @@ requesting the user to be redirected to a Web site (or other URL) for the video-call. @node Security question qa,Snail mail verification post,Video identification vid,Authentication Methods -@anchor{authentication security-question-qa}@anchor{6a} +@anchor{authentication security-question-qa}@anchor{78} @subsection Security question (qa) @@ -4455,14 +5008,14 @@ remains irrecoverable without the answer even if the Anastasis provider storing the security question is malicious. @node Snail mail verification post,,Security question qa,Authentication Methods -@anchor{authentication snail-mail-verification-post}@anchor{6b} +@anchor{authentication snail-mail-verification-post}@anchor{79} @subsection Snail mail verification (post) Sends physical mail (snail mail) with a code (prefixed with @code{A-}) to the user’s mail address, including a UUID which identifies the challenge the code is for. The user must send this code back with their request (see -@code{$RESPONSE} under @ref{52,,Managing truth}). If the transmitted code is correct, +@code{$RESPONSE} under @ref{5c,,Managing truth}). If the transmitted code is correct, the server responds with the requested encrypted key share. @c This file is part of Anastasis @@ -4484,7 +5037,7 @@ the server responds with the requested encrypted key share. @c @author Dennis Neufeld @node DB Schema,Anastasis licensing information,Authentication Methods,Documentation Overview -@anchor{db doc}@anchor{6c}@anchor{db db-schema}@anchor{6d} +@anchor{db doc}@anchor{7a}@anchor{db db-schema}@anchor{7b} @section DB Schema @@ -4499,7 +5052,7 @@ the server responds with the requested encrypted key share. @image{anastasis-figures/anastasis_truth_payment,,,,png} @node Anastasis licensing information,Man Pages,DB Schema,Documentation Overview -@anchor{global-licensing doc}@anchor{6e}@anchor{global-licensing anastasis-licensing-information}@anchor{6f} +@anchor{global-licensing doc}@anchor{7c}@anchor{global-licensing anastasis-licensing-information}@anchor{7d} @section Anastasis licensing information @@ -4521,7 +5074,7 @@ GPL. @end menu @node Anastasis git //git taler net/anastasis,Anastasis-gtk git //git taler net/anastasis-gtk,,Anastasis licensing information -@anchor{global-licensing anastasis-git-git-taler-net-anastasis}@anchor{70}@anchor{global-licensing exchange-repo}@anchor{71} +@anchor{global-licensing anastasis-git-git-taler-net-anastasis}@anchor{7e}@anchor{global-licensing exchange-repo}@anchor{7f} @subsection Anastasis (git://git.taler.net/anastasis) @@ -4533,7 +5086,7 @@ Anastasis core logic is under AGPL. @end menu @node Runtime dependencies,,,Anastasis git //git taler net/anastasis -@anchor{global-licensing runtime-dependencies}@anchor{72} +@anchor{global-licensing runtime-dependencies}@anchor{80} @subsubsection Runtime dependencies @@ -4563,7 +5116,7 @@ GNU Taler: LGPLv3+ / GPLv3+ / AGPLv3+: owned by Taler Systems SA @end itemize @node Anastasis-gtk git //git taler net/anastasis-gtk,Documentation,Anastasis git //git taler net/anastasis,Anastasis licensing information -@anchor{global-licensing anastasis-gtk-git-git-taler-net-anastasis-gtk}@anchor{73} +@anchor{global-licensing anastasis-gtk-git-git-taler-net-anastasis-gtk}@anchor{81} @subsection Anastasis-gtk (git://git.taler.net/anastasis-gtk) @@ -4575,7 +5128,7 @@ Anastasis-gtk is under AGPL. @end menu @node Runtime dependencies<2>,,,Anastasis-gtk git //git taler net/anastasis-gtk -@anchor{global-licensing id1}@anchor{74} +@anchor{global-licensing id1}@anchor{82} @subsubsection Runtime dependencies @@ -4608,28 +5161,31 @@ GNU Taler: LGPLv3+ / GPLv3+ / AGPLv3+: owned by Taler Systems SA @end itemize @node Documentation,,Anastasis-gtk git //git taler net/anastasis-gtk,Anastasis licensing information -@anchor{global-licensing documentation}@anchor{75} +@anchor{global-licensing documentation}@anchor{83} @subsection Documentation The documentation is licensed under the GNU Free Documentation License Version 1.3 or later. @node Man Pages,Complete Index,Anastasis licensing information,Documentation Overview -@anchor{manindex doc}@anchor{76}@anchor{manindex man-pages}@anchor{77} +@anchor{manindex doc}@anchor{84}@anchor{manindex man-pages}@anchor{85} @section Man Pages @menu * anastasis-config(1): anastasis-config 1. +* anastasis-dbconfig(1): anastasis-dbconfig 1. +* anastasis-dbinit(1): anastasis-dbinit 1. * anastasis-gtk(1): anastasis-gtk 1. +* anastasis-helper-authorization-iban(1): anastasis-helper-authorization-iban 1. * anastasis-httpd(1): anastasis-httpd 1. * anastasis-reducer(1): anastasis-reducer 1. * anastasis.conf(5): anastasis conf 5. @end menu -@node anastasis-config 1,anastasis-gtk 1,,Man Pages -@anchor{manpages/anastasis-config 1 doc}@anchor{78}@anchor{manpages/anastasis-config 1 anastasis-config-1}@anchor{79} +@node anastasis-config 1,anastasis-dbconfig 1,,Man Pages +@anchor{manpages/anastasis-config 1 doc}@anchor{86}@anchor{manpages/anastasis-config 1 anastasis-config-1}@anchor{87} @subsection anastasis-config(1) @@ -4643,7 +5199,7 @@ The documentation is licensed under the GNU Free Documentation License Version 1 @end menu @node Synopsis,Description,,anastasis-config 1 -@anchor{manpages/anastasis-config 1 synopsis}@anchor{7a} +@anchor{manpages/anastasis-config 1 synopsis}@anchor{88} @subsubsection Synopsis @@ -4663,7 +5219,7 @@ The documentation is licensed under the GNU Free Documentation License Version 1 [@strong{-v} | @strong{––version}] @node Description,See Also,Synopsis,anastasis-config 1 -@anchor{manpages/anastasis-config 1 description}@anchor{7b} +@anchor{manpages/anastasis-config 1 description}@anchor{89} @subsubsection Description @@ -4747,23 +5303,23 @@ Print Anastasis version number. @end table @node See Also,Bugs,Description,anastasis-config 1 -@anchor{manpages/anastasis-config 1 see-also}@anchor{7c} +@anchor{manpages/anastasis-config 1 see-also}@anchor{8a} @subsubsection See Also anastasis.conf(5) @node Bugs,,See Also,anastasis-config 1 -@anchor{manpages/anastasis-config 1 bugs}@anchor{7d} +@anchor{manpages/anastasis-config 1 bugs}@anchor{8b} @subsubsection Bugs Report bugs by using @indicateurl{https://bugs.anastasis.lu} or by sending electronic mail to <@email{contact@@anastasis.lu}>. -@node anastasis-gtk 1,anastasis-httpd 1,anastasis-config 1,Man Pages -@anchor{manpages/anastasis-gtk 1 doc}@anchor{7e}@anchor{manpages/anastasis-gtk 1 anastasis-gtk-1}@anchor{7f} -@subsection anastasis-gtk(1) +@node anastasis-dbconfig 1,anastasis-dbinit 1,anastasis-config 1,Man Pages +@anchor{manpages/anastasis-dbconfig 1 doc}@anchor{8c}@anchor{manpages/anastasis-dbconfig 1 anastasis-dbconfig-1}@anchor{8d} +@subsection anastasis-dbconfig(1) @@ -4775,20 +5331,194 @@ mail to <@email{contact@@anastasis.lu}>. @end menu -@node Synopsis<2>,Description<2>,,anastasis-gtk 1 -@anchor{manpages/anastasis-gtk 1 synopsis}@anchor{80} +@node Synopsis<2>,Description<2>,,anastasis-dbconfig 1 +@anchor{manpages/anastasis-dbconfig 1 synopsis}@anchor{8e} +@subsubsection Synopsis + + +@strong{anastasis-dbconfig} +[@strong{-c} @emph{FILENAME} @emph{] +[*}-h**] +[@strong{-n} @emph{NAME} @emph{] +[*}-r**] +[@strong{-s}] +[@strong{-u} @emph{USER} >>*<<] + +@node Description<2>,See Also<2>,Synopsis<2>,anastasis-dbconfig 1 +@anchor{manpages/anastasis-dbconfig 1 description}@anchor{8f} +@subsubsection Description + + +@strong{anastasis-dbconfig} is a simple shell script that configures +a Postgresql database for use by the GNU Anastasis servers. + +Its options are as follows: + + +@table @asis + +@item @strong{-c} @emph{FILENAME} + +Write the database configuration to FILENAME. The tool +will append the required @code{CONFIG} option for the +Postgresql access to the respective file. + +@item @strong{-h} + +Print short help on options. + +@item @strong{-n} @emph{DBNAME} + +Use DBNAME for the name of the created database. + +@item @strong{-r} + +Reset any existing database. Looses all existing data. DANGEROUS. + +@item @strong{-s} + +Skip database initialization. Useful if you want to run +@code{anastasis-dbinit} manually. + +@item @strong{-u} @emph{USER} + +Specifies the (main) Anastasis user that will access the database. +@end table + +@node See Also<2>,Bugs<2>,Description<2>,anastasis-dbconfig 1 +@anchor{manpages/anastasis-dbconfig 1 see-also}@anchor{90} +@subsubsection See Also + + +anastassis-dbinit(1), anastasis.conf(5). + +@node Bugs<2>,,See Also<2>,anastasis-dbconfig 1 +@anchor{manpages/anastasis-dbconfig 1 bugs}@anchor{91} +@subsubsection Bugs + + +Report bugs by using @indicateurl{https://bugs.taler.net} or by sending electronic +mail to <@email{taler@@gnu.org}>. + +@node anastasis-dbinit 1,anastasis-gtk 1,anastasis-dbconfig 1,Man Pages +@anchor{manpages/anastasis-dbinit 1 doc}@anchor{92}@anchor{manpages/anastasis-dbinit 1 anastasis-dbinit-1}@anchor{93} +@subsection anastasis-dbinit(1) + + + +@menu +* Synopsis: Synopsis<3>. +* Description: Description<3>. +* See Also: See Also<3>. +* Bugs: Bugs<3>. + +@end menu + +@node Synopsis<3>,Description<3>,,anastasis-dbinit 1 +@anchor{manpages/anastasis-dbinit 1 synopsis}@anchor{94} +@subsubsection Synopsis + + +@strong{anastasis-dbinit} +[@strong{-c} @emph{FILENAME} | @strong{–config=}@emph{FILENAME}] +[@strong{-g} | @strong{–gc}] +[@strong{-h} | @strong{–help}] +[@strong{-L} @emph{LOGLEVEL} | @strong{–loglevel=}@emph{LOGLEVEL}] +[@strong{-l} @emph{FILENAME} | @strong{–logfile=}@emph{FILENAME}] +[@strong{-r} | @strong{–reset}] +[@strong{-v} | @strong{–version}] + +@node Description<3>,See Also<3>,Synopsis<3>,anastasis-dbinit 1 +@anchor{manpages/anastasis-dbinit 1 description}@anchor{95} +@subsubsection Description + + +@strong{anastasis-dbinit} is a command-line tool to initialize the GNU +Anastasis database. It creates the necessary tables and indices for +an Anastasis server to operate. + +Its options are as follows: + + +@table @asis + +@item @strong{-c} @emph{FILENAME} | @strong{–config=}@emph{FILENAME} + +Use the configuration and other resources for the exchange to operate +from @emph{FILENAME}. + +@item @strong{-g} | @strong{–gc} + +Garbage collect database. Deletes all unnecessary data in the +database. + +@item @strong{-h} | @strong{–help} + +Print short help on options. + +@item @strong{-L} @emph{LOGLEVEL} | @strong{–loglevel=}@emph{LOGLEVEL} + +Specifies the log level to use. Accepted values are: @code{DEBUG}, @code{INFO}, +@code{WARNING}, @code{ERROR}. + +@item @strong{-l} @emph{FILENAME} | @strong{–logfile=}@emph{FILENAME} + +Send logging output to @emph{FILENAME}. + +@item @strong{-r} | @strong{–reset} + +Drop tables. Dangerous, will delete all existing data in the database +before creating the tables. + +@item @strong{-v} | @strong{–version} + +Print version information. +@end table + +@node See Also<3>,Bugs<3>,Description<3>,anastasis-dbinit 1 +@anchor{manpages/anastasis-dbinit 1 see-also}@anchor{96} +@subsubsection See Also + + +anastasis-httpd(1), anastasis.conf(5). + +@node Bugs<3>,,See Also<3>,anastasis-dbinit 1 +@anchor{manpages/anastasis-dbinit 1 bugs}@anchor{97} +@subsubsection Bugs + + +Report bugs by using @indicateurl{https://bugs.taler.net} or by sending electronic +mail to <@email{taler@@gnu.org}>. + +@node anastasis-gtk 1,anastasis-helper-authorization-iban 1,anastasis-dbinit 1,Man Pages +@anchor{manpages/anastasis-gtk 1 doc}@anchor{98}@anchor{manpages/anastasis-gtk 1 anastasis-gtk-1}@anchor{99} +@subsection anastasis-gtk(1) + + + +@menu +* Synopsis: Synopsis<4>. +* Description: Description<4>. +* See Also: See Also<4>. +* Bugs: Bugs<4>. + +@end menu + +@node Synopsis<4>,Description<4>,,anastasis-gtk 1 +@anchor{manpages/anastasis-gtk 1 synopsis}@anchor{9a} @subsubsection Synopsis @strong{anastasis-gtk} +[@strong{-A**_*ID*_|_}–application=**@emph{ID}] [@strong{-c} @emph{FILENAME} | @strong{––config=}@emph{FILENAME}] [@strong{-h} | @strong{––help}] [@strong{-L} @emph{LOGLEVEL} | @strong{––loglevel=}@emph{LOGLEVEL}] [@strong{-l} @emph{FILENAME} | @strong{––logfile=}@emph{FILENAME}] [@strong{-v} | @strong{––version}] -@node Description<2>,See Also<2>,Synopsis<2>,anastasis-gtk 1 -@anchor{manpages/anastasis-gtk 1 description}@anchor{81} +@node Description<4>,See Also<4>,Synopsis<4>,anastasis-gtk 1 +@anchor{manpages/anastasis-gtk 1 description}@anchor{9b} @subsubsection Description @@ -4798,6 +5528,21 @@ key recover and backup operations. @table @asis +@item @strong{-A} @emph{ID} | @strong{–application=}@emph{ID} + +Set the application ID to @emph{ID}. Default is @code{anastasis-gtk}. Used +to store different types of secrets from different applications +while using the same user attributes. Basically the application ID +is included in the user attributes. Not changable by the GUI as +only advanced users should even known about this. Applications that +tightly integrate Anastasis should set the application ID to their +respective unique name, for example the GNU Taler wallet may use +@code{gnu-taler-wallet} for the application ID. If anastasis-gtk is +to be used to recover such a secret, the respective application ID +must be provided on the command-line. Users that only use +anastasis-gtk to backup and restore secrets should not set the +application ID, as forgetting the ID makes the secrets irrecoverable. + @item @strong{-c} @emph{FILENAME} | @strong{––config=}@emph{FILENAME} Use the configuration from @emph{FILENAME}. @@ -4820,45 +5565,123 @@ Send logging output to @emph{FILENAME}. Print version information. @end table -@node See Also<2>,Bugs<2>,Description<2>,anastasis-gtk 1 -@anchor{manpages/anastasis-gtk 1 see-also}@anchor{82} +@node See Also<4>,Bugs<4>,Description<4>,anastasis-gtk 1 +@anchor{manpages/anastasis-gtk 1 see-also}@anchor{9c} @subsubsection See Also anastasis-reducer(1), anastasis-httpd(1), anastasis.conf(5). -@node Bugs<2>,,See Also<2>,anastasis-gtk 1 -@anchor{manpages/anastasis-gtk 1 bugs}@anchor{83} +@node Bugs<4>,,See Also<4>,anastasis-gtk 1 +@anchor{manpages/anastasis-gtk 1 bugs}@anchor{9d} @subsubsection Bugs Report bugs by using @indicateurl{https://bugs.anastasis.lu/} or by sending electronic mail to <@email{contact@@anastasis.lu}>. -@node anastasis-httpd 1,anastasis-reducer 1,anastasis-gtk 1,Man Pages -@anchor{manpages/anastasis-httpd 1 doc}@anchor{84}@anchor{manpages/anastasis-httpd 1 anastasis-httpd-1}@anchor{85} +@node anastasis-helper-authorization-iban 1,anastasis-httpd 1,anastasis-gtk 1,Man Pages +@anchor{manpages/anastasis-helper-authorization-iban 1 doc}@anchor{9e}@anchor{manpages/anastasis-helper-authorization-iban 1 anastasis-helper-authorization-iban-1}@anchor{9f} +@subsection anastasis-helper-authorization-iban(1) + + + +@menu +* Synopsis: Synopsis<5>. +* Description: Description<5>. +* See Also: See Also<5>. +* Bugs: Bugs<5>. + +@end menu + +@node Synopsis<5>,Description<5>,,anastasis-helper-authorization-iban 1 +@anchor{manpages/anastasis-helper-authorization-iban 1 synopsis}@anchor{a0} +@subsubsection Synopsis + + +@strong{anastasis-helper-authorization-iban} +[@strong{-c} @emph{FILENAME} | @strong{––config=}@emph{FILENAME}] +[@strong{-h} | @strong{––help}] +[@strong{-L} @emph{LOGLEVEL} | @strong{––loglevel=}@emph{LOGLEVEL}] +[@strong{-l} @emph{FILENAME} | @strong{––logfile=}@emph{FILENAME}] +[@strong{-t} | @strong{––test}] +[@strong{-v} | @strong{––version}] + +@node Description<5>,See Also<5>,Synopsis<5>,anastasis-helper-authorization-iban 1 +@anchor{manpages/anastasis-helper-authorization-iban 1 description}@anchor{a1} +@subsubsection Description + + +@strong{anastasis-helper-authorization-iban} monitors the Anastasis provider’s bank account for incoming wire transfers. This process supports the IBAN authentication method. It must be configured with the respective wire configuration to talk to LibEuFin/Nexus. + + +@table @asis + +@item @strong{-c} @emph{FILENAME} | @strong{––config=}@emph{FILENAME} + +Use the configuration from @emph{FILENAME}. + +@item @strong{-h} | @strong{––help} + +Print short help on options. + +@item @strong{-L} @emph{LOGLEVEL} | @strong{––loglevel=}@emph{LOGLEVEL} + +Specifies the log level to use. Accepted values are: @code{DEBUG}, @code{INFO}, +@code{WARNING}, @code{ERROR}. + +@item @strong{-l} @emph{FILENAME} | @strong{––logfile=}@emph{FILENAME} + +Send logging output to @emph{FILENAME}. + +@item @strong{-t} | @strong{––test} + +Run in test mode. Causes the process to terminate after importing current wire transfers instead of running forever in the background. + +@item @strong{-v} | @strong{––version} + +Print version information. +@end table + +@node See Also<5>,Bugs<5>,Description<5>,anastasis-helper-authorization-iban 1 +@anchor{manpages/anastasis-helper-authorization-iban 1 see-also}@anchor{a2} +@subsubsection See Also + + +anastasis-httpd(1), anastasis.conf(5). + +@node Bugs<5>,,See Also<5>,anastasis-helper-authorization-iban 1 +@anchor{manpages/anastasis-helper-authorization-iban 1 bugs}@anchor{a3} +@subsubsection Bugs + + +Report bugs by using @indicateurl{https://bugs.anastasis.lu/} or by sending electronic +mail to <@email{contact@@anastasis.lu}>. + +@node anastasis-httpd 1,anastasis-reducer 1,anastasis-helper-authorization-iban 1,Man Pages +@anchor{manpages/anastasis-httpd 1 doc}@anchor{a4}@anchor{manpages/anastasis-httpd 1 anastasis-httpd-1}@anchor{a5} @subsection anastasis-httpd(1) @menu -* Synopsis: Synopsis<3>. -* Description: Description<3>. +* Synopsis: Synopsis<6>. +* Description: Description<6>. * Signals:: * See also:: -* Bugs: Bugs<3>. +* Bugs: Bugs<6>. @end menu -@node Synopsis<3>,Description<3>,,anastasis-httpd 1 -@anchor{manpages/anastasis-httpd 1 synopsis}@anchor{86} +@node Synopsis<6>,Description<6>,,anastasis-httpd 1 +@anchor{manpages/anastasis-httpd 1 synopsis}@anchor{a6} @subsubsection Synopsis @strong{anastasis-httpd} -@node Description<3>,Signals,Synopsis<3>,anastasis-httpd 1 -@anchor{manpages/anastasis-httpd 1 description}@anchor{87} +@node Description<6>,Signals,Synopsis<6>,anastasis-httpd 1 +@anchor{manpages/anastasis-httpd 1 description}@anchor{a7} @subsubsection Description @@ -4889,8 +5712,8 @@ Print short help on options. Print version information. @end table -@node Signals,See also,Description<3>,anastasis-httpd 1 -@anchor{manpages/anastasis-httpd 1 signals}@anchor{88} +@node Signals,See also,Description<6>,anastasis-httpd 1 +@anchor{manpages/anastasis-httpd 1 signals}@anchor{a8} @subsubsection Signals @@ -4904,15 +5727,15 @@ Print version information. Sending a SIGTERM to the process will cause it to shutdown cleanly. @end table -@node See also,Bugs<3>,Signals,anastasis-httpd 1 -@anchor{manpages/anastasis-httpd 1 see-also}@anchor{89} +@node See also,Bugs<6>,Signals,anastasis-httpd 1 +@anchor{manpages/anastasis-httpd 1 see-also}@anchor{a9} @subsubsection See also anastasis-dbinit(1), anastasis-config(1), anastasis-gtk(1), anastasis-reducer(1) -@node Bugs<3>,,See also,anastasis-httpd 1 -@anchor{manpages/anastasis-httpd 1 bugs}@anchor{8a} +@node Bugs<6>,,See also,anastasis-httpd 1 +@anchor{manpages/anastasis-httpd 1 bugs}@anchor{aa} @subsubsection Bugs @@ -4920,25 +5743,26 @@ Report bugs by using @indicateurl{https://bugs.anastasis.lu} or by sending electronic mail to <@email{contact@@anastasis.lu}>. @node anastasis-reducer 1,anastasis conf 5,anastasis-httpd 1,Man Pages -@anchor{manpages/anastasis-reducer 1 doc}@anchor{8b}@anchor{manpages/anastasis-reducer 1 anastasis-reducer-1}@anchor{8c} +@anchor{manpages/anastasis-reducer 1 doc}@anchor{ab}@anchor{manpages/anastasis-reducer 1 anastasis-reducer-1}@anchor{ac} @subsection anastasis-reducer(1) @menu -* Synopsis: Synopsis<4>. -* Description: Description<4>. -* See Also: See Also<3>. -* Bugs: Bugs<4>. +* Synopsis: Synopsis<7>. +* Description: Description<7>. +* See Also: See Also<6>. +* Bugs: Bugs<7>. @end menu -@node Synopsis<4>,Description<4>,,anastasis-reducer 1 -@anchor{manpages/anastasis-reducer 1 synopsis}@anchor{8d} +@node Synopsis<7>,Description<7>,,anastasis-reducer 1 +@anchor{manpages/anastasis-reducer 1 synopsis}@anchor{ad} @subsubsection Synopsis @strong{anastasis-reducer} +[@strong{-A**_*ID*_|_}–application=**@emph{ID}] [@strong{-a**_*JSON*_|_}–arguments=@emph{JSON}] [@strong{-b**_|_}–backup] [@strong{-c} @emph{FILENAME} | @strong{––config=}@emph{FILENAME}] @@ -4948,8 +5772,8 @@ electronic mail to <@email{contact@@anastasis.lu}>. [@strong{-r**_|_}–restore] [@strong{-v} | @strong{––version}] COMMAND -@node Description<4>,See Also<3>,Synopsis<4>,anastasis-reducer 1 -@anchor{manpages/anastasis-reducer 1 description}@anchor{8e} +@node Description<7>,See Also<6>,Synopsis<7>,anastasis-reducer 1 +@anchor{manpages/anastasis-reducer 1 description}@anchor{ae} @subsubsection Description @@ -4959,7 +5783,7 @@ The reducer will read the current state from standard input and write the resulting state to standard output. A COMMAND must be given on the command line. The arguments (if any) are to be given in JSON format to the @strong{-a} option. A list of -commands can be found in the @ref{58,,Reducer API} +commands can be found in the @ref{66,,Reducer API} chapter. @@ -4969,6 +5793,20 @@ chapter. Provide JSON inputs for the given command. +@item @strong{-A} @emph{ID} | @strong{–application=}@emph{ID} + +Set the application ID to @emph{ID}. Default is empty, which means the application-id must be explicitly provided +as part of the JSON inputs or it will be omitted. +The @strong{-A} option overrides any application ID that +may be given in the @strong{-a} arguments. Application IDs +are used to store different types of secrets from different applications +while using the same user attributes. Basically the application ID +is included in the user attributes. Applications that +tightly integrate Anastasis should set the application ID to their +respective unique name, for example the GNU Taler wallet may use +@code{gnu-taler-wallet} for the application ID. +Forgetting the application ID makes the secrets irrecoverable. + @item @strong{-b} | @strong{–backup} Begin fresh reducer operation for a back up operation. @@ -4999,15 +5837,15 @@ Begin fresh reducer operation for a restore operation. Print version information. @end table -@node See Also<3>,Bugs<4>,Description<4>,anastasis-reducer 1 -@anchor{manpages/anastasis-reducer 1 see-also}@anchor{8f} +@node See Also<6>,Bugs<7>,Description<7>,anastasis-reducer 1 +@anchor{manpages/anastasis-reducer 1 see-also}@anchor{af} @subsubsection See Also anastasis-gtk(1), anastasis-httpd(1), anastasis.conf(5). -@node Bugs<4>,,See Also<3>,anastasis-reducer 1 -@anchor{manpages/anastasis-reducer 1 bugs}@anchor{90} +@node Bugs<7>,,See Also<6>,anastasis-reducer 1 +@anchor{manpages/anastasis-reducer 1 bugs}@anchor{b0} @subsubsection Bugs @@ -5015,20 +5853,20 @@ Report bugs by using @indicateurl{https://bugs.anastasis.lu/} or by sending elec mail to <@email{contact@@anastasis.lu}>. @node anastasis conf 5,,anastasis-reducer 1,Man Pages -@anchor{manpages/anastasis conf 5 doc}@anchor{91}@anchor{manpages/anastasis conf 5 anastasis-conf-5}@anchor{92} +@anchor{manpages/anastasis conf 5 doc}@anchor{b1}@anchor{manpages/anastasis conf 5 anastasis-conf-5}@anchor{b2} @subsection anastasis.conf(5) @menu -* Description: Description<5>. +* Description: Description<8>. * SEE ALSO:: * BUGS:: @end menu -@node Description<5>,SEE ALSO,,anastasis conf 5 -@anchor{manpages/anastasis conf 5 description}@anchor{93} +@node Description<8>,SEE ALSO,,anastasis conf 5 +@anchor{manpages/anastasis conf 5 description}@anchor{b3} @subsubsection Description @@ -5076,13 +5914,14 @@ include the entirety of @code{sub.conf} at that point in @code{main.conf}. @menu * GLOBAL OPTIONS:: +* Backend options:: * Authorization options:: * Postgres database configuration:: @end menu -@node GLOBAL OPTIONS,Authorization options,,Description<5> -@anchor{manpages/anastasis conf 5 global-options}@anchor{94} +@node GLOBAL OPTIONS,Backend options,,Description<8> +@anchor{manpages/anastasis conf 5 global-options}@anchor{b4} @subsubsection GLOBAL OPTIONS @@ -5092,11 +5931,6 @@ the @strong{anastasis-httpd} service. @table @asis -@item PAYMENT_BACKEND_URL - -Base-URL of the Taler merchant backend instance to use for payments. -FIXME: How do we pass the access token? - @item ANNUAL_FEE Annual fee to be paid for policy uploads, i.e. “EUR:1.5”. @@ -5105,6 +5939,10 @@ Annual fee to be paid for policy uploads, i.e. “EUR:1.5”. Annual fee to be paid for truth uploads, i.e. “EUR:1.5”. +@item INSURANCE + +Amount up to which key shares are warranted, i.e. “EUR:1000000”. + @item DB Database backend to use, only @code{postgres} is supported right now. @@ -5131,14 +5969,36 @@ change after the initial configuration. TCP port on which the HTTP service should listen on. @end table -@node Authorization options,Postgres database configuration,GLOBAL OPTIONS,Description<5> -@anchor{manpages/anastasis conf 5 authorization-options}@anchor{95} +@node Backend options,Authorization options,GLOBAL OPTIONS,Description<8> +@anchor{manpages/anastasis conf 5 backend-options}@anchor{b5} +@subsubsection Backend options + + +The following options are from the @code{[anastasis-merchant-backend]} section and used by +the @strong{anastasis-httpd} service. + + +@table @asis + +@item PAYMENT_BACKEND_URL + +Base-URL of the Taler merchant backend instance to use for payments. + +@item API_KEY + +API key to transmit to the merchant backend for authentication. +@end table + +@node Authorization options,Postgres database configuration,Backend options,Description<8> +@anchor{manpages/anastasis conf 5 authorization-options}@anchor{b6} @subsubsection Authorization options -For each active authorization plugin, options must be configured in -a section called @code{[authorization-$PLUGIN]} where @code{$PLUGIN} is -the name of the authorization plugin. +For each active authorization plugin, options must be configured in a +section called @code{[authorization-$PLUGIN]} where @code{$PLUGIN} is the +name of the authorization plugin. Specific plugins may require +additional options, which are described in the respective sections +below. @table @asis @@ -5151,14 +6011,91 @@ authorization plugin during recovery. @item ENABLED @code{yes} to enable this plugin, @code{no} to disable. +@end table + +@menu +* SMS Authorization options:: +* Email Authorization options:: +* Post Authorization options:: +* IBAN Authorization options:: + +@end menu + +@node SMS Authorization options,Email Authorization options,,Authorization options +@anchor{manpages/anastasis conf 5 sms-authorization-options}@anchor{b7} +@subsubsection SMS Authorization options + + + +@table @asis @item COMMAND -Helper command to run (only relevant for some plugins). +Helper command to run to send SMS. The command will be given the phone number as its first argument. The message to be transmitted will be passed via STDIN. +@end table + +@node Email Authorization options,Post Authorization options,SMS Authorization options,Authorization options +@anchor{manpages/anastasis conf 5 email-authorization-options}@anchor{b8} +@subsubsection Email Authorization options + + + +@table @asis + +@item COMMAND + +Helper command to run to send E-mail. The command will be given the e-mail address as its first argument. The message to be transmitted will be passed via STDIN. +@end table + +@node Post Authorization options,IBAN Authorization options,Email Authorization options,Authorization options +@anchor{manpages/anastasis conf 5 post-authorization-options}@anchor{b9} +@subsubsection Post Authorization options + + + +@table @asis + +@item COMMAND + +Helper command to run to send physical mail. The command will be given the mailing address address as its first argument in JSON object fields ‘full_name’, ‘street’, ‘city’, ‘postcode’ and ‘country’. The message to be transmitted will be passed via STDIN. +@end table + +@node IBAN Authorization options,,Post Authorization options,Authorization options +@anchor{manpages/anastasis conf 5 iban-authorization-options}@anchor{ba} +@subsubsection IBAN Authorization options + + + +@table @asis + +@item CREDIT_IBAN + +IBAN number where the consumers must +wire the money to for authentication. + +@item BUSINESS_NAME + +Name of the account holder. + +@item WIRE_GATEWAY_URL + +Base URL of the LibEuFin wire gateway (Anastasis facade). + +@item WIRE_GATEWAY_AUTH_METHOD + +Authentication method used to talk to the LibEuFin wire gateway, i.e. ‘basic’ for HTTP basic authentication. + +@item USERNAME + +Username to use when using HTTP basic authentication. + +@item PASSWORD + +Password to use when using HTTP basic authentication. @end table -@node Postgres database configuration,,Authorization options,Description<5> -@anchor{manpages/anastasis conf 5 postgres-database-configuration}@anchor{96} +@node Postgres database configuration,,Authorization options,Description<8> +@anchor{manpages/anastasis conf 5 postgres-database-configuration}@anchor{bb} @subsubsection Postgres database configuration @@ -5175,15 +6112,15 @@ Path under which the Postgres database is that the service should use, i.e. @code{postgres://anastasis}. @end table -@node SEE ALSO,BUGS,Description<5>,anastasis conf 5 -@anchor{manpages/anastasis conf 5 see-also}@anchor{97} +@node SEE ALSO,BUGS,Description<8>,anastasis conf 5 +@anchor{manpages/anastasis conf 5 see-also}@anchor{bc} @subsubsection SEE ALSO anastasis-httpd(1), anastasis-config(1) @node BUGS,,SEE ALSO,anastasis conf 5 -@anchor{manpages/anastasis conf 5 bugs}@anchor{98} +@anchor{manpages/anastasis conf 5 bugs}@anchor{bd} @subsubsection BUGS @@ -5191,12 +6128,12 @@ Report bugs by using @indicateurl{https://bugs.anastasis.lu/} or by sending elec mail to <@email{contact@@anastasis.lu}>. @node Complete Index,GNU Free Documentation License,Man Pages,Documentation Overview -@anchor{genindex doc}@anchor{99}@anchor{genindex complete-index}@anchor{9a} +@anchor{genindex doc}@anchor{be}@anchor{genindex complete-index}@anchor{bf} @section Complete Index @node GNU Free Documentation License,,Complete Index,Documentation Overview -@anchor{fdl-1 3 doc}@anchor{9b}@anchor{fdl-1 3 gnu-fdl-1-3}@anchor{9c}@anchor{fdl-1 3 gnu-free-documentation-license}@anchor{9d} +@anchor{fdl-1 3 doc}@anchor{c0}@anchor{fdl-1 3 gnu-fdl-1-3}@anchor{c1}@anchor{fdl-1 3 gnu-free-documentation-license}@anchor{c2} @section GNU Free Documentation License @@ -5226,7 +6163,7 @@ license document, but changing it is not allowed. @end menu @node 0 PREAMBLE,1 APPLICABILITY AND DEFINITIONS,,GNU Free Documentation License -@anchor{fdl-1 3 preamble}@anchor{9e} +@anchor{fdl-1 3 preamble}@anchor{c3} @subsection 0. PREAMBLE @@ -5252,7 +6189,7 @@ published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. @node 1 APPLICABILITY AND DEFINITIONS,2 VERBATIM COPYING,0 PREAMBLE,GNU Free Documentation License -@anchor{fdl-1 3 applicability-and-definitions}@anchor{9f} +@anchor{fdl-1 3 applicability-and-definitions}@anchor{c4} @subsection 1. APPLICABILITY AND DEFINITIONS @@ -5342,7 +6279,7 @@ these Warranty Disclaimers may have is void and has no effect on the meaning of this License. @node 2 VERBATIM COPYING,3 COPYING IN QUANTITY,1 APPLICABILITY AND DEFINITIONS,GNU Free Documentation License -@anchor{fdl-1 3 verbatim-copying}@anchor{a0} +@anchor{fdl-1 3 verbatim-copying}@anchor{c5} @subsection 2. VERBATIM COPYING @@ -5360,7 +6297,7 @@ You may also lend copies, under the same conditions stated above, and you may publicly display copies. @node 3 COPYING IN QUANTITY,4 MODIFICATIONS,2 VERBATIM COPYING,GNU Free Documentation License -@anchor{fdl-1 3 copying-in-quantity}@anchor{a1} +@anchor{fdl-1 3 copying-in-quantity}@anchor{c6} @subsection 3. COPYING IN QUANTITY @@ -5400,7 +6337,7 @@ Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. @node 4 MODIFICATIONS,5 COMBINING DOCUMENTS,3 COPYING IN QUANTITY,GNU Free Documentation License -@anchor{fdl-1 3 modifications}@anchor{a2} +@anchor{fdl-1 3 modifications}@anchor{c7} @subsection 4. MODIFICATIONS @@ -5536,7 +6473,7 @@ give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. @node 5 COMBINING DOCUMENTS,6 COLLECTIONS OF DOCUMENTS,4 MODIFICATIONS,GNU Free Documentation License -@anchor{fdl-1 3 combining-documents}@anchor{a3} +@anchor{fdl-1 3 combining-documents}@anchor{c8} @subsection 5. COMBINING DOCUMENTS @@ -5563,7 +6500,7 @@ sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements”. @node 6 COLLECTIONS OF DOCUMENTS,7 AGGREGATION WITH INDEPENDENT WORKS,5 COMBINING DOCUMENTS,GNU Free Documentation License -@anchor{fdl-1 3 collections-of-documents}@anchor{a4} +@anchor{fdl-1 3 collections-of-documents}@anchor{c9} @subsection 6. COLLECTIONS OF DOCUMENTS @@ -5579,7 +6516,7 @@ License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. @node 7 AGGREGATION WITH INDEPENDENT WORKS,8 TRANSLATION,6 COLLECTIONS OF DOCUMENTS,GNU Free Documentation License -@anchor{fdl-1 3 aggregation-with-independent-works}@anchor{a5} +@anchor{fdl-1 3 aggregation-with-independent-works}@anchor{ca} @subsection 7. AGGREGATION WITH INDEPENDENT WORKS @@ -5600,7 +6537,7 @@ equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. @node 8 TRANSLATION,9 TERMINATION,7 AGGREGATION WITH INDEPENDENT WORKS,GNU Free Documentation License -@anchor{fdl-1 3 translation}@anchor{a6} +@anchor{fdl-1 3 translation}@anchor{cb} @subsection 8. TRANSLATION @@ -5622,7 +6559,7 @@ If a section in the Document is Entitled “Acknowledgements”, Title (section 1) will typically require changing the actual title. @node 9 TERMINATION,10 FUTURE REVISIONS OF THIS LICENSE,8 TRANSLATION,GNU Free Documentation License -@anchor{fdl-1 3 termination}@anchor{a7} +@anchor{fdl-1 3 termination}@anchor{cc} @subsection 9. TERMINATION @@ -5652,7 +6589,7 @@ reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it. @node 10 FUTURE REVISIONS OF THIS LICENSE,11 RELICENSING,9 TERMINATION,GNU Free Documentation License -@anchor{fdl-1 3 future-revisions-of-this-license}@anchor{a8} +@anchor{fdl-1 3 future-revisions-of-this-license}@anchor{cd} @subsection 10. FUTURE REVISIONS OF THIS LICENSE @@ -5674,7 +6611,7 @@ used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document. @node 11 RELICENSING,ADDENDUM How to use this License for your documents,10 FUTURE REVISIONS OF THIS LICENSE,GNU Free Documentation License -@anchor{fdl-1 3 relicensing}@anchor{a9} +@anchor{fdl-1 3 relicensing}@anchor{ce} @subsection 11. RELICENSING @@ -5705,7 +6642,7 @@ under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing. @node ADDENDUM How to use this License for your documents,,11 RELICENSING,GNU Free Documentation License -@anchor{fdl-1 3 addendum-how-to-use-this-license-for-your-documents}@anchor{aa} +@anchor{fdl-1 3 addendum-how-to-use-this-license-for-your-documents}@anchor{cf} @subsection ADDENDUM: How to use this License for your documents @@ -5739,7 +6676,7 @@ If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. -@anchor{29}@w{ } +@anchor{30}@w{ } @anchor{rest tsref-type-ErrorDetail}@w{ } @c %**end of body |