Data.KeyStore.KS

Documentation

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

createRSAKeyPairKS :: Name -> Comment -> Identity -> [Safeguard] -> KS ()

encryptWithRSAKeyKS :: Name -> ClearText -> KS EncryptionPacket

Encrypt a clear text message with a name RSA key pair.

encryptWithRSAKeyKS_ :: Name -> ClearText -> KS RSASecretData

decryptWithRSAKeyKS :: EncryptionPacket -> KS ClearText

Decrypt an RSA-encrypted message (the RSA secret key named in the message must be available.)

decryptWithRSAKeyKS_ :: Name -> RSASecretData -> KS ClearText

signWithRSAKeyKS :: Name -> ClearText -> KS SignaturePacket

Sign a message with a named RSA secret key (which must be available).

verifyWithRSAKeyKS :: ClearText -> SignaturePacket -> KS Bool

Verify that an RSA signature of a message is correct.

encryptWithKeysKS :: Safeguard -> ClearText -> KS EncrypedCopy

Symetrically encrypt a message with a Safeguard (list of names private keys).

decryptWithKeysKS :: EncrypedCopy -> KS ClearText

Symetrically encrypt a message with a Safeguard (list of names private keys).

createKeyKS

Arguments

:: Name

(unique) name of the new key

-> Comment

the comment string

-> Identity

the identity string

-> Maybe EnvVar

the environment variable used to hold a clear text copy

-> Maybe ClearText

(optionally) the clear test copy

-> KS ()

Create a private key.

backupKeysKS :: KS ()

Backup all of the keys in the store with their configured backup keys.

rememberKeyKS :: Name -> ClearText -> KS ()

Remember the secret text for a key -- will record the hash and encrypt it with the configured safeguards, generating an error if any of the safeguards are not available.

secureKeyKS :: Name -> Safeguard -> KS ()

Primitive to make a cryptographic copy (i.e., a safeguard) of the secret text of a key, storing it in the key (and doing nothing if the that safeguard is already present).

getKeysKS :: KS [Key]

Return all of the keys in the keystore.

listKS :: KS ()

List all of the keys in the store, one per line, on the output.

keyInfoKS :: Name -> KS ()

Print out the information of a particular key.

loadKeyKS :: Name -> KS Key

Try to load the secret copy into the key and return it. (No error is raised if it failed to recover the secret.)

loadEncryptionKeyKS :: Dirctn -> EncrypedCopy -> KS (Maybe EncryptionKey)

Try to load an encryption or decryption key for an encrypted message.

module Data.KeyStore.KS.Crypto

module Data.KeyStore.KS.KS

module Data.KeyStore.KS.Opt

module Data.KeyStore.KS.Configuration

module Data.KeyStore.KS.CPRNG