Class IndexedDBCryptoStore

An implementation of CryptoStore, which is normally backed by an indexeddb, but with fallback to MemoryCryptoStore.

Implements

CryptoStore

Index

Constructors

Properties

STORE_ACCOUNT STORE_BACKUP STORE_DEVICE_DATA STORE_INBOUND_GROUP_SESSIONS STORE_INBOUND_GROUP_SESSIONS_WITHHELD STORE_PARKED_SHARED_HISTORY STORE_ROOMS STORE_SESSIONS STORE_SHARED_HISTORY_INBOUND_GROUP_SESSIONS

Methods

Constructors

constructor

new IndexedDBCryptoStore(indexedDB, dbName): IndexedDBCryptoStore
Create a new IndexedDBCryptoStore
Parameters
- indexedDB: IDBFactory
  global indexedDB instance
- dbName: string
  name of db to connect to
Returns IndexedDBCryptoStore
- Defined in src/crypto/store/indexeddb-crypto-store.ts:122

Properties

`Static`STORE_ACCOUNT

STORE_ACCOUNT: string = "account"

`Static`STORE_BACKUP

STORE_BACKUP: string = "sessions_needing_backup"

`Static`STORE_DEVICE_DATA

STORE_DEVICE_DATA: string = "device_data"

`Static`STORE_INBOUND_GROUP_SESSIONS

STORE_INBOUND_GROUP_SESSIONS: string = "inbound_group_sessions"

`Static`STORE_INBOUND_GROUP_SESSIONS_WITHHELD

STORE_INBOUND_GROUP_SESSIONS_WITHHELD: string = "inbound_group_sessions_withheld"

`Static`STORE_PARKED_SHARED_HISTORY

STORE_PARKED_SHARED_HISTORY: string = "parked_shared_history"

`Static`STORE_ROOMS

STORE_ROOMS: string = "rooms"

`Static`STORE_SESSIONS

STORE_SESSIONS: string = "sessions"

`Static`STORE_SHARED_HISTORY_INBOUND_GROUP_SESSIONS

STORE_SHARED_HISTORY_INBOUND_GROUP_SESSIONS: string = "shared_history_inbound_group_sessions"

Methods

addEndToEndInboundGroupSession

addEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn): void
Adds an end-to-end inbound group session to the store. If there already exists an inbound group session with the same senderCurve25519Key and sessionID, the session will not be added.
Parameters
- senderCurve25519Key: string
  The sender's curve 25519 key
- sessionId: string
  The ID of the session
- sessionData: InboundGroupSessionData
  The session data structure
- txn: IDBTransaction
  An active transaction. See doTxn().
Returns void
Implementation of CryptoStore.addEndToEndInboundGroupSession
- Defined in src/crypto/store/indexeddb-crypto-store.ts:629

addParkedSharedHistory

addParkedSharedHistory(roomId, parkedData, txn?): void
Park a shared-history group session for a room we may be invited to later.
Parameters
- roomId: string
- parkedData: ParkedSharedHistory
- Optionaltxn: IDBTransaction
Returns void
Implementation of CryptoStore.addParkedSharedHistory
- Defined in src/crypto/store/indexeddb-crypto-store.ts:809

addSharedHistoryInboundGroupSession

addSharedHistoryInboundGroupSession(roomId, senderKey, sessionId, txn?): void
Add a shared-history group session for a room.
Parameters
- roomId: string
  The room that the key belongs to
- senderKey: string
  The sender's curve 25519 key
- sessionId: string
  The ID of the session
- Optionaltxn: IDBTransaction
  An active transaction. See doTxn(). (optional)
Returns void
Implementation of CryptoStore.addSharedHistoryInboundGroupSession
- Defined in src/crypto/store/indexeddb-crypto-store.ts:784

containsData

containsData(): Promise<boolean>
Internal
Returns true if this CryptoStore has ever been initialised (ie, it might contain data).

Implementation of CryptoStore.containsData.

Returns Promise<boolean>
Implementation of CryptoStore.containsData
- Defined in src/crypto/store/indexeddb-crypto-store.ts:134

countEndToEndInboundGroupSessions

