Safe Haskell	None

Data.KeyStore.Types

Description

The KeyStore and Associated Types

Note that most of these types and functions were generated by the api-tools (Data.Api.Tools) from the schema in Data.KeyStore.Types.Schema, marked down in https://github.com/cdornan/keystore/blob/master/schema.md.

Synopsis

Documentation

data REP__Settings Source

Constructors

REP__Settings
Fields _stgs_json :: !Value

Instances

Eq REP__Settings
Show REP__Settings
Typeable REP__Settings
ToJSON REP__Settings
FromJSONWithErrs REP__Settings

data REP__Safeguard Source

Constructors

REP__Safeguard
Fields _sg_names :: ![Name]

Instances

Eq REP__Safeguard
Show REP__Safeguard
Typeable REP__Safeguard
ToJSON REP__Safeguard
FromJSONWithErrs REP__Safeguard

data REP__PublicKey Source

Constructors

REP__PublicKey
Fields _puk_size :: !Int _puk_n :: !Integer _puk_e :: !Integer

Instances

Eq REP__PublicKey
Show REP__PublicKey
Typeable REP__PublicKey
ToJSON REP__PublicKey
FromJSONWithErrs REP__PublicKey

data REP__PrivateKey Source

Constructors

REP__PrivateKey
Fields _prk_pub :: !PublicKey _prk_d :: !Integer _prk_p :: !Integer _prk_q :: !Integer _prk_dP :: !Integer _prk_dQ :: !Integer _prk_qinv :: !Integer

Instances

Eq REP__PrivateKey
Show REP__PrivateKey
Typeable REP__PrivateKey
ToJSON REP__PrivateKey
FromJSONWithErrs REP__PrivateKey

data Cipher Source

Constructors

CPH_aes128
CPH_aes192
CPH_aes256

Instances

Bounded Cipher
Enum Cipher
Eq Cipher
Ord Cipher
Show Cipher
Typeable Cipher
ToJSON Cipher
FromJSONWithErrs Cipher

data HashPRF Source

Constructors

PRF_sha1
PRF_sha256
PRF_sha512

Instances

Bounded HashPRF
Enum HashPRF
Eq HashPRF
Ord HashPRF
Show HashPRF
Typeable HashPRF
ToJSON HashPRF
FromJSONWithErrs HashPRF

newtype FragmentID Source

Constructors

FragmentID
Fields _FragmentID :: Text

Instances

Eq FragmentID
Ord FragmentID
Show FragmentID
Typeable FragmentID
IsString FragmentID
ToJSON FragmentID
FromJSONWithErrs FragmentID

newtype REP__Pattern Source

Constructors

REP__Pattern
Fields _REP__Pattern :: Text

Instances

Eq REP__Pattern
Ord REP__Pattern
Show REP__Pattern
Typeable REP__Pattern
IsString REP__Pattern
ToJSON REP__Pattern
FromJSONWithErrs REP__Pattern

newtype Iterations Source

Constructors

Iterations
Fields _Iterations :: Int

Instances

Eq Iterations
Num Iterations
Ord Iterations
Show Iterations
Typeable Iterations
ToJSON Iterations
FromJSONWithErrs Iterations

newtype Octets Source

Constructors

Octets
Fields _Octets :: Int

Instances

Eq Octets
Num Octets
Ord Octets
Show Octets
Typeable Octets
ToJSON Octets
FromJSONWithErrs Octets

newtype REP__Name Source

Constructors

REP__Name
Fields _REP__Name :: Text

Instances

Eq REP__Name
Ord REP__Name
Show REP__Name
Typeable REP__Name
IsString REP__Name
ToJSON REP__Name
FromJSONWithErrs REP__Name

newtype Identity Source

Constructors

Identity
Fields _Identity :: Text

Instances

Eq Identity
Ord Identity
Show Identity
Typeable Identity
IsString Identity
ToJSON Identity
FromJSONWithErrs Identity

newtype SettingID Source

Constructors

SettingID
Fields _SettingID :: Text

Instances

Eq SettingID
Ord SettingID
Show SettingID
Typeable SettingID
IsString SettingID
ToJSON SettingID
FromJSONWithErrs SettingID

data TextJsonAssoc Source

Constructors

TextJsonAssoc
Fields _tja_id :: !SettingID _tja_key :: !Value

Instances

Eq TextJsonAssoc
Show TextJsonAssoc
Typeable TextJsonAssoc
ToJSON TextJsonAssoc
FromJSONWithErrs TextJsonAssoc

newtype TriggerID Source

Constructors

TriggerID
Fields _TriggerID :: Text

Instances

