Safe Haskell	None
Language	Haskell2010

Codec.Encryption.OpenPGP.Encrypt

Synopsis

data PKESKEncryptError
- = UnsupportedSessionKeyAlgorithm SymmetricAlgorithm String
- | InvalidSessionKeyLength SymmetricAlgorithm Int Int
- | InvalidRecipientIdentifier String
- | UnsupportedRecipientAlgorithm PubKeyAlgorithm
- | InvalidRecipientKeyMaterial PubKeyAlgorithm String
- | RecipientKdfFailure PubKeyAlgorithm String
- | RecipientKeyWrapFailure PubKeyAlgorithm String
- | RecipientCapabilitySelectionFailure RecipientCapabilityError
- | PayloadBuildFailure String
- | NoRecipientsProvided
data RecipientCapabilityNegotiationMode
- = RecipientCapabilityNegotiationOff
- | RecipientCapabilityNegotiationOn
data RecipientCapabilityError
- = RecipientCapabilityMissingEncryptionFlags SomePKPayload (Set KeyFlag)
- | RecipientCapabilityNoEncryptableKeyMaterialInTK
- | RecipientCapabilityMissingSEIPDv1Support [SomePKPayload]
- | RecipientCapabilityMissingSEIPDv2Support [SomePKPayload]
- | RecipientCapabilityNoCommonSymmetricAlgorithms [SymmetricAlgorithm]
- | RecipientCapabilityNoCommonAEADAlgorithms [AEADAlgorithm]
renderRecipientCapabilityError :: RecipientCapabilityError -> String
data RecipientCapabilities = RecipientCapabilities {
- recipientCapabilityKeyVersion :: KeyVersion
- recipientCapabilityPublicKeyAlgorithm :: PubKeyAlgorithm
- recipientCapabilityKeyFlags :: Set KeyFlag
- recipientCapabilityFeatures :: Set FeatureFlag
- recipientCapabilityPreferredSymmetricAlgorithms :: [SymmetricAlgorithm]
- recipientCapabilityPreferredAEADAlgorithms :: [AEADAlgorithm]
}
recipientCapabilitiesFromSubpacketPayloads :: SomePKPayload -> [SigSubPacketPayload] -> RecipientCapabilities
recipientCapabilitySupportsEncryption :: RecipientCapabilities -> Bool
data RecipientTargetRejectionReason
- = RecipientTargetUnsupportedAlgorithm PubKeyAlgorithm
- | RecipientTargetMissingEncryptionFlags SomePKPayload (Set KeyFlag)
- | RecipientTargetRevoked SomePKPayload
- | RecipientTargetNotValidAtTimestamp SomePKPayload ThirtyTwoBitTimeStamp
data RecipientEncryptionTargetRejected = RecipientEncryptionTargetRejected {
- recipientEncryptionTargetRejectedKey :: SomePKPayload
- recipientEncryptionTargetRejectedCapabilities :: Maybe RecipientCapabilities
- recipientEncryptionTargetRejectedReason :: RecipientTargetRejectionReason
}
data RecipientEncryptionTargetsReport = RecipientEncryptionTargetsReport {
- recipientEncryptionTargetsAccepted :: [RecipientEncryptionTarget]
- recipientEncryptionTargetsRejected :: [RecipientEncryptionTargetRejected]
}
recipientEncryptionTargetsReportFromTKAtTimestamp :: ThirtyTwoBitTimeStamp -> TKUnknown -> RecipientEncryptionTargetsReport
recipientEncryptionTargetsReportFromTK :: TK 'PublicTK -> RecipientEncryptionTargetsReport
recipientEncryptionTargetFromTKAtTimestamp :: ThirtyTwoBitTimeStamp -> TKUnknown -> Either RecipientCapabilityError RecipientEncryptionTarget
recipientEncryptionTargetFromTKAtTimestampWithPolicy :: RecipientTargetSelectionPolicy -> ThirtyTwoBitTimeStamp -> TKUnknown -> Either RecipientCapabilityError RecipientEncryptionTarget
recipientEncryptionTargetsFromTKAtTimestamp :: ThirtyTwoBitTimeStamp -> TKUnknown -> [RecipientEncryptionTarget]
recipientEncryptionTargetFromTK :: TK 'PublicTK -> Either RecipientCapabilityError RecipientEncryptionTarget
recipientEncryptionTargetFromTKWithPolicy :: RecipientTargetSelectionPolicy -> TK 'PublicTK -> Either RecipientCapabilityError RecipientEncryptionTarget
recipientEncryptionTargetsFromTK :: TK 'PublicTK -> [RecipientEncryptionTarget]
data RecipientTargetSelectionPolicy
- = RecipientTargetSelectionFirstValid
- | RecipientTargetSelectionPreferPrimary
- | RecipientTargetSelectionPreferSubkey
- | RecipientTargetSelectionPreferNewestCreationTime
data PassphraseSKESKVersionPolicy
- = PassphraseSKESKPreferV6
- | PassphraseSKESKForceV4Interop
data PassphraseEncryptRequest = PassphraseEncryptRequest {
- passphraseEncryptVersionPolicy :: PassphraseSKESKVersionPolicy
- passphraseEncryptSymmetricAlgorithm :: SymmetricAlgorithm
- passphraseEncryptS2K :: S2K
- passphraseEncryptPassphrase :: ByteString
- passphraseEncryptPayload :: ByteString
- passphraseEncryptSEIPDv1IVOverride :: Maybe IV
- passphraseEncryptSEIPDv2AEADOverride :: Maybe AEADAlgorithm
- passphraseEncryptSEIPDv2ChunkSizeOverride :: Maybe Word8
- passphraseEncryptSEIPDv2SaltOverride :: Maybe Salt
}
encryptPassphraseWithPolicy :: MonadRandom m => PassphraseEncryptRequest -> m (Either String [Pkt])
data PKESKVersionPolicy
- = PreferV6
- | ForceV3Interop
data RecipientPKESKVersionStrategy
- = RecipientPreferV6
- | RecipientForceV3Interop
data RecipientPKESKVersionStrategyW (strategy :: RecipientPKESKVersionStrategy) where
- RecipientPreferV6W :: RecipientPKESKVersionStrategyW 'RecipientPreferV6
- RecipientForceV3InteropW :: RecipientPKESKVersionStrategyW 'RecipientForceV3Interop
data SomeRecipientPKESKVersionStrategyW where
- SomeRecipientPKESKVersionStrategyW :: forall (strategy :: RecipientPKESKVersionStrategy). RecipientPKESKVersionStrategyW strategy -> SomeRecipientPKESKVersionStrategyW
type RecipientPKESKVersionSelector = SomePKPayload -> Either PKESKEncryptError RecipientPKESKVersionStrategy
type RecipientPKESKVersionSelectorTyped = SomePKPayload -> Either PKESKEncryptError SomeRecipientPKESKVersionStrategyW
data EncryptCompatibilityProfile
- = EncryptStrictDefault
- | EncryptInteropLegacy
data EncryptCompatibilityProfileW (profile :: EncryptCompatibilityProfile) where
- EncryptStrictDefaultW :: EncryptCompatibilityProfileW 'EncryptStrictDefault
- EncryptInteropLegacyW :: EncryptCompatibilityProfileW 'EncryptInteropLegacy
data SomeEncryptCompatibilityProfileW where
- SomeEncryptCompatibilityProfileW :: forall (profile :: EncryptCompatibilityProfile). EncryptCompatibilityProfileW profile -> SomeEncryptCompatibilityProfileW
data RecipientEncryptionTarget = RecipientEncryptionTarget {
- recipientEncryptionTargetKey :: SomePKPayload
- recipientEncryptionTargetStrategy :: Maybe RecipientPKESKVersionStrategy
- recipientEncryptionTargetCapabilities :: Maybe RecipientCapabilities
}
recipientEncryptionTarget :: SomePKPayload -> RecipientEncryptionTarget
recipientEncryptionTargetWithStrategy :: SomePKPayload -> RecipientPKESKVersionStrategy -> RecipientEncryptionTarget
recipientEncryptionTargetWithCapabilities :: SomePKPayload -> RecipientCapabilities -> RecipientEncryptionTarget
recipientEncryptionTargetWithStrategyTyped :: forall (strategy :: RecipientPKESKVersionStrategy). SomePKPayload -> RecipientPKESKVersionStrategyW strategy -> RecipientEncryptionTarget
recipientVersionStrategyForProfile :: EncryptCompatibilityProfile -> RecipientEncryptionTarget -> Either PKESKEncryptError RecipientPKESKVersionStrategy
recipientVersionStrategyForProfileTyped :: forall (profile :: EncryptCompatibilityProfile). EncryptCompatibilityProfileW profile -> RecipientEncryptionTarget -> Either PKESKEncryptError SomeRecipientPKESKVersionStrategyW
data RecipientPayloadShape = RecipientPayloadShape {
- recipientPayloadDataType :: DataType
- recipientPayloadFileName :: FileName
- recipientPayloadTimestamp :: ThirtyTwoBitTimeStamp
- recipientPayloadUseOnePassSignatures :: Bool
- recipientPayloadSignatures :: [SignaturePayload]
}
defaultRecipientPayloadShape :: RecipientPayloadShape
data SEIPDVersion
- = SEIPDv1
- | SEIPDv2
data RecipientEncryptResult = RecipientEncryptResult {
- recipientEncryptPackets :: [Pkt]
- recipientEncryptSessionMaterial :: PKESKSessionMaterial
}
data RecipientEncryptRequest (v :: SEIPDVersion) = RecipientEncryptRequest {
- recipientEncryptRequestTargets :: [RecipientEncryptionTarget]
- recipientEncryptRequestPayloadShape :: RecipientPayloadShape
- recipientEncryptRequestPayload :: ByteString
- recipientEncryptRequestSymmetricOverride :: Maybe SymmetricAlgorithm
- recipientEncryptRequestOverrides :: RecipientEncryptRequestOverrides v
}
data RecipientEncryptRequestOverrides (v :: SEIPDVersion) where
- RecipientEncryptRequestSEIPDv1Overrides :: {..} -> RecipientEncryptRequestOverrides 'SEIPDv1
- RecipientEncryptRequestSEIPDv2Overrides :: {..} -> RecipientEncryptRequestOverrides 'SEIPDv2
encryptForRecipients :: forall m (v :: SEIPDVersion). MonadRandom m => RecipientEncryptRequest v -> m (Either PKESKEncryptError RecipientEncryptResult)
encryptForRecipientsLegacy :: forall m (v :: SEIPDVersion). MonadRandom m => RecipientEncryptRequest v -> m (Either PKESKEncryptError RecipientEncryptResult)
encryptForRecipientsWithCapabilityNegotiation :: forall m (v :: SEIPDVersion). MonadRandom m => RecipientCapabilityNegotiationMode -> RecipientEncryptRequest v -> m (Either PKESKEncryptError RecipientEncryptResult)
data PKESKV3SessionMaterial
data PKESKV6RawSessionMaterial
data PKESKSessionMaterial
pkeskSessionAlgorithm :: PKESKSessionMaterial -> SymmetricAlgorithm
pkeskSessionKey :: PKESKSessionMaterial -> SessionKey
mkPKESKSessionMaterial :: SymmetricAlgorithm -> SessionKey -> Either PKESKEncryptError PKESKSessionMaterial
mkPKESKV3SessionMaterial :: SymmetricAlgorithm -> SessionKey -> Either PKESKEncryptError PKESKV3SessionMaterial
mkPKESKV6RawSessionMaterial :: SymmetricAlgorithm -> SessionKey -> Either PKESKEncryptError PKESKV6RawSessionMaterial
pkeskV3SessionMaterial :: PKESKSessionMaterial -> PKESKV3SessionMaterial
pkeskV6RawSessionMaterial :: PKESKSessionMaterial -> PKESKV6RawSessionMaterial
encodeOpenPGPSessionMaterial :: SymmetricAlgorithm -> SessionKey -> Either PKESKEncryptError ByteString
generateSessionKeyMaterial :: MonadRandom m => SymmetricAlgorithm -> m (Either PKESKEncryptError PKESKSessionMaterial)
canonicalizePKESKRecipientId :: PKESKPayload -> Either PKESKEncryptError PKESKPayload
canonicalizePKESKPacketRecipientIds :: [Pkt] -> Either PKESKEncryptError [Pkt]
buildPKESKv3PayloadForRecipient :: MonadRandom m => SomePKPayload -> PKESKV3SessionMaterial -> m (Either PKESKEncryptError PKESKPayload)
buildPKESKv3PktForRecipient :: MonadRandom m => SomePKPayload -> PKESKV3SessionMaterial -> m (Either PKESKEncryptError Pkt)
buildPKESKPayloadForRecipient :: MonadRandom m => PKESKVersionPolicy -> SomePKPayload -> PKESKSessionMaterial -> m (Either PKESKEncryptError PKESKPayload)
buildPKESKPktForRecipient :: MonadRandom m => PKESKVersionPolicy -> SomePKPayload -> PKESKSessionMaterial -> m (Either PKESKEncryptError Pkt)
buildPKESKPktsForRecipientTargetsWithSelector :: MonadRandom m => (RecipientEncryptionTarget -> Either PKESKEncryptError RecipientPKESKVersionStrategy) -> [RecipientEncryptionTarget] -> PKESKSessionMaterial -> m (Either PKESKEncryptError [Pkt])
buildPKESKPktsForRecipientTargetsWithSelectorTyped :: MonadRandom m => (RecipientEncryptionTarget -> Either PKESKEncryptError SomeRecipientPKESKVersionStrategyW) -> [RecipientEncryptionTarget] -> PKESKSessionMaterial -> m (Either PKESKEncryptError [Pkt])
encryptSEIPDv2Payload :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> SessionKey -> ByteString -> Either String ByteString
encryptSEIPDv1Payload :: SymmetricAlgorithm -> IV -> SessionKey -> ByteString -> Either String ByteString
encryptSEIPDv2WithSKESK :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> S2K -> ByteString -> ByteString -> Either String [Pkt]
encryptSEIPDv2WithSKESKBlock :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> S2K -> ByteString -> Block Pkt -> Either String [Pkt]
encryptSEIPDv2LiteralDataWithSKESK :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> S2K -> ByteString -> ByteString -> Either String [Pkt]
composeMessageWithSEIPDv2 :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> S2K -> ByteString -> ByteString -> Maybe [Pkt] -> Either String [Pkt]