countEndToEndInboundGroupSessions(): Promise<number>
Internal
Count the number of Megolm sessions in the database.

Implementation of CryptoStore.countEndToEndInboundGroupSessions.

Returns Promise<number>
Implementation of CryptoStore.countEndToEndInboundGroupSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:563

countEndToEndSessions

countEndToEndSessions(txn, func): void
Returns the number of end-to-end sessions in the store
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((count: number) => void)
  Called with the count of sessions
  - - (count): void
    - Parameters
      count: number
      Returns void
Returns void
Implementation of CryptoStore.countEndToEndSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:473

countSessionsNeedingBackup

countSessionsNeedingBackup(txn?): Promise<number>
Count the inbound group sessions that need to be backed up.
Parameters
- Optionaltxn: IDBTransaction
  An active transaction. See doTxn(). (optional)
Returns Promise<number>
resolves to the number of sessions
Implementation of CryptoStore.countSessionsNeedingBackup
- Defined in src/crypto/store/indexeddb-crypto-store.ts:753

deleteAllData

deleteAllData(): Promise<void>
Delete all data from this store.

Returns Promise<void>
resolves when the store has been cleared.
Implementation of CryptoStore.deleteAllData
- Defined in src/crypto/store/indexeddb-crypto-store.ts:232

deleteEndToEndInboundGroupSessionsBatch

deleteEndToEndInboundGroupSessionsBatch(sessions): Promise<void>
Internal
Delete a batch of Megolm sessions from the database.

Implementation of CryptoStore.deleteEndToEndInboundGroupSessionsBatch.
Parameters
- sessions: {
  senderKey: string;
  sessionId: string;
  }[]
Returns Promise<void>
Implementation of CryptoStore.deleteEndToEndInboundGroupSessionsBatch
- Defined in src/crypto/store/indexeddb-crypto-store.ts:683

deleteEndToEndSessionsBatch

deleteEndToEndSessionsBatch(sessions): Promise<void>
Internal
Delete a batch of Olm sessions from the database.

Implementation of CryptoStore.deleteEndToEndSessionsBatch.
Parameters
- sessions: {
  deviceKey: string;
  sessionId: string;
  }[]
Returns Promise<void>
Implementation of CryptoStore.deleteEndToEndSessionsBatch
- Defined in src/crypto/store/indexeddb-crypto-store.ts:585

deleteOutgoingRoomKeyRequest

deleteOutgoingRoomKeyRequest(requestId, expectedState): Promise<null | OutgoingRoomKeyRequest>
Look for an existing room key request by id and state, and delete it if found
Parameters
- requestId: string
  ID of request to update
- expectedState: number
  state we expect to find the request in
Returns Promise<null | OutgoingRoomKeyRequest>
resolves once the operation is completed
Implementation of CryptoStore.deleteOutgoingRoomKeyRequest
- Defined in src/crypto/store/indexeddb-crypto-store.ts:382

doTxn

doTxn<T>(mode, stores, func, log?): Promise<T>
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.
Type Parameters
- T
Parameters
- mode: Mode
  'readwrite' if you need to call setter functions with this transaction. Otherwise, 'readonly'.
- stores: Iterable<string, any, any>
  List IndexedDBCryptoStore.STORE_* options representing all types of object that will be accessed or written to with this transaction.
- func: ((txn: IDBTransaction) => T)
  Function called with the transaction object: an opaque object that should be passed to store functions.
  - - (txn): T
    - Parameters
      txn: IDBTransaction
      Returns T
- Optionallog: Logger
  A possibly customised log
Returns Promise<T>
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.
Implementation of CryptoStore.doTxn
- Defined in src/crypto/store/indexeddb-crypto-store.ts:842

filterOutNotifiedErrorDevices

filterOutNotifiedErrorDevices(devices): Promise<IOlmDevice<DeviceInfo>[]>
Parameters
- devices: IOlmDevice<DeviceInfo>[]
Returns Promise<IOlmDevice<DeviceInfo>[]>
Implementation of CryptoStore.filterOutNotifiedErrorDevices
- Defined in src/crypto/store/indexeddb-crypto-store.ts:552

getAccount

