Network.VaultTool

Unless otherwise specified, all IO functions in this module may potentially throw HttpException or VaultException

Documentation

newtype VaultAddress

Constructors

VaultAddress

Fields

• unVaultAddress :: Text

Instances

Eq VaultAddress

Methods

(==) :: VaultAddress -> VaultAddress -> Bool

(/=) :: VaultAddress -> VaultAddress -> Bool

Ord VaultAddress

Methods

compare :: VaultAddress -> VaultAddress -> Ordering

(<) :: VaultAddress -> VaultAddress -> Bool

(<=) :: VaultAddress -> VaultAddress -> Bool

(>) :: VaultAddress -> VaultAddress -> Bool

(>=) :: VaultAddress -> VaultAddress -> Bool

max :: VaultAddress -> VaultAddress -> VaultAddress

min :: VaultAddress -> VaultAddress -> VaultAddress

Show VaultAddress

Methods

showsPrec :: Int -> VaultAddress -> ShowS

show :: VaultAddress -> String

showList :: [VaultAddress] -> ShowS

newtype VaultUnsealKey

Constructors

VaultUnsealKey

Fields

• unVaultUnsealKey :: Text

Instances

Eq VaultUnsealKey

Methods

(==) :: VaultUnsealKey -> VaultUnsealKey -> Bool

(/=) :: VaultUnsealKey -> VaultUnsealKey -> Bool

Ord VaultUnsealKey

Methods

compare :: VaultUnsealKey -> VaultUnsealKey -> Ordering

(<) :: VaultUnsealKey -> VaultUnsealKey -> Bool

(<=) :: VaultUnsealKey -> VaultUnsealKey -> Bool

(>) :: VaultUnsealKey -> VaultUnsealKey -> Bool

(>=) :: VaultUnsealKey -> VaultUnsealKey -> Bool

max :: VaultUnsealKey -> VaultUnsealKey -> VaultUnsealKey

min :: VaultUnsealKey -> VaultUnsealKey -> VaultUnsealKey

Show VaultUnsealKey

Methods

showsPrec :: Int -> VaultUnsealKey -> ShowS

show :: VaultUnsealKey -> String

showList :: [VaultUnsealKey] -> ShowS

newtype VaultAuthToken

Constructors

VaultAuthToken

Fields

• unVaultAuthToken :: ByteString

Instances

Eq VaultAuthToken

Methods

(==) :: VaultAuthToken -> VaultAuthToken -> Bool

(/=) :: VaultAuthToken -> VaultAuthToken -> Bool

Ord VaultAuthToken

Methods

compare :: VaultAuthToken -> VaultAuthToken -> Ordering

(<) :: VaultAuthToken -> VaultAuthToken -> Bool

(<=) :: VaultAuthToken -> VaultAuthToken -> Bool

(>) :: VaultAuthToken -> VaultAuthToken -> Bool

(>=) :: VaultAuthToken -> VaultAuthToken -> Bool

max :: VaultAuthToken -> VaultAuthToken -> VaultAuthToken

min :: VaultAuthToken -> VaultAuthToken -> VaultAuthToken

Show VaultAuthToken

Methods

showsPrec :: Int -> VaultAuthToken -> ShowS

show :: VaultAuthToken -> String

showList :: [VaultAuthToken] -> ShowS

FromJSON VaultAuthToken

Methods

parseJSON :: Value -> Parser VaultAuthToken

parseJSONList :: Value -> Parser [VaultAuthToken]

data VaultException

Constructors

VaultException

VaultException_InvalidAddress ByteString String

VaultException_BadStatusCode ByteString String ByteString Int ByteString

VaultException_ParseBodyError ByteString String ByteString String

Instances

Eq VaultException

Methods

(==) :: VaultException -> VaultException -> Bool

(/=) :: VaultException -> VaultException -> Bool

Show VaultException

Methods

showsPrec :: Int -> VaultException -> ShowS

show :: VaultException -> String

showList :: [VaultException] -> ShowS

Exception VaultException

Methods

toException :: VaultException -> SomeException

fromException :: SomeException -> Maybe VaultException

displayException :: VaultException -> String

data VaultHealth

https://www.vaultproject.io/docs/http/sys-health.html

See vaultHealth

Constructors

VaultHealth

Fields

• _VaultHealth_Version :: Text
• _VaultHealth_ServerTimeUtc :: Int
• _VaultHealth_Initialized :: Bool
• _VaultHealth_Sealed :: Bool
• _VaultHealth_Standby :: Bool

