-
Notifications
You must be signed in to change notification settings - Fork 375
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Spec the e2e key-management APIs.
- Loading branch information
Showing
8 changed files
with
715 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
# 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. | ||
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.curve25519-aes-sha256", "m.megolm.v1.aes-sha"] | ||
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 | ||
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`_. | ||
additionalProperties: | ||
type: object | ||
additionalProperties: | ||
type: string | ||
example: | ||
"@alice:example.com": | ||
"ed25519:JLAFKJWSCS": "dSO80A01XiigH3uBiDVx/EjzaoycHcjq9lfQX0uWsqxl2giMIiSPR8a4d291W1ihKJL/a+myXS367WT6NAIcBA" | ||
required: | ||
- user_id | ||
- device_id | ||
- algorithms | ||
- keys | ||
- signatures |
Oops, something went wrong.