Class SecretStorage<B>

Implements Secure Secret Storage and Sharing (MSC1946)

Deprecated

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

Type Parameters

B extends MatrixClient | undefined = MatrixClient

Hierarchy

SecretStorage

Implements

ServerSideSecretStorage

Index

Constructors

Properties

sharingImpl storageImpl

Methods

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

Constructors

constructor

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

Properties

`Private` `Readonly` sharingImpl

sharingImpl: SecretSharing

`Private` `Readonly` storageImpl

storageImpl: ServerSideSecretStorageImpl

Methods

addKey

addKey(algorithm: string, opts?: AddSecretStorageKeyOpts, keyId?: string): Promise<SecretStorageKeyObject>
Add a key for encrypting secrets.
Parameters
- algorithm: string
- opts: AddSecretStorageKeyOpts = {}
- Optional keyId: 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:101

get

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

getDefaultKeyId

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

Returns
The default key ID or null if no default key ID is set

Returns Promise<null | string>
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
- Optional keyId: null | string
Returns Promise<null | SecretStorageKeyTuple>
Implementation of ServerSideSecretStorage.getKey
- Defined in src/crypto/SecretStorage.ts:87

hasKey

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

isStored

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

onRequestReceived

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

onSecretReceived

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

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:129

setDefaultKeyId

setDefaultKeyId(keyId: string): Promise<void>
Set the default key ID for encrypting secrets.
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: string, secret: string, keys?: null | string[]): Promise<void>
Store an encrypted secret on the server
Parameters
- name: string
- secret: string
- Optional keys: null | string[]
Returns Promise<void>
Implementation of ServerSideSecretStorage.store
- Defined in src/crypto/SecretStorage.ts:108

Generated using TypeDoc