Safe Haskell	None
Language	Haskell2010

Codec.Encryption.OpenPGP.Policy

Contents

Signature context validation (RFC9580/RFC4880)
Signature type validation helpers (for parser use)

Synopsis

data OpenPGPRFC
- = RFC2440
- | RFC4880
- | RFC9580
data OpenPGPRFCW (rfc :: OpenPGPRFC) where
- RFC2440W :: OpenPGPRFCW 'RFC2440
- RFC4880W :: OpenPGPRFCW 'RFC4880
- RFC9580W :: OpenPGPRFCW 'RFC9580
data SomeOpenPGPRFCW where
- SomeOpenPGPRFCW :: forall (rfc :: OpenPGPRFC). OpenPGPRFCW rfc -> SomeOpenPGPRFCW
promoteOpenPGPRFC :: OpenPGPRFC -> SomeOpenPGPRFCW
demoteOpenPGPRFCW :: forall (rfc :: OpenPGPRFC). OpenPGPRFCW rfc -> OpenPGPRFC
data HashAlgorithmW (h :: HashAlgorithm) where
- DeprecatedMD5W :: HashAlgorithmW 'DeprecatedMD5
- SHA1W :: HashAlgorithmW 'SHA1
- RIPEMD160W :: HashAlgorithmW 'RIPEMD160
- SHA256W :: HashAlgorithmW 'SHA256
- SHA384W :: HashAlgorithmW 'SHA384
- SHA512W :: HashAlgorithmW 'SHA512
- SHA224W :: HashAlgorithmW 'SHA224
- SHA3_256W :: HashAlgorithmW 'SHA3_256
- SHA3_512W :: HashAlgorithmW 'SHA3_512
data SomeHashAlgorithmW where
- SomeHashAlgorithmW :: forall (h :: HashAlgorithm). HashAlgorithmW h -> SomeHashAlgorithmW
promoteHashAlgorithm :: HashAlgorithm -> Maybe SomeHashAlgorithmW
demoteHashAlgorithmW :: forall (h :: HashAlgorithm). HashAlgorithmW h -> HashAlgorithm
data HashAlgoStatus
- = HashAllowed
- | HashShouldNot
- | HashMustNot
type family HashAlgoStatusFor (rfc :: OpenPGPRFC) (h :: HashAlgorithm) :: HashAlgoStatus where ...
type HashAlgoAllowedFor (rfc :: OpenPGPRFC) (h :: HashAlgorithm) = AssertHashAllowed (HashAlgoStatusFor rfc h)
type HashAlgoVerifiableFor (rfc :: OpenPGPRFC) (h :: HashAlgorithm) = AssertHashVerifiable (HashAlgoStatusFor rfc h)
data PKESKVersionPolicy
- = PreferV6
- | ForceV3Interop
data MessageEncryptionPolicy = MessageEncryptionPolicy {
- messageDefaultSymmetricAlgorithm :: SymmetricAlgorithm
- messageDefaultAEADAlgorithm :: AEADAlgorithm
- messageDefaultChunkSize :: Word8
- messageS2KSaltOctets :: Int
- messageSEIPDv2SaltOctets :: Int
- messageDefaultS2KForSalt :: Salt -> S2K
- messageSEIPDv2SymmetricAlgorithms :: [SymmetricAlgorithm]
}
data SecretKeyProtectionPolicy = SecretKeyProtectionPolicy {
- secretKeyDefaultSymmetricAlgorithm :: SymmetricAlgorithm
- secretKeyDefaultAEADAlgorithm :: AEADAlgorithm
- secretKeyDefaultS2KForSalt :: Salt -> S2K
- secretKeyS2KSaltOctets :: Int
- secretKeyAEADNonceOctets :: Int
}
data GenerationDeprecationPolicy = GenerationDeprecationPolicy {
- deprecatedHashAlgorithms :: [HashAlgorithm]
- deprecatedSymmetricAlgorithms :: [SymmetricAlgorithm]
}
data VerificationDefaults = VerificationDefaults {
- verificationDefaultStrict :: Bool
- verificationDefaultStreaming :: Bool
}
data DecryptPolicy = DecryptPolicy {
- decryptAllowSEDNoIntegrity :: Bool
- decryptAllowSEIPDv1 :: Bool
- decryptAllowedSymmetricAlgos :: Maybe [SymmetricAlgorithm]
- decryptAllowedAEADAlgos :: Maybe [AEADAlgorithm]
- decryptRejectDeprecatedSKESK :: Bool
- decryptRejectTrailingData :: Bool
- decryptRejectESKVersionMismatch :: Bool
}
data OpenPGPPolicy = OpenPGPPolicy {
- policyRFC :: OpenPGPRFC
- policyMessageEncryption :: MessageEncryptionPolicy
- policySecretKeyProtection :: Maybe SecretKeyProtectionPolicy
- policyGenerationDeprecations :: GenerationDeprecationPolicy
- policyDecrypt :: DecryptPolicy
}
policyForRFC :: OpenPGPRFC -> OpenPGPPolicy
defaultPolicy :: OpenPGPPolicy
defaultPKESKVersionPolicy :: PKESKVersionPolicy
defaultVerificationDefaults :: VerificationDefaults
defaultDecryptPolicy :: DecryptPolicy
lenientDecryptPolicy :: DecryptPolicy
supportsSEIPDv2Symmetric :: OpenPGPPolicy -> SymmetricAlgorithm -> Bool
secretKeyProtectionPolicyForKeyVersion :: OpenPGPPolicy -> KeyVersion -> Maybe SecretKeyProtectionPolicy
signatureV6SaltSizeForHashAlgorithm :: HashAlgorithm -> Maybe Word8
ecdhKdfHashDigest :: HashAlgorithm -> ByteString -> Either String ByteString
validateTable30PolicyForRecipient :: SomePKPayload -> HashAlgorithm -> SymmetricAlgorithm -> Either String ()
legacySecretKeyProtectionErrorMessage :: String
isAllowedPrimaryKeySig :: SignaturePayload -> Bool
isAllowedSubkeySig :: SignaturePayload -> Bool
isAllowedUIDSig :: SignaturePayload -> Bool
isAllowedPrimaryKeySigType :: SigType -> Bool
isAllowedSubkeySigType :: SigType -> Bool
isAllowedUIDSigType :: SigType -> Bool

