From d261084f5ba863e03c18ad47271d30052af76b4b Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Wed, 10 Jun 2020 17:31:21 -0400 Subject: [PATCH] apply changes from review --- .../client_server/newsfragments/2597.feature | 2 +- specification/modules/secrets.rst | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/changelogs/client_server/newsfragments/2597.feature b/changelogs/client_server/newsfragments/2597.feature index 299d295f..833006a9 100644 --- a/changelogs/client_server/newsfragments/2597.feature +++ b/changelogs/client_server/newsfragments/2597.feature @@ -1 +1 @@ -Document Secure Secret Storage and Sharing. +Document Secure Secret Storage and Sharing (MSC1946/2472). diff --git a/specification/modules/secrets.rst b/specification/modules/secrets.rst index 69a1af70..cb6b6a9e 100644 --- a/specification/modules/secrets.rst +++ b/specification/modules/secrets.rst @@ -123,7 +123,7 @@ it will be presented as a string constructed as follows: `_, that is, using the alphabet ``123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz``. -4. A space should be added after every 4th character. +4. The string is formatted into groups of four characters separated by spaces. When decoding a raw key, the process should be reversed, with the exception that whitespace is insignificant in the user's input. @@ -147,9 +147,9 @@ properties: ============ =========== ======================================================== Parameter Type Description ============ =========== ======================================================== -algorithm string Required. Must be ``m.pbkdf2`` -salt string Required. The salt used in PBKDF2. -iterations integer Required. The number of iterations to use in PBKDF2. +algorithm string **Required.** Must be ``m.pbkdf2`` +salt string **Required.** The salt used in PBKDF2. +iterations integer **Required.** The number of iterations to use in PBKDF2. bits integer Optional. The number of bits to generate for the key. Defaults to 256. ============ =========== ======================================================== @@ -260,9 +260,9 @@ previous request. It is sent as an unencrypted to-device event. ===================== =========== ===================================================== name string Required if ``action`` is ``request``. The name of the secret that is being requested. - action enum Required. One of ["request", "request_cancellation"]. - requesting_device_id string Required. The ID of the device requesting the secret. - request_id string Required. A random string uniquely identifying (with + action enum **Required.** One of ["request", "request_cancellation"]. + requesting_device_id string **Required.** The ID of the device requesting the secret. + request_id string **Required.** A random string uniquely identifying (with respect to the requester and the target) the target for a secret. If the secret is requested from multiple devices at the same time, the same ID may @@ -291,8 +291,8 @@ then sent as a to-device event. ============ =========== ======================================================== Parameter Type Description ============ =========== ======================================================== -request_id string Required. The ID of the request that this a response to. -secret string Required. The contents of the secret. +request_id string **Required.** The ID of the request that this a response to. +secret string **Required.** The contents of the secret. ============ =========== ======================================================== Example: