@textrp/briij-js-sdk 41.0.1 → 43.0.0

package/lib/crypto/store/indexeddb-crypto-store.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";
@@ -23,22 +23,22 @@ import * as IndexedDBCryptoStoreBackend from "./indexeddb-crypto-store-backend.j
 import { InvalidCryptoStoreError, InvalidCryptoStoreState } from "../../errors.js";
 import * as IndexedDBHelpers from "../../indexeddb-helpers.js";
 import { MigrationState, ACCOUNT_OBJECT_KEY_MIGRATION_STATE } from "./base.js";
-/*
- * Internal module. indexeddb storage for e2e.
+/*
+ * Internal module. indexeddb storage for e2e.
  */
 
-/**
- * An implementation of CryptoStore, which is normally backed by an indexeddb,
- * but with fallback to MemoryCryptoStore.
+/**
+ * An implementation of CryptoStore, which is normally backed by an indexeddb,
+ * but with fallback to MemoryCryptoStore.
  */
 export class IndexedDBCryptoStore {
   static exists(indexedDB, dbName) {
     return IndexedDBHelpers.exists(indexedDB, dbName);
   }
 
-  /**
-   * Utility to check if a legacy crypto store exists and has not been migrated.
-   * Returns true if the store exists and has not been migrated, false otherwise.
+  /**
+   * Utility to check if a legacy crypto store exists and has not been migrated.
+   * Returns true if the store exists and has not been migrated, false otherwise.
    */
   static existsAndIsNotMigrated(indexedDb, dbName) {
     return new Promise((resolve, reject) => {
@@ -79,11 +79,11 @@ export class IndexedDBCryptoStore {
       openDBRequest.onerror = () => reject(openDBRequest.error);
     });
   }
-  /**
-   * Create a new IndexedDBCryptoStore
-   *
-   * @param indexedDB -  global indexedDB instance
-   * @param dbName -   name of db to connect to
+  /**
+   * Create a new IndexedDBCryptoStore
+   *
+   * @param indexedDB -  global indexedDB instance
+   * @param dbName -   name of db to connect to
    */
   constructor(indexedDB, dbName) {
     this.indexedDB = indexedDB;
@@ -92,12 +92,12 @@ export class IndexedDBCryptoStore {
     _defineProperty(this, "backend", void 0);
   }
 
-  /**
-   * Returns true if this CryptoStore has ever been initialised (ie, it might contain data).
-   *
-   * Implementation of {@link CryptoStore.containsData}.
-   *
-   * @internal
+  /**
+   * Returns true if this CryptoStore has ever been initialised (ie, it might contain data).
+   *
+   * Implementation of {@link CryptoStore.containsData}.
+   *
+   * @internal
    */
   containsData() {
     var _this = this;
@@ -106,14 +106,14 @@ export class IndexedDBCryptoStore {
     })();
   }
 
-  /**
-   * Ensure the database exists and is up-to-date, or fall back to
-   * a local storage or in-memory store.
-   *
-   * This must be called before the store can be used.
-   *
-   * @returns resolves to either an IndexedDBCryptoStoreBackend.Backend,
-   * or a MemoryCryptoStore
+  /**
+   * Ensure the database exists and is up-to-date, or fall back to
+   * a local storage or in-memory store.
+   *
+   * This must be called before the store can be used.
+   *
+   * @returns resolves to either an IndexedDBCryptoStoreBackend.Backend,
+   * or a MemoryCryptoStore
    */
   startup() {
     if (this.backendPromise) {
@@ -174,10 +174,10 @@ export class IndexedDBCryptoStore {
     return this.backendPromise;
   }
 
-  /**
-   * Delete all data from this store.
-   *
-   * @returns resolves when the store has been cleared.
+  /**
+   * Delete all data from this store.
+   *
+   * @returns resolves when the store has been cleared.
    */
   deleteAllData() {
     return new Promise((resolve, reject) => {
@@ -206,23 +206,23 @@ export class IndexedDBCryptoStore {
     });
   }
 
-  /**
-   * Get data on how much of the libolm to Rust Crypto migration has been done.
-   *
-   * Implementation of {@link CryptoStore.getMigrationState}.
-   *
-   * @internal
+  /**
+   * Get data on how much of the libolm to Rust Crypto migration has been done.
+   *
+   * Implementation of {@link CryptoStore.getMigrationState}.
+   *
+   * @internal
    */
   getMigrationState() {
     return this.backend.getMigrationState();
   }
 
-  /**
-   * Set data on how much of the libolm to Rust Crypto migration has been done.
-   *
-   * Implementation of {@link CryptoStore.setMigrationState}.
-   *
-   * @internal
+  /**
+   * Set data on how much of the libolm to Rust Crypto migration has been done.
+   *
+   * Implementation of {@link CryptoStore.setMigrationState}.
+   *
+   * @internal
    */
   setMigrationState(migrationState) {
     return this.backend.setMigrationState(migrationState);
@@ -230,55 +230,55 @@ export class IndexedDBCryptoStore {
 
   // Olm Account
 
-  /*
-   * Get the account pickle from the store.
-   * This requires an active transaction. See doTxn().
-   *
-   * @param txn - An active transaction. See doTxn().
-   * @param func - Called with the account pickle
+  /*
+   * Get the account pickle from the store.
+   * This requires an active transaction. See doTxn().
+   *
+   * @param txn - An active transaction. See doTxn().
+   * @param func - Called with the account pickle
    */
   getAccount(txn, func) {
     this.backend.getAccount(txn, func);
   }
 
-  /**
-   * Write the account pickle to the store.
-   * This requires an active transaction. See doTxn().
-   *
-   * @param txn - An active transaction. See doTxn().
-   * @param accountPickle - The new account pickle to store.
+  /**
+   * Write the account pickle to the store.
+   * This requires an active transaction. See doTxn().
+   *
+   * @param txn - An active transaction. See doTxn().
+   * @param accountPickle - The new account pickle to store.
    */
   storeAccount(txn, accountPickle) {
     this.backend.storeAccount(txn, accountPickle);
   }
 
-  /**
-   * Get the public part of the cross-signing keys (eg. self-signing key,
-   * user signing key).
-   *
-   * @param txn - An active transaction. See doTxn().
-   * @param func - Called with the account keys object:
-   *        `{ key_type: base64 encoded seed }` where key type = user_signing_key_seed or self_signing_key_seed
+  /**
+   * Get the public part of the cross-signing keys (eg. self-signing key,
+   * user signing key).
+   *
+   * @param txn - An active transaction. See doTxn().
+   * @param func - Called with the account keys object:
+   *        `{ key_type: base64 encoded seed }` where key type = user_signing_key_seed or self_signing_key_seed
    */
   getCrossSigningKeys(txn, func) {
     this.backend.getCrossSigningKeys(txn, func);
   }
 
-  /**
-   * @param txn - An active transaction. See doTxn().
-   * @param func - Called with the private key
-   * @param type - A key type
+  /**
+   * @param txn - An active transaction. See doTxn().
+   * @param func - Called with the private key
+   * @param type - A key type
    */
   getSecretStorePrivateKey(txn, func, type) {
     this.backend.getSecretStorePrivateKey(txn, func, type);
   }
 
-  /**
-   * Write the cross-signing private keys back to the store
-   *
-   * @param txn - An active transaction. See doTxn().
-   * @param type - The type of cross-signing private key to store
-   * @param key - keys object as getCrossSigningKeys()
+  /**
+   * Write the cross-signing private keys back to the store
+   *
+   * @param txn - An active transaction. See doTxn().
+   * @param type - The type of cross-signing private key to store
+   * @param key - keys object as getCrossSigningKeys()
    */
   storeSecretStorePrivateKey(txn, type, key) {
     this.backend.storeSecretStorePrivateKey(txn, type, key);
@@ -286,85 +286,85 @@ export class IndexedDBCryptoStore {
 
   // Olm sessions
 
-  /**
-   * Returns the number of end-to-end sessions in the store
-   * @param txn - An active transaction. See doTxn().
-   * @param func - Called with the count of sessions
+  /**
+   * Returns the number of end-to-end sessions in the store
+   * @param txn - An active transaction. See doTxn().
+   * @param func - Called with the count of sessions
    */
   countEndToEndSessions(txn, func) {
     this.backend.countEndToEndSessions(txn, func);
   }
 
-  /**
-   * Retrieve a specific end-to-end session between the logged-in user
-   * and another device.
-   * @param deviceKey - The public key of the other device.
-   * @param sessionId - The ID of the session to retrieve
-   * @param txn - An active transaction. See doTxn().
-   * @param func - Called with A map from sessionId
-   *     to session information object with 'session' key being the
-   *     Base64 end-to-end session and lastReceivedMessageTs being the
-   *     timestamp in milliseconds at which the session last received
-   *     a message.
+  /**
+   * Retrieve a specific end-to-end session between the logged-in user
+   * and another device.
+   * @param deviceKey - The public key of the other device.
+   * @param sessionId - The ID of the session to retrieve
+   * @param txn - An active transaction. See doTxn().
+   * @param func - Called with A map from sessionId
+   *     to session information object with 'session' key being the
+   *     Base64 end-to-end session and lastReceivedMessageTs being the
+   *     timestamp in milliseconds at which the session last received
+   *     a message.
    */
   getEndToEndSession(deviceKey, sessionId, txn, func) {
     this.backend.getEndToEndSession(deviceKey, sessionId, txn, func);
   }
 
-  /**
-   * Retrieve the end-to-end sessions between the logged-in user and another
-   * device.
-   * @param deviceKey - The public key of the other device.
-   * @param txn - An active transaction. See doTxn().
-   * @param func - Called with A map from sessionId
-   *     to session information object with 'session' key being the
-   *     Base64 end-to-end session and lastReceivedMessageTs being the
-   *     timestamp in milliseconds at which the session last received
-   *     a message.
+  /**
+   * Retrieve the end-to-end sessions between the logged-in user and another
+   * device.
+   * @param deviceKey - The public key of the other device.
+   * @param txn - An active transaction. See doTxn().
+   * @param func - Called with A map from sessionId
+   *     to session information object with 'session' key being the
+   *     Base64 end-to-end session and lastReceivedMessageTs being the
+   *     timestamp in milliseconds at which the session last received
+   *     a message.
    */
   getEndToEndSessions(deviceKey, txn, func) {
     this.backend.getEndToEndSessions(deviceKey, txn, func);
   }
 
-  /**
-   * Store a session between the logged-in user and another device
-   * @param deviceKey - The public key of the other device.
-   * @param sessionId - The ID for this end-to-end session.
-   * @param sessionInfo - Session information object
-   * @param txn - An active transaction. See doTxn().
+  /**
+   * Store a session between the logged-in user and another device
+   * @param deviceKey - The public key of the other device.
+   * @param sessionId - The ID for this end-to-end session.
+   * @param sessionInfo - Session information object
+   * @param txn - An active transaction. See doTxn().
    */
   storeEndToEndSession(deviceKey, sessionId, sessionInfo, txn) {
     this.backend.storeEndToEndSession(deviceKey, sessionId, sessionInfo, txn);
   }
 
-  /**
-   * 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() {
     return this.backend.countEndToEndInboundGroupSessions();
   }
 
-  /**
-   * Fetch a batch of Olm sessions from the database.
-   *
-   * Implementation of {@link CryptoStore.getEndToEndSessionsBatch}.
-   *
-   * @internal
+  /**
+   * Fetch a batch of Olm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.getEndToEndSessionsBatch}.
+   *
+   * @internal
    */
   getEndToEndSessionsBatch() {
     return this.backend.getEndToEndSessionsBatch();
   }
 
-  /**
-   * 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) {
     return this.backend.deleteEndToEndSessionsBatch(sessions);
@@ -372,94 +372,94 @@ export class IndexedDBCryptoStore {
 
   // Inbound group sessions
 
-  /**
-   * Retrieve the end-to-end inbound group session for a given
-   * server key and session ID
-   * @param senderCurve25519Key - The sender's curve 25519 key
-   * @param sessionId - The ID of the session
-   * @param txn - An active transaction. See doTxn().
-   * @param func - Called with A map from sessionId
-   *     to Base64 end-to-end session.
+  /**
+   * Retrieve the end-to-end inbound group session for a given
+   * server key and session ID
+   * @param senderCurve25519Key - The sender's curve 25519 key
+   * @param sessionId - The ID of the session
+   * @param txn - An active transaction. See doTxn().
+   * @param func - Called with A map from sessionId
+   *     to Base64 end-to-end session.
    */
   getEndToEndInboundGroupSession(senderCurve25519Key, sessionId, txn, func) {
     this.backend.getEndToEndInboundGroupSession(senderCurve25519Key, sessionId, txn, func);
   }
 
-  /**
-   * Writes an end-to-end inbound group session to the store.
-   * If there already exists an inbound group session with the same
-   * senderCurve25519Key and sessionID, it will be overwritten.
-   * @param senderCurve25519Key - The sender's curve 25519 key
-   * @param sessionId - The ID of the session
-   * @param sessionData - The session data structure
-   * @param txn - An active transaction. See doTxn().
+  /**
+   * Writes an end-to-end inbound group session to the store.
+   * If there already exists an inbound group session with the same
+   * senderCurve25519Key and sessionID, it will be overwritten.
+   * @param senderCurve25519Key - The sender's curve 25519 key
+   * @param sessionId - The ID of the session
+   * @param sessionData - The session data structure
+   * @param txn - An active transaction. See doTxn().
    */
   storeEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn) {
     this.backend.storeEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn);
   }
 
-  /**
-   * Fetch a batch of Megolm sessions from the database.
-   *
-   * Implementation of {@link CryptoStore.getEndToEndInboundGroupSessionsBatch}.
-   *
-   * @internal
+  /**
+   * Fetch a batch of Megolm sessions from the database.
+   *
+   * Implementation of {@link CryptoStore.getEndToEndInboundGroupSessionsBatch}.
+   *
+   * @internal
    */
   getEndToEndInboundGroupSessionsBatch() {
     return this.backend.getEndToEndInboundGroupSessionsBatch();
   }
 
-  /**
-   * 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) {
     return this.backend.deleteEndToEndInboundGroupSessionsBatch(sessions);
   }
 
-  /**
-   * Get an object of `roomId->roomInfo` for all e2e rooms in the store
-   * @param txn - An active transaction. See doTxn().
-   * @param func - Function called with the end-to-end encrypted rooms
+  /**
+   * Get an object of `roomId->roomInfo` for all e2e rooms in the store
+   * @param txn - An active transaction. See doTxn().
+   * @param func - Function called with the end-to-end encrypted rooms
    */
   getEndToEndRooms(txn, func) {
     this.backend.getEndToEndRooms(txn, func);
   }
 
-  /**
-   * Mark sessions as needing to be backed up.
-   * @param sessions - The sessions that need to be backed up.
-   * @param txn - An active transaction. See doTxn(). (optional)
-   * @returns resolves when the sessions are marked
+  /**
+   * Mark sessions as needing to be backed up.
+   * @param sessions - The sessions that need to be backed up.
+   * @param txn - An active transaction. See doTxn(). (optional)
+   * @returns resolves when the sessions are marked
    */
   markSessionsNeedingBackup(sessions, txn) {
     return this.backend.markSessionsNeedingBackup(sessions, txn);
   }
 
-  /**
-   * Perform a transaction on the crypto store. Any store methods
-   * that require a transaction (txn) object to be passed in may
-   * only be called within a callback of either this function or
-   * one of the store functions operating on the same transaction.
-   *
-   * @param mode - 'readwrite' if you need to call setter
-   *     functions with this transaction. Otherwise, 'readonly'.
-   * @param stores - List IndexedDBCryptoStore.STORE_*
-   *     options representing all types of object that will be
-   *     accessed or written to with this transaction.
-   * @param func - Function called with the
-   *     transaction object: an opaque object that should be passed
-   *     to store functions.
-   * @param log - A possibly customised log
-   * @returns Promise that resolves with the result of the `func`
-   *     when the transaction is complete. If the backend is
-   *     async (ie. the indexeddb backend) any of the callback
-   *     functions throwing an exception will cause this promise to
-   *     reject with that exception. On synchronous backends, the
-   *     exception will propagate to the caller of the getFoo method.
+  /**
+   * Perform a transaction on the crypto store. Any store methods
+   * that require a transaction (txn) object to be passed in may
+   * only be called within a callback of either this function or
+   * one of the store functions operating on the same transaction.
+   *
+   * @param mode - 'readwrite' if you need to call setter
+   *     functions with this transaction. Otherwise, 'readonly'.
+   * @param stores - List IndexedDBCryptoStore.STORE_*
+   *     options representing all types of object that will be
+   *     accessed or written to with this transaction.
+   * @param func - Function called with the
+   *     transaction object: an opaque object that should be passed
+   *     to store functions.
+   * @param log - A possibly customised log
+   * @returns Promise that resolves with the result of the `func`
+   *     when the transaction is complete. If the backend is
+   *     async (ie. the indexeddb backend) any of the callback
+   *     functions throwing an exception will cause this promise to
+   *     reject with that exception. On synchronous backends, the
+   *     exception will propagate to the caller of the getFoo method.
    */
   doTxn(mode, stores, func, log) {
     return this.backend.doTxn(mode, stores, func, log);