Class IndexedDBCryptoStore

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

Implements

Hierarchy

IndexedDBCryptoStore

Implements

CryptoStore

Index

Constructors

constructor

new IndexedDBCryptoStore(indexedDB: IDBFactory, dbName: string): 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:76

Properties

`Private` `Optional` backend

backend?: CryptoStore

`Private` `Optional` backendPromise

backendPromise?: Promise<CryptoStore>

`Private` `Readonly` dbName

dbName: string

name of db to connect to

`Private` `Readonly` indexedDB

indexedDB: IDBFactory

global indexedDB instance

`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: string, sessionId: string, sessionData: InboundGroupSessionData, txn: IDBTransaction): 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:526

addParkedSharedHistory

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

addSharedHistoryInboundGroupSession

addSharedHistoryInboundGroupSession(roomId: string, senderKey: string, sessionId: string, txn?: IDBTransaction): 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
- Optional txn: IDBTransaction
  
  An active transaction. See doTxn(). (optional)
Returns void
Implementation of CryptoStore.addSharedHistoryInboundGroupSession
- Defined in src/crypto/store/indexeddb-crypto-store.ts:658

countEndToEndSessions

countEndToEndSessions(txn: IDBTransaction, func: ((count: number) => void)): 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: number): void
    - Parameters
      
      count: number
      
      Returns void
Returns void
Implementation of CryptoStore.countEndToEndSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:400

countSessionsNeedingBackup

countSessionsNeedingBackup(txn?: IDBTransaction): Promise<number>
Count the inbound group sessions that need to be backed up.

Returns
resolves to the number of sessions
Parameters
- Optional txn: IDBTransaction
  
  An active transaction. See doTxn(). (optional)
Returns Promise<number>
Implementation of CryptoStore.countSessionsNeedingBackup
- Defined in src/crypto/store/indexeddb-crypto-store.ts:627

deleteAllData

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

Returns
resolves when the store has been cleared.

Returns Promise<void>
Implementation of CryptoStore.deleteAllData
- Defined in src/crypto/store/indexeddb-crypto-store.ts:172

deleteOutgoingRoomKeyRequest

deleteOutgoingRoomKeyRequest(requestId: string, expectedState: number): Promise<null | OutgoingRoomKeyRequest>
Look for an existing room key request by id and state, and delete it if found

Returns
resolves once the operation is completed
Parameters
- requestId: string
  
  ID of request to update
- expectedState: number
  
  state we expect to find the request in
Returns Promise<null | OutgoingRoomKeyRequest>
Implementation of CryptoStore.deleteOutgoingRoomKeyRequest
- Defined in src/crypto/store/indexeddb-crypto-store.ts:309

doTxn

doTxn<T>(mode: Mode, stores: Iterable<string>, func: ((txn: IDBTransaction) => T), log?: PrefixedLogger): 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.

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.
Type Parameters
- T
Parameters
- mode: Mode
  
  'readwrite' if you need to call setter functions with this transaction. Otherwise, 'readonly'.
- stores: Iterable<string>
  
  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: IDBTransaction): T
    - Parameters
      
      txn: IDBTransaction
      
      Returns T
- Optional log: PrefixedLogger
  
  A possibly customised log
Returns Promise<T>
Implementation of CryptoStore.doTxn
- Defined in src/crypto/store/indexeddb-crypto-store.ts:723

filterOutNotifiedErrorDevices

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

getAccount

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

getAllEndToEndInboundGroupSessions

getAllEndToEndInboundGroupSessions(txn: IDBTransaction, func: ((session: null | ISession) => void)): 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: null | ISession): void
    - Parameters
      
      session: null | ISession
      
      Returns void
Returns void
Implementation of CryptoStore.getAllEndToEndInboundGroupSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:510

getAllEndToEndSessions

getAllEndToEndSessions(txn: IDBTransaction, func: ((session: null | ISessionInfo) => void)): 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: null | ISessionInfo): void
    - Parameters
      
      session: null | ISessionInfo
      
      Returns void
Returns void
Implementation of CryptoStore.getAllEndToEndSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:451

getAllOutgoingRoomKeyRequestsByState

getAllOutgoingRoomKeyRequestsByState(wantedState: number): Promise<OutgoingRoomKeyRequest[]>
Look for room key requests by state – unlike above, return a list of all entries in one state.

Returns
Returns an array of requests in the given state
Parameters
- wantedState: number
Returns Promise<OutgoingRoomKeyRequest[]>
Implementation of CryptoStore.getAllOutgoingRoomKeyRequestsByState
- Defined in src/crypto/store/indexeddb-crypto-store.ts:254

getCrossSigningKeys

getCrossSigningKeys(txn: IDBTransaction, func: ((keys: null | Record<string, ICrossSigningKey>) => void)): 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, ICrossSigningKey>) => 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: null | Record<string, ICrossSigningKey>): void
    - Parameters
      
      keys: null | Record<string, ICrossSigningKey>
      
      Returns void
Returns void
Implementation of CryptoStore.getCrossSigningKeys
- Defined in src/crypto/store/indexeddb-crypto-store.ts:348

getEndToEndDeviceData

getEndToEndDeviceData(txn: IDBTransaction, func: ((deviceData: null | IDeviceData) => void)): 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: null | IDeviceData): void
    - Parameters
      
      deviceData: null | IDeviceData
      
      Returns void
Returns void
Implementation of CryptoStore.getEndToEndDeviceData
- Defined in src/crypto/store/indexeddb-crypto-store.ts:585

getEndToEndInboundGroupSession

getEndToEndInboundGroupSession(senderCurve25519Key: string, sessionId: string, txn: IDBTransaction, func: ((groupSession: null | InboundGroupSessionData, groupSessionWithheld: null | IWithheld) => void)): 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: null | InboundGroupSessionData, groupSessionWithheld: null | IWithheld): 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:494

getEndToEndRooms

getEndToEndRooms(txn: IDBTransaction, func: ((rooms: Record<string, IRoomEncryption>) => void)): 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: Record<string, IRoomEncryption>): void
    - Parameters
      
      rooms: Record<string, IRoomEncryption>
      
      Returns void
Returns void
Implementation of CryptoStore.getEndToEndRooms
- Defined in src/crypto/store/indexeddb-crypto-store.ts:606

getEndToEndSession

getEndToEndSession(deviceKey: string, sessionId: string, txn: IDBTransaction, func: ((session: null | ISessionInfo) => void)): 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: null | ISessionInfo): void
    - Parameters
      
      session: null | ISessionInfo
      
      Returns void
Returns void
Implementation of CryptoStore.getEndToEndSession
- Defined in src/crypto/store/indexeddb-crypto-store.ts:416

getEndToEndSessionProblem

getEndToEndSessionProblem(deviceKey: string, timestamp: number): 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:475

getEndToEndSessions

getEndToEndSessions(deviceKey: string, txn: IDBTransaction, func: ((sessions: {
[sessionId: string]: ISessionInfo;
}) => void)): 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: {
      [sessionId: string]: ISessionInfo;
      }): 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:436

getOrAddOutgoingRoomKeyRequest

getOrAddOutgoingRoomKeyRequest(request: OutgoingRoomKeyRequest): Promise<OutgoingRoomKeyRequest>
Look for an existing outgoing room key request, and if none is found, add a new one

Returns
resolves to module:crypto/store/base~OutgoingRoomKeyRequest: either the same instance as passed in, or the existing one.
Parameters
- request: OutgoingRoomKeyRequest
Returns Promise<OutgoingRoomKeyRequest>
Implementation of CryptoStore.getOrAddOutgoingRoomKeyRequest
- Defined in src/crypto/store/indexeddb-crypto-store.ts:215

getOutgoingRoomKeyRequest

getOutgoingRoomKeyRequest(requestBody: IRoomKeyRequestBody): Promise<null | OutgoingRoomKeyRequest>
Look for an existing room key request

Returns
resolves to the matching module:crypto/store/base~OutgoingRoomKeyRequest, or null if not found
Parameters
- requestBody: IRoomKeyRequestBody
  
  existing request to look for
Returns Promise<null | OutgoingRoomKeyRequest>
Implementation of CryptoStore.getOutgoingRoomKeyRequest
- Defined in src/crypto/store/indexeddb-crypto-store.ts:229

getOutgoingRoomKeyRequestByState

getOutgoingRoomKeyRequestByState(wantedStates: number[]): Promise<null | OutgoingRoomKeyRequest>
Look for room key requests by state

Returns
resolves to the a module:crypto/store/base~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.
Parameters
- wantedStates: number[]
  
  list of acceptable states
Returns Promise<null | OutgoingRoomKeyRequest>
Implementation of CryptoStore.getOutgoingRoomKeyRequestByState
- Defined in src/crypto/store/indexeddb-crypto-store.ts:243

getOutgoingRoomKeyRequestsByTarget

getOutgoingRoomKeyRequestsByTarget(userId: string, deviceId: string, wantedStates: number[]): Promise<OutgoingRoomKeyRequest[]>
Look for room key requests by target device and state

Returns
resolves to a list of all the module:crypto/store/base~OutgoingRoomKeyRequest
Parameters
- userId: string
  
  Target user ID
- deviceId: string
  
  Target device ID
- wantedStates: number[]
  
  list of acceptable states
Returns Promise<OutgoingRoomKeyRequest[]>
Implementation of CryptoStore.getOutgoingRoomKeyRequestsByTarget
- Defined in src/crypto/store/indexeddb-crypto-store.ts:268

getSecretStorePrivateKey

getSecretStorePrivateKey<K>(txn: IDBTransaction, func: ((key: null | SecretStorePrivateKeys[K]) => void), type: K): 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: null | SecretStorePrivateKeys[K]): 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:360

getSessionsNeedingBackup

getSessionsNeedingBackup(limit: number): Promise<ISession[]>
Get the inbound group sessions that need to be backed up.

Returns
resolves to an array of inbound group sessions
Parameters
- limit: number
  
  The maximum number of sessions to retrieve. 0 for no limit.
Returns Promise<ISession[]>
Implementation of CryptoStore.getSessionsNeedingBackup
- Defined in src/crypto/store/indexeddb-crypto-store.ts:618

getSharedHistoryInboundGroupSessions

getSharedHistoryInboundGroupSessions(roomId: string, txn?: IDBTransaction): Promise<[senderKey: string, sessionId: string][]>
Get the shared-history group session for a room.

Returns
Resolves to an array of [senderKey, sessionId]
Parameters
- roomId: string
  
  The room that the key belongs to
- Optional txn: IDBTransaction
  
  An active transaction. See doTxn(). (optional)
Returns Promise<[senderKey: string, sessionId: string][]>
Implementation of CryptoStore.getSharedHistoryInboundGroupSessions
- Defined in src/crypto/store/indexeddb-crypto-store.ts:673

markSessionsNeedingBackup

markSessionsNeedingBackup(sessions: ISession[], txn?: IDBTransaction): Promise<void>
Mark sessions as needing to be backed up.

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

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
resolves to either an IndexedDBCryptoStoreBackend.Backend, or a MemoryCryptoStore

Returns Promise<CryptoStore>
Implementation of CryptoStore.startup
- Defined in src/crypto/store/indexeddb-crypto-store.ts:87

storeAccount

storeAccount(txn: IDBTransaction, accountPickle: string): 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:336

storeCrossSigningKeys

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

storeEndToEndDeviceData

storeEndToEndDeviceData(deviceData: IDeviceData, txn: IDBTransaction): 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:574

storeEndToEndInboundGroupSession

storeEndToEndInboundGroupSession(senderCurve25519Key: string, sessionId: string, sessionData: InboundGroupSessionData, txn: IDBTransaction): 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:544

storeEndToEndInboundGroupSessionWithheld

storeEndToEndInboundGroupSessionWithheld(senderCurve25519Key: string, sessionId: string, sessionData: IWithheld, txn: IDBTransaction): 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:553

storeEndToEndRoom

storeEndToEndRoom(roomId: string, roomInfo: IRoomEncryption, txn: IDBTransaction): 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:597

storeEndToEndSession

storeEndToEndSession(deviceKey: string, sessionId: string, sessionInfo: ISessionInfo, txn: IDBTransaction): 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:462

storeEndToEndSessionProblem

storeEndToEndSessionProblem(deviceKey: string, type: string, fixed: boolean): 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:471

storeSecretStorePrivateKey

storeSecretStorePrivateKey<K>(txn: IDBTransaction, type: K, key: SecretStorePrivateKeys[K]): 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:385

takeParkedSharedHistory

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

unmarkSessionsNeedingBackup

unmarkSessionsNeedingBackup(sessions: ISession[], txn?: IDBTransaction): Promise<void>
Unmark sessions as needing to be backed up.

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

updateOutgoingRoomKeyRequest

updateOutgoingRoomKeyRequest(requestId: string, expectedState: number, updates: Partial<OutgoingRoomKeyRequest>): Promise<null | OutgoingRoomKeyRequest>
Look for an existing room key request by id and state, and update it if found

Returns
resolves to module:crypto/store/base~OutgoingRoomKeyRequest updated request, or null if no matching row was 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>
Implementation of CryptoStore.updateOutgoingRoomKeyRequest
- Defined in src/crypto/store/indexeddb-crypto-store.ts:290

`Static` exists

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

Class IndexedDBCryptoStore

Implements

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

indexedDB: IDBFactory

dbName: string

Returns IndexedDBCryptoStore

Properties

Private Optional backend

Private Optional backendPromise

Private Readonly dbName

Private Readonly indexedDB

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

Methods

addEndToEndInboundGroupSession

Parameters

senderCurve25519Key: string

sessionId: string

sessionData: InboundGroupSessionData

txn: IDBTransaction

Returns void

addParkedSharedHistory

Parameters

roomId: string

parkedData: ParkedSharedHistory

Optional txn: IDBTransaction

Returns void

addSharedHistoryInboundGroupSession

Parameters

roomId: string

senderKey: string

sessionId: string

Optional txn: IDBTransaction

Returns void

countEndToEndSessions

Parameters

txn: IDBTransaction

func: ((count: number) => void)

Parameters

count: number

Returns void

Returns void

countSessionsNeedingBackup

Returns

Parameters

Optional txn: IDBTransaction

Returns Promise<number>

deleteAllData

Returns

Returns Promise<void>

deleteOutgoingRoomKeyRequest

Returns

Parameters

requestId: string

expectedState: number

Returns Promise<null | OutgoingRoomKeyRequest>

doTxn

Returns

Type Parameters

T

Parameters

mode: Mode

stores: Iterable<string>

func: ((txn: IDBTransaction) => T)

Parameters

`Private` `Optional` backend

`Private` `Optional` backendPromise

`Private` `Readonly` dbName

`Private` `Readonly` indexedDB

`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

`Optional` txn: IDBTransaction

`Optional` txn: IDBTransaction

`Optional` txn: IDBTransaction

`Optional` log: PrefixedLogger