mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-02-25 23:43:43 +01:00
57a1d5ad0e
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
* Clarify terminology for keys in cross-signing module - the naming of the master signing key has been harmonised (no more 'master cross-signing key' or 'master key'). - in the QR code example, the term 'cross-signing key' has been replaced by 'master signing key' since in mode 0x00, the current user's own master signing key and what the device thinks the other user's master signng key is used. - it has been made more explicit that cross-signing private keys stored on the server are stored as described in the secrets module (as opposed to store them in unencrypted form) Signed-off-by: codedust <codedust@so.urceco.de> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
58 lines
1.8 KiB
YAML
58 lines
1.8 KiB
YAML
# Copyright 2020 The Matrix.org Foundation C.I.C.
|
|
#
|
|
# 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: CrossSigningKey
|
|
description: Key used for cross signing
|
|
properties:
|
|
user_id:
|
|
type: string
|
|
description: |-
|
|
The ID of the user the key belongs to.
|
|
example: "@alice:example.com"
|
|
usage:
|
|
type: array
|
|
description: |-
|
|
What the key is used for.
|
|
items:
|
|
type: string
|
|
enum: ["master", "self_signing", "user_signing"]
|
|
keys:
|
|
type: object
|
|
additionalProperties:
|
|
type: string
|
|
description: |-
|
|
The public key. The object must have exactly one property, whose name is
|
|
in the form `<algorithm>:<unpadded_base64_public_key>`, and whose value
|
|
is the unpadded base64 public key.
|
|
minProperties: 1
|
|
maxProperties: 1
|
|
example:
|
|
"ed25519:alice+base64+public+key": "alice+base64+public+key"
|
|
signatures:
|
|
type: object
|
|
title: Signatures
|
|
description: |-
|
|
Signatures of the key, calculated using the process described at [Signing JSON](/appendices/#signing-json).
|
|
Optional for the master signing key. Other keys must be signed by the
|
|
user\'s master signing key.
|
|
example: {
|
|
"@alice:example.com": {
|
|
"ed25519:alice+base64+master+key": "signature+of+key"
|
|
}
|
|
}
|
|
required:
|
|
- user_id
|
|
- usage
|
|
- keys
|