@textrp/briij-js-sdk 41.0.1 → 43.0.0

package/lib/crypto/store/base.js

@@ -1,25 +1,25 @@
-/*
-Copyright 2021 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.
+/*
+Copyright 2021 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.
 */
 
-/**
- * Internal module. Definitions for storage for the crypto module
+/**
+ * Internal module. Definitions for storage for the crypto module
  */
 
-/**
- * Abstraction of things that can store data required for end-to-end encryption
+/**
+ * Abstraction of things that can store data required for end-to-end encryption
  */
 
 /** Data on a Megolm session */
@@ -28,23 +28,23 @@ limitations under the License.
 
 /** Data on an Olm session */
 
-/**
- * Represents an outgoing room key request
+/**
+ * Represents an outgoing room key request
  */
 
-/**
- * Keys for the `account` object store to store the migration state.
- * Values are defined in `MigrationState`.
- * @internal
+/**
+ * Keys for the `account` object store to store the migration state.
+ * Values are defined in `MigrationState`.
+ * @internal
  */
 export var ACCOUNT_OBJECT_KEY_MIGRATION_STATE = "migrationState";
 
-/**
- * A record of which steps have been completed in the libolm to Rust Crypto migration.
- *
- * Used by {@link CryptoStore#getMigrationState} and {@link CryptoStore#setMigrationState}.
- *
- * @internal
+/**
+ * A record of which steps have been completed in the libolm to Rust Crypto migration.
+ *
+ * Used by {@link CryptoStore#getMigrationState} and {@link CryptoStore#setMigrationState}.
+ *
+ * @internal
  */
 export var MigrationState = /*#__PURE__*/function (MigrationState) {
   /** No migration steps have yet been completed. */
@@ -57,15 +57,15 @@ export var MigrationState = /*#__PURE__*/function (MigrationState) {
   MigrationState[MigrationState["MEGOLM_SESSIONS_MIGRATED"] = 3] = "MEGOLM_SESSIONS_MIGRATED";
   /** MEGOLM_SESSIONS_MIGRATED, and in addition, we have migrated all the room settings. */
   MigrationState[MigrationState["ROOM_SETTINGS_MIGRATED"] = 4] = "ROOM_SETTINGS_MIGRATED";
-  /** ROOM_SETTINGS_MIGRATED, and in addition, we have done the first own keys query in order to
+  /** ROOM_SETTINGS_MIGRATED, and in addition, we have done the first own keys query in order to
    * load the public part of the keys that have been migrated */
   MigrationState[MigrationState["INITIAL_OWN_KEY_QUERY_DONE"] = 5] = "INITIAL_OWN_KEY_QUERY_DONE";
   return MigrationState;
 }({});
 
-/**
- * The size of batches to be returned by {@link CryptoStore#getEndToEndSessionsBatch} and
- * {@link CryptoStore#getEndToEndInboundGroupSessionsBatch}.
+/**
+ * The size of batches to be returned by {@link CryptoStore#getEndToEndSessionsBatch} and
+ * {@link CryptoStore#getEndToEndInboundGroupSessionsBatch}.
  */
 export var SESSION_BATCH_SIZE = 50;
 
@@ -81,34 +81,34 @@ export var TrackingStatus = /*#__PURE__*/function (TrackingStatus) {
   return TrackingStatus;
 }({});
 
-/**
- *  possible states for a room key request
- *
- * The state machine looks like:
- * ```
- *
- *     |         (cancellation sent)
- *     | .-------------------------------------------------.
- *     | |                                                 |
- *     V V       (cancellation requested)                  |
- *   UNSENT  -----------------------------+                |
- *     |                                  |                |
- *     |                                  |                |
- *     | (send successful)                |  CANCELLATION_PENDING_AND_WILL_RESEND
- *     V                                  |                Λ
- *    SENT                                |                |
- *     |--------------------------------  |  --------------'
- *     |                                  |  (cancellation requested with intent
- *     |                                  |   to resend the original request)
- *     |                                  |
- *     | (cancellation requested)         |
- *     V                                  |
- * CANCELLATION_PENDING                   |
- *     |                                  |
- *     | (cancellation sent)              |
- *     V                                  |
- * (deleted)  <---------------------------+
- * ```
+/**
+ *  possible states for a room key request
+ *
+ * The state machine looks like:
+ * ```
+ *
+ *     |         (cancellation sent)
+ *     | .-------------------------------------------------.
+ *     | |                                                 |
+ *     V V       (cancellation requested)                  |
+ *   UNSENT  -----------------------------+                |
+ *     |                                  |                |
+ *     |                                  |                |
+ *     | (send successful)                |  CANCELLATION_PENDING_AND_WILL_RESEND
+ *     V                                  |                Λ
+ *    SENT                                |                |
+ *     |--------------------------------  |  --------------'
+ *     |                                  |  (cancellation requested with intent
+ *     |                                  |   to resend the original request)
+ *     |                                  |
+ *     | (cancellation requested)         |
+ *     V                                  |
+ * CANCELLATION_PENDING                   |
+ *     |                                  |
+ *     | (cancellation sent)              |
+ *     V                                  |
+ * (deleted)  <---------------------------+
+ * ```
  */
 export var RoomKeyRequestState = /*#__PURE__*/function (RoomKeyRequestState) {
   /** request not yet sent */
@@ -117,9 +117,9 @@ export var RoomKeyRequestState = /*#__PURE__*/function (RoomKeyRequestState) {
   RoomKeyRequestState[RoomKeyRequestState["Sent"] = 1] = "Sent";
   /** reply received, cancellation not yet sent */
   RoomKeyRequestState[RoomKeyRequestState["CancellationPending"] = 2] = "CancellationPending";
-  /**
-   * Cancellation not yet sent and will transition to UNSENT instead of
-   * being deleted once the cancellation has been sent.
+  /**
+   * Cancellation not yet sent and will transition to UNSENT instead of
+   * being deleted once the cancellation has been sent.
    */
   RoomKeyRequestState[RoomKeyRequestState["CancellationPendingAndWillResend"] = 3] = "CancellationPendingAndWillResend";
   return RoomKeyRequestState;
@@ -127,10 +127,10 @@ export var RoomKeyRequestState = /*#__PURE__*/function (RoomKeyRequestState) {
 
 /* eslint-disable camelcase */
 
-/**
- * The parameters of a room key request. The details of the request may
- * vary with the crypto algorithm, but the management and storage layers for
- * outgoing requests expect it to have 'room_id' and 'session_id' properties.
+/**
+ * The parameters of a room key request. The details of the request may
+ * vary with the crypto algorithm, but the management and storage layers for
+ * outgoing requests expect it to have 'room_id' and 'session_id' properties.
  */
 
 /* eslint-enable camelcase */

package/lib/crypto/store/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","names":["ACCOUNT_OBJECT_KEY_MIGRATION_STATE","MigrationState","SESSION_BATCH_SIZE","TrackingStatus","RoomKeyRequestState","DeviceVerification"],"sources":["../../../src/crypto/store/base.ts"],"sourcesContent":["/*\r\nCopyright 2021 The Matrix.org Foundation C.I.C.\r\n\r\nLicensed under the Apache License, Version 2.0 (the \"License\");\r\nyou may not use this file except in compliance with the License.\r\nYou may obtain a copy of the License at\r\n\r\n    http://www.apache.org/licenses/LICENSE-2.0\r\n\r\nUnless required by applicable law or agreed to in writing, software\r\ndistributed under the License is distributed on an \"AS IS\" BASIS,\r\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r\nSee the License for the specific language governing permissions and\r\nlimitations under the License.\r\n*/\r\n\r\nimport { type Logger } from \"../../logger.ts\";\r\nimport { type CrossSigningKeyInfo } from \"../../crypto-api/index.ts\";\r\nimport { type AESEncryptedSecretStoragePayload } from \"../../@types/AESEncryptedSecretStoragePayload.ts\";\r\nimport { type ISignatures } from \"../../@types/signed.ts\";\r\n\r\n/**\r\n * Internal module. Definitions for storage for the crypto module\r\n */\r\n\r\nexport interface SecretStorePrivateKeys {\r\n    \"m.megolm_backup.v1\": AESEncryptedSecretStoragePayload;\r\n}\r\n\r\n/**\r\n * Abstraction of things that can store data required for end-to-end encryption\r\n */\r\nexport interface CryptoStore {\r\n    /**\r\n     * Returns true if this CryptoStore has ever been initialised (ie, it might contain data).\r\n     *\r\n     * Unlike the rest of the methods in this interface, can be called before {@link CryptoStore#startup}.\r\n     *\r\n     * @internal\r\n     */\r\n    containsData(): Promise<boolean>;\r\n\r\n    /**\r\n     * Initialise this crypto store.\r\n     *\r\n     * Typically, this involves provisioning storage, and migrating any existing data to the current version of the\r\n     * storage schema where appropriate.\r\n     *\r\n     * Must be called before any of the rest of the methods in this interface.\r\n     */\r\n    startup(): Promise<CryptoStore>;\r\n\r\n    deleteAllData(): Promise<void>;\r\n\r\n    /**\r\n     * Get data on how much of the libolm to Rust Crypto migration has been done.\r\n     *\r\n     * @internal\r\n     */\r\n    getMigrationState(): Promise<MigrationState>;\r\n\r\n    /**\r\n     * Set data on how much of the libolm to Rust Crypto migration has been done.\r\n     *\r\n     * @internal\r\n     */\r\n    setMigrationState(migrationState: MigrationState): Promise<void>;\r\n\r\n    // Olm Account\r\n    getAccount(txn: unknown, func: (accountPickle: string | null) => void): void;\r\n    storeAccount(txn: unknown, accountPickle: string): void;\r\n    getCrossSigningKeys(txn: unknown, func: (keys: Record<string, CrossSigningKeyInfo> | null) => void): void;\r\n    getSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(\r\n        txn: unknown,\r\n        func: (key: SecretStorePrivateKeys[K] | null) => void,\r\n        type: K,\r\n    ): void;\r\n    storeSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(\r\n        txn: unknown,\r\n        type: K,\r\n        key: SecretStorePrivateKeys[K],\r\n    ): void;\r\n\r\n    // Olm Sessions\r\n    countEndToEndSessions(txn: unknown, func: (count: number) => void): void;\r\n    getEndToEndSession(\r\n        deviceKey: string,\r\n        sessionId: string,\r\n        txn: unknown,\r\n        func: (session: ISessionInfo | null) => void,\r\n    ): void;\r\n    getEndToEndSessions(\r\n        deviceKey: string,\r\n        txn: unknown,\r\n        func: (sessions: { [sessionId: string]: ISessionInfo }) => void,\r\n    ): void;\r\n\r\n    storeEndToEndSession(deviceKey: string, sessionId: string, sessionInfo: ISessionInfo, txn: unknown): void;\r\n\r\n    /**\r\n     * Get a batch of end-to-end sessions from the database.\r\n     *\r\n     * @returns A batch of Olm Sessions, or `null` if no sessions are left.\r\n     * @internal\r\n     */\r\n    getEndToEndSessionsBatch(): Promise<ISessionInfo[] | null>;\r\n\r\n    /**\r\n     * Delete a batch of end-to-end sessions from the database.\r\n     *\r\n     * Any sessions in the list which are not found are silently ignored.\r\n     *\r\n     * @internal\r\n     */\r\n    deleteEndToEndSessionsBatch(sessions: { deviceKey?: string; sessionId?: string }[]): Promise<void>;\r\n\r\n    // Inbound Group Sessions\r\n    getEndToEndInboundGroupSession(\r\n        senderCurve25519Key: string,\r\n        sessionId: string,\r\n        txn: unknown,\r\n        func: (groupSession: InboundGroupSessionData | null, groupSessionWithheld: IWithheld | null) => void,\r\n    ): void;\r\n    storeEndToEndInboundGroupSession(\r\n        senderCurve25519Key: string,\r\n        sessionId: string,\r\n        sessionData: InboundGroupSessionData,\r\n        txn: unknown,\r\n    ): void;\r\n\r\n    /**\r\n     * Count the number of Megolm sessions in the database.\r\n     *\r\n     * @internal\r\n     */\r\n    countEndToEndInboundGroupSessions(): Promise<number>;\r\n\r\n    /**\r\n     * Get a batch of Megolm sessions from the database.\r\n     *\r\n     * @returns A batch of Megolm Sessions, or `null` if no sessions are left.\r\n     * @internal\r\n     */\r\n    getEndToEndInboundGroupSessionsBatch(): Promise<SessionExtended[] | null>;\r\n\r\n    /**\r\n     * Delete a batch of Megolm sessions from the database.\r\n     *\r\n     * Any sessions in the list which are not found are silently ignored.\r\n     *\r\n     * @internal\r\n     */\r\n    deleteEndToEndInboundGroupSessionsBatch(sessions: { senderKey: string; sessionId: string }[]): Promise<void>;\r\n\r\n    // Device Data\r\n    getEndToEndRooms(txn: unknown, func: (rooms: Record<string, IRoomEncryption>) => void): void;\r\n    markSessionsNeedingBackup(sessions: ISession[], txn?: unknown): Promise<void>;\r\n\r\n    // Session key backups\r\n    doTxn<T>(mode: Mode, stores: Iterable<string>, func: (txn: unknown) => T, log?: Logger): Promise<T>;\r\n}\r\n\r\nexport type Mode = \"readonly\" | \"readwrite\";\r\n\r\n/** Data on a Megolm session */\r\nexport interface ISession {\r\n    senderKey: string;\r\n    sessionId: string;\r\n    sessionData?: InboundGroupSessionData;\r\n}\r\n\r\n/** Extended data on a Megolm session */\r\nexport interface SessionExtended extends ISession {\r\n    needsBackup: boolean;\r\n}\r\n\r\n/** Data on an Olm session */\r\nexport interface ISessionInfo {\r\n    deviceKey?: string;\r\n    sessionId?: string;\r\n    session?: string;\r\n    lastReceivedMessageTs?: number;\r\n}\r\n\r\nexport interface IDeviceData {\r\n    devices: {\r\n        [userId: string]: {\r\n            [deviceId: string]: IDevice;\r\n        };\r\n    };\r\n    trackingStatus: {\r\n        [userId: string]: TrackingStatus;\r\n    };\r\n    crossSigningInfo?: Record<string, ICrossSigningInfo>;\r\n    syncToken?: string;\r\n}\r\n\r\nexport interface IWithheld {\r\n    // eslint-disable-next-line camelcase\r\n    room_id: string;\r\n    code: string;\r\n    reason: string;\r\n}\r\n\r\n/**\r\n * Represents an outgoing room key request\r\n */\r\nexport interface OutgoingRoomKeyRequest {\r\n    /**\r\n     * Unique id for this request. Used for both an id within the request for later pairing with a cancellation,\r\n     * and for the transaction id when sending the to_device messages to our local server.\r\n     */\r\n    requestId: string;\r\n    requestTxnId?: string;\r\n    /**\r\n     * Transaction id for the cancellation, if any\r\n     */\r\n    cancellationTxnId?: string;\r\n    /**\r\n     * List of recipients for the request\r\n     */\r\n    recipients: IRoomKeyRequestRecipient[];\r\n    /**\r\n     * Parameters for the request\r\n     */\r\n    requestBody: IRoomKeyRequestBody;\r\n    /**\r\n     * current state of this request\r\n     */\r\n    state: RoomKeyRequestState;\r\n}\r\n\r\n/**\r\n * Keys for the `account` object store to store the migration state.\r\n * Values are defined in `MigrationState`.\r\n * @internal\r\n */\r\nexport const ACCOUNT_OBJECT_KEY_MIGRATION_STATE = \"migrationState\";\r\n\r\n/**\r\n * A record of which steps have been completed in the libolm to Rust Crypto migration.\r\n *\r\n * Used by {@link CryptoStore#getMigrationState} and {@link CryptoStore#setMigrationState}.\r\n *\r\n * @internal\r\n */\r\nexport enum MigrationState {\r\n    /** No migration steps have yet been completed. */\r\n    NOT_STARTED,\r\n\r\n    /** We have migrated the account data, cross-signing keys, etc. */\r\n    INITIAL_DATA_MIGRATED,\r\n\r\n    /** INITIAL_DATA_MIGRATED, and in addition, we have migrated all the Olm sessions. */\r\n    OLM_SESSIONS_MIGRATED,\r\n\r\n    /** OLM_SESSIONS_MIGRATED, and in addition, we have migrated all the Megolm sessions. */\r\n    MEGOLM_SESSIONS_MIGRATED,\r\n\r\n    /** MEGOLM_SESSIONS_MIGRATED, and in addition, we have migrated all the room settings. */\r\n    ROOM_SETTINGS_MIGRATED,\r\n\r\n    /** ROOM_SETTINGS_MIGRATED, and in addition, we have done the first own keys query in order to\r\n     * load the public part of the keys that have been migrated */\r\n    INITIAL_OWN_KEY_QUERY_DONE,\r\n}\r\n\r\n/**\r\n * The size of batches to be returned by {@link CryptoStore#getEndToEndSessionsBatch} and\r\n * {@link CryptoStore#getEndToEndInboundGroupSessionsBatch}.\r\n */\r\nexport const SESSION_BATCH_SIZE = 50;\r\n\r\nexport interface InboundGroupSessionData {\r\n    room_id: string; // eslint-disable-line camelcase\r\n    /** pickled Olm.InboundGroupSession */\r\n    session: string;\r\n    keysClaimed?: Record<string, string>;\r\n    /** Devices involved in forwarding this session to us (normally empty). */\r\n    forwardingCurve25519KeyChain: string[];\r\n    /** whether this session is untrusted. */\r\n    untrusted?: boolean;\r\n    /** whether this session exists during the room being set to shared history. */\r\n    sharedHistory?: boolean;\r\n}\r\n\r\nexport interface ICrossSigningInfo {\r\n    keys: Record<string, CrossSigningKeyInfo>;\r\n    firstUse: boolean;\r\n    crossSigningVerifiedBefore: boolean;\r\n}\r\n\r\n/* eslint-disable camelcase */\r\nexport interface IRoomEncryption {\r\n    algorithm: string;\r\n    rotation_period_ms?: number;\r\n    rotation_period_msgs?: number;\r\n}\r\n/* eslint-enable camelcase */\r\n\r\nexport enum TrackingStatus {\r\n    NotTracked,\r\n    PendingDownload,\r\n    DownloadInProgress,\r\n    UpToDate,\r\n}\r\n\r\n/**\r\n *  possible states for a room key request\r\n *\r\n * The state machine looks like:\r\n * ```\r\n *\r\n *     |         (cancellation sent)\r\n *     | .-------------------------------------------------.\r\n *     | |                                                 |\r\n *     V V       (cancellation requested)                  |\r\n *   UNSENT  -----------------------------+                |\r\n *     |                                  |                |\r\n *     |                                  |                |\r\n *     | (send successful)                |  CANCELLATION_PENDING_AND_WILL_RESEND\r\n *     V                                  |                Λ\r\n *    SENT                                |                |\r\n *     |--------------------------------  |  --------------'\r\n *     |                                  |  (cancellation requested with intent\r\n *     |                                  |   to resend the original request)\r\n *     |                                  |\r\n *     | (cancellation requested)         |\r\n *     V                                  |\r\n * CANCELLATION_PENDING                   |\r\n *     |                                  |\r\n *     | (cancellation sent)              |\r\n *     V                                  |\r\n * (deleted)  <---------------------------+\r\n * ```\r\n */\r\nexport enum RoomKeyRequestState {\r\n    /** request not yet sent */\r\n    Unsent,\r\n    /** request sent, awaiting reply */\r\n    Sent,\r\n    /** reply received, cancellation not yet sent */\r\n    CancellationPending,\r\n    /**\r\n     * Cancellation not yet sent and will transition to UNSENT instead of\r\n     * being deleted once the cancellation has been sent.\r\n     */\r\n    CancellationPendingAndWillResend,\r\n}\r\n\r\n/* eslint-disable camelcase */\r\ninterface IRoomKey {\r\n    room_id: string;\r\n    algorithm: string;\r\n}\r\n\r\n/**\r\n * The parameters of a room key request. The details of the request may\r\n * vary with the crypto algorithm, but the management and storage layers for\r\n * outgoing requests expect it to have 'room_id' and 'session_id' properties.\r\n */\r\nexport interface IRoomKeyRequestBody extends IRoomKey {\r\n    session_id: string;\r\n    sender_key: string;\r\n}\r\n\r\n/* eslint-enable camelcase */\r\n\r\nexport interface IRoomKeyRequestRecipient {\r\n    userId: string;\r\n    deviceId: string;\r\n}\r\n\r\ninterface IDevice {\r\n    keys: Record<string, string>;\r\n    algorithms: string[];\r\n    verified: DeviceVerification;\r\n    known: boolean;\r\n    unsigned?: Record<string, any>;\r\n    signatures?: ISignatures;\r\n}\r\n\r\n/** State of the verification of the device. */\r\nexport enum DeviceVerification {\r\n    Blocked = -1,\r\n    Unverified = 0,\r\n    Verified = 1,\r\n}\r\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;;AAMA;AACA;AACA;;AAqIA;;AAOA;;AAKA;;AA4BA;AACA;AACA;;AA0BA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMA,kCAAkC,GAAG,gBAAgB;;AAElE;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYC,cAAc,0BAAdA,cAAc;EACtB;EADQA,cAAc,CAAdA,cAAc;EAItB;EAJQA,cAAc,CAAdA,cAAc;EAOtB;EAPQA,cAAc,CAAdA,cAAc;EAUtB;EAVQA,cAAc,CAAdA,cAAc;EAatB;EAbQA,cAAc,CAAdA,cAAc;EAgBtB;AACJ;EAjBYA,cAAc,CAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;;AAqB1B;AACA;AACA;AACA;AACA,OAAO,IAAMC,kBAAkB,GAAG,EAAE;;AAqBpC;;AAMA;;AAEA,WAAYC,cAAc,0BAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;;AAO1B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYC,mBAAmB,0BAAnBA,mBAAmB;EAC3B;EADQA,mBAAmB,CAAnBA,mBAAmB;EAG3B;EAHQA,mBAAmB,CAAnBA,mBAAmB;EAK3B;EALQA,mBAAmB,CAAnBA,mBAAmB;EAO3B;AACJ;AACA;AACA;EAVYA,mBAAmB,CAAnBA,mBAAmB;EAAA,OAAnBA,mBAAmB;AAAA;;AAc/B;;AAMA;AACA;AACA;AACA;AACA;;AAMA;;AAgBA;AACA,WAAYC,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA","ignoreList":[]}
+{"version":3,"file":"base.js","names":["ACCOUNT_OBJECT_KEY_MIGRATION_STATE","MigrationState","SESSION_BATCH_SIZE","TrackingStatus","RoomKeyRequestState","DeviceVerification"],"sources":["../../../src/crypto/store/base.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { type Logger } from \"../../logger.ts\";\nimport { type CrossSigningKeyInfo } from \"../../crypto-api/index.ts\";\nimport { type AESEncryptedSecretStoragePayload } from \"../../@types/AESEncryptedSecretStoragePayload.ts\";\nimport { type ISignatures } from \"../../@types/signed.ts\";\n\n/**\n * Internal module. Definitions for storage for the crypto module\n */\n\nexport interface SecretStorePrivateKeys {\n    \"m.megolm_backup.v1\": AESEncryptedSecretStoragePayload;\n}\n\n/**\n * Abstraction of things that can store data required for end-to-end encryption\n */\nexport interface CryptoStore {\n    /**\n     * Returns true if this CryptoStore has ever been initialised (ie, it might contain data).\n     *\n     * Unlike the rest of the methods in this interface, can be called before {@link CryptoStore#startup}.\n     *\n     * @internal\n     */\n    containsData(): Promise<boolean>;\n\n    /**\n     * Initialise this crypto store.\n     *\n     * Typically, this involves provisioning storage, and migrating any existing data to the current version of the\n     * storage schema where appropriate.\n     *\n     * Must be called before any of the rest of the methods in this interface.\n     */\n    startup(): Promise<CryptoStore>;\n\n    deleteAllData(): Promise<void>;\n\n    /**\n     * Get data on how much of the libolm to Rust Crypto migration has been done.\n     *\n     * @internal\n     */\n    getMigrationState(): Promise<MigrationState>;\n\n    /**\n     * Set data on how much of the libolm to Rust Crypto migration has been done.\n     *\n     * @internal\n     */\n    setMigrationState(migrationState: MigrationState): Promise<void>;\n\n    // Olm Account\n    getAccount(txn: unknown, func: (accountPickle: string | null) => void): void;\n    storeAccount(txn: unknown, accountPickle: string): void;\n    getCrossSigningKeys(txn: unknown, func: (keys: Record<string, CrossSigningKeyInfo> | null) => void): void;\n    getSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(\n        txn: unknown,\n        func: (key: SecretStorePrivateKeys[K] | null) => void,\n        type: K,\n    ): void;\n    storeSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(\n        txn: unknown,\n        type: K,\n        key: SecretStorePrivateKeys[K],\n    ): void;\n\n    // Olm Sessions\n    countEndToEndSessions(txn: unknown, func: (count: number) => void): void;\n    getEndToEndSession(\n        deviceKey: string,\n        sessionId: string,\n        txn: unknown,\n        func: (session: ISessionInfo | null) => void,\n    ): void;\n    getEndToEndSessions(\n        deviceKey: string,\n        txn: unknown,\n        func: (sessions: { [sessionId: string]: ISessionInfo }) => void,\n    ): void;\n\n    storeEndToEndSession(deviceKey: string, sessionId: string, sessionInfo: ISessionInfo, txn: unknown): void;\n\n    /**\n     * Get a batch of end-to-end sessions from the database.\n     *\n     * @returns A batch of Olm Sessions, or `null` if no sessions are left.\n     * @internal\n     */\n    getEndToEndSessionsBatch(): Promise<ISessionInfo[] | null>;\n\n    /**\n     * Delete a batch of end-to-end sessions from the database.\n     *\n     * Any sessions in the list which are not found are silently ignored.\n     *\n     * @internal\n     */\n    deleteEndToEndSessionsBatch(sessions: { deviceKey?: string; sessionId?: string }[]): Promise<void>;\n\n    // Inbound Group Sessions\n    getEndToEndInboundGroupSession(\n        senderCurve25519Key: string,\n        sessionId: string,\n        txn: unknown,\n        func: (groupSession: InboundGroupSessionData | null, groupSessionWithheld: IWithheld | null) => void,\n    ): void;\n    storeEndToEndInboundGroupSession(\n        senderCurve25519Key: string,\n        sessionId: string,\n        sessionData: InboundGroupSessionData,\n        txn: unknown,\n    ): void;\n\n    /**\n     * Count the number of Megolm sessions in the database.\n     *\n     * @internal\n     */\n    countEndToEndInboundGroupSessions(): Promise<number>;\n\n    /**\n     * Get a batch of Megolm sessions from the database.\n     *\n     * @returns A batch of Megolm Sessions, or `null` if no sessions are left.\n     * @internal\n     */\n    getEndToEndInboundGroupSessionsBatch(): Promise<SessionExtended[] | null>;\n\n    /**\n     * Delete a batch of Megolm sessions from the database.\n     *\n     * Any sessions in the list which are not found are silently ignored.\n     *\n     * @internal\n     */\n    deleteEndToEndInboundGroupSessionsBatch(sessions: { senderKey: string; sessionId: string }[]): Promise<void>;\n\n    // Device Data\n    getEndToEndRooms(txn: unknown, func: (rooms: Record<string, IRoomEncryption>) => void): void;\n    markSessionsNeedingBackup(sessions: ISession[], txn?: unknown): Promise<void>;\n\n    // Session key backups\n    doTxn<T>(mode: Mode, stores: Iterable<string>, func: (txn: unknown) => T, log?: Logger): Promise<T>;\n}\n\nexport type Mode = \"readonly\" | \"readwrite\";\n\n/** Data on a Megolm session */\nexport interface ISession {\n    senderKey: string;\n    sessionId: string;\n    sessionData?: InboundGroupSessionData;\n}\n\n/** Extended data on a Megolm session */\nexport interface SessionExtended extends ISession {\n    needsBackup: boolean;\n}\n\n/** Data on an Olm session */\nexport interface ISessionInfo {\n    deviceKey?: string;\n    sessionId?: string;\n    session?: string;\n    lastReceivedMessageTs?: number;\n}\n\nexport interface IDeviceData {\n    devices: {\n        [userId: string]: {\n            [deviceId: string]: IDevice;\n        };\n    };\n    trackingStatus: {\n        [userId: string]: TrackingStatus;\n    };\n    crossSigningInfo?: Record<string, ICrossSigningInfo>;\n    syncToken?: string;\n}\n\nexport interface IWithheld {\n    // eslint-disable-next-line camelcase\n    room_id: string;\n    code: string;\n    reason: string;\n}\n\n/**\n * Represents an outgoing room key request\n */\nexport interface OutgoingRoomKeyRequest {\n    /**\n     * Unique id for this request. Used for both an id within the request for later pairing with a cancellation,\n     * and for the transaction id when sending the to_device messages to our local server.\n     */\n    requestId: string;\n    requestTxnId?: string;\n    /**\n     * Transaction id for the cancellation, if any\n     */\n    cancellationTxnId?: string;\n    /**\n     * List of recipients for the request\n     */\n    recipients: IRoomKeyRequestRecipient[];\n    /**\n     * Parameters for the request\n     */\n    requestBody: IRoomKeyRequestBody;\n    /**\n     * current state of this request\n     */\n    state: RoomKeyRequestState;\n}\n\n/**\n * Keys for the `account` object store to store the migration state.\n * Values are defined in `MigrationState`.\n * @internal\n */\nexport const ACCOUNT_OBJECT_KEY_MIGRATION_STATE = \"migrationState\";\n\n/**\n * A record of which steps have been completed in the libolm to Rust Crypto migration.\n *\n * Used by {@link CryptoStore#getMigrationState} and {@link CryptoStore#setMigrationState}.\n *\n * @internal\n */\nexport enum MigrationState {\n    /** No migration steps have yet been completed. */\n    NOT_STARTED,\n\n    /** We have migrated the account data, cross-signing keys, etc. */\n    INITIAL_DATA_MIGRATED,\n\n    /** INITIAL_DATA_MIGRATED, and in addition, we have migrated all the Olm sessions. */\n    OLM_SESSIONS_MIGRATED,\n\n    /** OLM_SESSIONS_MIGRATED, and in addition, we have migrated all the Megolm sessions. */\n    MEGOLM_SESSIONS_MIGRATED,\n\n    /** MEGOLM_SESSIONS_MIGRATED, and in addition, we have migrated all the room settings. */\n    ROOM_SETTINGS_MIGRATED,\n\n    /** ROOM_SETTINGS_MIGRATED, and in addition, we have done the first own keys query in order to\n     * load the public part of the keys that have been migrated */\n    INITIAL_OWN_KEY_QUERY_DONE,\n}\n\n/**\n * The size of batches to be returned by {@link CryptoStore#getEndToEndSessionsBatch} and\n * {@link CryptoStore#getEndToEndInboundGroupSessionsBatch}.\n */\nexport const SESSION_BATCH_SIZE = 50;\n\nexport interface InboundGroupSessionData {\n    room_id: string; // eslint-disable-line camelcase\n    /** pickled Olm.InboundGroupSession */\n    session: string;\n    keysClaimed?: Record<string, string>;\n    /** Devices involved in forwarding this session to us (normally empty). */\n    forwardingCurve25519KeyChain: string[];\n    /** whether this session is untrusted. */\n    untrusted?: boolean;\n    /** whether this session exists during the room being set to shared history. */\n    sharedHistory?: boolean;\n}\n\nexport interface ICrossSigningInfo {\n    keys: Record<string, CrossSigningKeyInfo>;\n    firstUse: boolean;\n    crossSigningVerifiedBefore: boolean;\n}\n\n/* eslint-disable camelcase */\nexport interface IRoomEncryption {\n    algorithm: string;\n    rotation_period_ms?: number;\n    rotation_period_msgs?: number;\n}\n/* eslint-enable camelcase */\n\nexport enum TrackingStatus {\n    NotTracked,\n    PendingDownload,\n    DownloadInProgress,\n    UpToDate,\n}\n\n/**\n *  possible states for a room key request\n *\n * The state machine looks like:\n * ```\n *\n *     |         (cancellation sent)\n *     | .-------------------------------------------------.\n *     | |                                                 |\n *     V V       (cancellation requested)                  |\n *   UNSENT  -----------------------------+                |\n *     |                                  |                |\n *     |                                  |                |\n *     | (send successful)                |  CANCELLATION_PENDING_AND_WILL_RESEND\n *     V                                  |                Λ\n *    SENT                                |                |\n *     |--------------------------------  |  --------------'\n *     |                                  |  (cancellation requested with intent\n *     |                                  |   to resend the original request)\n *     |                                  |\n *     | (cancellation requested)         |\n *     V                                  |\n * CANCELLATION_PENDING                   |\n *     |                                  |\n *     | (cancellation sent)              |\n *     V                                  |\n * (deleted)  <---------------------------+\n * ```\n */\nexport enum RoomKeyRequestState {\n    /** request not yet sent */\n    Unsent,\n    /** request sent, awaiting reply */\n    Sent,\n    /** reply received, cancellation not yet sent */\n    CancellationPending,\n    /**\n     * Cancellation not yet sent and will transition to UNSENT instead of\n     * being deleted once the cancellation has been sent.\n     */\n    CancellationPendingAndWillResend,\n}\n\n/* eslint-disable camelcase */\ninterface IRoomKey {\n    room_id: string;\n    algorithm: string;\n}\n\n/**\n * The parameters of a room key request. The details of the request may\n * vary with the crypto algorithm, but the management and storage layers for\n * outgoing requests expect it to have 'room_id' and 'session_id' properties.\n */\nexport interface IRoomKeyRequestBody extends IRoomKey {\n    session_id: string;\n    sender_key: string;\n}\n\n/* eslint-enable camelcase */\n\nexport interface IRoomKeyRequestRecipient {\n    userId: string;\n    deviceId: string;\n}\n\ninterface IDevice {\n    keys: Record<string, string>;\n    algorithms: string[];\n    verified: DeviceVerification;\n    known: boolean;\n    unsigned?: Record<string, any>;\n    signatures?: ISignatures;\n}\n\n/** State of the verification of the device. */\nexport enum DeviceVerification {\n    Blocked = -1,\n    Unverified = 0,\n    Verified = 1,\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAOA;AACA;AACA;;AAMA;AACA;AACA;;AAqIA;;AAOA;;AAKA;;AA4BA;AACA;AACA;;AA0BA;AACA;AACA;AACA;AACA;AACA,OAAO,IAAMA,kCAAkC,GAAG,gBAAgB;;AAElE;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYC,cAAc,0BAAdA,cAAc;EACtB;EADQA,cAAc,CAAdA,cAAc;EAItB;EAJQA,cAAc,CAAdA,cAAc;EAOtB;EAPQA,cAAc,CAAdA,cAAc;EAUtB;EAVQA,cAAc,CAAdA,cAAc;EAatB;EAbQA,cAAc,CAAdA,cAAc;EAgBtB;AACJ;EAjBYA,cAAc,CAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;;AAqB1B;AACA;AACA;AACA;AACA,OAAO,IAAMC,kBAAkB,GAAG,EAAE;;AAqBpC;;AAMA;;AAEA,WAAYC,cAAc,0BAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAdA,cAAc,CAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA;;AAO1B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYC,mBAAmB,0BAAnBA,mBAAmB;EAC3B;EADQA,mBAAmB,CAAnBA,mBAAmB;EAG3B;EAHQA,mBAAmB,CAAnBA,mBAAmB;EAK3B;EALQA,mBAAmB,CAAnBA,mBAAmB;EAO3B;AACJ;AACA;AACA;EAVYA,mBAAmB,CAAnBA,mBAAmB;EAAA,OAAnBA,mBAAmB;AAAA;;AAc/B;;AAMA;AACA;AACA;AACA;AACA;;AAMA;;AAgBA;AACA,WAAYC,kBAAkB,0BAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAlBA,kBAAkB,CAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA","ignoreList":[]}

package/lib/crypto/store/indexeddb-crypto-store-backend.js

@@ -1,19 +1,19 @@
 import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-/*
-Copyright 2017 - 2021 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.
+/*
+Copyright 2017 - 2021 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.
 */
 
 import { logger } from "../../logger.js";
@@ -21,15 +21,15 @@ import { MigrationState, SESSION_BATCH_SIZE, ACCOUNT_OBJECT_KEY_MIGRATION_STATE
 import { IndexedDBCryptoStore } from "./indexeddb-crypto-store.js";
 var PROFILE_TRANSACTIONS = false;
 
-/**
- * Implementation of a CryptoStore which is backed by an existing
- * IndexedDB connection. Generally you want IndexedDBCryptoStore
- * which connects to the database and defers to one of these.
- *
- * @internal
+/**
+ * Implementation of a CryptoStore which is backed by an existing
+ * IndexedDB connection. Generally you want IndexedDBCryptoStore
+ * which connects to the database and defers to one of these.
+ *
+ * @internal
  */
 export class Backend {
-  /**
+  /**
    */
   constructor(db) {
     this.db = db;
@@ -61,10 +61,10 @@ export class Backend {
     })();
   }
 
-  /**
-   * Get data on how much of the libolm to Rust Crypto migration has been done.
-   *
-   * Implementation of {@link CryptoStore.getMigrationState}.
+  /**
+   * Get data on how much of the libolm to Rust Crypto migration has been done.
+   *
+   * Implementation of {@link CryptoStore.getMigrationState}.
    */
   getMigrationState() {
     var _this2 = this;
@@ -82,10 +82,10 @@ export class Backend {
     })();
   }
 
-  /**
-   * Set data on how much of the libolm to Rust Crypto migration has been done.
-   *
-   * Implementation of {@link CryptoStore.setMigrationState}.
+  /**
+   * Set data on how much of the libolm to Rust Crypto migration has been done.
+   *
+   * Implementation of {@link CryptoStore.setMigrationState}.
    */
   setMigrationState(migrationState) {
     var _this3 = this;
@@ -204,10 +204,10 @@ export class Backend {
     });
   }
 
-  /**
-   * Fetch a batch of Olm sessions from the database.
-   *
-   * Implementation of {@link CryptoStore.getEndToEndSessionsBatch}.
+  /**
+   * Fetch a batch of Olm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.getEndToEndSessionsBatch}.
    */
   getEndToEndSessionsBatch() {
     var _this4 = this;
@@ -238,12 +238,12 @@ export class Backend {
     })();
   }
 
-  /**
-   * Delete a batch of Olm sessions from the database.
-   *
-   * Implementation of {@link CryptoStore.deleteEndToEndSessionsBatch}.
-   *
-   * @internal
+  /**
+   * Delete a batch of Olm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.deleteEndToEndSessionsBatch}.
+   *
+   * @internal
    */
   deleteEndToEndSessionsBatch(sessions) {
     var _this5 = this;
@@ -322,12 +322,12 @@ export class Backend {
     });
   }
 
-  /**
-   * Count the number of Megolm sessions in the database.
-   *
-   * Implementation of {@link CryptoStore.countEndToEndInboundGroupSessions}.
-   *
-   * @internal
+  /**
+   * Count the number of Megolm sessions in the database.
+   *
+   * Implementation of {@link CryptoStore.countEndToEndInboundGroupSessions}.
+   *
+   * @internal
    */
   countEndToEndInboundGroupSessions() {
     var _this6 = this;
@@ -344,10 +344,10 @@ export class Backend {
     })();
   }
 
