Class MemoryCryptoStore

Internal module. in-memory storage for e2e.

Hierarchy (View Summary)

MemoryCryptoStore
- LocalStorageCryptoStore

Implements

CryptoStore

Index

Constructors

constructor

Methods

Constructors

constructor

new MemoryCryptoStore(): MemoryCryptoStore
Returns MemoryCryptoStore

Methods

addEndToEndInboundGroupSession

addEndToEndInboundGroupSession(
    senderCurve25519Key: string,
    sessionId: string,
    sessionData: InboundGroupSessionData,
    txn: unknown,
): void
Parameters
- senderCurve25519Key: string
- sessionId: string
- sessionData: InboundGroupSessionData
- txn: unknown
Returns void
Implementation of CryptoStore.addEndToEndInboundGroupSession
- Defined in src/crypto/store/memory-crypto-store.ts:509

addParkedSharedHistory

addParkedSharedHistory(roomId: string, parkedData: ParkedSharedHistory): void
Parameters
- roomId: string
- parkedData: ParkedSharedHistory
Returns void
Implementation of CryptoStore.addParkedSharedHistory
- Defined in src/crypto/store/memory-crypto-store.ts:663

addSharedHistoryInboundGroupSession

addSharedHistoryInboundGroupSession(
    roomId: string,
    senderKey: string,
    sessionId: string,
): void
Parameters
- roomId: string
- senderKey: string
- sessionId: string
Returns void
Implementation of CryptoStore.addSharedHistoryInboundGroupSession
- Defined in src/crypto/store/memory-crypto-store.ts:653

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/memory-crypto-store.ts:81

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/memory-crypto-store.ts:548

countEndToEndSessions

countEndToEndSessions(txn: unknown, func: (count: number) => void): void
Parameters
- txn: unknown
- func: (count: number) => void
Returns void
Implementation of CryptoStore.countEndToEndSessions
- Defined in src/crypto/store/memory-crypto-store.ts:349

countSessionsNeedingBackup

countSessionsNeedingBackup(): Promise<number>
Returns Promise<number>
Implementation of CryptoStore.countSessionsNeedingBackup
- Defined in src/crypto/store/memory-crypto-store.ts:633

deleteAllData

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

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

deleteEndToEndInboundGroupSessionsBatch

deleteEndToEndInboundGroupSessionsBatch(
sessions: { senderKey: string; sessionId: string }[],
): 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/memory-crypto-store.ts:588

deleteEndToEndSessionsBatch

deleteEndToEndSessionsBatch(
sessions: { deviceKey: string; sessionId: string }[],
): 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/memory-crypto-store.ts:476

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
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/memory-crypto-store.ts:289

doTxn

doTxn<T>(
    mode: Mode,
    stores: Iterable<string, any, any>,
    func: (txn?: unknown) => T,
): Promise<T>
Type Parameters
- T
Parameters
- mode: Mode
- stores: Iterable<string, any, any>
- func: (txn?: unknown) => T
Returns Promise<T>
Implementation of CryptoStore.doTxn
- Defined in src/crypto/store/memory-crypto-store.ts:677

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/memory-crypto-store.ts:422

getAccount

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

getAllEndToEndInboundGroupSessions

getAllEndToEndInboundGroupSessions(
txn: unknown,
func: (session: null | ISession) => void,
): void
Parameters
- txn: unknown
- func: (session: null | ISession) => void
Returns void
Implementation of CryptoStore.getAllEndToEndInboundGroupSessions
- Defined in src/crypto/store/memory-crypto-store.ts:499

getAllEndToEndSessions

getAllEndToEndSessions(
txn: unknown,
func: (session: ISessionInfo) => void,
): void
Parameters
- txn: unknown
- func: (session: ISessionInfo) => void
Returns void
Implementation of CryptoStore.getAllEndToEndSessions
- Defined in src/crypto/store/memory-crypto-store.ts:375

getAllOutgoingRoomKeyRequestsByState

getAllOutgoingRoomKeyRequestsByState(
wantedState: number,
): Promise<OutgoingRoomKeyRequest[]>
Parameters
- wantedState: number
Returns Promise<OutgoingRoomKeyRequest[]>
All OutgoingRoomKeyRequests in state
Implementation of CryptoStore.getAllOutgoingRoomKeyRequestsByState
- Defined in src/crypto/store/memory-crypto-store.ts:220

getCrossSigningKeys

getCrossSigningKeys(
txn: unknown,
func: (keys: null | Record<string, CrossSigningKeyInfo>) => void,
): void
Parameters
- txn: unknown
- func: (keys: null | Record<string, CrossSigningKeyInfo>) => void
Returns void
Implementation of CryptoStore.getCrossSigningKeys
- Defined in src/crypto/store/memory-crypto-store.ts:322

getEndToEndDeviceData

getEndToEndDeviceData(
txn: unknown,
func: (deviceData: null | IDeviceData) => void,
): void
Parameters
- txn: unknown
- func: (deviceData: null | IDeviceData) => void
Returns void
Implementation of CryptoStore.getEndToEndDeviceData
- Defined in src/crypto/store/memory-crypto-store.ts:599