Documentation

data PKESKEncryptError Source #

Typed failures surfaced by encrypt-side PKESK and SEIPD-v2 helpers.

Instances

Instances details

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

data RecipientCapabilityNegotiationMode Source #

Constructors

RecipientCapabilityNegotiationOff
RecipientCapabilityNegotiationOn

Instances

Instances details

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

data RecipientCapabilityError Source #

Constructors

RecipientCapabilityMissingEncryptionFlags SomePKPayload (Set KeyFlag)
RecipientCapabilityNoEncryptableKeyMaterialInTK
RecipientCapabilityMissingSEIPDv1Support [SomePKPayload]
RecipientCapabilityMissingSEIPDv2Support [SomePKPayload]
RecipientCapabilityNoCommonSymmetricAlgorithms [SymmetricAlgorithm]
RecipientCapabilityNoCommonAEADAlgorithms [AEADAlgorithm]

Instances

Instances details

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

renderRecipientCapabilityError :: RecipientCapabilityError -> String Source #

data RecipientCapabilities Source #

Constructors

RecipientCapabilities
Fields recipientCapabilityKeyVersion :: KeyVersion recipientCapabilityPublicKeyAlgorithm :: PubKeyAlgorithm recipientCapabilityKeyFlags :: Set KeyFlag recipientCapabilityFeatures :: Set FeatureFlag recipientCapabilityPreferredSymmetricAlgorithms :: [SymmetricAlgorithm] recipientCapabilityPreferredAEADAlgorithms :: [AEADAlgorithm]

