Safe Haskell	None
Language	Haskell2010

Data.Conduit.OpenPGP.Decrypt

Synopsis

conduitDecrypt :: forall (m :: Type -> Type). (MonadFail m, MonadResource m, MonadThrow m, MonadUnliftIO m) => DecryptOptions -> ConduitT Pkt Pkt m DecryptOutcome
conduitDecryptWithReport :: forall (m :: Type -> Type). (MonadFail m, MonadResource m, MonadThrow m, MonadUnliftIO m) => DecryptOptions -> ConduitT Pkt Pkt m DecryptReport
data DecryptOptions = DecryptOptions {
- decryptOptionsKeyResolution :: DecryptKeyResolution
- decryptOptionsPolicy :: DecryptPolicy
- decryptOptionsPassphraseCallback :: InputCallback IO
}
data DecryptKeyResolution
- = DecryptWithoutPKESK
- | DecryptWithKeyring SecretKeyring
- | DecryptWithKeyringAndPassphrase SecretKeyring (SomePKPayload -> IO (Maybe Passphrase))
- | DecryptWithUnwrapCandidatesCallback (KeyIdentifier -> PubKeyAlgorithm -> IO [PKESKRecipientKey])
data PKESKRecipientKey = PKESKRecipientKey {
- pkeskRecipientPKPayload :: Maybe SomePKPayload
- pkeskRecipientSKey :: SKey
}
data PKESKAttemptFailureKind
- = PKESKAttemptUnwrapFailed
- | PKESKAttemptSessionMaterialDecodeFailed
data PKESKAttemptFailure = PKESKAttemptFailure {
}
data DecryptStructureError
data DecryptOutcome
data DecryptReport = DecryptReport {
- decryptReportOutcome :: DecryptOutcome
- decryptReportSessionKeyResolutions :: [DecryptSessionKeyResolutionReport]
}
data DecryptSessionKeyResolutionReport = DecryptSessionKeyResolutionReport {
}
data DecryptSessionKeyResolutionPath
data PKESKResolverAttempt = PKESKResolverAttempt {
- pkeskResolverAttemptPreviousFailures :: [PKESKAttemptFailure]
- pkeskResolverAttemptAction :: PKESKResolverAttemptAction
}
data PKESKResolverAttemptAction
decryptSEIPDv2Payload :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> ByteString -> SessionKey -> Either SEIPDv2Failure ByteString
renderDecryptStructureError :: DecryptStructureError -> String
renderDecryptOutcome :: DecryptOutcome -> String
renderDecryptSessionKeyResolutionReport :: DecryptSessionKeyResolutionReport -> String
renderDecryptReport :: DecryptReport -> String

Documentation

conduitDecrypt :: forall (m :: Type -> Type). (MonadFail m, MonadResource m, MonadThrow m, MonadUnliftIO m) => DecryptOptions -> ConduitT Pkt Pkt m DecryptOutcome Source #

conduitDecryptWithReport :: forall (m :: Type -> Type). (MonadFail m, MonadResource m, MonadThrow m, MonadUnliftIO m) => DecryptOptions -> ConduitT Pkt Pkt m DecryptReport Source #

data DecryptOptions Source #

Canonical decrypt configuration.

Most callers should prefer conduitDecrypt and set:

decryptOptionsKeyResolution to DecryptWithKeyring or DecryptWithKeyringAndPassphrase
decryptOptionsPolicy to strict (defaultDecryptPolicy) or lenient
decryptOptionsPassphraseCallback for SKESK passphrase lookup

Constructors

DecryptOptions
Fields decryptOptionsKeyResolution :: DecryptKeyResolution decryptOptionsPolicy :: DecryptPolicy decryptOptionsPassphraseCallback :: InputCallback IO

data DecryptKeyResolution Source #

Build a stateful PKESKResolver that iterates over a pre-populated candidate list. The returned resolver yields candidates in order and returns ResolveExhausted once the list is depleted. | How to resolve secret keys for PKESK-encrypted messages.

Constructors

