Safe Haskell	None
Language	Haskell2010

Data.Mail.TLSRPT.Reports

Contents

Parsers
Data types

Description

Utilities for parsing an SMTP-TLRPT aggregated report, following RFC 8460. These functions also handle decompression (gzip or pkzip)

Synopsis

tlsReportFromStrict :: ByteString -> Either String Report
tlsReportFromLazy :: ByteString -> Either String Report
tlsReportFromJson :: Value -> Either String Report
data Report = Report {
- rpOrganizationName :: Text
- rpDateRange :: (UTCTime, UTCTime)
- rpContactInfo :: Text
- rpReportId :: Text
- rpPolicies :: [Policy]
}
data Policy = Policy {
- pcPolicy :: PolicyDesc
- pcSummary :: PolicySummary
- pcFailureDetails :: [FailureDetails]
}
data PolicyDesc = PolicyDesc {
- pdPolicyType :: PolicyType
- pdPolicyString :: [Text]
- pdPolicyDomain :: Text
- pdMxHost :: [Text]
}
data FailureDetails = FailureDetails {
- fdResultType :: ResultType
- fdSendingMtaIp :: IpAddress
- fdReceivingMxHostname :: Text
- fdReceivingMxHelo :: Maybe Text
- fdReceivingIp :: IpAddress
- fdFailedSessionCount :: Int
- fdAdditionalInformation :: Maybe Text
- fdFailureReasonCode :: Maybe Text
}
type IpAddress = String
data PolicySummary = PolicySummary {
- psTotalSuccessfulSessionCount :: Int
- psTotalFailureSessionCount :: Int
}
data PolicyType
- = NoPolicyFound
- | TlsaPolicy
- | StsPolicy
data ResultType

Parsers

tlsReportFromStrict :: ByteString -> Either String Report Source #

Parse a TLSRPT report from a strict ByteString

tlsReportFromLazy :: ByteString -> Either String Report Source #

Parse a TLSRPT report from a lazy ByteString

tlsReportFromJson :: Value -> Either String Report Source #

Parse a TLSRPT report from a JSON Value

Data types

data Report Source #

The entire SMTP-TLSRPT report

Constructors

Report
Fields rpOrganizationName :: Text organization responsible for the report rpDateRange :: (UTCTime, UTCTime) start and end times for the report range rpContactInfo :: Text e-mail address of the party responsible for the report rpReportId :: Text unique identifier rpPolicies :: [Policy] results for each policy

Instances

Instances details

Eq Report Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods (==) :: Report -> Report -> Bool # (/=) :: Report -> Report -> Bool #
Read Report Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods readsPrec :: Int -> ReadS Report # readList :: ReadS [Report] # readPrec :: ReadPrec Report # readListPrec :: ReadPrec [Report] #
Show Report Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods showsPrec :: Int -> Report -> ShowS # show :: Report -> String # showList :: [Report] -> ShowS #
ToJSON Report Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods toJSON :: Report -> Value # toEncoding :: Report -> Encoding # toJSONList :: [Report] -> Value # toEncodingList :: [Report] -> Encoding #
FromJSON Report Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods parseJSON :: Value -> Parser Report # parseJSONList :: Value -> Parser [Report] #

data Policy Source #

Constructors

Policy
Fields pcPolicy :: PolicyDesc description of the evaluated policy pcSummary :: PolicySummary failure/success summary pcFailureDetails :: [FailureDetails] details about failure types

Instances

Instances details

Eq Policy Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods (==) :: Policy -> Policy -> Bool # (/=) :: Policy -> Policy -> Bool #
Read Policy Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods readsPrec :: Int -> ReadS Policy # readList :: ReadS [Policy] # readPrec :: ReadPrec Policy # readListPrec :: ReadPrec [Policy] #
Show Policy Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods showsPrec :: Int -> Policy -> ShowS # show :: Policy -> String # showList :: [Policy] -> ShowS #
ToJSON Policy Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods toJSON :: Policy -> Value # toEncoding :: Policy -> Encoding # toJSONList :: [Policy] -> Value # toEncodingList :: [Policy] -> Encoding #
FromJSON Policy Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods parseJSON :: Value -> Parser Policy # parseJSONList :: Value -> Parser [Policy] #

data PolicyDesc Source #

Description of the evaluated policy

Constructors

PolicyDesc
Fields pdPolicyType :: PolicyType Policy type (DANE or MTA-STS) pdPolicyString :: [Text] Applied policy as strings pdPolicyDomain :: Text domain (if punycode: A-labels, not U-labels) pdMxHost :: [Text] if MTA-STS, then this is a list of mx host patterns

Instances

Instances details

Eq PolicyDesc Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods (==) :: PolicyDesc -> PolicyDesc -> Bool # (/=) :: PolicyDesc -> PolicyDesc -> Bool #
Read PolicyDesc Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods readsPrec :: Int -> ReadS PolicyDesc # readList :: ReadS [PolicyDesc] # readPrec :: ReadPrec PolicyDesc # readListPrec :: ReadPrec [PolicyDesc] #
Show PolicyDesc Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods showsPrec :: Int -> PolicyDesc -> ShowS # show :: PolicyDesc -> String # showList :: [PolicyDesc] -> ShowS #
ToJSON PolicyDesc Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods toJSON :: PolicyDesc -> Value # toEncoding :: PolicyDesc -> Encoding # toJSONList :: [PolicyDesc] -> Value # toEncodingList :: [PolicyDesc] -> Encoding #
FromJSON PolicyDesc Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods parseJSON :: Value -> Parser PolicyDesc # parseJSONList :: Value -> Parser [PolicyDesc] #

data FailureDetails Source #

Constructors

FailureDetails

