hOpenPGP-0.9: native Haskell implementation of OpenPGP (RFC4880)

Safe HaskellNone

Codec.Encryption.OpenPGP.Types

Documentation

type TimeStamp = Word32Source

type Exportability = BoolSource

type TrustLevel = Word8Source

type TrustAmount = Word8Source

type AlmostPublicDomainRegex = ByteStringSource

type Revocability = BoolSource

type RevocationReason = ByteStringSource

type KeyServer = ByteStringSource

type URL = ByteStringSource

type NotationName = ByteStringSource

type NotationValue = ByteStringSource

type SignatureHash = ByteStringSource

type PacketVersion = Word8Source

type Salt = ByteStringSource

type Count = IntSource

type V3Expiration = Word16Source

type CompressedDataPayload = ByteStringSource

type FileName = ByteStringSource

type ImageData = ByteStringSource

type NestedFlag = BoolSource

type IV = ByteStringSource

data SymmetricAlgorithm Source

Constructors

Plaintext 
IDEA 
TripleDES 
CAST5 
Blowfish 
ReservedSAFER 
ReservedDES 
AES128 
AES192 
AES256 
Twofish 
OtherSA Word8 

Instances

data NotationFlag Source

Constructors

HumanReadable 
OtherNF Int 

Instances

data SigSubPacket Source

Constructors

SigSubPacket 

Fields

_sspCriticality :: Bool
 
_sspPayload :: SigSubPacketPayload
 

Instances

data SigSubPacketPayload Source

Constructors

SigCreationTime TimeStamp 
SigExpirationTime TimeStamp 
ExportableCertification Exportability 
TrustSignature TrustLevel TrustAmount 
RegularExpression AlmostPublicDomainRegex 
Revocable Revocability 
KeyExpirationTime TimeStamp 
PreferredSymmetricAlgorithms [SymmetricAlgorithm] 
RevocationKey (Set RevocationClass) PubKeyAlgorithm TwentyOctetFingerprint 
Issuer EightOctetKeyId 
NotationData (Set NotationFlag) NotationName NotationValue 
PreferredHashAlgorithms [HashAlgorithm] 
PreferredCompressionAlgorithms [CompressionAlgorithm] 
KeyServerPreferences (Set KSPFlag) 
PreferredKeyServer KeyServer 
PrimaryUserId Bool 
PolicyURL URL 
KeyFlags (Set KeyFlag) 
SignersUserId String 
ReasonForRevocation RevocationCode RevocationReason 
Features (Set FeatureFlag) 
SignatureTarget PubKeyAlgorithm HashAlgorithm SignatureHash 
EmbeddedSignature SignaturePayload 
UserDefinedSigSub Word8 ByteString 
OtherSigSub Word8 ByteString 

Instances

data HashAlgorithm Source

Constructors

DeprecatedMD5 
SHA1 
RIPEMD160 
SHA256 
SHA384 
SHA512 
SHA224 
OtherHA Word8 

Instances

data CompressionAlgorithm Source

Constructors

Uncompressed 
ZIP 
ZLIB 
BZip2 
OtherCA Word8 

Instances

class (Eq a, Ord a) => FutureVal a whereSource

Methods

fromFVal :: a -> Word8Source

toFVal :: Word8 -> aSource

Instances

data PubKeyAlgorithm Source

Constructors

RSA 
DeprecatedRSAEncryptOnly 
DeprecatedRSASignOnly 
ElgamalEncryptOnly 
DSA 
EC 
ECDSA 
ForbiddenElgamal 
DH 
OtherPKA Word8 

Instances

class (Eq a, Ord a) => FutureFlag a whereSource

Methods

fromFFlag :: a -> IntSource

toFFlag :: Int -> aSource

Instances

data KSPFlag Source

Constructors

NoModify 
KSPOther Int 

Instances

Eq KSPFlag 
Data KSPFlag 
Ord KSPFlag 
Show KSPFlag 
Typeable KSPFlag 
FutureFlag KSPFlag 

data KeyFlag Source

Constructors

GroupKey 
AuthKey 
SplitKey 
EncryptStorageKey 
EncryptCommunicationsKey 
SignDataKey 
CertifyKeysKey 
KFOther Int 

Instances

Eq KeyFlag 
Data KeyFlag 
Ord KeyFlag 
Show KeyFlag 
Typeable KeyFlag 
FutureFlag KeyFlag 

data RevocationClass Source

Constructors

SensitiveRK 
RClOther Int 

Instances

data RevocationCode Source

Constructors

NoReason 
KeySuperseded 
KeyMaterialCompromised 
KeyRetiredAndNoLongerUsed 
UserIdInfoNoLongerValid 
RCoOther Word8 

Instances

data FeatureFlag Source

Constructors

ModificationDetection 
FeatureOther Int 

