Interface CryptoStore

Abstraction of things that can store data required for end-to-end encryption

interface CryptoStore {
    addEndToEndInboundGroupSession(senderCurve25519Key: string, sessionId: string, sessionData: InboundGroupSessionData, txn: unknown): void;
    addParkedSharedHistory(roomId: string, data: ParkedSharedHistory, txn?: unknown): void;
    addSharedHistoryInboundGroupSession(roomId: string, senderKey: string, sessionId: string, txn?: unknown): void;
    containsData(): Promise<boolean>;
    countEndToEndInboundGroupSessions(): Promise<number>;
    countEndToEndSessions(txn: unknown, func: ((count: number) => void)): void;
    countSessionsNeedingBackup(txn?: unknown): Promise<number>;
    deleteAllData(): Promise<void>;
    deleteEndToEndInboundGroupSessionsBatch(sessions: {
        senderKey: string;
        sessionId: string;
    }[]): Promise<void>;
    deleteEndToEndSessionsBatch(sessions: {
        deviceKey?: string;
        sessionId?: string;
    }[]): Promise<void>;
    deleteOutgoingRoomKeyRequest(requestId: string, expectedState: number): Promise<null | OutgoingRoomKeyRequest>;
    doTxn<T>(mode: Mode, stores: Iterable<string, any, any>, func: ((txn: unknown) => T), log?: Logger): Promise<T>;
    filterOutNotifiedErrorDevices(devices: IOlmDevice<DeviceInfo>[]): Promise<IOlmDevice<DeviceInfo>[]>;
    getAccount(txn: unknown, func: ((accountPickle: null | string) => void)): void;
    getAllEndToEndInboundGroupSessions(txn: unknown, func: ((session: null | ISession) => void)): void;
    getAllEndToEndSessions(txn: unknown, func: ((session: null | ISessionInfo) => void)): void;
    getAllOutgoingRoomKeyRequestsByState(wantedState: number): Promise<OutgoingRoomKeyRequest[]>;
    getCrossSigningKeys(txn: unknown, func: ((keys: null | Record<string, CrossSigningKeyInfo>) => void)): void;
    getEndToEndDeviceData(txn: unknown, func: ((deviceData: null | IDeviceData) => void)): void;
    getEndToEndInboundGroupSession(senderCurve25519Key: string, sessionId: string, txn: unknown, func: ((groupSession: null | InboundGroupSessionData, groupSessionWithheld: null | IWithheld) => void)): void;
    getEndToEndInboundGroupSessionsBatch(): Promise<null | SessionExtended[]>;
    getEndToEndRooms(txn: unknown, func: ((rooms: Record<string, IRoomEncryption>) => void)): void;
    getEndToEndSession(deviceKey: string, sessionId: string, txn: unknown, func: ((session: null | ISessionInfo) => void)): void;
    getEndToEndSessionProblem(deviceKey: string, timestamp: number): Promise<null | IProblem>;
    getEndToEndSessions(deviceKey: string, txn: unknown, func: ((sessions: {
        [sessionId: string]: ISessionInfo;
    }) => void)): void;
    getEndToEndSessionsBatch(): Promise<null | ISessionInfo[]>;
    getMigrationState(): Promise<MigrationState>;
    getOrAddOutgoingRoomKeyRequest(request: OutgoingRoomKeyRequest): Promise<OutgoingRoomKeyRequest>;
    getOutgoingRoomKeyRequest(requestBody: IRoomKeyRequestBody): Promise<null | OutgoingRoomKeyRequest>;
    getOutgoingRoomKeyRequestByState(wantedStates: number[]): Promise<null | OutgoingRoomKeyRequest>;
    getOutgoingRoomKeyRequestsByTarget(userId: string, deviceId: string, wantedStates: number[]): Promise<OutgoingRoomKeyRequest[]>;
    getSecretStorePrivateKey<K>(txn: unknown, func: ((key: null | SecretStorePrivateKeys[K]) => void), type: K): void;
    getSessionsNeedingBackup(limit: number): Promise<ISession[]>;
    getSharedHistoryInboundGroupSessions(roomId: string, txn?: unknown): Promise<[senderKey: string, sessionId: string][]>;
    markSessionsNeedingBackup(sessions: ISession[], txn?: unknown): Promise<void>;
    setMigrationState(migrationState: MigrationState): Promise<void>;
    startup(): Promise<CryptoStore>;
    storeAccount(txn: unknown, accountPickle: string): void;
    storeCrossSigningKeys(txn: unknown, keys: Record<string, CrossSigningKeyInfo>): void;
    storeEndToEndDeviceData(deviceData: IDeviceData, txn: unknown): void;
    storeEndToEndInboundGroupSession(senderCurve25519Key: string, sessionId: string, sessionData: InboundGroupSessionData, txn: unknown): void;
    storeEndToEndInboundGroupSessionWithheld(senderCurve25519Key: string, sessionId: string, sessionData: IWithheld, txn: unknown): void;
    storeEndToEndRoom(roomId: string, roomInfo: IRoomEncryption, txn: unknown): void;
    storeEndToEndSession(deviceKey: string, sessionId: string, sessionInfo: ISessionInfo, txn: unknown): void;
    storeEndToEndSessionProblem(deviceKey: string, type: string, fixed: boolean): Promise<void>;
    storeSecretStorePrivateKey<K>(txn: unknown, type: K, key: SecretStorePrivateKeys[K]): void;
    takeParkedSharedHistory(roomId: string, txn?: unknown): Promise<ParkedSharedHistory[]>;
    unmarkSessionsNeedingBackup(sessions: ISession[], txn?: unknown): Promise<void>;
    updateOutgoingRoomKeyRequest(requestId: string, expectedState: number, updates: Partial<OutgoingRoomKeyRequest>): Promise<null | OutgoingRoomKeyRequest>;
}

