Safe Haskell	None
Language	Haskell2010

Codec.Encryption.OpenPGP.Message

Documentation

data Passphrase Source #

Instances

Instances details

Show Passphrase Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> Passphrase -> ShowS Source # show :: Passphrase -> String Source # showList :: [Passphrase] -> ShowS Source #
Eq Passphrase Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: Passphrase -> Passphrase -> Bool Source # (/=) :: Passphrase -> Passphrase -> Bool Source #
Ord Passphrase Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods compare :: Passphrase -> Passphrase -> Ordering Source # (<) :: Passphrase -> Passphrase -> Bool Source # (<=) :: Passphrase -> Passphrase -> Bool Source # (>) :: Passphrase -> Passphrase -> Bool Source # (>=) :: Passphrase -> Passphrase -> Bool Source # max :: Passphrase -> Passphrase -> Passphrase Source # min :: Passphrase -> Passphrase -> Passphrase Source #

mkPassphrase :: ByteString -> Passphrase Source #

passphraseBytes :: Passphrase -> ByteString Source #

data EncryptedPayload Source #

Instances

Instances details

Show EncryptedPayload Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> EncryptedPayload -> ShowS Source # show :: EncryptedPayload -> String Source # showList :: [EncryptedPayload] -> ShowS Source #
Eq EncryptedPayload Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: EncryptedPayload -> EncryptedPayload -> Bool Source # (/=) :: EncryptedPayload -> EncryptedPayload -> Bool Source #
Ord EncryptedPayload Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods compare :: EncryptedPayload -> EncryptedPayload -> Ordering Source # (<) :: EncryptedPayload -> EncryptedPayload -> Bool Source # (<=) :: EncryptedPayload -> EncryptedPayload -> Bool Source # (>) :: EncryptedPayload -> EncryptedPayload -> Bool Source # (>=) :: EncryptedPayload -> EncryptedPayload -> Bool Source # max :: EncryptedPayload -> EncryptedPayload -> EncryptedPayload Source # min :: EncryptedPayload -> EncryptedPayload -> EncryptedPayload Source #

mkEncryptedPayload :: ByteString -> EncryptedPayload Source #

encryptedPayloadBytes :: EncryptedPayload -> ByteString Source #

data ClearPayload Source #

Instances

Instances details

Show ClearPayload Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> ClearPayload -> ShowS Source # show :: ClearPayload -> String Source # showList :: [ClearPayload] -> ShowS Source #
Eq ClearPayload Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: ClearPayload -> ClearPayload -> Bool Source # (/=) :: ClearPayload -> ClearPayload -> Bool Source #
Ord ClearPayload Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods compare :: ClearPayload -> ClearPayload -> Ordering Source # (<) :: ClearPayload -> ClearPayload -> Bool Source # (<=) :: ClearPayload -> ClearPayload -> Bool Source # (>) :: ClearPayload -> ClearPayload -> Bool Source # (>=) :: ClearPayload -> ClearPayload -> Bool Source # max :: ClearPayload -> ClearPayload -> ClearPayload Source # min :: ClearPayload -> ClearPayload -> ClearPayload Source #

mkClearPayload :: ByteString -> ClearPayload Source #

clearPayloadBytes :: ClearPayload -> ByteString Source #

data WrappedSessionMaterial Source #

Instances

Instances details

Show WrappedSessionMaterial Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> WrappedSessionMaterial -> ShowS Source # show :: WrappedSessionMaterial -> String Source # showList :: [WrappedSessionMaterial] -> ShowS Source #
Eq WrappedSessionMaterial Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: WrappedSessionMaterial -> WrappedSessionMaterial -> Bool Source # (/=) :: WrappedSessionMaterial -> WrappedSessionMaterial -> Bool Source #
Ord WrappedSessionMaterial Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods compare :: WrappedSessionMaterial -> WrappedSessionMaterial -> Ordering Source # (<) :: WrappedSessionMaterial -> WrappedSessionMaterial -> Bool Source # (<=) :: WrappedSessionMaterial -> WrappedSessionMaterial -> Bool Source # (>) :: WrappedSessionMaterial -> WrappedSessionMaterial -> Bool Source # (>=) :: WrappedSessionMaterial -> WrappedSessionMaterial -> Bool Source # max :: WrappedSessionMaterial -> WrappedSessionMaterial -> WrappedSessionMaterial Source # min :: WrappedSessionMaterial -> WrappedSessionMaterial -> WrappedSessionMaterial Source #

data SigningAlgorithm Source #