Instances

newtype MPI Source

Constructors

MPI 

Fields

unMPI :: Integer
 

Instances

Eq MPI 
Data MPI 
Show MPI 
Typeable MPI 
Serialize MPI 

data SignaturePayload Source

Constructors

SigV3 SigType Word32 EightOctetKeyId PubKeyAlgorithm HashAlgorithm Word16 [MPI] 
SigV4 SigType PubKeyAlgorithm HashAlgorithm [SigSubPacket] [SigSubPacket] Word16 [MPI] 
SigVOther Word8 ByteString 

Instances

data KeyVersion Source

Constructors

DeprecatedV3 
V4 

Instances

Eq KeyVersion 
Data KeyVersion 
Ord KeyVersion 
Show KeyVersion 
Typeable KeyVersion 

data PKPayload Source

Constructors

PKPayload 

Fields

_keyVersion :: KeyVersion
 
_timestamp :: TimeStamp
 
_v3exp :: V3Expiration
 
_pkalgo :: PubKeyAlgorithm
 
_pubkey :: PKey
 

Instances

data SKAddendum Source

Constructors

SUS16bit SymmetricAlgorithm S2K IV ByteString 
SUSSHA1 SymmetricAlgorithm S2K IV ByteString 
SUSym SymmetricAlgorithm IV ByteString 
SUUnencrypted SKey Word16 

Instances

Eq SKAddendum 
Data SKAddendum 
Show SKAddendum 
Typeable SKAddendum 

data DataType Source

Constructors

BinaryData 
TextData 
UTF8Data 
OtherData Word8 

Instances

Eq DataType 
Data DataType 
Ord DataType 
Show DataType 
Typeable DataType 
FutureVal DataType 

data S2K Source

Constructors

Simple HashAlgorithm 
Salted HashAlgorithm Salt 
IteratedSalted HashAlgorithm Salt Count 
OtherS2K Word8 ByteString 

Instances

Eq S2K 
Data S2K 
Show S2K 
Typeable S2K 
Serialize S2K 

data UserAttrSubPacket Source

Constructors

ImageAttribute ImageHeader ImageData 
OtherUASub Word8 ByteString 

Instances

data ImageHeader Source

Constructors

ImageHV1 ImageFormat 

Instances

Eq ImageHeader 
Data ImageHeader 
Show ImageHeader 
Typeable ImageHeader 

data ImageFormat Source

Constructors

JPEG 
OtherImage Word8 

Instances

data SigType Source

Constructors

BinarySig 
CanonicalTextSig 
StandaloneSig 
GenericCert 
PersonaCert 
CasualCert 
PositiveCert 
SubkeyBindingSig 
PrimaryKeyBindingSig 
SignatureDirectlyOnAKey 
KeyRevocationSig 
SubkeyRevocationSig 
CertRevocationSig 
TimestampSig 
ThirdPartyConfirmationSig 
OtherSig Word8 

Instances

data PKey Source

Constructors

RSAPubKey PublicKey 
DSAPubKey PublicKey 
ElGamalPubKey [Integer] 

Instances

Eq PKey 
Data PKey 
Show PKey 
Typeable PKey 

data SKey Source

Constructors

RSAPrivateKey PrivateKey 
DSAPrivateKey PrivateKey 
ElGamalPrivateKey [Integer] 

Instances

Eq SKey 
Data SKey 
Show SKey 
Typeable SKey 

newtype Block a Source

Constructors

Block 

Fields

unBlock :: [a]
 

Instances

Eq a => Eq (Block a) 
Show a => Show (Block a) 
Serialize a => Serialize (Block a) 

newtype EightOctetKeyId Source

Constructors

EightOctetKeyId 

Fields

unEOKI :: ByteString
 

Instances

newtype TwentyOctetFingerprint Source

Constructors

TwentyOctetFingerprint 

Fields

unTOF :: ByteString
 

Instances

w8sToHex :: [Word8] -> StringSource

hexToW8s :: ReadS Word8Source

data TK Source

Constructors

TK 

Fields

_tkPKP :: PKPayload
 
_tkmSKA :: Maybe SKAddendum
 
_tkRevs :: [SignaturePayload]
 
_tkUIDs :: [(String, [SignaturePayload])]
 
_tkUAts :: [([UserAttrSubPacket], [SignaturePayload])]
 
_tkSubs :: [(Pkt, SignaturePayload, Maybe SignaturePayload)]
 

Instances

Eq TK 
Data TK 
Ord TK 
Show TK 
Typeable TK 
Indexable TK 

type Keyring = IxSet TKSource

class Packet a whereSource

Associated Types

data PacketType a :: *Source

Methods

packetType :: a -> PacketType aSource

packetCode :: PacketType a -> Word8Source