getEndToEndInboundGroupSession

getEndToEndInboundGroupSession(
    senderCurve25519Key: string,
    sessionId: string,
    txn: unknown,
    func: (
        groupSession: null | InboundGroupSessionData,
        groupSessionWithheld: null | IWithheld,
    ) => void,
): void
Parameters
- senderCurve25519Key: string
- sessionId: string
- txn: unknown
- func: (
  groupSession: null | InboundGroupSessionData,
  groupSessionWithheld: null | IWithheld,
  ) => void
Returns void
Implementation of CryptoStore.getEndToEndInboundGroupSession
- Defined in src/crypto/store/memory-crypto-store.ts:489

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/memory-crypto-store.ts:559

getEndToEndRooms

getEndToEndRooms(
txn: unknown,
func: (rooms: Record<string, IRoomEncryption>) => void,
): void
Parameters
- txn: unknown
- func: (rooms: Record<string, IRoomEncryption>) => void
Returns void
Implementation of CryptoStore.getEndToEndRooms
- Defined in src/crypto/store/memory-crypto-store.ts:613

getEndToEndSession

getEndToEndSession(
    deviceKey: string,
    sessionId: string,
    txn: unknown,
    func: (session: ISessionInfo) => void,
): void
Parameters
- deviceKey: string
- sessionId: string
- txn: unknown
- func: (session: ISessionInfo) => void
Returns void
Implementation of CryptoStore.getEndToEndSession
- Defined in src/crypto/store/memory-crypto-store.ts:357

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/memory-crypto-store.ts:404

getEndToEndSessions

getEndToEndSessions(
    deviceKey: string,
    txn: unknown,
    func: (sessions: { [sessionId: string]: ISessionInfo }) => void,
): void
Parameters
- deviceKey: string
- txn: unknown
- func: (sessions: { [sessionId: string]: ISessionInfo }) => void
Returns void
Implementation of CryptoStore.getEndToEndSessions
- Defined in src/crypto/store/memory-crypto-store.ts:367

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/memory-crypto-store.ts:449

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/memory-crypto-store.ts:114

getOrAddOutgoingRoomKeyRequest

getOrAddOutgoingRoomKeyRequest(
request: OutgoingRoomKeyRequest,
): 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/memory-crypto-store.ts:138

getOutgoingRoomKeyRequest

getOutgoingRoomKeyRequest(
requestBody: IRoomKeyRequestBody,
): 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/memory-crypto-store.ts:172

getOutgoingRoomKeyRequestByState

getOutgoingRoomKeyRequestByState(
wantedStates: number[],
): 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
Implementation of CryptoStore.getOutgoingRoomKeyRequestByState
- Defined in src/crypto/store/memory-crypto-store.ts:205

getOutgoingRoomKeyRequestsByTarget

getOutgoingRoomKeyRequestsByTarget(
    userId: string,
    deviceId: string,
    wantedStates: number[],
): Promise<OutgoingRoomKeyRequest[]>
Parameters
- userId: string
- deviceId: string
- wantedStates: number[]
Returns Promise<OutgoingRoomKeyRequest[]>
Implementation of CryptoStore.getOutgoingRoomKeyRequestsByTarget
- Defined in src/crypto/store/memory-crypto-store.ts:224

getSecretStorePrivateKey

getSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(
    txn: unknown,
    func: (key: null | SecretStorePrivateKeys[K]) => void,
    type: K,
): void
Type Parameters
- K extends keyof SecretStorePrivateKeys
Parameters
- txn: unknown
- func: (key: null | SecretStorePrivateKeys[K]) => void
- type: K
Returns void
Implementation of CryptoStore.getSecretStorePrivateKey
- Defined in src/crypto/store/memory-crypto-store.ts:326

getSessionsNeedingBackup

getSessionsNeedingBackup(limit: number): Promise<ISession[]>
Parameters
- limit: number
Returns Promise<ISession[]>
Implementation of CryptoStore.getSessionsNeedingBackup
- Defined in src/crypto/store/memory-crypto-store.ts:617

getSharedHistoryInboundGroupSessions

getSharedHistoryInboundGroupSessions(
roomId: string,
): Promise<[senderKey: string, sessionId: string][]>
Parameters
- roomId: string
Returns Promise<[senderKey: string, sessionId: string][]>
Implementation of CryptoStore.getSharedHistoryInboundGroupSessions
- Defined in src/crypto/store/memory-crypto-store.ts:659

markSessionsNeedingBackup

markSessionsNeedingBackup(sessions: ISession[]): Promise<void>
Parameters
- sessions: ISession[]
Returns Promise<void>
Implementation of CryptoStore.markSessionsNeedingBackup
- Defined in src/crypto/store/memory-crypto-store.ts:645

setMigrationState