Constructors

AlgoRSA
AlgoEd25519
AlgoEd448

type family SecretKeyFor (alg :: SigningAlgorithm) where ... Source #

Equations

SecretKeyFor 'AlgoRSA = PrivateKey
SecretKeyFor 'AlgoEd25519 = SecretKey
SecretKeyFor 'AlgoEd448 = SecretKey

data VersionedPKPayload (v :: KeyVersion) Source #

asV4PKPayload :: SomePKPayload -> Either String (VersionedPKPayload 'V4) Source #

asV6PKPayload :: SomePKPayload -> Either String (VersionedPKPayload 'V6) Source #

data Signer (alg :: SigningAlgorithm) v Source #

class SigningCapability (alg :: SigningAlgorithm) v Source #

Instances

Instances details

SigningCapability 'AlgoEd25519 V4Sig Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message
SigningCapability 'AlgoEd25519 V6Sig Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message
SigningCapability 'AlgoEd448 V4Sig Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message
SigningCapability 'AlgoEd448 V6Sig Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message
SigningCapability 'AlgoRSA V4Sig Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message
SigningCapability 'AlgoRSA V6Sig Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message

mkRSASignerV4 :: VersionedPKPayload 'V4 -> SecretKeyFor 'AlgoRSA -> Signer 'AlgoRSA V4Sig Source #

mkRSASignerV6 :: VersionedPKPayload 'V6 -> SecretKeyFor 'AlgoRSA -> Signer 'AlgoRSA V6Sig Source #

mkEd25519SignerV4 :: VersionedPKPayload 'V4 -> SecretKeyFor 'AlgoEd25519 -> Signer 'AlgoEd25519 V4Sig Source #

mkEd25519SignerV6 :: VersionedPKPayload 'V6 -> SecretKeyFor 'AlgoEd25519 -> Signer 'AlgoEd25519 V6Sig Source #

mkEd448SignerV4 :: VersionedPKPayload 'V4 -> SecretKeyFor 'AlgoEd448 -> Signer 'AlgoEd448 V4Sig Source #

mkEd448SignerV6 :: VersionedPKPayload 'V6 -> SecretKeyFor 'AlgoEd448 -> Signer 'AlgoEd448 V6Sig Source #

data MessageParseFailure Source #

Constructors

MissingEncryptedMessage
ExpectedSKESKThenEncryptedData
SKESKSEIPDAlgorithmMismatch
UnsupportedEncryptedSKESK
MissingLiteralDataPacket
UnknownCriticalPacketType Word8
BrokenCriticalPacketType Word8 String

Instances

Instances details

Show MessageParseFailure Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> MessageParseFailure -> ShowS Source # show :: MessageParseFailure -> String Source # showList :: [MessageParseFailure] -> ShowS Source #
Eq MessageParseFailure Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: MessageParseFailure -> MessageParseFailure -> Bool Source # (/=) :: MessageParseFailure -> MessageParseFailure -> Bool Source #

data MessageDecryptFailure Source #

Constructors

SessionMaterialDerivationFailed S2KError
PayloadDecryptFailed String

Instances

Instances details

Show MessageDecryptFailure Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> MessageDecryptFailure -> ShowS Source # show :: MessageDecryptFailure -> String Source # showList :: [MessageDecryptFailure] -> ShowS Source #
Eq MessageDecryptFailure Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: MessageDecryptFailure -> MessageDecryptFailure -> Bool Source # (/=) :: MessageDecryptFailure -> MessageDecryptFailure -> Bool Source #

data MessageError Source #

Constructors

MessageEncryptError String
MessageDecryptError String
MessageSignError SignError
MessageParseError String
MessageParseFailureError MessageParseFailure
MessageDecryptFailureError MessageDecryptFailure

Instances

Instances details

Show MessageError Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> MessageError -> ShowS Source # show :: MessageError -> String Source # showList :: [MessageError] -> ShowS Source #
Eq MessageError Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: MessageError -> MessageError -> Bool Source # (/=) :: MessageError -> MessageError -> Bool Source #

data SessionMaterialExposure Source #

Constructors

DoNotExposeSessionMaterial
ExposeSessionMaterial

Instances

Instances details

Show SessionMaterialExposure Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> SessionMaterialExposure -> ShowS Source # show :: SessionMaterialExposure -> String Source # showList :: [SessionMaterialExposure] -> ShowS Source #
Eq SessionMaterialExposure Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: SessionMaterialExposure -> SessionMaterialExposure -> Bool Source # (/=) :: SessionMaterialExposure -> SessionMaterialExposure -> Bool Source #

data EncryptMessageProfile Source #

data EncryptMessageOptions (p :: EncryptMessageProfile) where Source #

Constructors

RFC4880EncryptMessageOptions
Fields :: { rfc4880EncryptMessageExposure :: SessionMaterialExposure , rfc4880EncryptMessageSymmetricAlgorithm :: SymmetricAlgorithm , rfc4880EncryptMessageS2K :: S2K , rfc4880EncryptMessageIV :: IV } -> EncryptMessageOptions 'RFC4880Message
RFC9580EncryptMessageOptions
Fields :: { rfc9580EncryptMessageExposure :: SessionMaterialExposure , rfc9580EncryptMessageSymmetricAlgorithm :: SymmetricAlgorithm , rfc9580EncryptMessageS2K :: S2K , rfc9580EncryptMessageIV :: IV } -> EncryptMessageOptions 'RFC9580Message

Instances

Instances details

Show (EncryptMessageOptions p) Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> EncryptMessageOptions p -> ShowS Source # show :: EncryptMessageOptions p -> String Source # showList :: [EncryptMessageOptions p] -> ShowS Source #
Eq (EncryptMessageOptions p) Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: EncryptMessageOptions p -> EncryptMessageOptions p -> Bool Source # (/=) :: EncryptMessageOptions p -> EncryptMessageOptions p -> Bool Source #

data RecoveredSessionMaterial Source #

Constructors

RecoveredSessionMaterial
Fields recoveredSessionAlgorithm :: SymmetricAlgorithm recoveredSessionKey :: SessionKey

Instances

Instances details

Show RecoveredSessionMaterial Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods showsPrec :: Int -> RecoveredSessionMaterial -> ShowS Source # show :: RecoveredSessionMaterial -> String Source # showList :: [RecoveredSessionMaterial] -> ShowS Source #
Eq RecoveredSessionMaterial Source #
Instance details Defined in Codec.Encryption.OpenPGP.Message Methods (==) :: RecoveredSessionMaterial -> RecoveredSessionMaterial -> Bool Source # (/=) :: RecoveredSessionMaterial -> RecoveredSessionMaterial -> Bool Source #

encryptMessage :: forall (p :: EncryptMessageProfile). EncryptMessageOptions p -> Passphrase -> ClearPayload -> Either MessageError (EncryptedPayload, Maybe RecoveredSessionMaterial) Source #

decryptMessage :: Passphrase -> EncryptedPayload -> Either MessageError ClearPayload Source #

signMessage :: forall m (alg :: SigningAlgorithm) v. (MonadRandom m, SigningCapability alg v) => Signer alg v -> ByteString -> m (Either MessageError ByteString) Source #

signMessageWith :: forall m (alg :: SigningAlgorithm) v. (MonadRandom m, SigningCapability alg v) => Signer alg v -> ClearPayload -> m (Either MessageError ByteString) Source #

data VerificationPolicy Source #

Constructors

VerifyInformational
VerifyStrict

Instances

Instances details

Show VerificationPolicy Source #
Instance details Defined in Data.Conduit.OpenPGP.Message Methods showsPrec :: Int -> VerificationPolicy -> ShowS Source # show :: VerificationPolicy -> String Source # showList :: [VerificationPolicy] -> ShowS Source #
Eq VerificationPolicy Source #
Instance details Defined in Data.Conduit.OpenPGP.Message Methods (==) :: VerificationPolicy -> VerificationPolicy -> Bool Source # (/=) :: VerificationPolicy -> VerificationPolicy -> Bool Source #

data VerificationOptions Source #

Constructors

VerificationOptions
Fields verificationPolicy :: VerificationPolicy verificationMode :: VerificationMode verificationTime :: Maybe UTCTime

Instances

Instances details

Show VerificationOptions Source #
Instance details Defined in Data.Conduit.OpenPGP.Message Methods showsPrec :: Int -> VerificationOptions -> ShowS Source # show :: VerificationOptions -> String Source # showList :: [VerificationOptions] -> ShowS Source #
Eq VerificationOptions Source #
Instance details Defined in Data.Conduit.OpenPGP.Message Methods (==) :: VerificationOptions -> VerificationOptions -> Bool Source # (/=) :: VerificationOptions -> VerificationOptions -> Bool Source #

defaultVerificationOptions :: VerificationOptions Source #

verifySignedMessage :: VerificationOptions -> PublicKeyring -> ByteString -> [Either VerificationError Verification] Source #