toPkt :: a -> PktSource

fromPkt :: Pkt -> aSource

Instances

data Pkt Source

Constructors

PKESKPkt PacketVersion EightOctetKeyId PubKeyAlgorithm [MPI] 
SignaturePkt SignaturePayload 
SKESKPkt PacketVersion SymmetricAlgorithm S2K (Maybe ByteString) 
OnePassSignaturePkt PacketVersion SigType HashAlgorithm PubKeyAlgorithm EightOctetKeyId NestedFlag 
SecretKeyPkt PKPayload SKAddendum 
PublicKeyPkt PKPayload 
SecretSubkeyPkt PKPayload SKAddendum 
CompressedDataPkt CompressionAlgorithm CompressedDataPayload 
SymEncDataPkt ByteString 
MarkerPkt ByteString 
LiteralDataPkt DataType FileName TimeStamp ByteString 
TrustPkt ByteString 
UserIdPkt String 
PublicSubkeyPkt PKPayload 
UserAttributePkt [UserAttrSubPacket] 
SymEncIntegrityProtectedDataPkt PacketVersion ByteString 
ModificationDetectionCodePkt ByteString 
OtherPacketPkt Word8 ByteString 

Instances

Eq Pkt 
Data Pkt 
Show Pkt 
Typeable Pkt 
Serialize Pkt 

data PKESK Source

Constructors

PKESK 

Fields

_pkeskPacketVersion :: PacketVersion
 
_pkeskEightOctetKeyId :: EightOctetKeyId
 
_pkeskPubKeyAlgorithm :: PubKeyAlgorithm
 
_pkeskMPIs :: [MPI]
 

Instances

Eq PKESK 
Data PKESK 
Show PKESK 
Typeable PKESK 
Serialize PKESK 
Packet PKESK 
Eq (PacketType PKESK) 
Show (PacketType PKESK) 

data Signature Source

Constructors

Signature 

Fields

_signaturePayload :: SignaturePayload
 

Instances

data SKESK Source

Constructors

SKESK 

Fields

_skeskPacketVersion :: PacketVersion
 
_skeskSymmetricAlgorithm :: SymmetricAlgorithm
 
_skeskS2K :: S2K
 
_skeskESK :: Maybe ByteString
 

Instances

Eq SKESK 
Data SKESK 
Show SKESK 
Typeable SKESK 
Serialize SKESK 
Packet SKESK 
Eq (PacketType SKESK) 
Show (PacketType SKESK) 

data OnePassSignature Source

Constructors

OnePassSignature 

Fields

_onePassSignaturePacketVersion :: PacketVersion
 
_onePassSignatureSigType :: SigType
 
_onePassSignatureHashAlgorithm :: HashAlgorithm
 
_onePassSignaturePubKeyAlgorithm :: PubKeyAlgorithm
 
_onePassSignatureEightOctetKeyId :: EightOctetKeyId
 
_onePassSignatureNestedFlag :: NestedFlag
 

Instances

data SecretKey Source

Constructors

SecretKey 

Fields

_secretKeyPKPayload :: PKPayload
 
_secretKeySKAddendum :: SKAddendum
 

Instances

data PublicKey Source

Constructors

PublicKey 

Fields

_publicKeyPKPayload :: PKPayload
 

Instances

data SecretSubkey Source

Constructors

SecretSubkey 

Fields

_secretSubkeyPKPayload :: PKPayload
 
_secretSubkeySKAddendum :: SKAddendum
 

Instances

data CompressedData Source

Constructors

CompressedData 

Fields

_compressedDataCompressionAlgorithm :: CompressionAlgorithm
 
_compressedDataPayload :: CompressedDataPayload
 

Instances

data SymEncData Source

Constructors

SymEncData 

Fields

_symEncDataPayload :: ByteString
 

Instances

data Marker Source

Constructors

Marker 

Fields

_markerPayload :: ByteString
 

Instances

data LiteralData Source

Constructors

LiteralData 

Fields

_literalDataDataType :: DataType
 
_literalDataFileName :: FileName
 
_literalDataTimeStamp :: TimeStamp
 
_literalDataPayload :: ByteString
 

Instances

data Trust Source

Constructors

Trust 

Fields

_trustPayload :: ByteString
 

Instances

Eq Trust 
Data Trust 
Show Trust 
Typeable Trust 
Serialize Trust 
Packet Trust 
Eq (PacketType Trust) 
Show (PacketType Trust) 

data UserId Source

Constructors

UserId 

Fields

_userIdPayload :: String
 

Instances

data PublicSubkey Source

Constructors

PublicSubkey 

Fields

_publicSubkeyPKPayload :: PKPayload
 

Instances

data UserAttribute Source

Constructors

UserAttribute 

Fields

_userAttributeSubPackets :: [UserAttrSubPacket]
 