getAccount(txn, func): void
Parameters
- txn: IDBTransaction
- func: ((accountPickle: null | string) => void)
  - - (accountPickle): void
    - Parameters
      accountPickle: null | string
      Returns void
Returns void
Implementation of CryptoStore.getAccount
- Defined in src/crypto/store/indexeddb-crypto-store.ts:398

getAllEndToEndInboundGroupSessions

getAllEndToEndInboundGroupSessions(txn, func): void
Fetches all inbound group sessions in the store
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((session: null | ISession) => void)
  Called once for each group session in the store with an object having keys {senderKey, sessionId, sessionData}, then once with null to indicate the end of the list.
  - - (session): void
    - Parameters
      session: null | ISession
      Returns void
Returns void
Implementation of CryptoStore.getAllEndToEndInboundGroupSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:616

getAllEndToEndSessions

getAllEndToEndSessions(txn, func): void
Retrieve all end-to-end sessions
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((session: null | ISessionInfo) => void)
  Called one for each session with an object with, deviceKey, lastReceivedMessageTs, sessionId and session keys.
  - - (session): void
    - Parameters
      session: null | ISessionInfo
      Returns void
Returns void
Implementation of CryptoStore.getAllEndToEndSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:524

getAllOutgoingRoomKeyRequestsByState

getAllOutgoingRoomKeyRequestsByState(wantedState): Promise<OutgoingRoomKeyRequest[]>
Look for room key requests by state – unlike above, return a list of all entries in one state.
Parameters
- wantedState: number
Returns Promise<OutgoingRoomKeyRequest[]>
Returns an array of requests in the given state
Implementation of CryptoStore.getAllOutgoingRoomKeyRequestsByState
- Defined in src/crypto/store/indexeddb-crypto-store.ts:331

getCrossSigningKeys

getCrossSigningKeys(txn, func): void
Get the public part of the cross-signing keys (eg. self-signing key, user signing key).
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((keys: null | Record<string, CrossSigningKeyInfo>) => void)
  Called with the account keys object: { key_type: base64 encoded seed } where key type = user_signing_key_seed or self_signing_key_seed
  - - (keys): void
    - Parameters
      keys: null | Record<string, CrossSigningKeyInfo>
      Returns void
Returns void
Implementation of CryptoStore.getCrossSigningKeys
- Defined in src/crypto/store/indexeddb-crypto-store.ts:421

getEndToEndDeviceData

getEndToEndDeviceData(txn, func): void
Get the state of all tracked devices
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((deviceData: null | IDeviceData) => void)
  Function called with the device data
  - - (deviceData): void
    - Parameters
      deviceData: null | IDeviceData
      Returns void
Returns void
Implementation of CryptoStore.getEndToEndDeviceData
- Defined in src/crypto/store/indexeddb-crypto-store.ts:711

getEndToEndInboundGroupSession

getEndToEndInboundGroupSession(senderCurve25519Key, sessionId, txn, func): void
Retrieve the end-to-end inbound group session for a given server key and session ID
Parameters
- senderCurve25519Key: string
  The sender's curve 25519 key
- sessionId: string
  The ID of the session
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((groupSession: null | InboundGroupSessionData, groupSessionWithheld: null | IWithheld) => void)
  Called with A map from sessionId to Base64 end-to-end session.
  - - (groupSession, groupSessionWithheld): void
    - Parameters
      groupSession: null | InboundGroupSessionData
      groupSessionWithheld: null | IWithheld
      Returns void
Returns void
Implementation of CryptoStore.getEndToEndInboundGroupSession
- Defined in src/crypto/store/indexeddb-crypto-store.ts:600

getEndToEndInboundGroupSessionsBatch

getEndToEndInboundGroupSessionsBatch(): Promise<null | SessionExtended[]>
Internal
Fetch a batch of Megolm sessions from the database.

Implementation of CryptoStore.getEndToEndInboundGroupSessionsBatch.

Returns Promise<null | SessionExtended[]>
Implementation of CryptoStore.getEndToEndInboundGroupSessionsBatch
- Defined in src/crypto/store/indexeddb-crypto-store.ts:672

getEndToEndRooms

