Database.Vault.KVv2.Client

See https://www.vaultproject.io/api/secret/kv/kv-v2.html for HashiCorp Vault KVv2 API details

Documentation

data VaultConnection

Instances

Show VaultConnection

Defined in Database.Vault.KVv2.Client.Types

Methods

showsPrec :: Int -> VaultConnection -> ShowS

show :: VaultConnection -> String

showList :: [VaultConnection] -> ShowS

Connect & configure Vault KVv2 Engine

vaultConnect

Arguments

:: Maybe String

Use Just this string as Vault address or get it from variable environment VAULT_ADDR

-> String

KV engine path

-> Maybe VaultToken

Use Just this VaultToken or get it from $HOME/.vaut-token

-> Bool

Disable certificate validation

-> IO (Either String VaultConnection)

Get a VaultConnection, or an error message.

λ: vaultConnect (Just "https://vault.local.lan:8200/") "/secret" Nothing False

kvEngineConfig

Arguments

:: VaultConnection

-> Int

Max versions

-> Bool

CAS required

-> IO (Either String Value)

Set default secret settings for the KVv2 engine.

secretConfig

Arguments

:: VaultConnection

-> SecretPath

-> Int

Max versions

-> Bool

CAS required

-> IO (Either String Value)

Override default secret settings for the given secret.

Basic operations

putSecret

Arguments

:: VaultConnection

-> CheckAndSet

WriteAllowed, CreateOnly or CurrentVersion

-> SecretPath

-> SecretData

Data to put at SecretPath location

-> IO (Either String SecretVersion)

Put SecretData into Vault at the given location.

getSecret :: VaultConnection -> SecretPath -> Maybe SecretVersion -> IO (Either String SecretData)

Get a secret from Vault. Give Just the SecretVersion to retrieve or Nothing to get the current one.

λ>getSecret conn (SecretPath "MySecret") Nothing
Right (SecretData (fromList [("my","password")]))

Soft secret deletion

deleteSecret :: VaultConnection -> SecretPath -> IO (Maybe Error)

deleteSecretVersions :: VaultConnection -> SecretPath -> SecretVersions -> IO (Maybe Error)

unDeleteSecretVersions :: VaultConnection -> SecretPath -> SecretVersions -> IO (Maybe Error)

Permanent secret deletion

destroySecret :: VaultConnection -> SecretPath -> IO (Maybe Error)

Permanently delete a secret, i.e. all its versions and metadata.

destroySecretVersions :: VaultConnection -> SecretPath -> SecretVersions -> IO (Either String Value)

Get informations

currentSecretVersion :: VaultConnection -> SecretPath -> IO (Either String SecretVersion)

Get version number of the current given secret.

readSecretMetadata :: VaultConnection -> SecretPath -> IO (Either String SecretMetadata)

Retrieve versions history of the given secret.

λ: readSecretMetadata conn (SecretPath "MySecret") 
Right (SecretMetadata (fromList [(SecretVersion 1,Metadata {destroyed = True, deletion_time = "", created_time = "2019-05-30T13:22:58.416399224Z"}),(SecretVersion 2,Metadata {destroyed = True, deletion_time = "2019-06-29T15:28:46.145302138Z"})]))

secretsList :: VaultConnection -> SecretPath -> IO (Either String [VaultKey])

Get list of secrets and folders at the given location.

Utils

toSecretData :: [(Text, Text)] -> SecretData

fromSecretData :: SecretData -> [(Text, Text)]

toSecretVersions :: [Int] -> SecretVersions