Interface CryptoStore

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

Hierarchy

CryptoStore

Implemented by

Index

Methods

addEndToEndInboundGroupSession addParkedSharedHistory addSharedHistoryInboundGroupSession countEndToEndSessions countSessionsNeedingBackup deleteAllData deleteOutgoingRoomKeyRequest doTxn filterOutNotifiedErrorDevices getAccount getAllEndToEndInboundGroupSessions getAllEndToEndSessions getAllOutgoingRoomKeyRequestsByState getCrossSigningKeys getEndToEndDeviceData getEndToEndInboundGroupSession getEndToEndRooms getEndToEndSession getEndToEndSessionProblem getEndToEndSessions getOrAddOutgoingRoomKeyRequest getOutgoingRoomKeyRequest getOutgoingRoomKeyRequestByState getOutgoingRoomKeyRequestsByTarget getSecretStorePrivateKey getSessionsNeedingBackup getSharedHistoryInboundGroupSessions markSessionsNeedingBackup startup storeAccount storeCrossSigningKeys storeEndToEndDeviceData storeEndToEndInboundGroupSession storeEndToEndInboundGroupSessionWithheld storeEndToEndRoom storeEndToEndSession storeEndToEndSessionProblem storeSecretStorePrivateKey takeParkedSharedHistory unmarkSessionsNeedingBackup updateOutgoingRoomKeyRequest

Methods

addEndToEndInboundGroupSession

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

addParkedSharedHistory

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

addSharedHistoryInboundGroupSession

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

countEndToEndSessions

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

countSessionsNeedingBackup

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

deleteAllData

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

deleteOutgoingRoomKeyRequest

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

doTxn

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

filterOutNotifiedErrorDevices

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

getAccount

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

getAllEndToEndInboundGroupSessions

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

getAllEndToEndSessions

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

getAllOutgoingRoomKeyRequestsByState

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

getCrossSigningKeys

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

getEndToEndDeviceData

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

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)
  - - (groupSession: null | InboundGroupSessionData, groupSessionWithheld: null | IWithheld): void
    - Parameters
      
      groupSession: null | InboundGroupSessionData
      
      groupSessionWithheld: null | IWithheld
      
      Returns void
Returns void
- Defined in src/crypto/store/base.ts:103

getEndToEndRooms

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

getEndToEndSession

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

getEndToEndSessionProblem

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

getEndToEndSessions

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

getOrAddOutgoingRoomKeyRequest

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

getOutgoingRoomKeyRequest

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

getOutgoingRoomKeyRequestByState

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

getOutgoingRoomKeyRequestsByTarget

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

getSecretStorePrivateKey

getSecretStorePrivateKey<K>(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)
  - - (key: null | SecretStorePrivateKeys[K]): void
    - Parameters
      
      key: null | SecretStorePrivateKeys[K]
      
      Returns void
- type: K
Returns void
- Defined in src/crypto/store/base.ts:71

getSessionsNeedingBackup

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

getSharedHistoryInboundGroupSessions

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

markSessionsNeedingBackup

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

startup

startup(): Promise<CryptoStore>
Returns Promise<CryptoStore>
- Defined in src/crypto/store/base.ts:49

storeAccount

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

storeCrossSigningKeys

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

storeEndToEndDeviceData

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

storeEndToEndInboundGroupSession

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

storeEndToEndInboundGroupSessionWithheld

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

storeEndToEndRoom

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

storeEndToEndSession

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

storeEndToEndSessionProblem

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

storeSecretStorePrivateKey

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

takeParkedSharedHistory

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

unmarkSessionsNeedingBackup

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

updateOutgoingRoomKeyRequest

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

Interface CryptoStore

Hierarchy

Implemented by

Index

Methods

Methods

addEndToEndInboundGroupSession

Parameters

senderCurve25519Key: string

sessionId: string

sessionData: InboundGroupSessionData

txn: unknown

Returns void

addParkedSharedHistory

Parameters

roomId: string

data: ParkedSharedHistory

Optional txn: unknown

Returns void

addSharedHistoryInboundGroupSession

Parameters

roomId: string

senderKey: string

sessionId: string

Optional txn: unknown

Returns void

countEndToEndSessions

Parameters

txn: unknown

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

Parameters

count: number

Returns void

Returns void

countSessionsNeedingBackup

Parameters

Optional txn: unknown

Returns Promise<number>

deleteAllData

Returns Promise<void>

deleteOutgoingRoomKeyRequest

Parameters

requestId: string

expectedState: number

Returns Promise<null | OutgoingRoomKeyRequest>

doTxn

Type Parameters

T

Parameters

mode: Mode

stores: Iterable<string>

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

Parameters

txn: unknown

Returns T

Optional log: PrefixedLogger

Returns Promise<T>

filterOutNotifiedErrorDevices

Parameters

devices: IOlmDevice<DeviceInfo>[]

Returns Promise<IOlmDevice<DeviceInfo>[]>

getAccount

Parameters

txn: unknown

func: ((accountPickle: null | string) => void)

Parameters

accountPickle: null | string

Returns void

Returns void

getAllEndToEndInboundGroupSessions

Parameters

txn: unknown

func: ((session: null | ISession) => void)

Parameters

session: null | ISession

Returns void

Returns void

getAllEndToEndSessions

Parameters

txn: unknown

`Optional` txn: unknown

`Optional` txn: unknown

`Optional` txn: unknown

`Optional` log: PrefixedLogger

func: ((sessions: {
[sessionId: string]: ISessionInfo;
}) => void)

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