commit db20ce2cdf58391166bc2c1b60abdbeeb2e56bd4
parent 8ed6688f77fb1cef2fb4c8cee5d7a4fe985f8180
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 4 Apr 2021 16:43:05 +0200
update spec based on actual implementation
Diffstat:
1 file changed, 7 insertions(+), 16 deletions(-)
diff --git a/anastasis.rst b/anastasis.rst
@@ -1787,29 +1787,20 @@ into an ERROR state instead of allowing the user to continue.
**enter_secret:**
-This transition provides the reducer with the actual core secret of the user
+This transition provides the reducer with the actual core ``secret`` of the user
that Anastasis is supposed to backup (and possibly recover). The argument is
-simply the Crockford-Base32 encoded ``secret``, for example:
+simply the Crockford-Base32 encoded ``value`` together with its ``mime`` type,
+for example:
.. code-block:: javascript
{
- "secret": "EDJP6WK5EG50"
+ "secret": {
+ "value": "EDJP6WK5EG50",
+ "mime" : "text/plain"
}
-Applications SHOULD prefix the encoded ``secret`` with some data that allows
-applications to recognize the application and the version of the secret. The
-suggested notation is ``$APPLICATION/$VERSION:$SECRET``, for example
-``taler-wallet/42:KEYMATERIAL``. In case the secret is provided from a file
-and the application is oblivious to the details, the same syntax can be used
-to prefix the secret with a MIME type, for example ``image/png:IMAGE``. If
-the application is unaware of the format, it should use ``*/*:DATA``.
-
-..note::
-
- The prefixing of the secret with the mime-type or application version
- is currently not implemented (#6825).
-
+If the application is unaware of the format, it set the ``mime`` field to ``null`.
After adding a secret, the reducer may transition into different states
depending on whether payment(s) are necessary. If payments are needed, the