Instances

Eq VaultHealth

Methods

(==) :: VaultHealth -> VaultHealth -> Bool

(/=) :: VaultHealth -> VaultHealth -> Bool

Ord VaultHealth

Methods

compare :: VaultHealth -> VaultHealth -> Ordering

(<) :: VaultHealth -> VaultHealth -> Bool

(<=) :: VaultHealth -> VaultHealth -> Bool

(>) :: VaultHealth -> VaultHealth -> Bool

(>=) :: VaultHealth -> VaultHealth -> Bool

max :: VaultHealth -> VaultHealth -> VaultHealth

min :: VaultHealth -> VaultHealth -> VaultHealth

Show VaultHealth

Methods

showsPrec :: Int -> VaultHealth -> ShowS

show :: VaultHealth -> String

showList :: [VaultHealth] -> ShowS

FromJSON VaultHealth

Methods

parseJSON :: Value -> Parser VaultHealth

parseJSONList :: Value -> Parser [VaultHealth]

vaultHealth :: VaultAddress -> IO VaultHealth

https://www.vaultproject.io/docs/http/sys-health.html

data VaultConnection

connectToVault :: VaultAddress -> VaultAuthToken -> IO VaultConnection

Just initializes the VaultConnection objects, does not actually make any contact with the vault server. (That is also the explanation why there is no function to disconnect)

vaultInit

Arguments

:: VaultAddress

-> Int

secret_shares: The number of shares to split the master key into

-> Int

secret_threshold: The number of shares required to reconstruct the master key. This must be less than or equal to secret_shares

-> IO ([VaultUnsealKey], VaultAuthToken)

master keys and initial root token

https://www.vaultproject.io/docs/http/sys-init.html

data VaultSealStatus

https://www.vaultproject.io/docs/http/sys-seal-status.html

See vaultSealStatus

Constructors

VaultSealStatus

Fields

• _VaultSealStatus_Sealed :: Bool
• _VaultSealStatus_T :: Int

  threshold

• _VaultSealStatus_N :: Int

  number of shares

• _VaultSealStatus_Progress :: Int

Instances

Eq VaultSealStatus

Methods

(==) :: VaultSealStatus -> VaultSealStatus -> Bool

(/=) :: VaultSealStatus -> VaultSealStatus -> Bool

Ord VaultSealStatus

Methods

compare :: VaultSealStatus -> VaultSealStatus -> Ordering

(<) :: VaultSealStatus -> VaultSealStatus -> Bool

(<=) :: VaultSealStatus -> VaultSealStatus -> Bool

(>) :: VaultSealStatus -> VaultSealStatus -> Bool

(>=) :: VaultSealStatus -> VaultSealStatus -> Bool

max :: VaultSealStatus -> VaultSealStatus -> VaultSealStatus

min :: VaultSealStatus -> VaultSealStatus -> VaultSealStatus

Show VaultSealStatus

Methods

showsPrec :: Int -> VaultSealStatus -> ShowS

show :: VaultSealStatus -> String

showList :: [VaultSealStatus] -> ShowS

FromJSON VaultSealStatus

Methods

parseJSON :: Value -> Parser VaultSealStatus

parseJSONList :: Value -> Parser [VaultSealStatus]

vaultSealStatus :: VaultAddress -> IO VaultSealStatus

vaultSeal :: VaultConnection -> IO ()

data VaultUnseal

https://www.vaultproject.io/docs/http/sys-unseal.html

See vaultUnseal

Constructors

VaultUnseal_Key VaultUnsealKey

VaultUnseal_Reset

Instances

Eq VaultUnseal

Methods

(==) :: VaultUnseal -> VaultUnseal -> Bool

(/=) :: VaultUnseal -> VaultUnseal -> Bool

Ord VaultUnseal

Methods

compare :: VaultUnseal -> VaultUnseal -> Ordering

(<) :: VaultUnseal -> VaultUnseal -> Bool

(<=) :: VaultUnseal -> VaultUnseal -> Bool

(>) :: VaultUnseal -> VaultUnseal -> Bool

(>=) :: VaultUnseal -> VaultUnseal -> Bool

max :: VaultUnseal -> VaultUnseal -> VaultUnseal

min :: VaultUnseal -> VaultUnseal -> VaultUnseal

Show VaultUnseal