Eq TriggerID
Ord TriggerID
Show TriggerID
Typeable TriggerID
IsString TriggerID
ToJSON TriggerMap
ToJSON TriggerID
FromJSONWithErrs TriggerMap
FromJSONWithErrs TriggerID

newtype Comment Source

Constructors

Comment
Fields _Comment :: Text

Instances

Eq Comment
Ord Comment
Show Comment
Typeable Comment
IsString Comment
ToJSON Comment
FromJSONWithErrs Comment

newtype EnvVar Source

Constructors

EnvVar
Fields _EnvVar :: Text

Instances

Eq EnvVar
Ord EnvVar
Show EnvVar
Typeable EnvVar
IsString EnvVar
ToJSON EnvVar
FromJSONWithErrs EnvVar

newtype ClearText Source

Constructors

ClearText
Fields _ClearText :: Binary

Instances

Eq ClearText
Ord ClearText
Show ClearText
Typeable ClearText
ToJSON ClearText
FromJSONWithErrs ClearText

newtype Salt Source

Constructors

Salt
Fields _Salt :: Binary

Instances

Eq Salt
Ord Salt
Show Salt
Typeable Salt
ToJSON Salt
FromJSONWithErrs Salt

data HashDescription Source

Constructors

HashDescription
Fields _hashd_comment :: !Comment _hashd_prf :: !HashPRF _hashd_iterations :: !Iterations _hashd_width_octets :: !Octets _hashd_salt_octets :: !Octets _hashd_salt :: !Salt

Instances

Eq HashDescription
Show HashDescription
Typeable HashDescription
ToJSON HashDescription
FromJSONWithErrs HashDescription

newtype IV Source

Constructors

IV
Fields _IV :: Binary

Instances

Eq IV
Ord IV
Show IV
Typeable IV
ToJSON IV
FromJSONWithErrs IV

newtype HashData Source

Constructors

HashData
Fields _HashData :: Binary

Instances

Eq HashData
Ord HashData
Show HashData
Typeable HashData
ToJSON HashData
FromJSONWithErrs HashData

data Hash Source

Constructors

Hash
Fields _hash_description :: !HashDescription _hash_hash :: !HashData

Instances

Eq Hash
Show Hash
Typeable Hash
ToJSON Hash
FromJSONWithErrs Hash

newtype AESKey Source

Constructors

AESKey
Fields _AESKey :: Binary

Instances

Eq AESKey
Ord AESKey
Show AESKey
Typeable AESKey
ToJSON AESKey
FromJSONWithErrs AESKey

newtype SecretData Source

Constructors

SecretData
Fields _SecretData :: Binary

Instances

Eq SecretData
Ord SecretData
Show SecretData
Typeable SecretData
ToJSON SecretData
FromJSONWithErrs SecretData

data AESSecretData Source

Constructors

AESSecretData
Fields _asd_iv :: !IV _asd_secret_data :: !SecretData

Instances

Eq AESSecretData
Show AESSecretData
Typeable AESSecretData
ToJSON AESSecretData
FromJSONWithErrs AESSecretData

newtype RSAEncryptedKey Source

Constructors

RSAEncryptedKey
Fields _RSAEncryptedKey :: Binary

Instances

Eq RSAEncryptedKey
Ord RSAEncryptedKey
Show RSAEncryptedKey
Typeable RSAEncryptedKey
ToJSON RSAEncryptedKey
FromJSONWithErrs RSAEncryptedKey

data RSASecretData Source

Constructors

RSASecretData
Fields _rsd_encrypted_key :: !RSAEncryptedKey _rsd_aes_secret_data :: !AESSecretData

Instances

Eq RSASecretData
Show RSASecretData
Typeable RSASecretData
ToJSON RSASecretData
FromJSONWithErrs RSASecretData

newtype RSASecretBytes Source

Constructors

RSASecretBytes
Fields _RSASecretBytes :: Binary

Instances

Eq RSASecretBytes
Ord RSASecretBytes
Show RSASecretBytes
Typeable RSASecretBytes
ToJSON RSASecretBytes
FromJSONWithErrs RSASecretBytes

newtype RSASignature Source

Constructors

RSASignature
Fields _RSASignature :: Binary

Instances

Eq RSASignature
Ord RSASignature
Show RSASignature
Typeable RSASignature
ToJSON RSASignature
FromJSONWithErrs RSASignature

newtype EncryptionPacket Source

Constructors

EncryptionPacket
Fields _EncryptionPacket :: Binary

Instances

Eq EncryptionPacket
Ord EncryptionPacket
Show EncryptionPacket
Typeable EncryptionPacket
ToJSON EncryptionPacket
FromJSONWithErrs EncryptionPacket

