vault.secrets.kvv1 — amperity/vault-clj 1.0.3

Interface for communicating with a Vault key value version 1 secret store (generic)

delete-secret! clj

(delete-secret! client path)

Removes secret data from a path. Returns a boolean indicating whether the deletion was successful.

Params:

• client: vault.client, A client that handles vault auth, leases, and basic CRUD ops
• path: String, the path in vault of the secret you wish to delete

list-secrets clj

(list-secrets client path)

Returns a vector of the secrets names located under a path.

Params:

• client: vault.client, A client that handles vault auth, leases, and basic CRUD ops
• path: String, the path in vault of the secret you wish to list secrets at

read-secret clj

(read-secret client path)

(read-secret client path opts)

Reads a secret from a path. Returns the full map of stored secret data if the secret exists, or throws an exception if not.

Params:

• client: vault.client, A client that handles vault auth, leases, and basic CRUD ops
• path: String, the path in vault of the secret you wish to read
• opts: map, Further optional read described below.

Additional options may include:

• :not-found If the requested path is not found, return this value instead of throwing an exception.
• :renew Whether or not to renew this secret when the lease is near expiry.
• :rotate Whether or not to rotate this secret when the lease is near expiry and cannot be renewed.
• :force-read Force the secret to be read from the server even if there is a valid lease cached.

write-secret! clj

(write-secret! client path data)

Writes secret data to a path. Returns a boolean indicating whether the write was successful.

Params:

• client: vault.client, A client that handles vault auth, leases, and basic CRUD ops
• path: String, the path in vault of the secret you wish to write the secret to
• data: map, The data you wish to write to the given secret path.