Buckypaper secrets engine
This is the API documentation for the Vault buckypaper secrets engine. The secrets engine is compatible with the KV version 2 by default with the addition of dynamic secret generation. Dynamic secrets are useful to provision cloud workload. They include
SSH keys and password
secret environment variables, for example, like the disk decrytpion key
DISK_KEY
or the DB admin password DB_ADMIN_PASSWORD
Remark: For general information about the usage and operation of the version 2 KV secrets engine, please see the Vault KV documentation. For information about the differences between KV version 1 and version 2, please see the KV overview documentation.
Configure the KV engine
This path configures backend level settings that are applied to every key in the key-value store.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount to config, such assecret
. This is specified as part of the URL.max_versions
(int: 0)
– The number of versions to keep per key. This value applies to all keys, but a key's metadata setting can overwrite this value. Once a key has more than the configured allowed versions, the oldest version will be permanently deleted. When 0 is used or the value is unset, Vault will keep 10 versions.cas_required
(bool: false)
– If true all keys will require the cas parameter to be set on all write requests.delete_version_after
(string:"0s")
– If set, specifies the length of time before a version is deleted. Accepts duration format strings.
Sample payload
Sample request
Read KV engine configuration
This path retrieves the current configuration for the secrets backend at the given path.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount to read the config, of, such assecret
. This is specified as part of the URL.
Sample request
Sample response
Read secret version
This endpoint retrieves the secret at the specified location. The metadata fields created_time
, deletion_time
, destroyed
, and version
are version specific. The custom_metadata
field is part of the secret's key metadata and is included in the response whether or not the calling token has read
access to the associated metadata endpoint.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to read, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to read. This is specified as part of the URL.version
(int: 0)
- Specifies the version to return. If not set the latest version is returned.
Sample request
Sample response
Create/Update secret
This endpoint creates a new version of a secret at the specified location. If the value does not yet exist, the calling token must have an ACL policy granting the create
capability. If the value already exists, the calling token must have an ACL policy granting the update
capability.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to update, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to update. This is specified as part of the URL.options
(Map: <optional>)
– An object that holds option settings.cas
(int: <optional>)
- This flag is required ifcas_required
is set to true on either the secret or the engine's config. If not set the write will be allowed. In order for a write to be successful,cas
must be set to the current version of the secret. If set to 0 a write will only be allowed if the key doesn't exist as unset keys do not have any version information. Also remember that soft deletes do not remove any underlying version data from storage. In order to write to a soft deleted key, the cas parameter must match the key's current version.
data
(Map: <required>)
– The contents of the data map will be stored and returned on read.
Sample payload
Sample request
Sample response
Create/Update dynamic secrets
Enabled paths are configured as patterns. If no secret is found and the request path matches one of the patterns, the secret is generated. To enable this feature, the parameter dynamic
must be set while reading.
Parameters
encoding
hex
base32
base64
password
, encodes a byte-array as a base32 string where trailing equal signs are removedenvironment
, encodes a byte-array as a base32 string where trailing equal signs are removed
random
crypto
, golang builtinvault
, vhsm builtin
algorithm
, for ssh-keyrsa
with(3072 <= bits <= 8192)
ed25519
bytes
bits
, for ssh-key
Paths
:workload/disk/:name
Defaults:
encoding=base64, random=crypto, bytes=32
Result:
:workload/env/:name
Defaults:
encoding=environment, random=crypto, bytes=32
Result:
:user/ssh-pw/:name
Defaults:
encoding=password, random=crypto, bytes=32
Result:
:user/ssh-key/:name
Defaults:
algorithm=ed25519, random=crypto, bits=-1
Result:
Patterns for placeholders are defined as [^/]
.
Examples
With vhsm read
on a mount (prefix :mount/data
):
:uuid/disk/:name dynamic=
:uuid/env/:name dynamic= bytes=64
:user/ssh-pw/:name dynamic= encoding=environment
:user/ssh-key/:name dynamic= algorithm=rsa bits=3072
This will result in a request to:
test/data/:user/ssh-key/:name?dynamic&algorithm=rsa&bits=3072
Patch secret
This endpoint provides the ability to patch an existing secret at the specified location. The secret must neither be deleted nor destroyed. The calling token must have an ACL policy granting the patch
capability. Currently, only JSON merge patch is supported and must be specified using a Content-Type
header value of application/merge-patch+json
. A new version will be created upon successfully applying a patch with the provided data.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to patch, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to patch. This is specified as part of the URL.options
(Map: <optional>)
– An object that holds option settings.cas
(int: <optional>)
- This flag is required ifcas_required
is set to true on either the secret or the engine's config. In order for a write to be successful,cas
must be set to the current version of the secret. A patch operation must be attempted on an existing key, thus the providedcas
value must be greater than 0.
data
(Map: <required>)
– The contents of the data map will be applied as a partial update to the existing entry via a JSON merge patch to the existing entry.
Sample payload
Sample request
Sample response
Read secret subkeys
This endpoint provides the subkeys within a secret entry that exists at the requested path. The secret entry at this path will be retrieved and stripped of all data by replacing underlying values of leaf keys (i.e. non-map keys or map keys with no underlying subkeys) with null
.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to read, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to read. This is specified as part of the URL.version
(int: 0)
- Specifies the version to return. If not set the latest version is returned.depth
(int: 0)
- Specifies the deepest nesting level to provide in the output. The default value 0 will not impose any limit. If non-zero, keys that reside at the specifieddepth
value will be artificially treated as leaves and will thus benull
even if further underlying subkeys exist.
Sample request
Sample secret data
Sample response
Delete latest version of secret
This endpoint issues a soft delete of the secret's latest version at the specified location. This marks the version as deleted and will stop it from being returned from reads, but the underlying data will not be removed. A delete can be undone using the undelete
path.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to delete, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to delete. This is specified as part of the URL.
Sample request
Delete secret versions
This endpoint issues a soft delete of the specified versions of the secret. This marks the versions as deleted and will stop them from being returned from reads, but the underlying data will not be removed. A delete can be undone using the undelete
path.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to delete, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to delete. This is specified as part of the URL.versions
([]int: <required>)
- The versions to be deleted. The versioned data will not be deleted, but it will no longer be returned in normal get requests.
Sample payload
Sample request
Undelete secret versions
Undeletes the data for the provided version and path in the key-value store. This restores the data, allowing it to be returned on get requests.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to undelete, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to undelete. This is specified as part of the URL.versions
([]int: <required>)
- The versions to undelete. The versions will be restored and their data will be returned on normal get requests.
Sample payload
Sample request
Destroy secret versions
Permanently removes the specified version data for the provided key and version numbers from the key-value store.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to destroy, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to destroy. This is specified as part of the URL.versions
([]int: <required>)
- The versions to destroy. Their data will be permanently deleted.
Sample payload
Sample request
List secrets
This endpoint returns a list of key names at the specified location. Folders are suffixed with /
. The input must be a folder; list on a file will not return a value. Note that no policy-based filtering is performed on keys; do not encode sensitive information in key names. The values themselves are not accessible via this command.
To list secrets for KV v2, a user must have a policy granting them the list capability on this /metadata/
path - even if all the rest of their interactions with the KV v2 are via the /data/
APIs. Access to at least list the /metadata/
path should typically also be granted.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to list, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secrets to list. This is specified as part of the URL.
Sample request
Sample response
The example below shows output for a query path of secret/
when there are secrets at secret/foo
and secret/foo/bar
; note the difference in the two entries.
Read secret metadata
This endpoint retrieves the metadata and versions for the secret at the specified path. Metadata is version-agnostic.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to read, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to read. This is specified as part of the URL.
Sample request
Sample response
Create/Update metadata
This endpoint creates or updates the metadata of a secret at the specified location. It does not create a new version.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to update, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to update. This is specified as part of the URL.max_versions
(int: 0)
– The number of versions to keep per key. If not set, the backend’s configured max version is used. Once a key has more than the configured allowed versions, the oldest version will be permanently deleted.cas_required
(bool: false)
– If true, the key will require thecas
parameter to be set on all write requests. If false, the backend’s configuration will be used.delete_version_after
(string:"0s")
– Set thedelete_version_after
value to a duration to specify thedeletion_time
for all new versions written to this key. If not set, the backend'sdelete_version_after
will be used. If the value is greater than the backend'sdelete_version_after
, the backend'sdelete_version_after
will be used. Accepts duration format strings.custom_metadata
(map<string|string>: nil)
- A map of arbitrary string to string valued user-provided metadata meant to describe the secret.
Sample payload
Sample request
Patch metadata
This endpoint patches an existing metadata entry of a secret at the specified location. The calling token must have an ACL policy granting the patch
capability. Currently, only JSON merge patch is supported and must be specified using a Content-Type
header value of application/merge-patch+json
. It does not create a new version.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to patch, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to patch. This is specified as part of the URL.max_versions
(int: 0)
– The number of versions to keep per key. If not set, the backend’s configured max version is used. Once a key has more than the configured allowed versions, the oldest version will be permanently deleted.cas_required
(bool: false)
– If true, the key will require thecas
parameter to be set on all write requests. If false, the backend’s configuration will be used.delete_version_after
(string:"0s")
– Set thedelete_version_after
value to a duration to specify thedeletion_time
for all new versions written to this key. If not set, the backend'sdelete_version_after
will be used. If the value is greater than the backend'sdelete_version_after
, the backend'sdelete_version_after
will be used. Accepts duration format strings.custom_metadata
(map<string|string>: nil)
- A map of arbitrary string to string valued user-provided metadata meant to describe the secret.
Sample payload
Sample request
Delete metadata and all versions
This endpoint permanently deletes the key metadata and all version data for the specified key. All version history will be removed.
Method | Path |
---|---|
|
|
Parameters
secret-mount-path
(string: <required>)
- The path to the KV mount containing the secret to delete, such assecret
. This is specified as part of the URL.path
(string: <required>)
– Specifies the path of the secret to delete. This is specified as part of the URL.
Sample request
Last updated