Documentation

data OpenPGPRFC Source #

Constructors

RFC2440
RFC4880
RFC9580

Instances

Instances details

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

data OpenPGPRFCW (rfc :: OpenPGPRFC) where Source #

Constructors

RFC2440W :: OpenPGPRFCW 'RFC2440
RFC4880W :: OpenPGPRFCW 'RFC4880
RFC9580W :: OpenPGPRFCW 'RFC9580

data SomeOpenPGPRFCW where Source #

Constructors

SomeOpenPGPRFCW :: forall (rfc :: OpenPGPRFC). OpenPGPRFCW rfc -> SomeOpenPGPRFCW

promoteOpenPGPRFC :: OpenPGPRFC -> SomeOpenPGPRFCW Source #

demoteOpenPGPRFCW :: forall (rfc :: OpenPGPRFC). OpenPGPRFCW rfc -> OpenPGPRFC Source #

data HashAlgorithmW (h :: HashAlgorithm) where Source #

Constructors

DeprecatedMD5W :: HashAlgorithmW 'DeprecatedMD5
SHA1W :: HashAlgorithmW 'SHA1
RIPEMD160W :: HashAlgorithmW 'RIPEMD160
SHA256W :: HashAlgorithmW 'SHA256
SHA384W :: HashAlgorithmW 'SHA384
SHA512W :: HashAlgorithmW 'SHA512
SHA224W :: HashAlgorithmW 'SHA224
SHA3_256W :: HashAlgorithmW 'SHA3_256
SHA3_512W :: HashAlgorithmW 'SHA3_512

data SomeHashAlgorithmW where Source #

Constructors

SomeHashAlgorithmW :: forall (h :: HashAlgorithm). HashAlgorithmW h -> SomeHashAlgorithmW

promoteHashAlgorithm :: HashAlgorithm -> Maybe SomeHashAlgorithmW Source #

demoteHashAlgorithmW :: forall (h :: HashAlgorithm). HashAlgorithmW h -> HashAlgorithm Source #

data HashAlgoStatus Source #

Constructors

HashAllowed
HashShouldNot
HashMustNot

type family HashAlgoStatusFor (rfc :: OpenPGPRFC) (h :: HashAlgorithm) :: HashAlgoStatus where ... Source #

Equations

HashAlgoStatusFor 'RFC4880 'DeprecatedMD5 = 'HashShouldNot
HashAlgoStatusFor 'RFC9580 'DeprecatedMD5 = 'HashMustNot
HashAlgoStatusFor 'RFC9580 'SHA1 = 'HashMustNot
HashAlgoStatusFor 'RFC9580 'RIPEMD160 = 'HashShouldNot
HashAlgoStatusFor rfc h = 'HashAllowed

type HashAlgoAllowedFor (rfc :: OpenPGPRFC) (h :: HashAlgorithm) = AssertHashAllowed (HashAlgoStatusFor rfc h) Source #

type HashAlgoVerifiableFor (rfc :: OpenPGPRFC) (h :: HashAlgorithm) = AssertHashVerifiable (HashAlgoStatusFor rfc h) 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 MessageEncryptionPolicy Source #

Constructors

MessageEncryptionPolicy
Fields messageDefaultSymmetricAlgorithm :: SymmetricAlgorithm messageDefaultAEADAlgorithm :: AEADAlgorithm messageDefaultChunkSize :: Word8 messageS2KSaltOctets :: Int messageSEIPDv2SaltOctets :: Int messageDefaultS2KForSalt :: Salt -> S2K messageSEIPDv2SymmetricAlgorithms :: [SymmetricAlgorithm]

data SecretKeyProtectionPolicy Source #

Constructors

