Class SecretStorage<B>

Implements Secure Secret Storage and Sharing (MSC1946)

Deprecated

This is just a backwards-compatibility hack which will be removed soon. Use SecretStorage.ServerSideSecretStorageImpl from ../secret-storage and/or SecretSharing from ./SecretSharing.

Type Parameters

B extends MatrixClient | undefined = MatrixClient

Implements

ServerSideSecretStorage

Index

Constructors

Methods

addKey checkKey get getDefaultKeyId getKey hasKey isStored onRequestReceived onSecretReceived request setDefaultKeyId store

Constructors

constructor

new SecretStorage<B extends undefined | MatrixClient = MatrixClient>(
    accountDataAdapter: AccountDataClient,
    cryptoCallbacks: CryptoCallbacks,
    baseApis: B,
): SecretStorage<B>
Type Parameters
- B extends undefined | MatrixClient = MatrixClient
Parameters
- accountDataAdapter: AccountDataClient
- cryptoCallbacks: CryptoCallbacks
- baseApis: B
Returns SecretStorage<B>
- Defined in src/crypto/SecretStorage.ts:60

Methods

addKey

addKey(
    algorithm: string,
    opts: AddSecretStorageKeyOpts,
    keyId?: string,
): Promise<SecretStorageKeyObject>
Add a key for encrypting secrets.
Parameters
- algorithm: string
- opts: AddSecretStorageKeyOpts
- OptionalkeyId: string
Returns Promise<SecretStorageKeyObject>
Implementation of ServerSideSecretStorage.addKey
- Defined in src/crypto/SecretStorage.ts:76

checkKey

checkKey(
key: Uint8Array,
info: SecretStorageKeyDescriptionAesV1,
): Promise<boolean>
Check whether a key matches what we expect based on the key info
Parameters
- key: Uint8Array
- info: SecretStorageKeyDescriptionAesV1
Returns Promise<boolean>
Implementation of ServerSideSecretStorage.checkKey
- Defined in src/crypto/SecretStorage.ts:97

get

get(name: keyof SecretStorageAccountDataEvents): Promise<undefined | string>
Get a secret from storage.
Parameters
- name: keyof SecretStorageAccountDataEvents
Returns Promise<undefined | string>
Implementation of ServerSideSecretStorage.get
- Defined in src/crypto/SecretStorage.ts:111

getDefaultKeyId

getDefaultKeyId(): Promise<null | string>
Get the current default key ID for encrypting secrets.

Returns Promise<null | string>
The default key ID or null if no default key ID is set
Implementation of ServerSideSecretStorage.getDefaultKeyId
- Defined in src/crypto/SecretStorage.ts:65

getKey

getKey(keyId?: null | string): Promise<null | SecretStorageKeyTuple>
Get the key information for a given ID.
Parameters
- OptionalkeyId: null | string
Returns Promise<null | SecretStorageKeyTuple>
Implementation of ServerSideSecretStorage.getKey
- Defined in src/crypto/SecretStorage.ts:83

hasKey

hasKey(keyId?: string): Promise<boolean>
Check whether we have a key with a given ID.
Parameters
- OptionalkeyId: string
Returns Promise<boolean>
Implementation of ServerSideSecretStorage.hasKey
- Defined in src/crypto/SecretStorage.ts:90

isStored

isStored(
name: keyof SecretStorageAccountDataEvents,
): Promise<null | Record<string, SecretStorageKeyDescriptionAesV1>>
Check if a secret is stored on the server.
Parameters
- name: keyof SecretStorageAccountDataEvents
Returns Promise<null | Record<string, SecretStorageKeyDescriptionAesV1>>
Implementation of ServerSideSecretStorage.isStored
- Defined in src/crypto/SecretStorage.ts:118

onRequestReceived

onRequestReceived(event: MatrixEvent): Promise<void>
Parameters
- event: MatrixEvent
Returns Promise<void>
- Defined in src/crypto/SecretStorage.ts:129

onSecretReceived

onSecretReceived(event: MatrixEvent): void
Parameters
- event: MatrixEvent
Returns void
- Defined in src/crypto/SecretStorage.ts:133

request

request(name: string, devices: string[]): ISecretRequest
Request a secret from another device
Parameters
- name: string
- devices: string[]
Returns ISecretRequest
- Defined in src/crypto/SecretStorage.ts:125

setDefaultKeyId

setDefaultKeyId(keyId: string): Promise<void>
Set the default key ID for encrypting secrets.

If keyId is null, the default key id value in the account data will be set to an empty object. This is considered as "disabling" the default key.
Parameters
- keyId: string
  The new default key ID
Returns Promise<void>
Implementation of ServerSideSecretStorage.setDefaultKeyId
- Defined in src/crypto/SecretStorage.ts:69

store

store(
    name: keyof SecretStorageAccountDataEvents,
    secret: string,
    keys?: null | string[],
): Promise<void>
Store an encrypted secret on the server
Parameters
- name: keyof SecretStorageAccountDataEvents
- secret: string
- Optionalkeys: null | string[]
Returns Promise<void>
Implementation of ServerSideSecretStorage.store
- Defined in src/crypto/SecretStorage.ts:104