setMigrationState(migrationState: 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/memory-crypto-store.ts:125

startup

startup(): Promise<CryptoStore>
Ensure the database exists and is up-to-date.

This must be called before the store can be used.

Returns Promise<CryptoStore>
resolves to the store.
Implementation of CryptoStore.startup
- Defined in src/crypto/store/memory-crypto-store.ts:93

storeAccount

storeAccount(txn: unknown, accountPickle: string): void
Parameters
- txn: unknown
- accountPickle: string
Returns void
Implementation of CryptoStore.storeAccount
- Defined in src/crypto/store/memory-crypto-store.ts:318

storeCrossSigningKeys

storeCrossSigningKeys(
txn: unknown,
keys: Record<string, CrossSigningKeyInfo>,
): void
Parameters
- txn: unknown
- keys: Record<string, CrossSigningKeyInfo>
Returns void
Implementation of CryptoStore.storeCrossSigningKeys
- Defined in src/crypto/store/memory-crypto-store.ts:335

storeEndToEndDeviceData

storeEndToEndDeviceData(deviceData: IDeviceData, txn: unknown): void
Parameters
- deviceData: IDeviceData
- txn: unknown
Returns void
Implementation of CryptoStore.storeEndToEndDeviceData
- Defined in src/crypto/store/memory-crypto-store.ts:603

storeEndToEndInboundGroupSession

storeEndToEndInboundGroupSession(
    senderCurve25519Key: string,
    sessionId: string,
    sessionData: InboundGroupSessionData,
    txn: unknown,
): void
Parameters
- senderCurve25519Key: string
- sessionId: string
- sessionData: InboundGroupSessionData
- txn: unknown
Returns void
Implementation of CryptoStore.storeEndToEndInboundGroupSession
- Defined in src/crypto/store/memory-crypto-store.ts:521

storeEndToEndInboundGroupSessionWithheld

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

storeEndToEndRoom

storeEndToEndRoom(roomId: string, roomInfo: IRoomEncryption, txn: unknown): void
Parameters
- roomId: string
- roomInfo: IRoomEncryption
- txn: unknown
Returns void
Implementation of CryptoStore.storeEndToEndRoom
- Defined in src/crypto/store/memory-crypto-store.ts:609

storeEndToEndSession

storeEndToEndSession(
    deviceKey: string,
    sessionId: string,
    sessionInfo: ISessionInfo,
    txn: unknown,
): void
Parameters
- deviceKey: string
- sessionId: string
- sessionInfo: ISessionInfo
- txn: unknown
Returns void
Implementation of CryptoStore.storeEndToEndSession
- Defined in src/crypto/store/memory-crypto-store.ts:387

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/memory-crypto-store.ts:396

storeSecretStorePrivateKey

storeSecretStorePrivateKey<K extends keyof SecretStorePrivateKeys>(
    txn: unknown,
    type: K,
    key: SecretStorePrivateKeys[K],
): void
Type Parameters
- K extends keyof SecretStorePrivateKeys
Parameters
- txn: unknown
- type: K
- key: SecretStorePrivateKeys[K]
Returns void
Implementation of CryptoStore.storeSecretStorePrivateKey
- Defined in src/crypto/store/memory-crypto-store.ts:339

takeParkedSharedHistory

takeParkedSharedHistory(roomId: string): Promise<ParkedSharedHistory[]>
Parameters
- roomId: string
Returns Promise<ParkedSharedHistory[]>
Implementation of CryptoStore.takeParkedSharedHistory
- Defined in src/crypto/store/memory-crypto-store.ts:669

unmarkSessionsNeedingBackup

unmarkSessionsNeedingBackup(sessions: ISession[]): Promise<void>
Parameters
- sessions: ISession[]
Returns Promise<void>
Implementation of CryptoStore.unmarkSessionsNeedingBackup
- Defined in src/crypto/store/memory-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
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/memory-crypto-store.ts:256

Class MemoryCryptoStore

Hierarchy (View Summary)

Implements

Index

Constructors

Methods

Constructors

constructor

Returns MemoryCryptoStore

Methods

addEndToEndInboundGroupSession

Parameters

Returns void

addParkedSharedHistory

Parameters

Returns void

addSharedHistoryInboundGroupSession

Parameters

Returns void

containsData

Returns Promise<boolean>

countEndToEndInboundGroupSessions

Returns Promise<number>

countEndToEndSessions

Parameters

Returns void

countSessionsNeedingBackup

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

Returns Promise<T>

filterOutNotifiedErrorDevices

Parameters

Returns Promise<IOlmDevice<DeviceInfo>[]>

getAccount

Parameters

Returns void

getAllEndToEndInboundGroupSessions

Parameters

Returns void

getAllEndToEndSessions

Parameters

Returns void

getAllOutgoingRoomKeyRequestsByState

Parameters

Returns Promise<OutgoingRoomKeyRequest[]>

getCrossSigningKeys

Parameters

Returns void

getEndToEndDeviceData

Parameters

Returns void

getEndToEndInboundGroupSession

Parameters

Returns void

getEndToEndInboundGroupSessionsBatch

Returns Promise<null | SessionExtended[]>

getEndToEndRooms

Parameters

Returns void

getEndToEndSession

Parameters

Returns void

getEndToEndSessionProblem

Parameters

Returns Promise<null | IProblem>

getEndToEndSessions

Parameters