DecryptWithoutPKESK	Do not attempt PKESK decryption; fall through to manual session-key input via the passphrase callback instead.
DecryptWithKeyring SecretKeyring	Resolve secret keys from a `SecretKeyring`. Only unencrypted secret keys (not passphrase-protected) are used. For passphrase-protected keys, use `DecryptWithKeyringAndPassphrase`.
DecryptWithKeyringAndPassphrase SecretKeyring (SomePKPayload -> IO (Maybe Passphrase))	Resolve secret keys from a `SecretKeyring`, unlocking passphrase- protected keys using the provided callback. The callback receives the public key payload and returns the passphrase, or `Nothing` to skip.
DecryptWithUnwrapCandidatesCallback (KeyIdentifier -> PubKeyAlgorithm -> IO [PKESKRecipientKey])	Preferred callback form for non-keyring key material. The callback receives a typed key identifier (8-octet key ID, fingerprint, or wildcard) plus the packet public-key algorithm, then returns all matching candidates in priority order. hOpenPGP iterates candidates deterministically without re-calling the callback for each retry.

data PKESKRecipientKey Source #

Constructors

PKESKRecipientKey
Fields pkeskRecipientPKPayload :: Maybe SomePKPayload Public key payload for the recipient. Required for X25519, X448, and ECDH unwrap paths; may be `Nothing` for RSA. pkeskRecipientSKey :: SKey Corresponding secret key.

data PKESKAttemptFailureKind Source #

Constructors

PKESKAttemptUnwrapFailed
PKESKAttemptSessionMaterialDecodeFailed

Instances

Instances details

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

data PKESKAttemptFailure Source #

Constructors

PKESKAttemptFailure
Fields pkeskAttemptFailureKeyContext :: Maybe (KeyVersion, PubKeyAlgorithm) pkeskAttemptFailureKind :: PKESKAttemptFailureKind pkeskAttemptFailureReason :: String

Instances

Instances details

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

data DecryptStructureError Source #

Constructors

DecryptStructureESKSEIPDMismatch
DecryptStructureESKOrder
DecryptStructureTrailingData

Instances

Instances details

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

data DecryptOutcome Source #

Constructors

DecryptClean
DecryptTruncated
DecryptTrailingData
DecryptMalformedStructure !DecryptStructureError

Instances

Instances details

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

data DecryptReport Source #

Constructors

DecryptReport
Fields decryptReportOutcome :: DecryptOutcome decryptReportSessionKeyResolutions :: [DecryptSessionKeyResolutionReport]

Instances

Instances details

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

data DecryptSessionKeyResolutionReport Source #

Constructors

DecryptSessionKeyResolutionReport
Fields decryptSessionResolutionPath :: DecryptSessionKeyResolutionPath decryptSessionResolutionSKESKErrors :: [SKESKSessionKeyResolutionError] decryptSessionResolutionPKESKErrors :: [PKESKAttemptFailure] decryptSessionResolutionResolverAttempts :: [PKESKResolverAttempt]

Instances

Instances details

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

data DecryptSessionKeyResolutionPath Source #

Constructors

DecryptResolvedViaSKESK
DecryptResolvedViaPKESK
DecryptResolvedViaManualPKESKInput

Instances

Instances details

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

data PKESKResolverAttempt Source #

Constructors

PKESKResolverAttempt
Fields pkeskResolverAttemptPreviousFailures :: [PKESKAttemptFailure] pkeskResolverAttemptAction :: PKESKResolverAttemptAction

Instances

Instances details

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

data PKESKResolverAttemptAction Source #

Constructors

ResolverAttemptResolveWith (Maybe (KeyVersion, PubKeyAlgorithm))
ResolverAttemptSkip
ResolverAttemptExhausted

Instances

Instances details

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

decryptSEIPDv2Payload :: SymmetricAlgorithm -> AEADAlgorithm -> Word8 -> Salt -> ByteString -> SessionKey -> Either SEIPDv2Failure ByteString Source #

renderDecryptStructureError :: DecryptStructureError -> String Source #

renderDecryptOutcome :: DecryptOutcome -> String Source #

renderDecryptSessionKeyResolutionReport :: DecryptSessionKeyResolutionReport -> String Source #

renderDecryptReport :: DecryptReport -> String Source #