Instances

Instances details

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

recipientCapabilitiesFromSubpacketPayloads :: SomePKPayload -> [SigSubPacketPayload] -> RecipientCapabilities Source #

Extract encrypt-relevant recipient capabilities from effective self-signature subpackets.

RFC 9580 preferred AEAD ciphersuites are currently carried through OtherSigSub type 39 and decoded into AEAD preferences here.

recipientCapabilitySupportsEncryption :: RecipientCapabilities -> Bool Source #

data RecipientTargetRejectionReason Source #

Constructors

RecipientTargetUnsupportedAlgorithm PubKeyAlgorithm
RecipientTargetMissingEncryptionFlags SomePKPayload (Set KeyFlag)
RecipientTargetRevoked SomePKPayload
RecipientTargetNotValidAtTimestamp SomePKPayload ThirtyTwoBitTimeStamp

Instances

Instances details

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

data RecipientEncryptionTargetRejected Source #

Constructors

RecipientEncryptionTargetRejected
Fields recipientEncryptionTargetRejectedKey :: SomePKPayload recipientEncryptionTargetRejectedCapabilities :: Maybe RecipientCapabilities recipientEncryptionTargetRejectedReason :: RecipientTargetRejectionReason

Instances

Instances details

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

data RecipientEncryptionTargetsReport Source #