getEndToEndRooms(txn, func): void
Get an object of roomId->roomInfo for all e2e rooms in the store
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((rooms: Record<string, IRoomEncryption>) => void)
  Function called with the end-to-end encrypted rooms
  - - (rooms): void
    - Parameters
      rooms: Record<string, IRoomEncryption>
      Returns void
Returns void
Implementation of CryptoStore.getEndToEndRooms
- Defined in src/crypto/store/indexeddb-crypto-store.ts:732

getEndToEndSession

getEndToEndSession(deviceKey, sessionId, txn, func): void
Retrieve a specific end-to-end session between the logged-in user and another device.
Parameters
- deviceKey: string
  The public key of the other device.
- sessionId: string
  The ID of the session to retrieve
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((session: null | ISessionInfo) => void)
  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.
  - - (session): void
    - Parameters
      session: null | ISessionInfo
      Returns void
Returns void
Implementation of CryptoStore.getEndToEndSession
- Defined in src/crypto/store/indexeddb-crypto-store.ts:489

getEndToEndSessionProblem

getEndToEndSessionProblem(deviceKey, timestamp): Promise<null | IProblem>
Parameters
- deviceKey: string
- timestamp: number
Returns Promise<null | IProblem>
Implementation of CryptoStore.getEndToEndSessionProblem
- Defined in src/crypto/store/indexeddb-crypto-store.ts:548

getEndToEndSessions

getEndToEndSessions(deviceKey, txn, func): void
Retrieve the end-to-end sessions between the logged-in user and another device.
Parameters
- deviceKey: string
  The public key of the other device.
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((sessions: {
  [sessionId: string]: ISessionInfo;
  }) => void)
  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.
  - - (sessions): void
    - Parameters
      sessions: {
      [sessionId: string]: ISessionInfo;
      }
      [sessionId: string]: ISessionInfo
      Returns void
Returns void
Implementation of CryptoStore.getEndToEndSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:509

getEndToEndSessionsBatch

getEndToEndSessionsBatch(): Promise<null | ISessionInfo[]>
Internal
Fetch a batch of Olm sessions from the database.

Implementation of CryptoStore.getEndToEndSessionsBatch.

Returns Promise<null | ISessionInfo[]>
Implementation of CryptoStore.getEndToEndSessionsBatch
- Defined in src/crypto/store/indexeddb-crypto-store.ts:574

getMigrationState

getMigrationState(): Promise<MigrationState>
Internal
Get data on how much of the libolm to Rust Crypto migration has been done.

Implementation of CryptoStore.getMigrationState.

Returns Promise<MigrationState>
Implementation of CryptoStore.getMigrationState
- Defined in src/crypto/store/indexeddb-crypto-store.ts:270

getOrAddOutgoingRoomKeyRequest

getOrAddOutgoingRoomKeyRequest(request): Promise<OutgoingRoomKeyRequest>
Look for an existing outgoing room key request, and if none is found, add a new one
Parameters
- request: OutgoingRoomKeyRequest
Returns Promise<OutgoingRoomKeyRequest>
resolves to OutgoingRoomKeyRequest: either the same instance as passed in, or the existing one.
Implementation of CryptoStore.getOrAddOutgoingRoomKeyRequest
- Defined in src/crypto/store/indexeddb-crypto-store.ts:294

getOutgoingRoomKeyRequest

getOutgoingRoomKeyRequest(requestBody): Promise<null | OutgoingRoomKeyRequest>
Look for an existing room key request
Parameters
- requestBody: IRoomKeyRequestBody
  existing request to look for
Returns Promise<null | OutgoingRoomKeyRequest>
resolves to the matching OutgoingRoomKeyRequest, or null if not found
Implementation of CryptoStore.getOutgoingRoomKeyRequest
- Defined in src/crypto/store/indexeddb-crypto-store.ts:307

getOutgoingRoomKeyRequestByState

getOutgoingRoomKeyRequestByState(wantedStates): Promise<null | OutgoingRoomKeyRequest>
Look for room key requests by state
Parameters
- wantedStates: number[]
  list of acceptable states