newtype SignaturePacket Source

Constructors

SignaturePacket
Fields _SignaturePacket :: Binary

Instances

Eq SignaturePacket
Ord SignaturePacket
Show SignaturePacket
Typeable SignaturePacket
ToJSON SignaturePacket
FromJSONWithErrs SignaturePacket

newtype Void Source

Constructors

Void
Fields _Void :: Int

Instances

Eq Void
Ord Void
Show Void
Typeable Void
ToJSON Void
FromJSONWithErrs Void

data EncryptionKey Source

Constructors

EK_public !PublicKey
EK_private !PrivateKey
EK_symmetric !AESKey
EK_none !Void

Instances

Eq EncryptionKey
Show EncryptionKey
Typeable EncryptionKey
ToJSON EncryptionKey
FromJSONWithErrs EncryptionKey

data EncrypedCopyData Source

Constructors

ECD_rsa !RSASecretData
ECD_aes !AESSecretData
ECD_clear !ClearText
ECD_no_data !Void

Instances

Eq EncrypedCopyData
Show EncrypedCopyData
Typeable EncrypedCopyData
ToJSON EncrypedCopyData
FromJSONWithErrs EncrypedCopyData

data EncrypedCopy Source

Constructors

EncrypedCopy
Fields _ec_safeguard :: !Safeguard _ec_cipher :: !Cipher _ec_prf :: !HashPRF _ec_iterations :: !Iterations _ec_salt :: !Salt _ec_secret_data :: !EncrypedCopyData

Instances

Eq EncrypedCopy
Show EncrypedCopy
Typeable EncrypedCopy
ToJSON EncrypedCopyMap
ToJSON EncrypedCopy
FromJSONWithErrs EncrypedCopyMap
FromJSONWithErrs EncrypedCopy

data REP__EncrypedCopyMap Source

Constructors

REP__EncrypedCopyMap
Fields _ecm_map :: ![EncrypedCopy]

Instances

Eq REP__EncrypedCopyMap
Show REP__EncrypedCopyMap
Typeable REP__EncrypedCopyMap
ToJSON REP__EncrypedCopyMap
FromJSONWithErrs REP__EncrypedCopyMap

data Trigger Source

Constructors

Trigger
Fields _trg_id :: !TriggerID _trg_pattern :: !Pattern _trg_settings :: !Settings

Instances

Eq Trigger
Show Trigger
Typeable Trigger
ToJSON TriggerMap
ToJSON Trigger
FromJSONWithErrs TriggerMap
FromJSONWithErrs Trigger

data REP__TriggerMap Source

Constructors

REP__TriggerMap
Fields _tmp_map :: ![Trigger]

Instances

Eq REP__TriggerMap
Show REP__TriggerMap
Typeable REP__TriggerMap
ToJSON REP__TriggerMap
FromJSONWithErrs REP__TriggerMap

data Configuration Source

Constructors

Configuration
Fields _cfg_settings :: !Settings _cfg_triggers :: !TriggerMap

Instances

Eq Configuration
Show Configuration
Typeable Configuration
ToJSON Configuration
FromJSONWithErrs Configuration

data Key Source

Constructors

Key
Fields _key_name :: !Name _key_comment :: !Comment _key_identity :: !Identity _key_is_binary :: !Bool _key_env_var :: !(Maybe EnvVar) _key_hash :: !(Maybe Hash) _key_public :: !(Maybe PublicKey) _key_secret_copies :: !EncrypedCopyMap _key_clear_text :: !(Maybe ClearText) _key_clear_private :: !(Maybe PrivateKey) _key_created_at :: !UTCTime

Instances

Eq Key
Show Key
Typeable Key
ToJSON KeyMap
ToJSON Key
FromJSONWithErrs KeyMap
FromJSONWithErrs Key

data KeyStore Source

Constructors

KeyStore
Fields _ks_config :: !Configuration _ks_keymap :: !KeyMap

Instances

Eq KeyStore
Show KeyStore
Typeable KeyStore
ToJSON KeyStore
FromJSONWithErrs KeyStore

data NameKeyAssoc Source

Constructors

NameKeyAssoc
Fields _nka_name :: !Name _nka_key :: !Key

Instances

Eq NameKeyAssoc
Show NameKeyAssoc
Typeable NameKeyAssoc
ToJSON NameKeyAssoc
FromJSONWithErrs NameKeyAssoc

data REP__KeyMap Source

Constructors

REP__KeyMap
Fields _kmp_map :: ![NameKeyAssoc]

Instances