Constructors

RecipientEncryptionTargetsReport
Fields recipientEncryptionTargetsAccepted :: [RecipientEncryptionTarget] recipientEncryptionTargetsRejected :: [RecipientEncryptionTargetRejected]

Instances

Instances details

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

recipientEncryptionTargetsReportFromTKAtTimestamp :: ThirtyTwoBitTimeStamp -> TKUnknown -> RecipientEncryptionTargetsReport Source #

recipientEncryptionTargetsReportFromTK :: TK 'PublicTK -> RecipientEncryptionTargetsReport Source #

recipientEncryptionTargetFromTKAtTimestamp :: ThirtyTwoBitTimeStamp -> TKUnknown -> Either RecipientCapabilityError RecipientEncryptionTarget Source #

recipientEncryptionTargetFromTKAtTimestampWithPolicy :: RecipientTargetSelectionPolicy -> ThirtyTwoBitTimeStamp -> TKUnknown -> Either RecipientCapabilityError RecipientEncryptionTarget Source #

recipientEncryptionTargetsFromTKAtTimestamp :: ThirtyTwoBitTimeStamp -> TKUnknown -> [RecipientEncryptionTarget] Source #

recipientEncryptionTargetFromTK :: TK 'PublicTK -> Either RecipientCapabilityError RecipientEncryptionTarget Source #