Methods

showsPrec :: Int -> VaultUnseal -> ShowS

show :: VaultUnseal -> String

showList :: [VaultUnseal] -> ShowS

vaultUnseal :: VaultAddress -> VaultUnseal -> IO VaultSealStatus

https://www.vaultproject.io/docs/http/sys-unseal.html

data VaultMount a b

https://www.vaultproject.io/docs/http/sys-mounts.html

Constructors

VaultMount

Fields

• _VaultMount_Type :: Text
• _VaultMount_Description :: a
• _VaultMount_Config :: b

Instances

FromJSON VaultMountRead

Methods

parseJSON :: Value -> Parser VaultMountRead

parseJSONList :: Value -> Parser [VaultMountRead]

ToJSON VaultMountWrite

Methods

toJSON :: VaultMountWrite -> Value

toEncoding :: VaultMountWrite -> Encoding

toJSONList :: [VaultMountWrite] -> Value

toEncodingList :: [VaultMountWrite] -> Encoding

(Eq b, Eq a) => Eq (VaultMount a b)

Methods

(==) :: VaultMount a b -> VaultMount a b -> Bool

(/=) :: VaultMount a b -> VaultMount a b -> Bool

(Ord b, Ord a) => Ord (VaultMount a b)

Methods

compare :: VaultMount a b -> VaultMount a b -> Ordering

(<) :: VaultMount a b -> VaultMount a b -> Bool

(<=) :: VaultMount a b -> VaultMount a b -> Bool

(>) :: VaultMount a b -> VaultMount a b -> Bool

(>=) :: VaultMount a b -> VaultMount a b -> Bool

max :: VaultMount a b -> VaultMount a b -> VaultMount a b

min :: VaultMount a b -> VaultMount a b -> VaultMount a b

(Show b, Show a) => Show (VaultMount a b)

Methods

showsPrec :: Int -> VaultMount a b -> ShowS

show :: VaultMount a b -> String

showList :: [VaultMount a b] -> ShowS

type VaultMountRead = VaultMount Text VaultMountConfigRead

type VaultMountWrite = VaultMount (Maybe Text) (Maybe VaultMountConfigWrite)

data VaultMountConfig a

https://www.vaultproject.io/docs/http/sys-mounts.html

Constructors

VaultMountConfig

Fields

• _VaultMountConfig_DefaultLeaseTtl :: a
• _VaultMountConfig_MaxLeaseTtl :: a

Instances

FromJSON VaultMountConfigRead

Methods

parseJSON :: Value -> Parser VaultMountConfigRead

parseJSONList :: Value -> Parser [VaultMountConfigRead]

FromJSON VaultMountRead

Methods

parseJSON :: Value -> Parser VaultMountRead

parseJSONList :: Value -> Parser [VaultMountRead]

ToJSON VaultMountConfigWrite

Methods

toJSON :: VaultMountConfigWrite -> Value

toEncoding :: VaultMountConfigWrite -> Encoding

toJSONList :: [VaultMountConfigWrite] -> Value

toEncodingList :: [VaultMountConfigWrite] -> Encoding

ToJSON VaultMountWrite

Methods

toJSON :: VaultMountWrite -> Value

toEncoding :: VaultMountWrite -> Encoding

toJSONList :: [VaultMountWrite] -> Value

toEncodingList :: [VaultMountWrite] -> Encoding

Eq a => Eq (VaultMountConfig a)

Methods

(==) :: VaultMountConfig a -> VaultMountConfig a -> Bool

(/=) :: VaultMountConfig a -> VaultMountConfig a -> Bool

Ord a => Ord (VaultMountConfig a)

Methods

compare :: VaultMountConfig a -> VaultMountConfig a -> Ordering

(<) :: VaultMountConfig a -> VaultMountConfig a -> Bool

(<=) :: VaultMountConfig a -> VaultMountConfig a -> Bool

(>) :: VaultMountConfig a -> VaultMountConfig a -> Bool

(>=) :: VaultMountConfig a -> VaultMountConfig a -> Bool

max :: VaultMountConfig a -> VaultMountConfig a -> VaultMountConfig a

min :: VaultMountConfig a -> VaultMountConfig a -> VaultMountConfig a

Show a => Show (VaultMountConfig a)

Methods

showsPrec :: Int -> VaultMountConfig a -> ShowS

show :: VaultMountConfig a -> String

showList :: [VaultMountConfig a] -> ShowS

