Merge pull request #2653 from uhoreg/spec-fixes-20200623

Various small fixes in e2e spec
This commit is contained in:
Hubert Chathi 2020-06-24 11:03:39 -04:00 committed by GitHub
commit b770cfee8b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 8 additions and 12 deletions

View file

@ -1 +1 @@
Improve consistency and clarity of event schema ``title``s. Improve consistency and clarity of event schema ``title``\ s.

View file

@ -0,0 +1 @@
Fix some errors in the end-to-end encryption spec.

View file

@ -13,11 +13,6 @@ properties:
description: |- description: |-
An opaque identifier for the verification process. Must be the same as An opaque identifier for the verification process. Must be the same as
the one used for the ``m.key.verification.start`` message. the one used for the ``m.key.verification.start`` message.
method:
type: string
enum: ["m.sas.v1"]
description: |-
The verification method to use.
key_agreement_protocol: key_agreement_protocol:
type: string type: string
description: |- description: |-

View file

@ -161,11 +161,11 @@ encrypted as follows:
============ =========== ======================================================= ============ =========== =======================================================
Parameter Type Description Parameter Type Description
============ =========== ======================================================= ============ =========== =======================================================
iv String **Required.** The 16-byte initialization vector, iv string **Required.** The 16-byte initialization vector,
encoded as base64. encoded as base64.
ciphertext String **Required.** The AES-CTR-encrypted data, encoded as ciphertext string **Required.** The AES-CTR-encrypted data, encoded as
base64. base64.
mac String **Required.** The MAC, encoded as base64. mac string **Required.** The MAC, encoded as base64.
============ =========== ======================================================= ============ =========== =======================================================
For the purposes of allowing clients to check whether a user has correctly For the purposes of allowing clients to check whether a user has correctly
@ -185,10 +185,10 @@ name string **Required.** The name of the key.
algorithm string **Required.** The encryption algorithm to be used for algorithm string **Required.** The encryption algorithm to be used for
this key. Currently, only this key. Currently, only
``m.secret_storage.v1.aes-hmac-sha2`` is supported. ``m.secret_storage.v1.aes-hmac-sha2`` is supported.
passphrase string See `deriving keys from passphrases`_ section for a passphrase object See `deriving keys from passphrases`_ section for a
description of this property. description of this property.
iv String The 16-byte initialization vector, encoded as base64. iv string The 16-byte initialization vector, encoded as base64.
mac String The MAC of the result of encrypting 32 bytes of 0, mac string The MAC of the result of encrypting 32 bytes of 0,
encoded as base64. encoded as base64.
============ =========== ======================================================= ============ =========== =======================================================