Instances

data SymEncIntegrityProtectedData Source

Constructors

SymEncIntegrityProtectedData 

Fields

_symEncIntegrityProtectedDataPacketVersion :: PacketVersion
 
_symEncIntegrityProtectedDataPayload :: ByteString
 

Instances

data ModificationDetectionCode Source

Constructors

ModificationDetectionCode 

Fields

_modificationDetectionCodePayload :: ByteString
 

Instances

data OtherPacket Source

Constructors

OtherPacket 

Fields

_otherPacketType :: Word8
 
_otherPacketPayload :: ByteString
 

Instances

data Verification Source

Constructors

Verification 

Fields

_verificationSigner :: PKPayload
 
_verificationSignature :: SignaturePayload
 

pkeskPubKeyAlgorithm :: Lens' PKESK PubKeyAlgorithmSource

pkeskPacketVersion :: Lens' PKESK PacketVersionSource

pkeskMPIs :: Lens' PKESK [MPI]Source

pkeskEightOctetKeyId :: Lens' PKESK EightOctetKeyIdSource

signaturePayload :: Iso' Signature SignaturePayloadSource

skeskSymmetricAlgorithm :: Lens' SKESK SymmetricAlgorithmSource

skeskS2K :: Lens' SKESK S2KSource

skeskPacketVersion :: Lens' SKESK PacketVersionSource

skeskESK :: Lens' SKESK (Maybe ByteString)Source

onePassSignatureSigType :: Lens' OnePassSignature SigTypeSource

onePassSignaturePubKeyAlgorithm :: Lens' OnePassSignature PubKeyAlgorithmSource

onePassSignaturePacketVersion :: Lens' OnePassSignature PacketVersionSource

onePassSignatureNestedFlag :: Lens' OnePassSignature NestedFlagSource

onePassSignatureHashAlgorithm :: Lens' OnePassSignature HashAlgorithmSource

onePassSignatureEightOctetKeyId :: Lens' OnePassSignature EightOctetKeyIdSource

secretKeySKAddendum :: Lens' SecretKey SKAddendumSource

secretKeyPKPayload :: Lens' SecretKey PKPayloadSource

v3exp :: Lens' PKPayload V3ExpirationSource

timestamp :: Lens' PKPayload TimeStampSource

pubkey :: Lens' PKPayload PKeySource

pkalgo :: Lens' PKPayload PubKeyAlgorithmSource

keyVersion :: Lens' PKPayload KeyVersionSource

publicKeyPKPayload :: Iso' PublicKey PKPayloadSource

secretSubkeySKAddendum :: Lens' SecretSubkey SKAddendumSource

secretSubkeyPKPayload :: Lens' SecretSubkey PKPayloadSource

compressedDataPayload :: Lens' CompressedData CompressedDataPayloadSource

compressedDataCompressionAlgorithm :: Lens' CompressedData CompressionAlgorithmSource

symEncDataPayload :: Iso' SymEncData ByteStringSource

markerPayload :: Iso' Marker ByteStringSource

literalDataTimeStamp :: Lens' LiteralData TimeStampSource

literalDataPayload :: Lens' LiteralData ByteStringSource

literalDataFileName :: Lens' LiteralData FileNameSource

literalDataDataType :: Lens' LiteralData DataTypeSource

trustPayload :: Iso' Trust ByteStringSource

userIdPayload :: Iso' UserId StringSource

publicSubkeyPKPayload :: Iso' PublicSubkey PKPayloadSource

userAttributeSubPackets :: Iso' UserAttribute [UserAttrSubPacket]Source

symEncIntegrityProtectedDataPayload :: Lens' SymEncIntegrityProtectedData ByteStringSource

symEncIntegrityProtectedDataPacketVersion :: Lens' SymEncIntegrityProtectedData PacketVersionSource

modificationDetectionCodePayload :: Iso' ModificationDetectionCode ByteStringSource

otherPacketType :: Lens' OtherPacket Word8Source

otherPacketPayload :: Lens' OtherPacket ByteStringSource

tkmSKA :: Lens' TK (Maybe SKAddendum)Source

tkUIDs :: Lens' TK [(String, [SignaturePayload])]Source

tkUAts :: Lens' TK [([UserAttrSubPacket], [SignaturePayload])]Source

tkSubs :: Lens' TK [(Pkt, SignaturePayload, Maybe SignaturePayload)]Source

tkRevs :: Lens' TK [SignaturePayload]Source

tkPKP :: Lens' TK PKPayloadSource

verificationSigner :: Lens' Verification PKPayloadSource

verificationSignature :: Lens' Verification SignaturePayloadSource

sspPayload :: Lens' SigSubPacket SigSubPacketPayloadSource

sspCriticality :: Lens' SigSubPacket BoolSource