Data.KeyStore.IO

This module provide an IO-based API. The ks executable provides some keystore management functions that can be used from the shell and Data.KeyStore.KeyStore provides the underlying functional model.

Documentation

readSettings :: FilePath -> IO Settings

Read the JSON-encoded KeyStore settings from the named file.

data CtxParams

The parameters used to set up a KeyStore session.

Constructors

CtxParams

Fields

cp_store :: Maybe FilePath

location of any explictlt specified keystore file

cp_debug :: Maybe Bool

whether debug output has been specified enabled or not

cp_readonly :: Maybe Bool

Just True => do not update keystore

Instances

Show CtxParams

data IC

Constructors

IC

Fields

ic_ctx_params :: CtxParams

ic_cache :: Maybe (IORef (Ctx, State))

module Data.KeyStore.Types

module Data.KeyStore.KS.KS

keyStoreBytes :: KeyStore -> ByteString

Encode a key store as a JSON ByteString (discarding any cached cleartext copies of secrets it may have)

keyStoreFromBytes :: ByteString -> E KeyStore

settingsFromBytes :: ByteString -> E Settings

defaultSettingsFilePath :: FilePath

The default place for keystore settings (settings).

settingsFilePath :: String -> FilePath

Add the standard file extension to a base name (.json).

defaultKeyStoreFilePath :: FilePath

The default file for a keystore (keystore.json).

defaultCtxParams :: CtxParams

Suitable default CtxParams.

instanceCtx :: CtxParams -> IO IC

Given CtxParams describing the location of the keystore, etc., generate an IC for use in the following keystore access functions that will allow context to be cached between calls to these access functions.

instanceCtx_ :: CtxParams -> IC

This functional method will generate an IC that will not cache any state between calls.

newKeyStore :: FilePath -> Settings -> IO ()

Generate a new keystore located in the given file with the given global settings.

store :: IC -> IO FilePath

the filepath of the loaded store

listSettings :: IC -> IO ()

List the JSON settings on stdout.

settings :: IC -> IO Settings

Return the settings associated with the keystore.

updateSettings :: IC -> FilePath -> IO ()

Update the global settings of a keystore from the given JSON settings.

listTriggers :: IC -> IO ()

List the triggers set up in the keystore on stdout.

triggers :: IC -> IO [Trigger]

Returns the striggers setup on the keystore.

addTrigger :: IC -> TriggerID -> Pattern -> FilePath -> IO ()

addTrigger' cariant that erads the setting from a file.

addTrigger' :: IC -> TriggerID -> Pattern -> Settings -> IO ()

Set up a named trigger on a keystore that will fire when a key matches the given pattern establishing the settings.

rmvTrigger :: IC -> TriggerID -> IO ()

Remove the named trigger from the keystore.

createRSAKeyPair :: IC -> Name -> Comment -> Identity -> [Safeguard] -> IO ()

Create an RSA key pair, encoding the private key in the named Safeguards.

createKey :: IC -> Name -> Comment -> Identity -> Maybe EnvVar -> Maybe ByteString -> IO ()

Create a symmetric key, possibly auto-loaded from an environment variable.

adjustKey :: IC -> Name -> (Key -> Key) -> IO ()

Adjust a named key.

rememberKey :: IC -> Name -> FilePath -> IO ()

Load a named key from the named file.

rememberKey_ :: IC -> Name -> ByteString -> IO ()

Load the named key.

secureKey :: IC -> Name -> Safeguard -> IO ()

Encrypt and store the key with the named safeguard.

loadKey :: IC -> Name -> IO Key

Try and retrieve the secret text for a given key.

showIdentity :: IC -> Bool -> Name -> IO ByteString

Return the identity of a key.

showComment :: IC -> Bool -> Name -> IO ByteString

Return the comment associated with a key.

showDate :: IC -> Bool -> Name -> IO ByteString

Return the creation UTC of a key.

showHash :: IC -> Bool -> Name -> IO ByteString

Return the hash of a key.

showHashComment :: IC -> Bool -> Name -> IO ByteString

Return the hash comment of a key/

showHashSalt :: IC -> Bool -> Name -> IO ByteString

Retuen the hash salt of a key.

showPublic :: IC -> Bool -> Name -> IO ByteString

(For public key pairs only) return the public key.

showSecret :: IC -> Bool -> Name -> IO ByteString

Return the secret text of a key (will be the private key for a public key pair).

keys :: IC -> IO [Key]

Return all of the keys in the keystore.

list :: IC -> IO ()

List a summary of all of the keys on stdout.

keyInfo :: IC -> Name -> IO ()

deleteKeys :: IC -> [Name] -> IO ()

Delete a list of keys from the keystore.

encrypt :: IC -> Name -> FilePath -> FilePath -> IO ()

encrypt_ :: IC -> Name -> ByteString -> IO ByteString

Encrypt a ByteString with a named key.

encrypt__ :: IC -> Name -> ByteString -> IO RSASecretData

Encrypt a ByteString with a named key to produce a RSASecretData.

decrypt :: IC -> FilePath -> FilePath -> IO ()

Decrypt a file with the named key (whose secret text must be accessible).

decrypt_ :: IC -> ByteString -> IO ByteString

Decrypt a ByteString with the named key (whose secret text must be accessible).

decrypt__ :: IC -> Name -> RSASecretData -> IO ByteString

Decrypt a ByteString from a RSASecretData with the named key (whose secret text must be accessible).

sign :: IC -> Name -> FilePath -> FilePath -> IO ()

Sign a file with the named key (whose secret text must be accessible) to produce a detached signature in the named file.

sign_ :: IC -> Name -> ByteString -> IO ByteString

Sign a ByteString with the named key (whose secret text must be accessible) to produce a detached signature.

verify :: IC -> FilePath -> FilePath -> IO Bool

Verify that a signature for a file via the named public key.

verify_ :: IC -> ByteString -> ByteString -> IO Bool

Verify that a signature for a ByteString via the named public key.

run :: IC -> KS a -> IO a

Run a KS function in an IO context, dealing with keystore updates, output, debug logging and errors.