archive
/
matrix-spec
mirror of https://github.com/matrix-org/matrix-spec
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

more clarifications and fixes

Browse Source
pull/977/head
Hubert Chathi 4 years ago
parent 40c50c80ea
commit a36284810d
2 changed files with 72 additions and 14 deletions
Show Stats Download Patch File Download Diff File

56
api/client-server/key_backup.yaml
Unescape Escape View File

@ -77,6 +77,10 @@ paths:
example: "1" example: "1"
required: required:
- version - version
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
tags: tags:
- End-to-end encryption - End-to-end encryption
get: get:
@ -144,6 +148,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
tags: tags:
- End-to-end encryption - End-to-end encryption
"/room_keys/version/{version}": "/room_keys/version/{version}":
@ -222,6 +230,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
tags: tags:
- End-to-end encryption - End-to-end encryption
put: put:
@ -305,6 +317,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
tags: tags:
- End-to-end encryption - End-to-end encryption
delete: delete:
@ -345,6 +361,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
tags: tags:
- End-to-end encryption - End-to-end encryption
"/room_keys/keys/{roomId}/{sessionId}": "/room_keys/keys/{roomId}/{sessionId}":
@ -412,6 +432,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
tags: tags:
- End-to-end encryption - End-to-end encryption
get: get:
@ -455,6 +479,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
delete: delete:
summary: Delete a key from the backup summary: Delete a key from the backup
description: |- description: |-
@ -511,6 +539,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
"/room_keys/keys/{roomId}": "/room_keys/keys/{roomId}":
put: put:
summary: Store several keys in the backup for a given room. summary: Store several keys in the backup for a given room.
@ -595,6 +627,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
tags: tags:
- End-to-end encryption - End-to-end encryption
get: get:
@ -650,6 +686,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
delete: delete:
summary: Delete a key from the backup summary: Delete a key from the backup
description: |- description: |-
@ -700,6 +740,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
"/room_keys/keys": "/room_keys/keys":
put: put:
summary: Store several keys in the backup. summary: Store several keys in the backup.
@ -784,6 +828,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
tags: tags:
- End-to-end encryption - End-to-end encryption
get: get:
@ -838,6 +886,10 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"
delete: delete:
summary: Delete a key from the backup summary: Delete a key from the backup
description: |- description: |-
@ -882,3 +934,7 @@ paths:
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
429:
description: This request was rate-limited.
schema:
"$ref": "definitions/errors/rate_limited.yaml"

30
specification/modules/end_to_end_encryption.rst
Unescape Escape View File

@ -783,13 +783,12 @@ decrypt the session keys.
To create a backup, a client will call `POST To create a backup, a client will call `POST
/_matrix/client/r0/room_keys/version`_ and define how the keys are to be /_matrix/client/r0/room_keys/version`_ and define how the keys are to be
encrypted through the backup's ``auth_data``; other clients can discover the encrypted through the backup's ``auth_data``; other clients can discover the
backup by calling `GET /_matrix/client/r0/room_keys/version/{version}`_, backup by calling `GET /_matrix/client/r0/room_keys/version`_. Keys are
setting ``{version}`` to the empty string. Keys are encrypted according to the encrypted according to the backup's ``auth_data`` and added to the backup by
backup's ``auth_data`` and added to the backup by calling `PUT calling `PUT /_matrix/client/r0/room_keys/keys`_ or one of its variants, and
/_matrix/client/r0/room_keys/keys`_ or one of its variants, and can be can be retrieved by calling `GET /_matrix/client/r0/room_keys/keys`_ or one of
retrieved by calling `GET /_matrix/client/r0/room_keys/keys`_ or one of its its variants. Keys can only be written to the most recently created version of
variants. Keys can only be written to the most recently created version of the the backup. Backups can also be deleted using `DELETE
backup. Backups can also be deleted using `DELETE
/_matrix/client/r0/room_keys/version/{version}`_, or individual keys can be /_matrix/client/r0/room_keys/version/{version}`_, or individual keys can be
deleted using `DELETE /_matrix/client/r0/room_keys/keys`_ or one of its deleted using `DELETE /_matrix/client/r0/room_keys/keys`_ or one of its
variants. variants.
@ -823,7 +822,10 @@ follows:
together to form a parity byte. This parity byte is appended to the byte together to form a parity byte. This parity byte is appended to the byte
string. string.
3. The byte string is encoded using base58, using the same `mapping as is used 3. The byte string is encoded using base58, using the same `mapping as is used
for Bitcoin addresses <https://en.bitcoin.it/wiki/Base58Check_encoding#Base58_symbol_chart>`_. for Bitcoin addresses
<https://en.bitcoin.it/wiki/Base58Check_encoding#Base58_symbol_chart>`_,
that is, using the alphabet
``123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz``.
4. A space should be added after every 4th character. 4. A space should be added after every 4th character.
When reading in a recovery key, clients must disregard whitespace, and perform When reading in a recovery key, clients must disregard whitespace, and perform
@ -844,7 +846,7 @@ following format:
========== =========== ====================================================== ========== =========== ======================================================
Parameter Type Description Parameter Type Description
========== =========== ====================================================== ========== =========== ======================================================
public_key string Required. The curve25519 public key used to encrypt public_key string **Required.** The curve25519 public key used to encrypt
the backups, encoded in unpadded base64. the backups, encoded in unpadded base64.
signatures Signatures Optional. Signatures of the ``auth_data``, as Signed signatures Signatures Optional. Signatures of the ``auth_data``, as Signed
JSON JSON
@ -860,19 +862,19 @@ The ``session_data`` field in the backups is constructed as follows:
=============================== ======== ========================================= =============================== ======== =========================================
Parameter Type Description Parameter Type Description
=============================== ======== ========================================= =============================== ======== =========================================
algorithm string Required. The end-to-end message algorithm string **Required.** The end-to-end message
encryption algorithm that the key is encryption algorithm that the key is
for. Must be ``m.megolm.v1.aes-sha2``. for. Must be ``m.megolm.v1.aes-sha2``.
forwarding_curve25519_key_chain [string] Required. Chain of Curve25519 keys forwarding_curve25519_key_chain [string] **Required.** Chain of Curve25519 keys
through which this session was through which this session was
forwarded, via forwarded, via
`m.forwarded_room_key`_ events. `m.forwarded_room_key`_ events.
sender_key string Required. Unpadded base64-encoded sender_key string **Required.** Unpadded base64-encoded
device curve25519 key. device curve25519 key.
sender_claimed_keys {string: Required. A map from algorithm name sender_claimed_keys {string: **Required.** A map from algorithm name
string} (``ed25519``) to the identity key string} (``ed25519``) to the identity key
for the sending device. for the sending device.
session_key string Required. Unpadded base64-encoded session_key string **Required.** Unpadded base64-encoded
session key in `session-sharing format session key in `session-sharing format
<https://gitlab.matrix.org/matrix-org/olm/blob/master/docs/megolm.md#session-sharing-format>`_. <https://gitlab.matrix.org/matrix-org/olm/blob/master/docs/megolm.md#session-sharing-format>`_.
=============================== ======== ========================================= =============================== ======== =========================================

Write Preview
Loading…
Cancel
Save