Eq REP__KeyMap
Show REP__KeyMap
Typeable REP__KeyMap
ToJSON REP__KeyMap
FromJSONWithErrs REP__KeyMap

data Pattern Source

Keystore session context, created at the start of a session and passed to the keystore access functions.

Constructors

Pattern
Fields _pat_string :: String _pat_regex :: Regex

Instances

Eq Pattern
Show Pattern
IsString Pattern
ToJSON Pattern
FromJSONWithErrs Pattern

pattern :: String -> Pattern Source

inj_pattern :: REP__Pattern -> ParserWithErrs Pattern Source

prj_pattern :: Pattern -> REP__Pattern Source

type TriggerMap = Map TriggerID Trigger Source

inj_trigger_map :: REP__TriggerMap -> ParserWithErrs TriggerMap Source

prj_trigger_map :: TriggerMap -> REP__TriggerMap Source

newtype Settings Source

Constructors

Settings
Fields _Settings :: Object

Instances

Eq Settings
Show Settings
ToJSON Settings
Monoid Settings
FromJSONWithErrs Settings

inj_settings :: REP__Settings -> ParserWithErrs Settings Source

prj_settings :: Settings -> REP__Settings Source

defaultSettings :: Settings Source

checkSettingsCollisions :: Settings -> [SettingID]Source

marker :: Value Source

type KeyMap = Map Name Key Source

inj_keymap :: REP__KeyMap -> ParserWithErrs KeyMap Source

prj_keymap :: KeyMap -> REP__KeyMap Source

emptyKeyStore :: Configuration -> KeyStore Source

emptyKeyMap :: KeyMap Source

type EncrypedCopyMap = Map Safeguard EncrypedCopy Source

inj_encrypted_copy_map :: REP__EncrypedCopyMap -> ParserWithErrs EncrypedCopyMap Source

prj_encrypted_copy_map :: EncrypedCopyMap -> REP__EncrypedCopyMap Source

defaultConfiguration :: Settings -> Configuration Source

inj_safeguard :: REP__Safeguard -> ParserWithErrs Safeguard Source

prj_safeguard :: Safeguard -> REP__Safeguard Source

inj_name :: REP__Name -> ParserWithErrs Name Source

prj_name :: Name -> REP__Name Source

inj_PublicKey :: REP__PublicKey -> ParserWithErrs PublicKey Source

prj_PublicKey :: PublicKey -> REP__PublicKey Source

inj_PrivateKey :: REP__PrivateKey -> ParserWithErrs PrivateKey Source

prj_PrivateKey :: PrivateKey -> REP__PrivateKey Source

e2p :: E a -> ParserWithErrs aSource

data Dirctn Source

Constructors

Encrypting
Decrypting

Instances

Show Dirctn

pbkdf :: HashPRF -> ClearText -> Salt -> Iterations -> Octets -> (ByteString -> a) -> aSource

keyWidth :: Cipher -> Octets Source

void_ :: Void Source

map_from_list :: Ord a => String -> (c -> [b]) -> (b -> a) -> (a -> Text) -> c -> ParserWithErrs (Map a b)Source

void :: Iso' Void IntSource

signaturePacket :: Iso' SignaturePacket Binary Source

encryptionPacket :: Iso' EncryptionPacket Binary Source

rSASignature :: Iso' RSASignature Binary Source

rSASecretBytes :: Iso' RSASecretBytes Binary Source

rSAEncryptedKey :: Iso' RSAEncryptedKey Binary Source

secretData :: Iso' SecretData Binary Source

aESKey :: Iso' AESKey Binary Source

hashData :: Iso' HashData Binary Source

iV :: Iso' IV Binary Source

salt :: Iso' Salt Binary Source

clearText :: Iso' ClearText Binary Source

envVar :: Iso' EnvVar Text Source

comment :: Iso' Comment Text Source

triggerID :: Iso' TriggerID Text Source

settingID :: Iso' SettingID Text Source

identity :: Iso' Identity Text Source

rEP__Name :: Iso' REP__Name Text Source

octets :: Iso' Octets IntSource

iterations :: Iso' Iterations IntSource

rEP__Pattern :: Iso' REP__Pattern Text Source

fragmentID :: Iso' FragmentID Text Source

prk_qinv :: Lens' REP__PrivateKey IntegerSource

prk_q :: Lens' REP__PrivateKey IntegerSource

prk_pub :: Lens' REP__PrivateKey PublicKey Source

prk_p :: Lens' REP__PrivateKey IntegerSource

prk_dQ :: Lens' REP__PrivateKey IntegerSource

prk_dP :: Lens' REP__PrivateKey IntegerSource

