Class LocalStorageCryptoStore

Internal module. in-memory storage for e2e.

Hierarchy

MemoryCryptoStore
- LocalStorageCryptoStore

Index

Constructors

Methods

_getEndToEndSessions 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 exists

Constructors

constructor

new LocalStorageCryptoStore(store): LocalStorageCryptoStore
Parameters
- store: Storage
Returns LocalStorageCryptoStore
Overrides MemoryCryptoStore.constructor
- Defined in src/crypto/store/localStorage-crypto-store.ts:75

Properties

`Private` `Readonly` store

store: Storage

Methods

`Private` _getEndToEndSessions

_getEndToEndSessions(deviceKey): Record<string, ISessionInfo>
Parameters
- deviceKey: string
Returns Record<string, ISessionInfo>
- Defined in src/crypto/store/localStorage-crypto-store.ts:90

addEndToEndInboundGroupSession

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

addParkedSharedHistory

addParkedSharedHistory(roomId, parkedData): void
Parameters
- roomId: string
- parkedData: ParkedSharedHistory
Returns void
Inherited from MemoryCryptoStore.addParkedSharedHistory
- Defined in src/crypto/store/memory-crypto-store.ts:515

addSharedHistoryInboundGroupSession

addSharedHistoryInboundGroupSession(roomId, senderKey, sessionId): void
Parameters
- roomId: string
- senderKey: string
- sessionId: string
Returns void
Inherited from MemoryCryptoStore.addSharedHistoryInboundGroupSession
- Defined in src/crypto/store/memory-crypto-store.ts:505

countEndToEndSessions

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

countSessionsNeedingBackup

countSessionsNeedingBackup(): Promise<number>
Returns Promise<number>
Overrides MemoryCryptoStore.countSessionsNeedingBackup
- Defined in src/crypto/store/localStorage-crypto-store.ts:308

deleteAllData

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

Returns Promise<void>
Promise which resolves when the store has been cleared.
Overrides MemoryCryptoStore.deleteAllData
- Defined in src/crypto/store/localStorage-crypto-store.ts:342

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
Inherited from MemoryCryptoStore.deleteOutgoingRoomKeyRequest
- Defined in src/crypto/store/memory-crypto-store.ts:240

doTxn

doTxn<T>(mode, stores, func): Promise<T>
Type Parameters
- T
Parameters
- mode: Mode
- stores: Iterable<string>
- func: ((txn) => T)
  - - (txn): T
    - Parameters
      
      txn: unknown
      
      Returns T
Returns Promise<T>
Overrides MemoryCryptoStore.doTxn
- Defined in src/crypto/store/localStorage-crypto-store.ts:384

filterOutNotifiedErrorDevices

filterOutNotifiedErrorDevices(devices): Promise<IOlmDevice<DeviceInfo>[]>
Parameters
- devices: IOlmDevice<DeviceInfo>[]
Returns Promise<IOlmDevice<DeviceInfo>[]>
Overrides MemoryCryptoStore.filterOutNotifiedErrorDevices
- Defined in src/crypto/store/localStorage-crypto-store.ts:172

getAccount

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

getAllEndToEndInboundGroupSessions

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

getAllEndToEndSessions

getAllEndToEndSessions(txn, func): void
Parameters
- txn: unknown
- func: ((session) => void)
  - - (session): void
    - Parameters
      
      session: ISessionInfo
      
      Returns void
Returns void
Overrides MemoryCryptoStore.getAllEndToEndSessions
- Defined in src/crypto/store/localStorage-crypto-store.ts:126

getAllOutgoingRoomKeyRequestsByState

getAllOutgoingRoomKeyRequestsByState(wantedState): Promise<OutgoingRoomKeyRequest[]>
Parameters
- wantedState: number
Returns Promise<OutgoingRoomKeyRequest[]>
All OutgoingRoomKeyRequests in state
Inherited from MemoryCryptoStore.getAllOutgoingRoomKeyRequestsByState
- Defined in src/crypto/store/memory-crypto-store.ts:171

getCrossSigningKeys

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

getEndToEndDeviceData

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

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
Overrides MemoryCryptoStore.getEndToEndInboundGroupSession
- Defined in src/crypto/store/localStorage-crypto-store.ts:197

getEndToEndRooms

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

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
Overrides MemoryCryptoStore.getEndToEndSession
- Defined in src/crypto/store/localStorage-crypto-store.ts:108

getEndToEndSessionProblem

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

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
Overrides MemoryCryptoStore.getEndToEndSessions
- Defined in src/crypto/store/localStorage-crypto-store.ts:118

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.
Inherited from MemoryCryptoStore.getOrAddOutgoingRoomKeyRequest
- Defined in src/crypto/store/memory-crypto-store.ts:89

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
Inherited from MemoryCryptoStore.getOutgoingRoomKeyRequest
- Defined in src/crypto/store/memory-crypto-store.ts:123

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
Inherited from MemoryCryptoStore.getOutgoingRoomKeyRequestByState
- Defined in src/crypto/store/memory-crypto-store.ts:156

getOutgoingRoomKeyRequestsByTarget

