Class MemoryCryptoStore

Internal module. in-memory storage for e2e.

Hierarchy (view full)

MemoryCryptoStore
- LocalStorageCryptoStore

Implements

CryptoStore

Index

Constructors

constructor

Properties

account crossSigningKeys deviceData inboundGroupSessions inboundGroupSessionsWithheld migrationState notifiedErrorDevices outgoingRoomKeyRequests parkedSharedHistory privateKeys rooms sessionProblems sessions sessionsNeedingBackup sharedHistoryInboundGroupSessions

Methods

Constructors

constructor

new MemoryCryptoStore(): MemoryCryptoStore
Returns MemoryCryptoStore

Properties

`Private` account

account: null | string = null

`Private` crossSigningKeys

crossSigningKeys: null | Record<string, CrossSigningKeyInfo> = null

`Private` deviceData

deviceData: null | IDeviceData = null

`Private` inboundGroupSessions

inboundGroupSessions: {
[sessionKey: string]: InboundGroupSessionData;
} = {}

Type declaration

[sessionKey: string]: InboundGroupSessionData

`Private` inboundGroupSessionsWithheld

inboundGroupSessionsWithheld: Record<string, IWithheld> = {}

`Private` migrationState

migrationState: MigrationState = MigrationState.NOT_STARTED

`Private` notifiedErrorDevices

notifiedErrorDevices: {
    [userId: string]: {
        [deviceId: string]: boolean;
    };
} = {}

Type declaration

[userId: string]: {
[deviceId: string]: boolean;
}
- [deviceId: string]: boolean

`Private` outgoingRoomKeyRequests

outgoingRoomKeyRequests: OutgoingRoomKeyRequest[] = []

`Private` parkedSharedHistory

parkedSharedHistory: Map<string, ParkedSharedHistory[]> = ...

`Private` privateKeys

privateKeys: Partial<SecretStorePrivateKeys> = {}

`Private` rooms

rooms: {
[roomId: string]: IRoomEncryption;
} = {}

Type declaration

[roomId: string]: IRoomEncryption

`Private` sessionProblems

sessionProblems: {
[deviceKey: string]: IProblem[];
} = {}

Type declaration

[deviceKey: string]: IProblem[]

`Private` sessions

sessions: {
    [deviceKey: string]: {
        [sessionId: string]: ISessionInfo;
    };
} = {}

Type declaration

[deviceKey: string]: {
[sessionId: string]: ISessionInfo;
}
- [sessionId: string]: ISessionInfo

`Private` sessionsNeedingBackup

sessionsNeedingBackup: {
[sessionKey: string]: boolean;
} = {}

Type declaration

[sessionKey: string]: boolean

`Private` sharedHistoryInboundGroupSessions

sharedHistoryInboundGroupSessions: {
[roomId: string]: [senderKey: string, sessionId: string][];
} = {}

Type declaration

[roomId: string]: [senderKey: string, sessionId: string][]

Methods

`Private` _getOutgoingRoomKeyRequest

_getOutgoingRoomKeyRequest(requestBody): null | OutgoingRoomKeyRequest
Internal
Looks for existing room key request, and returns the result synchronously.
Parameters
- requestBody: IRoomKeyRequestBody
  existing request to look for
Returns null | OutgoingRoomKeyRequest
the matching request, or null if not found
- Defined in src/crypto/store/memory-crypto-store.ts:176

addEndToEndInboundGroupSession

addEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn): 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:504

addParkedSharedHistory

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

addSharedHistoryInboundGroupSession

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

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:70

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:542

countEndToEndSessions

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

countSessionsNeedingBackup

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

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:92

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

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

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

doTxn

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

filterOutNotifiedErrorDevices

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

getAccount

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

getAllEndToEndInboundGroupSessions

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

getAllEndToEndSessions

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

getAllOutgoingRoomKeyRequestsByState

getAllOutgoingRoomKeyRequestsByState(wantedState): 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:209

getCrossSigningKeys

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

getEndToEndDeviceData

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

getEndToEndInboundGroupSession

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

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:553

getEndToEndRooms

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

getEndToEndSession

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

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

getEndToEndSessions

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

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:438

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:103

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

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

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
Implementation of CryptoStore.getOutgoingRoomKeyRequestByState
- Defined in src/crypto/store/memory-crypto-store.ts:194

getOutgoingRoomKeyRequestsByTarget

getOutgoingRoomKeyRequestsByTarget(userId, deviceId, wantedStates): 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:213

getSecretStorePrivateKey

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

getSessionsNeedingBackup

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

getSharedHistoryInboundGroupSessions

getSharedHistoryInboundGroupSessions(roomId): 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:655

markSessionsNeedingBackup

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

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

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:82

storeAccount

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

storeCrossSigningKeys

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

storeEndToEndDeviceData

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

storeEndToEndInboundGroupSession

storeEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn): 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:516

storeEndToEndInboundGroupSessionWithheld

storeEndToEndInboundGroupSessionWithheld(senderCurve25519Key, sessionId, sessionData, txn): 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:525

storeEndToEndRoom

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

storeEndToEndSession

storeEndToEndSession(deviceKey, sessionId, sessionInfo, txn): 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:376

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

storeSecretStorePrivateKey

storeSecretStorePrivateKey<K>(txn, type, key): 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:328

takeParkedSharedHistory

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

unmarkSessionsNeedingBackup

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

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

Class MemoryCryptoStore

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MemoryCryptoStore

Properties

Private account

Private crossSigningKeys

Private deviceData

Private inboundGroupSessions

Type declaration

[sessionKey: string]: InboundGroupSessionData

Private inboundGroupSessionsWithheld

Private migrationState

Private notifiedErrorDevices

Type declaration

[userId: string]: { [deviceId: string]: boolean; }

[deviceId: string]: boolean

Private outgoingRoomKeyRequests

Private parkedSharedHistory

Private privateKeys

Private rooms

Type declaration

[roomId: string]: IRoomEncryption

Private sessionProblems

Type declaration

[deviceKey: string]: IProblem[]

Private sessions

Type declaration

[deviceKey: string]: { [sessionId: string]: ISessionInfo; }

[sessionId: string]: ISessionInfo

Private sessionsNeedingBackup

Type declaration

[sessionKey: string]: boolean

Private sharedHistoryInboundGroupSessions

Type declaration

[roomId: string]: [senderKey: string, sessionId: string][]

Methods

Private _getOutgoingRoomKeyRequest

Parameters

Returns null | OutgoingRoomKeyRequest

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

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

`Private` account

`Private` crossSigningKeys

`Private` deviceData

`Private` inboundGroupSessions

`Private` inboundGroupSessionsWithheld

`Private` migrationState

`Private` notifiedErrorDevices

[userId: string]: {
[deviceId: string]: boolean;
}

`Private` outgoingRoomKeyRequests

`Private` parkedSharedHistory

`Private` privateKeys

`Private` rooms

`Private` sessionProblems

`Private` sessions

[deviceKey: string]: {
[sessionId: string]: ISessionInfo;
}

`Private` sessionsNeedingBackup

`Private` sharedHistoryInboundGroupSessions

`Private` _getOutgoingRoomKeyRequest