matrix-spec/data/api/client-server/definitions/room_key_backup.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: RoomKeyBackup
description: "The backed up keys for a room."
properties:
  sessions:
    type: object
    description: "A map of session IDs to key data."
    additionalProperties:
      $ref: "key_backup_data.yaml"
    example: {
      "sessionid1": {
        "first_message_index": 1,
        "forwarded_count": 0,
        "is_verified": true,
        "session_data": {
          "ephemeral": "base64+ephemeral+key",
          "ciphertext": "base64+ciphertext+of+JSON+data",
          "mac": "base64+mac+of+ciphertext"
        }
      }
    }
required:
  - sessions