getOutgoingRoomKeyRequestsByTarget(userId, deviceId, wantedStates): Promise<OutgoingRoomKeyRequest[]>
Parameters
- userId: string
- deviceId: string
- wantedStates: number[]
Returns Promise<OutgoingRoomKeyRequest[]>
Inherited from MemoryCryptoStore.getOutgoingRoomKeyRequestsByTarget
- Defined in src/crypto/store/memory-crypto-store.ts:175

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
Overrides MemoryCryptoStore.getSecretStorePrivateKey
- Defined in src/crypto/store/localStorage-crypto-store.ts:363

getSessionsNeedingBackup

getSessionsNeedingBackup(limit): Promise<ISession[]>
Parameters
- limit: number
Returns Promise<ISession[]>
Overrides MemoryCryptoStore.getSessionsNeedingBackup
- Defined in src/crypto/store/localStorage-crypto-store.ts:284

getSharedHistoryInboundGroupSessions

getSharedHistoryInboundGroupSessions(roomId): Promise<[senderKey: string, sessionId: string][]>
Parameters
- roomId: string
Returns Promise<[senderKey: string, sessionId: string][]>
Inherited from MemoryCryptoStore.getSharedHistoryInboundGroupSessions
- Defined in src/crypto/store/memory-crypto-store.ts:511

markSessionsNeedingBackup

markSessionsNeedingBackup(sessions): Promise<void>
Parameters
- sessions: ISession[]
Returns Promise<void>
Overrides MemoryCryptoStore.markSessionsNeedingBackup
- Defined in src/crypto/store/localStorage-crypto-store.ts:325

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.
Inherited from MemoryCryptoStore.startup
- Defined in src/crypto/store/memory-crypto-store.ts:66

storeAccount

storeAccount(txn, accountPickle): void
Parameters
- txn: unknown
- accountPickle: string
Returns void
Overrides MemoryCryptoStore.storeAccount
- Defined in src/crypto/store/localStorage-crypto-store.ts:354

storeCrossSigningKeys

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

storeEndToEndDeviceData

storeEndToEndDeviceData(deviceData, txn): void
Parameters
- deviceData: IDeviceData
- txn: unknown
Returns void
Overrides MemoryCryptoStore.storeEndToEndDeviceData
- Defined in src/crypto/store/localStorage-crypto-store.ts:262

storeEndToEndInboundGroupSession

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

storeEndToEndInboundGroupSessionWithheld

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

storeEndToEndRoom

storeEndToEndRoom(roomId, roomInfo, txn): void
Parameters
- roomId: string
- roomInfo: IRoomEncryption
- txn: unknown
Returns void
Overrides MemoryCryptoStore.storeEndToEndRoom
- Defined in src/crypto/store/localStorage-crypto-store.ts:266

storeEndToEndSession

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

storeEndToEndSessionProblem

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

storeSecretStorePrivateKey

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

takeParkedSharedHistory

takeParkedSharedHistory(roomId): Promise<ParkedSharedHistory[]>
Parameters
- roomId: string
Returns Promise<ParkedSharedHistory[]>
Inherited from MemoryCryptoStore.takeParkedSharedHistory
- Defined in src/crypto/store/memory-crypto-store.ts:521

unmarkSessionsNeedingBackup

unmarkSessionsNeedingBackup(sessions): Promise<void>
Parameters
- sessions: ISession[]
Returns Promise<void>
Overrides MemoryCryptoStore.unmarkSessionsNeedingBackup
- Defined in src/crypto/store/localStorage-crypto-store.ts:313

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
Inherited from MemoryCryptoStore.updateOutgoingRoomKeyRequest
- Defined in src/crypto/store/memory-crypto-store.ts:207

`Static` exists

exists(store): boolean
Parameters
- store: Storage
Returns boolean
- Defined in src/crypto/store/localStorage-crypto-store.ts:65

Class LocalStorageCryptoStore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

store: Storage

Returns LocalStorageCryptoStore

Properties

Private Readonly store

Methods

Private _getEndToEndSessions

Parameters

deviceKey: string

Returns Record<string, ISessionInfo>

addEndToEndInboundGroupSession

Parameters

senderCurve25519Key: string

sessionId: string

sessionData: InboundGroupSessionData

txn: unknown

Returns void

addParkedSharedHistory

Parameters

roomId: string

parkedData: ParkedSharedHistory

Returns void

addSharedHistoryInboundGroupSession

Parameters

roomId: string

senderKey: string

sessionId: string

Returns void

countEndToEndSessions

Parameters

txn: unknown

func: ((count) => void)

Parameters

count: number

Returns void

Returns void

countSessionsNeedingBackup

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) => T)

Parameters

txn: unknown

Returns T

Returns Promise<T>

filterOutNotifiedErrorDevices

Parameters

devices: IOlmDevice<DeviceInfo>[]

Returns Promise<IOlmDevice<DeviceInfo>[]>

getAccount

Parameters

txn: unknown

func: ((accountPickle) => void)

Parameters

accountPickle: null | string

Returns void

Returns void

getAllEndToEndInboundGroupSessions

Parameters

txn: unknown

func: ((session) => void)

`Private` `Readonly` store

`Private` _getEndToEndSessions