Fields

fdResultType :: ResultType
failure type
fdSendingMtaIp :: IpAddress
address of the sending MTA
fdReceivingMxHostname :: Text
hostname of the receiving MTA MX record
fdReceivingMxHelo :: Maybe Text
the HELO or EHLO string from thte banner announced during the reported session
fdReceivingIp :: IpAddress
destination IP address
fdFailedSessionCount :: Int
number of attempted sessions that match the result type
fdAdditionalInformation :: Maybe Text
URI that points to additional information
fdFailureReasonCode :: Maybe Text
failure code, esp. useful if result type is validation-failure

Instances

Instances details

Eq FailureDetails Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods (==) :: FailureDetails -> FailureDetails -> Bool # (/=) :: FailureDetails -> FailureDetails -> Bool #
Read FailureDetails Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods readsPrec :: Int -> ReadS FailureDetails # readList :: ReadS [FailureDetails] # readPrec :: ReadPrec FailureDetails # readListPrec :: ReadPrec [FailureDetails] #
Show FailureDetails Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods showsPrec :: Int -> FailureDetails -> ShowS # show :: FailureDetails -> String # showList :: [FailureDetails] -> ShowS #
ToJSON FailureDetails Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods toJSON :: FailureDetails -> Value # toEncoding :: FailureDetails -> Encoding # toJSONList :: [FailureDetails] -> Value # toEncodingList :: [FailureDetails] -> Encoding #
FromJSON FailureDetails Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods parseJSON :: Value -> Parser FailureDetails # parseJSONList :: Value -> Parser [FailureDetails] #

type IpAddress = String Source #

data PolicySummary Source #

Summary of policy evaluation

Constructors

PolicySummary
Fields psTotalSuccessfulSessionCount :: Int Successful sessions psTotalFailureSessionCount :: Int Failed sessions

Instances

Instances details

Eq PolicySummary Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods (==) :: PolicySummary -> PolicySummary -> Bool # (/=) :: PolicySummary -> PolicySummary -> Bool #
Read PolicySummary Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods readsPrec :: Int -> ReadS PolicySummary # readList :: ReadS [PolicySummary] # readPrec :: ReadPrec PolicySummary # readListPrec :: ReadPrec [PolicySummary] #
Show PolicySummary Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods showsPrec :: Int -> PolicySummary -> ShowS # show :: PolicySummary -> String # showList :: [PolicySummary] -> ShowS #
ToJSON PolicySummary Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods toJSON :: PolicySummary -> Value # toEncoding :: PolicySummary -> Encoding # toJSONList :: [PolicySummary] -> Value # toEncodingList :: [PolicySummary] -> Encoding #
FromJSON PolicySummary Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods parseJSON :: Value -> Parser PolicySummary # parseJSONList :: Value -> Parser [PolicySummary] #

data PolicyType Source #

Constructors

NoPolicyFound	neither MTA-STS nor DANE
TlsaPolicy	DANE policy (TLSA record)
StsPolicy	MTA-STS policy

Instances

Instances details

Eq PolicyType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods (==) :: PolicyType -> PolicyType -> Bool # (/=) :: PolicyType -> PolicyType -> Bool #
Read PolicyType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods readsPrec :: Int -> ReadS PolicyType # readList :: ReadS [PolicyType] # readPrec :: ReadPrec PolicyType # readListPrec :: ReadPrec [PolicyType] #
Show PolicyType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods showsPrec :: Int -> PolicyType -> ShowS # show :: PolicyType -> String # showList :: [PolicyType] -> ShowS #
ToJSON PolicyType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods toJSON :: PolicyType -> Value # toEncoding :: PolicyType -> Encoding # toJSONList :: [PolicyType] -> Value # toEncodingList :: [PolicyType] -> Encoding #
FromJSON PolicyType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods parseJSON :: Value -> Parser PolicyType # parseJSONList :: Value -> Parser [PolicyType] #

data ResultType Source #

Failure types

Constructors

StarttlsNotSupported	recipient MX did not support STARTTLS
CertificateHostMismatch	MX hostname does not match any of the subject alternative names in the certificate
CertificateExpired	certificate has expired
CertificateNotTrusted	certificate is not signed by any trusted CA
ValidationFailure	general negotiation failure (other)
TlsaInvalid	validation error in the TLSA record
DnssecInvalid	no valid records were returned from the recursive resolver
DaneRequired	sending system is configured to require DANE TLSA records for all the MX hosts of the destination domain, but no DNSSEC-validated TLSA records were present for the MX host
StsPolicyFetchError	failure to retrieve an MTA-STS policy (e.g. host unreachable)
StsPolicyInvalid	validation error for the overall MTA-STS policy
StsWebpkiInvalid	MTA-STS policy could not be authenticated using PKIX validation

Instances

Instances details

Eq ResultType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods (==) :: ResultType -> ResultType -> Bool # (/=) :: ResultType -> ResultType -> Bool #
Read ResultType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods readsPrec :: Int -> ReadS ResultType # readList :: ReadS [ResultType] # readPrec :: ReadPrec ResultType # readListPrec :: ReadPrec [ResultType] #
Show ResultType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods showsPrec :: Int -> ResultType -> ShowS # show :: ResultType -> String # showList :: [ResultType] -> ShowS #
ToJSON ResultType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods toJSON :: ResultType -> Value # toEncoding :: ResultType -> Encoding # toJSONList :: [ResultType] -> Value # toEncodingList :: [ResultType] -> Encoding #
FromJSON ResultType Source #
Instance details Defined in Data.Mail.TLSRPT.Reports Methods parseJSON :: Value -> Parser ResultType # parseJSONList :: Value -> Parser [ResultType] #