Class LocalStorageCryptoStore

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

Hierarchy (View Summary, Expand)

MemoryCryptoStore
- LocalStorageCryptoStore

Implements

CryptoStore

Constructors

constructor

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

Methods

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

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

countEndToEndSessions

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

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

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

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

doTxn

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

getAccount

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

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

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

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

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

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

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

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

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

getSecretStorePrivateKey

getSecretStorePrivateKey<K extends "m.megolm_backup.v1">(
    txn: unknown,
    func: (key: null | SecretStorePrivateKeys[K]) => void,
    type: K,
): void
Type Parameters
- K extends "m.megolm_backup.v1"
Parameters
- txn: unknown
- func: (key: null | SecretStorePrivateKeys[K]) => void
- type: K
Returns void
Implementation of CryptoStore.getSecretStorePrivateKey
Overrides MemoryCryptoStore.getSecretStorePrivateKey
- Defined in src/crypto/store/localStorage-crypto-store.ts:373

markSessionsNeedingBackup

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

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

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

storeAccount

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

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

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

storeSecretStorePrivateKey

storeSecretStorePrivateKey<K extends "m.megolm_backup.v1">(
    txn: unknown,
    type: K,
    key: SecretStorePrivateKeys[K],
): void
Type Parameters
- K extends "m.megolm_backup.v1"
Parameters
- txn: unknown
- type: K
- key: SecretStorePrivateKeys[K]
Returns void
Implementation of CryptoStore.storeSecretStorePrivateKey
Overrides MemoryCryptoStore.storeSecretStorePrivateKey
- Defined in src/crypto/store/localStorage-crypto-store.ts:382

`Static`exists

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

Class LocalStorageCryptoStore

Hierarchy (View Summary, Expand)

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns LocalStorageCryptoStore

Methods

containsData

Returns Promise<boolean>

countEndToEndInboundGroupSessions

Returns Promise<number>

countEndToEndSessions

Parameters

Returns void

deleteAllData

Returns Promise<void>

deleteEndToEndInboundGroupSessionsBatch

Parameters

Returns Promise<void>

deleteEndToEndSessionsBatch

Parameters

Returns Promise<void>

doTxn

Type Parameters

Parameters

Returns Promise<T>

getAccount

Parameters

Returns void

getCrossSigningKeys

Parameters

Returns void

getEndToEndInboundGroupSession

Parameters

Returns void

getEndToEndInboundGroupSessionsBatch

Returns Promise<null | SessionExtended[]>

getEndToEndRooms

Parameters

Returns void

getEndToEndSession

Parameters

Returns void

getEndToEndSessions

Parameters

Returns void

getEndToEndSessionsBatch

Returns Promise<null | ISessionInfo[]>

getMigrationState

Returns Promise<MigrationState>

getSecretStorePrivateKey

Type Parameters

Parameters

Returns void

markSessionsNeedingBackup

Parameters

Returns Promise<void>

setMigrationState

Parameters

Returns Promise<void>

startup

Returns Promise<CryptoStore>

storeAccount

Parameters

Returns void

storeEndToEndInboundGroupSession

Parameters

Returns void

storeEndToEndSession

Parameters

Returns void

storeSecretStorePrivateKey

Type Parameters

Parameters

Returns void

Staticexists

`Static`exists