SecretKeyProtectionPolicy
Fields secretKeyDefaultSymmetricAlgorithm :: SymmetricAlgorithm secretKeyDefaultAEADAlgorithm :: AEADAlgorithm secretKeyDefaultS2KForSalt :: Salt -> S2K secretKeyS2KSaltOctets :: Int secretKeyAEADNonceOctets :: Int

data GenerationDeprecationPolicy Source #

Constructors

GenerationDeprecationPolicy
Fields deprecatedHashAlgorithms :: [HashAlgorithm] deprecatedSymmetricAlgorithms :: [SymmetricAlgorithm]

data VerificationDefaults Source #

Constructors

VerificationDefaults
Fields verificationDefaultStrict :: Bool verificationDefaultStreaming :: Bool

data DecryptPolicy Source #

Per-message decrypt-side enforcement policy.

defaultDecryptPolicy applies RFC9580-strict rules: no unauthenticated (SED) ciphertext, modern symmetric algorithms only, and rejection of deprecated S2K specifiers in SKESK. Use lenientDecryptPolicy when interoperating with older RFC4880 or RFC2440 messages.

Constructors

DecryptPolicy

Fields

decryptAllowSEDNoIntegrity :: Bool
When False (RFC9580 default), receiving a Symmetrically Encrypted Data packet (SED, tag 9) is a hard error. RFC9580 §5.9 says implementations SHOULD reject unauthenticated ciphertext.
decryptAllowSEIPDv1 :: Bool
When False, receiving a SEIPDv1 (MDC-protected) packet is rejected. Defaults to True for interoperability with RFC4880 senders.
decryptAllowedSymmetricAlgos :: Maybe [SymmetricAlgorithm]
Allowed symmetric algorithms for session keys. Nothing means unrestricted. The RFC9580 default restricts to AES-128192256.
decryptAllowedAEADAlgos :: Maybe [AEADAlgorithm]
Allowed AEAD algorithms for SEIPDv2 payloads. Nothing means unrestricted. The RFC9580 default allows EAX, OCB, and GCM.
decryptRejectDeprecatedSKESK :: Bool
When True (RFC9580 default), reject SKESK packets that use Simple or Salted S2K specifiers (both deprecated since RFC9580).
decryptRejectTrailingData :: Bool
When True (RFC9580 default), any packet received after the message-integrity boundary (MDC for SEIPDv1, final AEAD tag for SEIPDv2, or the outer encrypted-data packet for SED) is a hard error. RFC9580 §5.13.2 requires that implementations detect and reject data appended after the authenticated payload. Set to False only when interoperating with legacy implementations that emit trailing garbage (implies lenientDecryptPolicy).
decryptRejectESKVersionMismatch :: Bool
When True (RFC9580 default), a payload with no version-aligned ESK is a hard error even when misaligned ESKs are present. This is a distinct concern from trailing-data rejection: a message could have correct framing yet still carry only v6 PKESKs before a SEIPDv1 payload (or only v4 SKESKs before a SEIPDv2 payload), which indicates a mis-assembled message rather than an integrity violation. Set to False only when salvaging malformed legacy messages.

Instances

Instances details

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

data OpenPGPPolicy Source #

Constructors

OpenPGPPolicy
Fields policyRFC :: OpenPGPRFC policyMessageEncryption :: MessageEncryptionPolicy policySecretKeyProtection :: Maybe SecretKeyProtectionPolicy policyGenerationDeprecations :: GenerationDeprecationPolicy policyDecrypt :: DecryptPolicy

policyForRFC :: OpenPGPRFC -> OpenPGPPolicy Source #

defaultPolicy :: OpenPGPPolicy Source #

defaultPKESKVersionPolicy :: PKESKVersionPolicy Source #

defaultVerificationDefaults :: VerificationDefaults Source #

defaultDecryptPolicy :: DecryptPolicy Source #

RFC9580-strict decrypt policy. Rejects unauthenticated SED ciphertext, restricts session-key symmetric algorithms to AES-128192256 and AEAD to EAXOCBGCM, and rejects SKESK packets carrying deprecated Simple or Salted S2K specifiers. SEIPDv1 (MDC-protected) is still accepted for interoperability with RFC4880 senders.

lenientDecryptPolicy :: DecryptPolicy Source #

Permissive decrypt policy for interoperability with RFC4880 and RFC2440 messages. No algorithm or integrity restrictions are applied.

supportsSEIPDv2Symmetric :: OpenPGPPolicy -> SymmetricAlgorithm -> Bool Source #

secretKeyProtectionPolicyForKeyVersion :: OpenPGPPolicy -> KeyVersion -> Maybe SecretKeyProtectionPolicy Source #

signatureV6SaltSizeForHashAlgorithm :: HashAlgorithm -> Maybe Word8 Source #

ecdhKdfHashDigest :: HashAlgorithm -> ByteString -> Either String ByteString Source #

validateTable30PolicyForRecipient :: SomePKPayload -> HashAlgorithm -> SymmetricAlgorithm -> Either String () Source #

legacySecretKeyProtectionErrorMessage :: String Source #