keystore-0.8.1.1: Managing stores of secret things

Safe Haskell	None
Language	Haskell2010

Data.KeyStore.IO.IC

Synopsis

data IC = IC {
- ic_ctx_params :: CtxParams
- ic_cache :: Maybe (IORef (Ctx, State))
}
data CtxParams = CtxParams {
- cp_store :: Maybe FilePath
- cp_debug :: Maybe Bool
- cp_readonly :: Maybe Bool
}
defaultCtxParams :: CtxParams
defaultSettingsFilePath :: FilePath
settingsFilePath :: String -> FilePath
defaultKeyStoreFilePath :: FilePath
determineCtx :: CtxParams -> IO (Ctx, State)
establishState :: Ctx -> IO State
newGenerator :: IO CPRNG
readKeyStore :: Ctx -> IO KeyStore
readSettings :: FilePath -> IO Settings
scanEnv :: KeyStore -> IO (KeyStore, [LogEntry])
errorIO :: String -> IO a
logit :: Ctx -> LogEntry -> IO ()

Documentation

data IC Source #

Constructors

IC
Fields ic_ctx_params :: CtxParams ic_cache :: Maybe (IORef (Ctx, State))

data CtxParams Source #

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 Source #
Instance details Defined in Data.KeyStore.IO.IC Methods showsPrec :: Int -> CtxParams -> ShowS # show :: CtxParams -> String # showList :: [CtxParams] -> ShowS #

defaultCtxParams :: CtxParams Source #

Suitable default CtxParams.

defaultSettingsFilePath :: FilePath Source #

The default place for keystore settings (settings).

settingsFilePath :: String -> FilePath Source #

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

defaultKeyStoreFilePath :: FilePath Source #

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

determineCtx :: CtxParams -> IO (Ctx, State) Source #

Determine the Ctx and keystore State from CtxParams

establishState :: Ctx -> IO State Source #

Set up the keystore state.

newGenerator :: IO CPRNG Source #

readKeyStore :: Ctx -> IO KeyStore Source #

readSettings :: FilePath -> IO Settings Source #

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

scanEnv :: KeyStore -> IO (KeyStore, [LogEntry]) Source #

errorIO :: String -> IO a Source #

logit :: Ctx -> LogEntry -> IO () Source #