recipientEncryptionTargetFromTKWithPolicy :: RecipientTargetSelectionPolicy -> TK 'PublicTK -> Either RecipientCapabilityError RecipientEncryptionTarget Source #

recipientEncryptionTargetsFromTK :: TK 'PublicTK -> [RecipientEncryptionTarget] Source #

data RecipientTargetSelectionPolicy Source #

Constructors

RecipientTargetSelectionFirstValid
RecipientTargetSelectionPreferPrimary
RecipientTargetSelectionPreferSubkey
RecipientTargetSelectionPreferNewestCreationTime

Instances

Instances details

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

data PassphraseSKESKVersionPolicy Source #

Constructors

PassphraseSKESKPreferV6
PassphraseSKESKForceV4Interop

Instances

Instances details

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

data PassphraseEncryptRequest Source #

Instances

Instances details

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

encryptPassphraseWithPolicy :: MonadRandom m => PassphraseEncryptRequest -> m (Either String [Pkt]) Source #

data PKESKVersionPolicy Source #

Constructors

PreferV6
ForceV3Interop

Instances

Instances details

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

data RecipientPKESKVersionStrategy Source #

Constructors

RecipientPreferV6
RecipientForceV3Interop

Instances

Instances details

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

data RecipientPKESKVersionStrategyW (strategy :: RecipientPKESKVersionStrategy) where Source #

Constructors

RecipientPreferV6W :: RecipientPKESKVersionStrategyW 'RecipientPreferV6
RecipientForceV3InteropW :: RecipientPKESKVersionStrategyW 'RecipientForceV3Interop

