Class SecretStorage<B>

Implements Secure Secret Storage and Sharing (MSC1946)

Type Parameters

B extends MatrixClient | undefined = MatrixClient

Hierarchy

SecretStorage

Index

Constructors

constructor

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

Properties

`Private` `Readonly` accountDataAdapter

accountDataAdapter: IAccountDataClient

`Private` `Readonly` baseApis

baseApis: B

`Private` `Readonly` cryptoCallbacks

cryptoCallbacks: ICryptoCallbacks

`Private` requests

requests: Map<string, ISecretRequestInternal> = ...

Methods

addKey

addKey(algorithm: string, opts?: IAddSecretStorageKeyOpts, keyId?: string): Promise<SecretStorageKeyObject>
Add a key for encrypting secrets.

Returns
An object with: keyId: the ID of the key keyInfo: details about the key (iv, mac, passphrase)
Parameters
- algorithm: string
  
  the algorithm used by the key.
- opts: IAddSecretStorageKeyOpts = {}
  
  the options for the algorithm. The properties used depend on the algorithm given.
- Optional keyId: string
  
  the ID of the key. If not given, a random ID will be generated.
Returns Promise<SecretStorageKeyObject>
- Defined in src/crypto/SecretStorage.ts:125

checkKey

checkKey(key: Uint8Array, info: ISecretStorageKeyInfo): Promise<boolean>
Check whether a key matches what we expect based on the key info

Returns
whether or not the key matches
Parameters
- key: Uint8Array
  
  the key to check
- info: ISecretStorageKeyInfo
  
  the key info
Returns Promise<boolean>
- Defined in src/crypto/SecretStorage.ts:209

get

get(name: string): Promise<undefined | string>
Get a secret from storage.

Returns
the contents of the secret
Parameters
- name: string
  
  the name of the secret
Returns Promise<undefined | string>
- Defined in src/crypto/SecretStorage.ts:277

getDefaultKeyId

getDefaultKeyId(): Promise<null | string>
Returns Promise<null | string>
- Defined in src/crypto/SecretStorage.ts:87

getKey

getKey(keyId?: null | string): Promise<null | SecretStorageKeyTuple>
Get the key information for a given ID.

Returns
If the key was found, the return value is an array of the form [keyId, keyInfo]. Otherwise, null is returned. XXX: why is this an array when addKey returns an object?
Parameters
- Optional keyId: null | string
  
  The ID of the key to check for. Defaults to the default key ID if not provided.
Returns Promise<null | SecretStorageKeyTuple>
- Defined in src/crypto/SecretStorage.ts:176

`Private` getSecretStorageKey

getSecretStorageKey(keys: Record<string, ISecretStorageKeyInfo>, name: string): Promise<[string, IDecryptors]>
Parameters
- keys: Record<string, ISecretStorageKeyInfo>
- name: string
Returns Promise<[string, IDecryptors]>
- Defined in src/crypto/SecretStorage.ts:552

hasKey

hasKey(keyId?: string): Promise<boolean>
Check whether we have a key with a given ID.

Returns
Whether we have the key.
Parameters
- Optional keyId: string
  
  The ID of the key to check for. Defaults to the default key ID if not provided.
Returns Promise<boolean>
- Defined in src/crypto/SecretStorage.ts:197

isStored

isStored(name: string): Promise<null | Record<string, ISecretStorageKeyInfo>>
Check if a secret is stored on the server.

Returns
map of key name to key info the secret is encrypted with, or null if it is not present or not encrypted with a trusted key
Parameters
- name: string
  
  the name of the secret
Returns Promise<null | Record<string, ISecretStorageKeyInfo>>
- Defined in src/crypto/SecretStorage.ts:325

onRequestReceived

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

onSecretReceived

onSecretReceived(this: SecretStorage<MatrixClient>, event: MatrixEvent): void
Parameters
- this: SecretStorage<MatrixClient>
- event: MatrixEvent
Returns void
- Defined in src/crypto/SecretStorage.ts:498

request

request(this: SecretStorage<MatrixClient>, name: string, devices: string[]): ISecretRequest
Request a secret from another device
Parameters
- this: SecretStorage<MatrixClient>
- name: string
  
  the name of the secret to request
- devices: string[]
  
  the devices to request the secret from
Returns ISecretRequest
- Defined in src/crypto/SecretStorage.ts:357

setDefaultKeyId

setDefaultKeyId(keyId: string): Promise<void>
Parameters
- keyId: string
Returns Promise<void>
- Defined in src/crypto/SecretStorage.ts:95

store

store(name: string, secret: string, keys?: null | string[]): Promise<void>
Store an encrypted secret on the server
Parameters
- name: string
  
  The name of the secret
- secret: string
  
  The secret contents.
- Optional keys: null | string[]
  
  The IDs of the keys to use to encrypt the secret or null/undefined to use the default key.
Returns Promise<void>
- Defined in src/crypto/SecretStorage.ts:231

Class SecretStorage<B>

Type Parameters

B extends MatrixClient | undefined = MatrixClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

B extends undefined | MatrixClient = MatrixClient

Parameters

accountDataAdapter: IAccountDataClient

cryptoCallbacks: ICryptoCallbacks

baseApis: B

Returns SecretStorage<B>

Properties

Private Readonly accountDataAdapter

Private Readonly baseApis

Private Readonly cryptoCallbacks

Private requests

Methods

addKey

Returns

Parameters

algorithm: string

opts: IAddSecretStorageKeyOpts = {}

Optional keyId: string

Returns Promise<SecretStorageKeyObject>

checkKey

Returns

Parameters

key: Uint8Array

info: ISecretStorageKeyInfo

Returns Promise<boolean>

get

Returns

Parameters

name: string

Returns Promise<undefined | string>

getDefaultKeyId

Returns Promise<null | string>

getKey

Returns

Parameters

Optional keyId: null | string

Returns Promise<null | SecretStorageKeyTuple>

Private getSecretStorageKey

Parameters

keys: Record<string, ISecretStorageKeyInfo>

name: string

Returns Promise<[string, IDecryptors]>

hasKey

Returns

Parameters

Optional keyId: string

Returns Promise<boolean>

isStored

Returns

Parameters

name: string

Returns Promise<null | Record<string, ISecretStorageKeyInfo>>

onRequestReceived

Parameters

this: SecretStorage<MatrixClient>

event: MatrixEvent

Returns Promise<void>

onSecretReceived

Parameters

this: SecretStorage<MatrixClient>

event: MatrixEvent

Returns void

request

Parameters

this: SecretStorage<MatrixClient>

name: string

devices: string[]

Returns ISecretRequest

setDefaultKeyId

`Private` `Readonly` accountDataAdapter

`Private` `Readonly` baseApis

`Private` `Readonly` cryptoCallbacks

`Private` requests

`Optional` keyId: string

`Optional` keyId: null | string

`Private` getSecretStorageKey

`Optional` keyId: string

`Optional` keys: null | string[]