Add a key for encrypting secrets.
details about the key.
the algorithm used by the key.
the options for the algorithm. The properties used depend on the algorithm given.
Optional
keyId: stringthe ID of the key. If not given, a random ID will be generated.
Check whether a key matches what we expect based on the key info
whether or not the key matches
the key to check
the key info
Get a secret from storage, and decrypt it.
the decrypted contents of the secret, or "undefined" if name
is not found in
the user's account data.
the name of the secret - i.e., the "event type" stored in the account data
Get the key information for a given ID.
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?
Optional
keyId: null | stringThe ID of the key to check for. Defaults to the default key ID if not provided.
Check if a secret is stored on the server.
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
the name of the secret
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 addKey.
The name of the secret - i.e., the "event type" to be stored in the account data
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 (will throw if no default key is set).
Generated using TypeDoc
Interface provided by SecretStorage implementations
Normally this will just be an ServerSideSecretStorageImpl, but for backwards compatibility some methods allow other implementations.