data SomeRecipientPKESKVersionStrategyW where Source #

Constructors

SomeRecipientPKESKVersionStrategyW :: forall (strategy :: RecipientPKESKVersionStrategy). RecipientPKESKVersionStrategyW strategy -> SomeRecipientPKESKVersionStrategyW

type RecipientPKESKVersionSelector = SomePKPayload -> Either PKESKEncryptError RecipientPKESKVersionStrategy Source #

type RecipientPKESKVersionSelectorTyped = SomePKPayload -> Either PKESKEncryptError SomeRecipientPKESKVersionStrategyW Source #

data EncryptCompatibilityProfile Source #

Constructors

EncryptStrictDefault
EncryptInteropLegacy

Instances

Instances details

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

data EncryptCompatibilityProfileW (profile :: EncryptCompatibilityProfile) where Source #

Constructors

EncryptStrictDefaultW :: EncryptCompatibilityProfileW 'EncryptStrictDefault
EncryptInteropLegacyW :: EncryptCompatibilityProfileW 'EncryptInteropLegacy

data SomeEncryptCompatibilityProfileW where Source #

Constructors

SomeEncryptCompatibilityProfileW :: forall (profile :: EncryptCompatibilityProfile). EncryptCompatibilityProfileW profile -> SomeEncryptCompatibilityProfileW

data RecipientEncryptionTarget Source #

Constructors

RecipientEncryptionTarget

Fields

recipientEncryptionTargetKey :: SomePKPayload
Recipient key packet selected for PKESK wrapping.
recipientEncryptionTargetStrategy :: Maybe RecipientPKESKVersionStrategy
Optional explicit PKESK version strategy hint. When absent, profile defaults and auto-detection apply.
recipientEncryptionTargetCapabilities :: Maybe RecipientCapabilities
Optional recipient capability hints used by negotiation-enabled encryption to choose common symmetric/AEAD algorithms.

Instances

Instances details

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

recipientEncryptionTarget :: SomePKPayload -> RecipientEncryptionTarget Source #

recipientEncryptionTargetWithStrategy :: SomePKPayload -> RecipientPKESKVersionStrategy -> RecipientEncryptionTarget Source #

recipientEncryptionTargetWithCapabilities :: SomePKPayload -> RecipientCapabilities -> RecipientEncryptionTarget Source #

recipientEncryptionTargetWithStrategyTyped :: forall (strategy :: RecipientPKESKVersionStrategy). SomePKPayload -> RecipientPKESKVersionStrategyW strategy -> RecipientEncryptionTarget Source #

recipientVersionStrategyForProfile :: EncryptCompatibilityProfile -> RecipientEncryptionTarget -> Either PKESKEncryptError RecipientPKESKVersionStrategy Source #

recipientVersionStrategyForProfileTyped :: forall (profile :: EncryptCompatibilityProfile). EncryptCompatibilityProfileW profile -> RecipientEncryptionTarget -> Either PKESKEncryptError SomeRecipientPKESKVersionStrategyW Source #

data RecipientPayloadShape Source #

Constructors

RecipientPayloadShape
Fields recipientPayloadDataType :: DataType recipientPayloadFileName :: FileName recipientPayloadTimestamp :: ThirtyTwoBitTimeStamp recipientPayloadUseOnePassSignatures :: Bool recipientPayloadSignatures :: [SignaturePayload]

Instances

Instances details

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

defaultRecipientPayloadShape :: RecipientPayloadShape Source #

data SEIPDVersion Source #

Constructors

SEIPDv1
SEIPDv2

Instances

Instances details

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

data RecipientEncryptResult Source #

Constructors

RecipientEncryptResult
Fields recipientEncryptPackets :: [Pkt] recipientEncryptSessionMaterial :: PKESKSessionMaterial

Instances

Instances details

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

data RecipientEncryptRequest (v :: SEIPDVersion) Source #

Constructors

RecipientEncryptRequest

Fields

