mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-07-26 07:47:47 +02:00
bf5fbc9945
Some checks are pending
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Spec / 🔎 Check Event schema examples (push) Waiting to run
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Spec / 📖 Build the spec (push) Blocked by required conditions
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Spec / Create release (push) Blocked by required conditions
Spell Check / Spell Check with Typos (push) Waiting to run
* use User ID type in OlmPayload and DeviceKeys Signed-off-by: Johanna Stuber <johannas@element.io> * add newsfragment Signed-off-by: Johanna Stuber <johannas@element.io> --------- Signed-off-by: Johanna Stuber <johannas@element.io>
73 lines
2.4 KiB
YAML
73 lines
2.4 KiB
YAML
# Copyright 2016 OpenMarket Ltd
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
type: object
|
|
title: DeviceKeys
|
|
description: Device identity keys
|
|
properties:
|
|
user_id:
|
|
type: string
|
|
description: |-
|
|
The ID of the user the device belongs to. Must match the user ID used
|
|
when logging in.
|
|
format: mx-user-id
|
|
pattern: "^@"
|
|
example: "@alice:example.com"
|
|
device_id:
|
|
type: string
|
|
description: |-
|
|
The ID of the device these keys belong to. Must match the device ID used
|
|
when logging in.
|
|
example: "JLAFKJWSCS"
|
|
algorithms:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: |-
|
|
The encryption algorithms supported by this device.
|
|
example: ["m.olm.v1.curve25519-aes-sha2", "m.megolm.v1.aes-sha2"]
|
|
keys:
|
|
type: object
|
|
description: |-
|
|
Public identity keys. The names of the properties should be in the
|
|
format `<algorithm>:<device_id>`. The keys themselves should be
|
|
encoded as specified by the key algorithm.
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
"curve25519:JLAFKJWSCS": "3C5BFWi2Y8MaVvjM8M22DBmh24PmgR0nPvJOIArzgyI"
|
|
"ed25519:JLAFKJWSCS": "lEuiRJBit0IG6nUf5pUzWTUEsRVVe/HJkoKuEww9ULI"
|
|
signatures:
|
|
type: object
|
|
title: Signatures
|
|
description: |-
|
|
Signatures for the device key object. A map from user ID, to a map from
|
|
`<algorithm>:<device_id>` to the signature.
|
|
|
|
The signature is calculated using the process described at [Signing JSON](/appendices/#signing-json).
|
|
patternProperties:
|
|
"^@":
|
|
x-pattern-format: mx-user-id
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
example:
|
|
"@alice:example.com":
|
|
"ed25519:JLAFKJWSCS": "dSO80A01XiigH3uBiDVx/EjzaoycHcjq9lfQX0uWsqxl2giMIiSPR8a4d291W1ihKJL/a+myXS367WT6NAIcBA"
|
|
required:
|
|
- user_id
|
|
- device_id
|
|
- algorithms
|
|
- keys
|
|
- signatures
|