prk_d :: Lens' REP__PrivateKey IntegerSource

puk_size :: Lens' REP__PublicKey IntSource

puk_n :: Lens' REP__PublicKey IntegerSource

puk_e :: Lens' REP__PublicKey IntegerSource

asd_secret_data :: Lens' AESSecretData SecretData Source

asd_iv :: Lens' AESSecretData IV Source

rsd_encrypted_key :: Lens' RSASecretData RSAEncryptedKey Source

rsd_aes_secret_data :: Lens' RSASecretData AESSecretData Source

sg_names :: Iso' REP__Safeguard [Name]Source

ec_secret_data :: Lens' EncrypedCopy EncrypedCopyData Source

ec_salt :: Lens' EncrypedCopy Salt Source

ec_safeguard :: Lens' EncrypedCopy Safeguard Source

ec_prf :: Lens' EncrypedCopy HashPRF Source

ec_iterations :: Lens' EncrypedCopy Iterations Source

ec_cipher :: Lens' EncrypedCopy Cipher Source

ecm_map :: Iso' REP__EncrypedCopyMap [EncrypedCopy]Source

hashd_width_octets :: Lens' HashDescription Octets Source

hashd_salt_octets :: Lens' HashDescription Octets Source

hashd_salt :: Lens' HashDescription Salt Source

hashd_prf :: Lens' HashDescription HashPRF Source

hashd_iterations :: Lens' HashDescription Iterations Source

hashd_comment :: Lens' HashDescription Comment Source

hash_hash :: Lens' Hash HashData Source

hash_description :: Lens' Hash HashDescription Source

key_secret_copies :: Lens' Key EncrypedCopyMap Source

key_public :: Lens' Key (Maybe PublicKey)Source

key_name :: Lens' Key Name Source

key_is_binary :: Lens' Key BoolSource

key_identity :: Lens' Key Identity Source

key_hash :: Lens' Key (Maybe Hash)Source

key_env_var :: Lens' Key (Maybe EnvVar)Source

key_created_at :: Lens' Key UTCTimeSource

key_comment :: Lens' Key Comment Source

key_clear_text :: Lens' Key (Maybe ClearText)Source

key_clear_private :: Lens' Key (Maybe PrivateKey)Source

nka_name :: Lens' NameKeyAssoc Name Source

nka_key :: Lens' NameKeyAssoc Key Source

kmp_map :: Iso' REP__KeyMap [NameKeyAssoc]Source

tja_key :: Lens' TextJsonAssoc Value Source

tja_id :: Lens' TextJsonAssoc SettingID Source

stgs_json :: Iso' REP__Settings Value Source

trg_settings :: Lens' Trigger Settings Source

trg_pattern :: Lens' Trigger Pattern Source

trg_id :: Lens' Trigger TriggerID Source

tmp_map :: Iso' REP__TriggerMap [Trigger]Source

cfg_triggers :: Lens' Configuration TriggerMap Source

cfg_settings :: Lens' Configuration Settings Source

ks_keymap :: Lens' KeyStore KeyMap Source

ks_config :: Lens' KeyStore Configuration Source

_map_HashPRF :: Map Text HashPRF Source

_text_HashPRF :: HashPRF -> Text Source

_map_Cipher :: Map Text Cipher Source

_text_Cipher :: Cipher -> Text Source

module Data.KeyStore.Types.NameAndSafeguard

module Data.KeyStore.Types.E

data PublicKey

Represent a RSA public key

Constructors

PublicKey
Fields public_size :: Int size of key in bytes public_n :: Integer public p*q public_e :: Integer public exponant e

Instances

Eq PublicKey
Data PublicKey
Read PublicKey
Show PublicKey
Typeable PublicKey
ToJSON PublicKey
FromJSONWithErrs PublicKey
ASN1Object PublicKey

data PrivateKey

Represent a RSA private key.

Only the pub, d fields are mandatory to fill.

p, q, dP, dQ, qinv are by-product during RSA generation, but are useful to record here to speed up massively the decrypt and sign operation.

implementations can leave optional fields to 0.

Constructors

PrivateKey
Fields private_pub :: PublicKey public part of a private key (size, n and e) private_d :: Integer private exponant d private_p :: Integer p prime number private_q :: Integer q prime number private_dP :: Integer d mod (p-1) private_dQ :: Integer d mod (q-1) private_qinv :: Integer q^(-1) mod p

Instances

Eq PrivateKey
Data PrivateKey
Read PrivateKey
Show PrivateKey
Typeable PrivateKey
ToJSON PrivateKey
FromJSONWithErrs PrivateKey
ASN1Object PrivateKey