Implemented by

Index

Methods

Methods

addEndToEndInboundGroupSession

addEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn): void
Parameters
- senderCurve25519Key: string
- sessionId: string
- sessionData: InboundGroupSessionData
- txn: unknown
Returns void
- Defined in src/crypto/store/base.ts:160

addParkedSharedHistory

addParkedSharedHistory(roomId, data, txn?): void
Parameters
- roomId: string
- data: ParkedSharedHistory
- Optionaltxn: unknown
Returns void
- Defined in src/crypto/store/base.ts:217

addSharedHistoryInboundGroupSession

addSharedHistoryInboundGroupSession(roomId, senderKey, sessionId, txn?): void
Parameters
- roomId: string
- senderKey: string
- sessionId: string
- Optionaltxn: unknown
Returns void
- Defined in src/crypto/store/base.ts:212

containsData

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

Unlike the rest of the methods in this interface, can be called before CryptoStore#startup.

Returns Promise<boolean>
- Defined in src/crypto/store/base.ts:56

countEndToEndInboundGroupSessions

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

Returns Promise<number>
- Defined in src/crypto/store/base.ts:184

countEndToEndSessions

countEndToEndSessions(txn, func): void
Parameters
- txn: unknown
- func: ((count: number) => void)
  - - (count): void
    - Parameters
      count: number
      Returns void
Returns void
- Defined in src/crypto/store/base.ts:117

countSessionsNeedingBackup

countSessionsNeedingBackup(txn?): Promise<number>
Parameters
- Optionaltxn: unknown
Returns Promise<number>
- Defined in src/crypto/store/base.ts:209

deleteAllData

deleteAllData(): Promise<void>
Returns Promise<void>
- Defined in src/crypto/store/base.ts:68

deleteEndToEndInboundGroupSessionsBatch

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

Any sessions in the list which are not found are silently ignored.
Parameters
- sessions: {
  senderKey: string;
  sessionId: string;
  }[]
Returns Promise<void>
- Defined in src/crypto/store/base.ts:201

deleteEndToEndSessionsBatch

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

Any sessions in the list which are not found are silently ignored.
Parameters
- sessions: {
  deviceKey?: string;
  sessionId?: string;
  }[]
Returns Promise<void>
- Defined in src/crypto/store/base.ts:150

deleteOutgoingRoomKeyRequest

deleteOutgoingRoomKeyRequest(requestId, expectedState): Promise<null | OutgoingRoomKeyRequest>
Parameters
- requestId: string
- expectedState: number
Returns Promise<null | OutgoingRoomKeyRequest>
- Defined in src/crypto/store/base.ts:98

doTxn

doTxn<T>(mode, stores, func, log?): Promise<T>
Type Parameters
- T
Parameters
- mode: Mode
- stores: Iterable<string, any, any>
- func: ((txn: unknown) => T)
  - - (txn): T
    - Parameters
      txn: unknown
      Returns T
- Optionallog: Logger
Returns Promise<T>
- Defined in src/crypto/store/base.ts:221

filterOutNotifiedErrorDevices

filterOutNotifiedErrorDevices(devices): Promise<IOlmDevice<DeviceInfo>[]>
Parameters
- devices: IOlmDevice<DeviceInfo>[]
Returns Promise<IOlmDevice<DeviceInfo>[]>
- Defined in src/crypto/store/base.ts:133

getAccount

getAccount(txn, func): void
Parameters
- txn: unknown
- func: ((accountPickle: null | string) => void)
  - - (accountPickle): void
    - Parameters
      accountPickle: null | string
      Returns void