type VaultMountConfigRead = VaultMountConfig Int

type VaultMountConfigWrite = VaultMountConfig (Maybe Int)

vaultMounts :: VaultConnection -> IO [(Text, VaultMountRead)]

https://www.vaultproject.io/docs/http/sys-mounts.html

For your convenience, the results are returned sorted (by the mount point)

vaultMountTune :: VaultConnection -> Text -> IO VaultMountConfigRead

https://www.vaultproject.io/docs/http/sys-mounts.html

vaultMountSetTune :: VaultConnection -> Text -> VaultMountConfigWrite -> IO ()

https://www.vaultproject.io/docs/http/sys-mounts.html

vaultNewMount :: VaultConnection -> Text -> VaultMountWrite -> IO ()

https://www.vaultproject.io/docs/http/sys-mounts.html

vaultUnmount :: VaultConnection -> Text -> IO ()

https://www.vaultproject.io/docs/http/sys-mounts.html

newtype VaultSecretPath

Constructors

VaultSecretPath

Fields

• unVaultSecretPath :: Text

Instances

Eq VaultSecretPath

Methods

(==) :: VaultSecretPath -> VaultSecretPath -> Bool

(/=) :: VaultSecretPath -> VaultSecretPath -> Bool

Ord VaultSecretPath

Methods

compare :: VaultSecretPath -> VaultSecretPath -> Ordering

(<) :: VaultSecretPath -> VaultSecretPath -> Bool

(<=) :: VaultSecretPath -> VaultSecretPath -> Bool

(>) :: VaultSecretPath -> VaultSecretPath -> Bool

(>=) :: VaultSecretPath -> VaultSecretPath -> Bool

max :: VaultSecretPath -> VaultSecretPath -> VaultSecretPath

min :: VaultSecretPath -> VaultSecretPath -> VaultSecretPath

Show VaultSecretPath

Methods

showsPrec :: Int -> VaultSecretPath -> ShowS

show :: VaultSecretPath -> String

showList :: [VaultSecretPath] -> ShowS

data VaultSecretMetadata

Constructors

VaultSecretMetadata

Fields

• _VaultSecretMetadata_leaseDuration :: Int
• _VaultSecretMetadata_leaseId :: Text
• _VauleSecretMetadata_renewable :: Bool

Instances

Eq VaultSecretMetadata

Methods

(==) :: VaultSecretMetadata -> VaultSecretMetadata -> Bool

(/=) :: VaultSecretMetadata -> VaultSecretMetadata -> Bool

Show VaultSecretMetadata

Methods

showsPrec :: Int -> VaultSecretMetadata -> ShowS

show :: VaultSecretMetadata -> String

showList :: [VaultSecretMetadata] -> ShowS

FromJSON VaultSecretMetadata

Methods

parseJSON :: Value -> Parser VaultSecretMetadata

parseJSONList :: Value -> Parser [VaultSecretMetadata]

vaultWrite :: ToJSON a => VaultConnection -> VaultSecretPath -> a -> IO ()

https://www.vaultproject.io/docs/secrets/generic/index.html

The value that you give must encode as a JSON object

vaultRead

Arguments

:: FromJSON a

=> VaultConnection

-> VaultSecretPath

-> IO (VaultSecretMetadata, Either (Value, String) a)

A Left result means that the secret's "data" could not be parsed into the data structure that you requested.

You will get the "data" as a raw Value as well as the error message from the parse failure

vaultDelete :: VaultConnection -> VaultSecretPath -> IO ()

https://www.vaultproject.io/docs/secrets/generic/index.html

vaultList :: VaultConnection -> VaultSecretPath -> IO [VaultSecretPath]

https://www.vaultproject.io/docs/secrets/generic/index.html

This will normalise the results to be full secret paths.

Will return only secrets that in the are located in the folder hierarchy directly below the given folder.

Use isFolder to check if whether each result is a secret or a subfolder.

The order of the results is unspecified.

To recursively retrieve all of the secrets use vaultListRecursive

isFolder :: VaultSecretPath -> Bool

Does the path end with a / character?

Meant to be used on the results of vaultList

vaultListRecursive :: VaultConnection -> VaultSecretPath -> IO [VaultSecretPath]

Recursively calls vaultList to retrieve all of the secrets in a folder (including all subfolders and sub-subfolders, etc...)

There will be no folders in the result.

The order of the results is unspecified.