Returns Promise<null | OutgoingRoomKeyRequest>
resolves to the a OutgoingRoomKeyRequest, or null if there are no pending requests in those states. If there are multiple requests in those states, an arbitrary one is chosen.
Implementation of CryptoStore.getOutgoingRoomKeyRequestByState
- Defined in src/crypto/store/indexeddb-crypto-store.ts:321

getOutgoingRoomKeyRequestsByTarget

getOutgoingRoomKeyRequestsByTarget(userId, deviceId, wantedStates): Promise<OutgoingRoomKeyRequest[]>
Look for room key requests by target device and state
Parameters
- userId: string
  Target user ID
- deviceId: string
  Target device ID
- wantedStates: number[]
  list of acceptable states
Returns Promise<OutgoingRoomKeyRequest[]>
resolves to a list of all the OutgoingRoomKeyRequest
Implementation of CryptoStore.getOutgoingRoomKeyRequestsByTarget
- Defined in src/crypto/store/indexeddb-crypto-store.ts:345

getSecretStorePrivateKey

getSecretStorePrivateKey<K>(txn, func, type): void
Type Parameters
- K extends keyof SecretStorePrivateKeys
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- func: ((key: null | SecretStorePrivateKeys[K]) => void)
  Called with the private key
  - - (key): void
    - Parameters
      key: null | SecretStorePrivateKeys[K]
      Returns void
- type: K
  A key type
Returns void
Implementation of CryptoStore.getSecretStorePrivateKey
- Defined in src/crypto/store/indexeddb-crypto-store.ts:433

getSessionsNeedingBackup

getSessionsNeedingBackup(limit): Promise<ISession[]>
Get the inbound group sessions that need to be backed up.
Parameters
- limit: number
  The maximum number of sessions to retrieve. 0 for no limit.
Returns Promise<ISession[]>
resolves to an array of inbound group sessions
Implementation of CryptoStore.getSessionsNeedingBackup
- Defined in src/crypto/store/indexeddb-crypto-store.ts:744

getSharedHistoryInboundGroupSessions

getSharedHistoryInboundGroupSessions(roomId, txn?): Promise<[senderKey: string, sessionId: string][]>
Get the shared-history group session for a room.
Parameters
- roomId: string
  The room that the key belongs to
- Optionaltxn: IDBTransaction
  An active transaction. See doTxn(). (optional)
Returns Promise<[senderKey: string, sessionId: string][]>
Promise which resolves to an array of [senderKey, sessionId]
Implementation of CryptoStore.getSharedHistoryInboundGroupSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:799

markSessionsNeedingBackup

markSessionsNeedingBackup(sessions, txn?): Promise<void>
Mark sessions as needing to be backed up.
Parameters
- sessions: ISession[]
  The sessions that need to be backed up.
- Optionaltxn: IDBTransaction
  An active transaction. See doTxn(). (optional)
Returns Promise<void>
resolves when the sessions are marked
Implementation of CryptoStore.markSessionsNeedingBackup
- Defined in src/crypto/store/indexeddb-crypto-store.ts:773

setMigrationState

setMigrationState(migrationState): Promise<void>
Internal
Set data on how much of the libolm to Rust Crypto migration has been done.

Implementation of CryptoStore.setMigrationState.
Parameters
- migrationState: MigrationState
Returns Promise<void>
Implementation of CryptoStore.setMigrationState
- Defined in src/crypto/store/indexeddb-crypto-store.ts:281

startup

startup(): Promise<CryptoStore>
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 Promise<CryptoStore>
resolves to either an IndexedDBCryptoStoreBackend.Backend, or a MemoryCryptoStore
Implementation of CryptoStore.startup
- Defined in src/crypto/store/indexeddb-crypto-store.ts:147

storeAccount

storeAccount(txn, accountPickle): void
Write the account pickle to the store. This requires an active transaction. See doTxn().
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- accountPickle: string
  The new account pickle to store.
Returns void
Implementation of CryptoStore.storeAccount
- Defined in src/crypto/store/indexeddb-crypto-store.ts:409

storeCrossSigningKeys

storeCrossSigningKeys(txn, keys): void
Write the cross-signing keys back to the store
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- keys: Record<string, CrossSigningKeyInfo>
  keys object as getCrossSigningKeys()
