Copyright	(c) Reto Hablützel 2014
License	MIT
Maintainer	rethab@rethab.ch
Stability	experimental
Portability	untested
Safe Haskell	None
Language	Haskell2010

Crypto.Gpgme

Contents

Context
Keys
Encryption
Other Types

Description

High Level Binding for GnuPG Made Easy (gpgme)

Most of these functions are a one-to-one translation from GnuPG API with some Haskell idiomatics to make the API more convenient.

See the GnuPG manual for more information: https://www.gnupg.org/documentation/manuals/gpgme.pdf

Example (from the tests):

let alice_pub_fpr = "EAACEB8A"

-- encrypt
enc <- withCtx "test/bob" "C" openPGP $ \bCtx ->
          withKey bCtx alice_pub_fpr noSecret $ \aPubKey ->
              encrypt bCtx [aPubKey] noFlag plain

-- decrypt
dec <- withCtx "test/alice" "C" openPGP $ \aCtx ->
        decrypt aCtx (fromJustAndRight enc)

Synopsis

Context

data Ctx Source

Context to be passed around with operations. Use newCtx or withCtx in order to obtain an instance.

newCtx Source

Arguments

:: String	path to gpg homedirectory
-> String	locale
-> Protocol	protocol
-> IO Ctx

Creates a new Ctx from a homedirectory, a locale and a protocol. Needs to be freed with freeCtx, which is why you are encouraged to use withCtx.

freeCtx :: Ctx -> IO () Source

Free a previously created Ctx

withCtx Source

Arguments

:: String	path to gpg homedirectory
-> String	locale
-> Protocol	protocol
-> (Ctx -> IO a)	action to be run with ctx
-> IO a

Runs the action with a new Ctx and frees it afterwards

See newCtx for a descrption of the parameters.

Keys

data Key Source

A key from the context

getKey Source

Arguments

:: Ctx	context to operate in
-> Fpr	fingerprint
-> IncludeSecret	whether to include secrets when searching for the key
-> IO (Maybe Key)

Returns a Key from the context based on its fingerprint. As a Key returned from the function needs to be freed with freeKey, the use of withKey is encouraged. Returns Nothing if no Key with this Fpr exists.

freeKey :: Key -> IO () Source

Frees a key previously created with getKey

withKey Source

Arguments

:: Ctx	context to operate in
-> Fpr	fingerprint
-> IncludeSecret	whether to include secrets when searching for the key
-> (Key -> IO a)	action to be run with key
-> IO (Maybe a)

Conveniently runs the action with the Key associated with the Fpr in the Ctx and frees it afterwards. If no Key with this Fpr exists, Nothing is returned.