Returns void
- Defined in src/crypto/store/base.ts:101

getAllEndToEndInboundGroupSessions

getAllEndToEndInboundGroupSessions(txn, func): void
Parameters
- txn: unknown
- func: ((session: null | ISession) => void)
  - - (session): void
    - Parameters
      session: null | ISession
      Returns void
Returns void
- Defined in src/crypto/store/base.ts:159

getAllEndToEndSessions

getAllEndToEndSessions(txn, func): void
Parameters
- txn: unknown
- func: ((session: null | ISessionInfo) => void)
  - - (session): void
    - Parameters
      session: null | ISessionInfo
      Returns void
Returns void
- Defined in src/crypto/store/base.ts:129

getAllOutgoingRoomKeyRequestsByState

getAllOutgoingRoomKeyRequestsByState(wantedState): Promise<OutgoingRoomKeyRequest[]>
Parameters
- wantedState: number
Returns Promise<OutgoingRoomKeyRequest[]>
- Defined in src/crypto/store/base.ts:87

getCrossSigningKeys

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

getEndToEndDeviceData

getEndToEndDeviceData(txn, func): void
Parameters
- txn: unknown
- func: ((deviceData: null | IDeviceData) => void)
  - - (deviceData): void
    - Parameters
      deviceData: null | IDeviceData
      Returns void
Returns void
- Defined in src/crypto/store/base.ts:204

getEndToEndInboundGroupSession

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

getEndToEndInboundGroupSessionsBatch

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

Returns Promise<null | SessionExtended[]>
A batch of Megolm Sessions, or null if no sessions are left.
- Defined in src/crypto/store/base.ts:192

getEndToEndRooms

getEndToEndRooms(txn, func): void
Parameters
- txn: unknown
- func: ((rooms: Record<string, IRoomEncryption>) => void)
  - - (rooms): void
    - Parameters
      rooms: Record<string, IRoomEncryption>
      Returns void
Returns void
- Defined in src/crypto/store/base.ts:207

getEndToEndSession

getEndToEndSession(deviceKey, sessionId, txn, func): void
Parameters
- deviceKey: string
- sessionId: string
- txn: unknown
- func: ((session: null | ISessionInfo) => void)
  - - (session): void
    - Parameters
      session: null | ISessionInfo
      Returns void
Returns void
- Defined in src/crypto/store/base.ts:118

getEndToEndSessionProblem

getEndToEndSessionProblem(deviceKey, timestamp): Promise<null | IProblem>
Parameters
- deviceKey: string
- timestamp: number
Returns Promise<null | IProblem>
- Defined in src/crypto/store/base.ts:132

getEndToEndSessions

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

getEndToEndSessionsBatch

getEndToEndSessionsBatch(): Promise<null | ISessionInfo[]>
Internal
Get a batch of end-to-end sessions from the database.

Returns Promise<null | ISessionInfo[]>
A batch of Olm Sessions, or null if no sessions are left.
- Defined in src/crypto/store/base.ts:141

getMigrationState

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

Returns Promise<MigrationState>
- Defined in src/crypto/store/base.ts:75

getOrAddOutgoingRoomKeyRequest

getOrAddOutgoingRoomKeyRequest(request): Promise<OutgoingRoomKeyRequest>
Parameters
- request: OutgoingRoomKeyRequest
Returns Promise<OutgoingRoomKeyRequest>
- Defined in src/crypto/store/base.ts:84

getOutgoingRoomKeyRequest

getOutgoingRoomKeyRequest(requestBody): Promise<null | OutgoingRoomKeyRequest>
Parameters
- requestBody: IRoomKeyRequestBody
Returns Promise<null | OutgoingRoomKeyRequest>
- Defined in src/crypto/store/base.ts:85

getOutgoingRoomKeyRequestByState

getOutgoingRoomKeyRequestByState(wantedStates): Promise<null | OutgoingRoomKeyRequest>
Parameters
- wantedStates: number[]
Returns Promise<null | OutgoingRoomKeyRequest>
- Defined in src/crypto/store/base.ts:86

getOutgoingRoomKeyRequestsByTarget

getOutgoingRoomKeyRequestsByTarget(userId, deviceId, wantedStates): Promise<OutgoingRoomKeyRequest[]>
Parameters
- userId: string
- deviceId: string
- wantedStates: number[]
Returns Promise<OutgoingRoomKeyRequest[]>
- Defined in src/crypto/store/base.ts:88

getSecretStorePrivateKey

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

getSessionsNeedingBackup