recipientEncryptRequestTargets :: [RecipientEncryptionTarget]
Recipient encryption targets. At least one target is required.
recipientEncryptRequestPayloadShape :: RecipientPayloadShape
recipientEncryptRequestPayload :: ByteString
recipientEncryptRequestSymmetricOverride :: Maybe SymmetricAlgorithm
Explicit symmetric algorithm override. When Nothing, the selected mode (negotiated or legacy) determines algorithm selection.
recipientEncryptRequestOverrides :: RecipientEncryptRequestOverrides v

Instances

Instances details

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

data RecipientEncryptRequestOverrides (v :: SEIPDVersion) where Source #

Constructors

RecipientEncryptRequestSEIPDv1Overrides
Fields :: { recipientEncryptRequestIVOverride :: Maybe IV } -> RecipientEncryptRequestOverrides 'SEIPDv1
RecipientEncryptRequestSEIPDv2Overrides	For SEIPDv2 requests: - when AEAD override is `Nothing`, encrypt-side capability negotiation selects a common recipient-supported AEAD algorithm (if enabled). - when AEAD override is `Just`, the explicit AEAD wins.
Fields :: { recipientEncryptRequestAEADOverride :: Maybe AEADAlgorithm , recipientEncryptRequestChunkSizeOverride :: Maybe Word8 , recipientEncryptRequestSaltOverride :: Maybe Salt } -> RecipientEncryptRequestOverrides 'SEIPDv2

Instances

Instances details

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

encryptForRecipients :: forall m (v :: SEIPDVersion). MonadRandom m => RecipientEncryptRequest v -> m (Either PKESKEncryptError RecipientEncryptResult) Source #

Encrypt for recipient targets with capability negotiation enabled.

By default this negotiates a common symmetric and (for SEIPDv2) AEAD algorithm from recipient capabilities when available. Explicit request overrides still take precedence.

encryptForRecipientsLegacy :: forall m (v :: SEIPDVersion). MonadRandom m => RecipientEncryptRequest v -> m (Either PKESKEncryptError RecipientEncryptResult) Source #

Encrypt for recipient targets without recipient capability negotiation.

This preserves legacy behavior by using policy defaults unless request overrides are provided.

encryptForRecipientsWithCapabilityNegotiation :: forall m (v :: SEIPDVersion). MonadRandom m => RecipientCapabilityNegotiationMode -> RecipientEncryptRequest v -> m (Either PKESKEncryptError RecipientEncryptResult) Source #

Encrypt for recipient targets with an explicit capability-negotiation mode.

When negotiation is on, symmetric and AEAD selection use the common intersection of recipient preferences constrained by the active policy. When off, policy defaults are used.

data PKESKV3SessionMaterial Source #

Session-key bundle for PKESK/SKESK packet construction.

Instances

Instances details

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

data PKESKV6RawSessionMaterial Source #

Instances

Instances details

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

data PKESKSessionMaterial Source #

Instances

Instances details

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

pkeskSessionAlgorithm :: PKESKSessionMaterial -> SymmetricAlgorithm Source #

pkeskSessionKey :: PKESKSessionMaterial -> SessionKey Source #

mkPKESKSessionMaterial :: SymmetricAlgorithm -> SessionKey -> Either PKESKEncryptError PKESKSessionMaterial Source #

mkPKESKV3SessionMaterial :: SymmetricAlgorithm -> SessionKey -> Either PKESKEncryptError PKESKV3SessionMaterial Source #

mkPKESKV6RawSessionMaterial :: SymmetricAlgorithm -> SessionKey -> Either PKESKEncryptError PKESKV6RawSessionMaterial Source #

pkeskV3SessionMaterial :: PKESKSessionMaterial -> PKESKV3SessionMaterial Source #

pkeskV6RawSessionMaterial :: PKESKSessionMaterial -> PKESKV6RawSessionMaterial Source #

encodeOpenPGPSessionMaterial :: SymmetricAlgorithm -> SessionKey -> Either PKESKEncryptError ByteString Source #

Encode the RFC 9580 PKESK/SKESK session-key material: one-octet algorithm ID, raw session key, then 16-bit checksum.

generateSessionKeyMaterial :: MonadRandom m => SymmetricAlgorithm -> m (Either PKESKEncryptError PKESKSessionMaterial) Source #