Returns void
Implementation of CryptoStore.storeCrossSigningKeys
- Defined in src/crypto/store/indexeddb-crypto-store.ts:447

storeEndToEndDeviceData

storeEndToEndDeviceData(deviceData, txn): void
Store the state of all tracked devices This contains devices for each user, a tracking state for each user and a sync token matching the point in time the snapshot represents. These all need to be written out in full each time such that the snapshot is always consistent, so they are stored in one object.
Parameters
- deviceData: IDeviceData
- txn: IDBTransaction
  An active transaction. See doTxn().
Returns void
Implementation of CryptoStore.storeEndToEndDeviceData
- Defined in src/crypto/store/indexeddb-crypto-store.ts:700

storeEndToEndInboundGroupSession

storeEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn): void
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.
Parameters
- senderCurve25519Key: string
  The sender's curve 25519 key
- sessionId: string
  The ID of the session
- sessionData: InboundGroupSessionData
  The session data structure
- txn: IDBTransaction
  An active transaction. See doTxn().
Returns void
Implementation of CryptoStore.storeEndToEndInboundGroupSession
- Defined in src/crypto/store/indexeddb-crypto-store.ts:647

storeEndToEndInboundGroupSessionWithheld

storeEndToEndInboundGroupSessionWithheld(senderCurve25519Key, sessionId, sessionData, txn): void
Parameters
- senderCurve25519Key: string
- sessionId: string
- sessionData: IWithheld
- txn: IDBTransaction
Returns void
Implementation of CryptoStore.storeEndToEndInboundGroupSessionWithheld
- Defined in src/crypto/store/indexeddb-crypto-store.ts:656

storeEndToEndRoom

storeEndToEndRoom(roomId, roomInfo, txn): void
Store the end-to-end state for a room.
Parameters
- roomId: string
  The room's ID.
- roomInfo: IRoomEncryption
  The end-to-end info for the room.
- txn: IDBTransaction
  An active transaction. See doTxn().
Returns void
Implementation of CryptoStore.storeEndToEndRoom
- Defined in src/crypto/store/indexeddb-crypto-store.ts:723

storeEndToEndSession

storeEndToEndSession(deviceKey, sessionId, sessionInfo, txn): void
Store a session between the logged-in user and another device
Parameters
- deviceKey: string
  The public key of the other device.
- sessionId: string
  The ID for this end-to-end session.
- sessionInfo: ISessionInfo
  Session information object
- txn: IDBTransaction
  An active transaction. See doTxn().
Returns void
Implementation of CryptoStore.storeEndToEndSession
- Defined in src/crypto/store/indexeddb-crypto-store.ts:535

storeEndToEndSessionProblem

storeEndToEndSessionProblem(deviceKey, type, fixed): Promise<void>
Parameters
- deviceKey: string
- type: string
- fixed: boolean
Returns Promise<void>
Implementation of CryptoStore.storeEndToEndSessionProblem
- Defined in src/crypto/store/indexeddb-crypto-store.ts:544

storeSecretStorePrivateKey

storeSecretStorePrivateKey<K>(txn, type, key): void
Write the cross-signing private keys back to the store
Type Parameters
- K extends keyof SecretStorePrivateKeys
Parameters
- txn: IDBTransaction
  An active transaction. See doTxn().
- type: K
  The type of cross-signing private key to store
- key: SecretStorePrivateKeys[K]
  keys object as getCrossSigningKeys()
Returns void
Implementation of CryptoStore.storeSecretStorePrivateKey
- Defined in src/crypto/store/indexeddb-crypto-store.ts:458

takeParkedSharedHistory

takeParkedSharedHistory(roomId, txn?): Promise<ParkedSharedHistory[]>
Pop out all shared-history group sessions for a room.
Parameters
- roomId: string
- Optionaltxn: IDBTransaction
Returns Promise<ParkedSharedHistory[]>
Implementation of CryptoStore.takeParkedSharedHistory
- Defined in src/crypto/store/indexeddb-crypto-store.ts:816

unmarkSessionsNeedingBackup