-  /**
-   * Fetch a batch of Megolm sessions from the database.
-   *
-   * Implementation of {@link CryptoStore.getEndToEndInboundGroupSessionsBatch}.
+  /**
+   * Fetch a batch of Megolm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.getEndToEndInboundGroupSessionsBatch}.
    */
   getEndToEndInboundGroupSessionsBatch() {
     var _this7 = this;
@@ -387,12 +387,12 @@ export class Backend {
     })();
   }
 
-  /**
-   * Delete a batch of Megolm sessions from the database.
-   *
-   * Implementation of {@link CryptoStore.deleteEndToEndInboundGroupSessionsBatch}.
-   *
-   * @internal
+  /**
+   * Delete a batch of Megolm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.deleteEndToEndInboundGroupSessionsBatch}.
+   *
+   * @internal
    */
   deleteEndToEndInboundGroupSessionsBatch(sessions) {
     var _this8 = this;
@@ -559,9 +559,9 @@ function createDatabase(db) {
   outgoingRoomKeyRequestsStore.createIndex("session", ["requestBody.room_id", "requestBody.session_id"]);
   outgoingRoomKeyRequestsStore.createIndex("state", "state");
 }
-/*
- * Aborts a transaction with a given exception
- * The transaction promise will be rejected with this exception.
+/*
+ * Aborts a transaction with a given exception
+ * The transaction promise will be rejected with this exception.
  */
 function abortWithException(txn, e) {
   // We cheekily stick our exception onto the transaction object here