Generate a fresh session key and return both raw and encoded forms.

canonicalizePKESKRecipientId :: PKESKPayload -> Either PKESKEncryptError PKESKPayload Source #

canonicalizePKESKPacketRecipientIds :: [Pkt] -> Either PKESKEncryptError [Pkt] Source #

buildPKESKv3PayloadForRecipient :: MonadRandom m => SomePKPayload -> PKESKV3SessionMaterial -> m (Either PKESKEncryptError PKESKPayload) Source #

Build a legacy PKESKv3 payload for v4/v3 RSA recipient interop.

buildPKESKv3PktForRecipient :: MonadRandom m => SomePKPayload -> PKESKV3SessionMaterial -> m (Either PKESKEncryptError Pkt) Source #

Build a legacy PKESKv3 packet for v4/v3 RSA recipient interop.

buildPKESKPayloadForRecipient :: MonadRandom m => PKESKVersionPolicy -> SomePKPayload -> PKESKSessionMaterial -> m (Either PKESKEncryptError PKESKPayload) Source #

Build a v6 PKESK payload for one recipient key according to the selected version policy.

buildPKESKPktForRecipient :: MonadRandom m => PKESKVersionPolicy -> SomePKPayload -> PKESKSessionMaterial -> m (Either PKESKEncryptError Pkt) Source #

Build a PKESK packet for one recipient key according to the selected version policy.

buildPKESKPktsForRecipientTargetsWithSelector :: MonadRandom m => (RecipientEncryptionTarget -> Either PKESKEncryptError RecipientPKESKVersionStrategy) -> [RecipientEncryptionTarget] -> PKESKSessionMaterial -> m (Either PKESKEncryptError [Pkt]) Source #

Build PKESK packets for all recipients with a single shared session key.

buildPKESKPktsForRecipientTargetsWithSelectorTyped :: MonadRandom m => (RecipientEncryptionTarget -> Either PKESKEncryptError SomeRecipientPKESKVersionStrategyW) -> [RecipientEncryptionTarget] -> PKESKSessionMaterial -> m (Either PKESKEncryptError [Pkt]) Source #

encryptSEIPDv2Payload :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> SessionKey -> ByteString -> Either String ByteString Source #

encryptSEIPDv1Payload Source #

Arguments

:: SymmetricAlgorithm
-> IV
-> SessionKey
-> ByteString	inner packet block plaintext
-> Either String ByteString

Encrypt a plaintext block with OpenPGP CFB + MDC to produce a SEIPDv1 ciphertext.

encryptSEIPDv2WithSKESK :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> S2K -> ByteString -> ByteString -> Either String [Pkt] Source #

encryptSEIPDv2WithSKESKBlock :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> S2K -> ByteString -> Block Pkt -> Either String [Pkt] Source #

encryptSEIPDv2LiteralDataWithSKESK :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> S2K -> ByteString -> ByteString -> Either String [Pkt] Source #

composeMessageWithSEIPDv2 :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> S2K -> ByteString -> ByteString -> Maybe [Pkt] -> Either String [Pkt] Source #

Compose a complete AEAD-encrypted message with optional literal data and signature. Returns a packet list (SKESK, SEIPD v2, optional signature) ready for serialization.

Example: composeMessageWithSEIPDv2 AES256 OCB 6 (Salt 32 bytes) (SimpleS2K SHA256) passphrase payload Nothing returns [SKESK v6, SEIPD v2, ciphertext]

If the signature is provided, it will be included in the encrypted payload.

UnsupportedSessionKeyAlgorithm SymmetricAlgorithm String
InvalidSessionKeyLength SymmetricAlgorithm Int Int
InvalidRecipientIdentifier String
UnsupportedRecipientAlgorithm PubKeyAlgorithm
InvalidRecipientKeyMaterial PubKeyAlgorithm String
RecipientKdfFailure PubKeyAlgorithm String
RecipientKeyWrapFailure PubKeyAlgorithm String
RecipientCapabilitySelectionFailure RecipientCapabilityError
PayloadBuildFailure String
NoRecipientsProvided