ServerSideSecretStorage

Interface provided by SecretStorage implementations

Normally this will just be an ServerSideSecretStorageImpl, but for backwards compatibility some methods allow other implementations.

Methods

addKey()

addKey(algorithm, opts, keyId?): Promise<SecretStorageKeyObject>

Defined in: src/secret-storage.ts:247

Add a key for encrypting secrets.

Parameters

algorithm

string

the algorithm used by the key.

opts

AddSecretStorageKeyOpts

the options for the algorithm. The properties used depend on the algorithm given.

keyId?

string

the ID of the key. If not given, a random ID will be generated.

Returns

Promise<SecretStorageKeyObject>

details about the key.

checkKey()

checkKey(key, info): Promise<boolean>

Defined in: src/secret-storage.ts:277

Check whether a key matches what we expect based on the key info

Parameters

key

Uint8Array

the key to check

info

SecretStorageKeyDescriptionAesV1

the key info

Returns

Promise<boolean>

whether or not the key matches

get()

get(name): Promise<string | undefined>

Defined in: src/secret-storage.ts:304

Get a secret from storage, and decrypt it.

Parameters

name

string

the name of the secret - i.e., the “event type” stored in the account data

Returns

Promise<string | undefined>

the decrypted contents of the secret, or “undefined” if name is not found in the user’s account data.

getDefaultKeyId()

getDefaultKeyId(): Promise<string | null>

Defined in: src/secret-storage.ts:322

Get the current default key ID for encrypting secrets.

Returns

Promise<string | null>

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

getKey()

getKey(keyId?): Promise<SecretStorageKeyTuple | null>

Defined in: src/secret-storage.ts:258

Get the key information for a given ID.

Parameters

keyId?

string | null

The ID of the key to check for. Defaults to the default key ID if not provided.

Returns

Promise<SecretStorageKeyTuple | null>

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?

hasKey()

hasKey(keyId?): Promise<boolean>

Defined in: src/secret-storage.ts:267

Check whether we have a key with a given ID.

Parameters

keyId?

string

The ID of the key to check for. Defaults to the default key ID if not provided.

Returns

Promise<boolean>

Whether we have the key.

isStored()

isStored(name): Promise<Record<string, SecretStorageKeyDescriptionAesV1> | null>

Defined in: src/secret-storage.ts:315

Check if a secret is stored on the server.

Parameters

name

keyof SecretStorageAccountDataEvents

the name of the secret

Returns

Promise<Record<string, SecretStorageKeyDescriptionAesV1> | null>

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

setDefaultKeyId()

setDefaultKeyId(keyId): Promise<void>

Defined in: src/secret-storage.ts:332

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 | null

The new default key ID

Returns

Promise<void>

store()

store(name, secret, keys?): Promise<void>

Defined in: src/secret-storage.ts:294

Store an encrypted secret on the server.

Details of the encryption keys to be used must previously have been stored in account data (for example, via ServerSideSecretStorageImpl#addKey. SecretStorageCallbacks#getSecretStorageKey will be called to obtain a secret storage key to decrypt the secret.

If the secret is null, the secret value in the account data will be set to an empty object. This is considered as “removing” the secret.

Parameters

name

string

The name of the secret - i.e., the “event type” to be stored in the account data

secret

string | null

The secret contents.

keys?

string[] | null

The IDs of the keys to use to encrypt the secret, or null/undefined to use the default key (will throw if no default key is set).

Returns

Promise<void>