unmarkSessionsNeedingBackup(sessions, txn?): Promise<void>
Unmark sessions as needing to be backed up.
Parameters
- sessions: ISession[]
  The sessions that need to be backed up.
- Optionaltxn: IDBTransaction
  An active transaction. See doTxn(). (optional)
Returns Promise<void>
resolves when the sessions are unmarked
Implementation of CryptoStore.unmarkSessionsNeedingBackup
- Defined in src/crypto/store/indexeddb-crypto-store.ts:763

updateOutgoingRoomKeyRequest

updateOutgoingRoomKeyRequest(requestId, expectedState, updates): Promise<null | OutgoingRoomKeyRequest>
Look for an existing room key request by id and state, and update it if found
Parameters
- requestId: string
  ID of request to update
- expectedState: number
  state we expect to find the request in
- updates: Partial<OutgoingRoomKeyRequest>
  name/value map of updates to apply
Returns Promise<null | OutgoingRoomKeyRequest>
resolves to OutgoingRoomKeyRequest updated request, or null if no matching row was found
Implementation of CryptoStore.updateOutgoingRoomKeyRequest
- Defined in src/crypto/store/indexeddb-crypto-store.ts:365

`Static`exists

exists(indexedDB, dbName): Promise<boolean>
Parameters
- indexedDB: IDBFactory
- dbName: string
Returns Promise<boolean>
- Defined in src/crypto/store/indexeddb-crypto-store.ts:63

`Static`existsAndIsNotMigrated

existsAndIsNotMigrated(indexedDb, dbName): Promise<boolean>
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.
Parameters
- indexedDb: IDBFactory
- dbName: string
Returns Promise<boolean>
- Defined in src/crypto/store/indexeddb-crypto-store.ts:71

Class IndexedDBCryptoStore

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IndexedDBCryptoStore

Properties

StaticSTORE_ACCOUNT

StaticSTORE_BACKUP

StaticSTORE_DEVICE_DATA

StaticSTORE_INBOUND_GROUP_SESSIONS

StaticSTORE_INBOUND_GROUP_SESSIONS_WITHHELD

StaticSTORE_PARKED_SHARED_HISTORY

StaticSTORE_ROOMS

StaticSTORE_SESSIONS

StaticSTORE_SHARED_HISTORY_INBOUND_GROUP_SESSIONS

Methods

addEndToEndInboundGroupSession

Parameters

Returns void

addParkedSharedHistory

Parameters

Returns void

addSharedHistoryInboundGroupSession

Parameters

Returns void

containsData

Returns Promise<boolean>

countEndToEndInboundGroupSessions

Returns Promise<number>

countEndToEndSessions

Parameters

Parameters

Returns void

Returns void

countSessionsNeedingBackup

Parameters

Returns Promise<number>

deleteAllData

Returns Promise<void>

deleteEndToEndInboundGroupSessionsBatch

Parameters

Returns Promise<void>

deleteEndToEndSessionsBatch

Parameters

Returns Promise<void>

deleteOutgoingRoomKeyRequest

Parameters

Returns Promise<null | OutgoingRoomKeyRequest>

doTxn

Type Parameters

Parameters

Parameters

Returns T

Returns Promise<T>

filterOutNotifiedErrorDevices

Parameters

Returns Promise<IOlmDevice<DeviceInfo>[]>

getAccount

Parameters

Parameters

Returns void

Returns void

getAllEndToEndInboundGroupSessions

Parameters

Parameters

Returns void

Returns void

getAllEndToEndSessions

Parameters

Parameters

Returns void

Returns void

getAllOutgoingRoomKeyRequestsByState

Parameters

Returns Promise<OutgoingRoomKeyRequest[]>

`Static`STORE_ACCOUNT

`Static`STORE_BACKUP

`Static`STORE_DEVICE_DATA

`Static`STORE_INBOUND_GROUP_SESSIONS

`Static`STORE_INBOUND_GROUP_SESSIONS_WITHHELD

`Static`STORE_PARKED_SHARED_HISTORY

`Static`STORE_ROOMS

`Static`STORE_SESSIONS

`Static`STORE_SHARED_HISTORY_INBOUND_GROUP_SESSIONS