Skip to main content

Secrets Manager

A Secrets Manager object exposes API used to save and load cryptographic secrets to/from the event store database. An encryption factory function can access this object through it's context parameter:

// common/aggregates/encryption.js
import { generate } from 'generate-password'

const createEncryption = (aggregateId, context) => {
  const { secretsManager } = context
  let aggregateKey = await secretsManager.getSecret(aggregateId)
  if (!aggregateKey) {
    aggregateKey = generate({
      length: 20,
      numbers: true,
    })
    await secretsManager.setSecret(aggregateId, aggregateKey)
  }
  ...
}

The secretsManager object contains the following functions:

Function NameDescription
getSecretTakes a unique ID as an argument and returns a promise that resolves to a string if a secret was found or null if a secret was not found.
setSecretTakes a unique ID and a secret string as arguments and returns a promise that resolves if the secret was successfully saved.
deleteSecretTakes a unique ID as an argument and returns a promise that resolves if the secret was successfully deleted.
caution

The unique ID of an existing or deleted secret cannot be reused. If you pass a previously used ID to the setSecret function, an exception is raised.

getSecretā€‹

Get a stored secret from the event store.

Example

const secret = await secretManager.getSecret(id)

Arguments

Argument NameTypeDescription
idstringThe secret's unique identifier within the event store.

Result

A promise that resolves to either the loaded secret or null if the secret with the specified id was not found.

setSecretā€‹

Saves the specified secret to the event store.

Example

await secretManager.setSecret(id, secret)

Arguments

Argument NameTypeDescription
idstringThe secret's unique identifier within the event store.
secretstringThe secret to save.

Result

A promise that resolves when the secret has been successfully saved to the event store.

deleteSecretā€‹

Deletes a secret from the event store.

Example

const isDeleted = await secretManager.deleteSecret(id)

Arguments

Argument NameTypeDescription
idstringThe secret's unique identifier within the event store.

Result

A promise that resolves to a boolean value. The value indicates whether or not a secret with the specified id has been found and successfully deleted.

See Alsoā€‹