License	Public Domain
Maintainer	daveparrish@tutanota.com
Stability	experimental
Portability	untested
Safe Haskell	None
Language	Haskell2010

Crypto.Gpgme.Key.Gen

Contents

Usage
Parameters
Other

Description

Key generation for h-gpgme.

It is suggested to import as qualified. For example:

import qualified  Crypto.Gpgme.Key.Gen as G

Synopsis

genKey :: Ctx -> GenKeyParams -> IO (Either GpgmeError Fpr)
data GenKeyParams = GenKeyParams {
- keyType :: Maybe PubKeyAlgo
- keyLength :: Maybe BitSize
- keyGrip :: ByteString
- keyUsage :: Maybe UsageList
- subkeyType :: Maybe PubKeyAlgo
- subkeyLength :: Maybe BitSize
- passphrase :: ByteString
- nameReal :: ByteString
- nameComment :: ByteString
- nameEmail :: Maybe EmailAddress
- expireDate :: Maybe ExpireDate
- creationDate :: Maybe CreationDate
- preferences :: ByteString
- revoker :: ByteString
- keyserver :: ByteString
- handle :: ByteString
- rawParams :: ByteString
}
data BitSize
bitSize :: Int -> Either String BitSize
data UsageList = UsageList {
- encrypt :: Maybe Encrypt
- sign :: Maybe Sign
- auth :: Maybe Auth
}
data Encrypt = Encrypt
data Sign = Sign
data Auth = Auth
data ExpireDate
- = ExpireT UTCTime
- | ExpireD Positive
- | ExpireW Positive
- | ExpireM Positive
- | ExpireY Positive
- | ExpireS Positive
data CreationDate
- = CreationT UTCTime
- | CreationS Positive
data Positive
toPositive :: Int -> Maybe Positive
toParamsString :: GenKeyParams -> ByteString

Usage

genKey Source #

Arguments

:: Ctx	context to operate in
-> GenKeyParams	parameters to use for generating key
-> IO (Either GpgmeError Fpr)

Generate a GPG key

Parameters

data GenKeyParams Source #

Key generation parameters.

See: https://www.gnupg.org/documentation/manuals/gnupg/Unattended-GPG-key-generation.html

Constructors

GenKeyParams

Fields

Instances

Instances details

Default GenKeyParams Source #

Default parameters

Intended to be used to build custom paramemters.

params = (def :: GenKeyParams) { keyType = Just Dsa }

See tests for working example of all parameters in use.

Instance details

Defined in Crypto.Gpgme.Key.Gen

Methods

def :: GenKeyParams #

BitSize

data BitSize Source #

Key-Length parameter

bitSize :: Int -> Either String BitSize Source #

Bit size constrained to 1024-4096 bits

UsageList

data UsageList Source #

Constructors

UsageList
Fields encrypt :: Maybe Encrypt sign :: Maybe Sign auth :: Maybe Auth

Instances

Instances details

Default UsageList Source #

Default UsageList

Intended to be used to build custom UsageList parameter

usageListParam = (def :: UsageList) (Just Encrypt)

See tests for working example of all parameters in use.

Instance details

Defined in Crypto.Gpgme.Key.Gen

Methods

def :: UsageList #

data Encrypt Source #

Constructors

Encrypt

data Sign Source #

Constructors

Sign

data Auth Source #

Constructors

Auth

ExpireDate

data ExpireDate Source #

Expire-Date parameter

Beware, genKey will not check that ExpireDate is after CreationDate of generated key.

Constructors

ExpireT UTCTime
ExpireD Positive
ExpireW Positive
ExpireM Positive
ExpireY Positive
ExpireS Positive

CreationDate

data CreationDate Source #

Creation-Date parameter

Constructors

CreationT UTCTime
CreationS Positive	Seconds since epoch

Other

data Positive Source #

Only a positive Int

toPositive :: Int -> Maybe Positive Source #

Create a Positive type as long as the Int is greater than -1

toParamsString :: GenKeyParams -> ByteString Source #

Used by genKey generate a XML string for GPG