getSessionsNeedingBackup(limit): Promise<ISession[]>
Parameters
- limit: number
Returns Promise<ISession[]>
- Defined in src/crypto/store/base.ts:208

getSharedHistoryInboundGroupSessions

getSharedHistoryInboundGroupSessions(roomId, txn?): Promise<[senderKey: string, sessionId: string][]>
Parameters
- roomId: string
- Optionaltxn: unknown
Returns Promise<[senderKey: string, sessionId: string][]>
- Defined in src/crypto/store/base.ts:213

markSessionsNeedingBackup

markSessionsNeedingBackup(sessions, txn?): Promise<void>
Parameters
- sessions: ISession[]
- Optionaltxn: unknown
Returns Promise<void>
- Defined in src/crypto/store/base.ts:211

setMigrationState

setMigrationState(migrationState): Promise<void>
Internal
Set data on how much of the libolm to Rust Crypto migration has been done.
Parameters
- migrationState: MigrationState
Returns Promise<void>
- Defined in src/crypto/store/base.ts:82

startup

startup(): Promise<CryptoStore>
Initialise this crypto store.

Typically, this involves provisioning storage, and migrating any existing data to the current version of the storage schema where appropriate.

Must be called before any of the rest of the methods in this interface.

Returns Promise<CryptoStore>
- Defined in src/crypto/store/base.ts:66

storeAccount

storeAccount(txn, accountPickle): void
Parameters
- txn: unknown
- accountPickle: string
Returns void
- Defined in src/crypto/store/base.ts:102

storeCrossSigningKeys

storeCrossSigningKeys(txn, keys): void
Parameters
- txn: unknown
- keys: Record<string, CrossSigningKeyInfo>
Returns void
- Defined in src/crypto/store/base.ts:109

storeEndToEndDeviceData

storeEndToEndDeviceData(deviceData, txn): void
Parameters
- deviceData: IDeviceData
- txn: unknown
Returns void
- Defined in src/crypto/store/base.ts:205

storeEndToEndInboundGroupSession

storeEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn): void
Parameters
- senderCurve25519Key: string
- sessionId: string
- sessionData: InboundGroupSessionData
- txn: unknown
Returns void
- Defined in src/crypto/store/base.ts:166

storeEndToEndInboundGroupSessionWithheld

storeEndToEndInboundGroupSessionWithheld(senderCurve25519Key, sessionId, sessionData, txn): void
Parameters
- senderCurve25519Key: string
- sessionId: string
- sessionData: IWithheld
- txn: unknown
Returns void
- Defined in src/crypto/store/base.ts:172

storeEndToEndRoom

storeEndToEndRoom(roomId, roomInfo, txn): void
Parameters
- roomId: string
- roomInfo: IRoomEncryption
- txn: unknown
Returns void
- Defined in src/crypto/store/base.ts:206

storeEndToEndSession

storeEndToEndSession(deviceKey, sessionId, sessionInfo, txn): void
Parameters
- deviceKey: string
- sessionId: string
- sessionInfo: ISessionInfo
- txn: unknown
Returns void
- Defined in src/crypto/store/base.ts:130

storeEndToEndSessionProblem

storeEndToEndSessionProblem(deviceKey, type, fixed): Promise<void>
Parameters
- deviceKey: string
- type: string
- fixed: boolean
Returns Promise<void>
- Defined in src/crypto/store/base.ts:131

storeSecretStorePrivateKey

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

takeParkedSharedHistory

takeParkedSharedHistory(roomId, txn?): Promise<ParkedSharedHistory[]>
Parameters
- roomId: string
- Optionaltxn: unknown
Returns Promise<ParkedSharedHistory[]>
- Defined in src/crypto/store/base.ts:218

unmarkSessionsNeedingBackup

unmarkSessionsNeedingBackup(sessions, txn?): Promise<void>
Parameters
- sessions: ISession[]
- Optionaltxn: unknown
Returns Promise<void>
- Defined in src/crypto/store/base.ts:210

updateOutgoingRoomKeyRequest

updateOutgoingRoomKeyRequest(requestId, expectedState, updates): Promise<null | OutgoingRoomKeyRequest>
Parameters
- requestId: string
- expectedState: number
- updates: Partial<OutgoingRoomKeyRequest>
Returns Promise<null | OutgoingRoomKeyRequest>
- Defined in src/crypto/store/base.ts:93

Interface CryptoStore

Implemented by

Index

Methods

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[]>

getCrossSigningKeys

Parameters

Parameters

Returns void

Returns void

getEndToEndDeviceData

Parameters

Parameters

Returns void

Returns void

getEndToEndInboundGroupSession

Parameters

Parameters

Returns void

Returns void

getEndToEndInboundGroupSessionsBatch