Data.Mail.TLSRPT.Reports

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

Parsers

tlsReportFromStrict :: ByteString -> Either String Report

Parse a TLSRPT report from a strict ByteString

tlsReportFromLazy :: ByteString -> Either String Report

Parse a TLSRPT report from a lazy ByteString

tlsReportFromStream :: (MonadFail m, MonadIO m) => ByteStream m r -> m (Either String Report)

Parse a TLSRPT report from a ByteStream

tlsReportFromJson :: Value -> Either String Report

Parse a TLSRPT report from a JSON Value

Data types

data Report

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

Eq Report

Defined in Data.Mail.TLSRPT.Reports

Methods

(==) :: Report -> Report -> Bool

(/=) :: Report -> Report -> Bool

Read Report

Defined in Data.Mail.TLSRPT.Reports

Methods

readsPrec :: Int -> ReadS Report

readList :: ReadS [Report]

readPrec :: ReadPrec Report

readListPrec :: ReadPrec [Report]

Show Report

Defined in Data.Mail.TLSRPT.Reports

Methods

showsPrec :: Int -> Report -> ShowS

show :: Report -> String

showList :: [Report] -> ShowS

ToJSON Report

Defined in Data.Mail.TLSRPT.Reports

Methods

toJSON :: Report -> Value

toEncoding :: Report -> Encoding

toJSONList :: [Report] -> Value

toEncodingList :: [Report] -> Encoding

FromJSON Report

Defined in Data.Mail.TLSRPT.Reports

Methods

parseJSON :: Value -> Parser Report

parseJSONList :: Value -> Parser [Report]

data Policy

Constructors

Policy

Fields

• pcPolicy :: PolicyDesc

  description of the evaluated policy

• pcSummary :: PolicySummary

  failure/success summary

• pcFailureDetails :: [FailureDetails]

  details about failure types

Instances

Eq Policy

Defined in Data.Mail.TLSRPT.Reports

Methods

(==) :: Policy -> Policy -> Bool

(/=) :: Policy -> Policy -> Bool

Read Policy

Defined in Data.Mail.TLSRPT.Reports

Methods

readsPrec :: Int -> ReadS Policy

readList :: ReadS [Policy]

readPrec :: ReadPrec Policy

readListPrec :: ReadPrec [Policy]

Show Policy

Defined in Data.Mail.TLSRPT.Reports

Methods

showsPrec :: Int -> Policy -> ShowS

show :: Policy -> String

showList :: [Policy] -> ShowS

ToJSON Policy

Defined in Data.Mail.TLSRPT.Reports

Methods

toJSON :: Policy -> Value

toEncoding :: Policy -> Encoding

toJSONList :: [Policy] -> Value

toEncodingList :: [Policy] -> Encoding

FromJSON Policy

Defined in Data.Mail.TLSRPT.Reports

Methods

parseJSON :: Value -> Parser Policy

parseJSONList :: Value -> Parser [Policy]

data PolicyDesc

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

Eq PolicyDesc

Defined in Data.Mail.TLSRPT.Reports

Methods

(==) :: PolicyDesc -> PolicyDesc -> Bool

(/=) :: PolicyDesc -> PolicyDesc -> Bool

Read PolicyDesc

Defined in Data.Mail.TLSRPT.Reports

Methods

readsPrec :: Int -> ReadS PolicyDesc

readList :: ReadS [PolicyDesc]

readPrec :: ReadPrec PolicyDesc

readListPrec :: ReadPrec [PolicyDesc]

Show PolicyDesc

Defined in Data.Mail.TLSRPT.Reports

Methods

showsPrec :: Int -> PolicyDesc -> ShowS

show :: PolicyDesc -> String

showList :: [PolicyDesc] -> ShowS

ToJSON PolicyDesc

Defined in Data.Mail.TLSRPT.Reports

Methods

toJSON :: PolicyDesc -> Value

toEncoding :: PolicyDesc -> Encoding

toJSONList :: [PolicyDesc] -> Value

toEncodingList :: [PolicyDesc] -> Encoding

FromJSON PolicyDesc

Defined in Data.Mail.TLSRPT.Reports

Methods

parseJSON :: Value -> Parser PolicyDesc

parseJSONList :: Value -> Parser [PolicyDesc]

data FailureDetails

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

Eq FailureDetails

Defined in Data.Mail.TLSRPT.Reports

Methods

(==) :: FailureDetails -> FailureDetails -> Bool

(/=) :: FailureDetails -> FailureDetails -> Bool

Read FailureDetails

Defined in Data.Mail.TLSRPT.Reports

Methods

readsPrec :: Int -> ReadS FailureDetails

readList :: ReadS [FailureDetails]

readPrec :: ReadPrec FailureDetails

readListPrec :: ReadPrec [FailureDetails]

Show FailureDetails

Defined in Data.Mail.TLSRPT.Reports

Methods

showsPrec :: Int -> FailureDetails -> ShowS

show :: FailureDetails -> String

showList :: [FailureDetails] -> ShowS

ToJSON FailureDetails

Defined in Data.Mail.TLSRPT.Reports

Methods

toJSON :: FailureDetails -> Value

toEncoding :: FailureDetails -> Encoding

toJSONList :: [FailureDetails] -> Value

toEncodingList :: [FailureDetails] -> Encoding

FromJSON FailureDetails

Defined in Data.Mail.TLSRPT.Reports

Methods

parseJSON :: Value -> Parser FailureDetails

parseJSONList :: Value -> Parser [FailureDetails]

type IpAddress = String

data PolicySummary

Summary of policy evaluation

Constructors

PolicySummary

Fields

• psTotalSuccessfulSessionCount :: Int

  Successful sessions

• psTotalFailureSessionCount :: Int

  Failed sessions

Instances

Eq PolicySummary

Defined in Data.Mail.TLSRPT.Reports

Methods

(==) :: PolicySummary -> PolicySummary -> Bool

(/=) :: PolicySummary -> PolicySummary -> Bool

Read PolicySummary

Defined in Data.Mail.TLSRPT.Reports

Methods

readsPrec :: Int -> ReadS PolicySummary

readList :: ReadS [PolicySummary]

readPrec :: ReadPrec PolicySummary

readListPrec :: ReadPrec [PolicySummary]

Show PolicySummary

Defined in Data.Mail.TLSRPT.Reports

Methods

showsPrec :: Int -> PolicySummary -> ShowS

show :: PolicySummary -> String

showList :: [PolicySummary] -> ShowS

ToJSON PolicySummary

Defined in Data.Mail.TLSRPT.Reports

Methods

toJSON :: PolicySummary -> Value

toEncoding :: PolicySummary -> Encoding

toJSONList :: [PolicySummary] -> Value

toEncodingList :: [PolicySummary] -> Encoding

FromJSON PolicySummary

Defined in Data.Mail.TLSRPT.Reports

Methods

parseJSON :: Value -> Parser PolicySummary

parseJSONList :: Value -> Parser [PolicySummary]

data PolicyType

Constructors

NoPolicyFound

neither MTA-STS nor DANE

TlsaPolicy

DANE policy (TLSA record)

StsPolicy

MTA-STS policy

Instances

Eq PolicyType

Defined in Data.Mail.TLSRPT.Reports

Methods

(==) :: PolicyType -> PolicyType -> Bool

(/=) :: PolicyType -> PolicyType -> Bool

Read PolicyType

Defined in Data.Mail.TLSRPT.Reports

Methods

readsPrec :: Int -> ReadS PolicyType

readList :: ReadS [PolicyType]

readPrec :: ReadPrec PolicyType

readListPrec :: ReadPrec [PolicyType]

Show PolicyType

Defined in Data.Mail.TLSRPT.Reports

Methods

showsPrec :: Int -> PolicyType -> ShowS

show :: PolicyType -> String

showList :: [PolicyType] -> ShowS

ToJSON PolicyType

Defined in Data.Mail.TLSRPT.Reports

Methods

toJSON :: PolicyType -> Value

toEncoding :: PolicyType -> Encoding

toJSONList :: [PolicyType] -> Value

toEncodingList :: [PolicyType] -> Encoding

FromJSON PolicyType

Defined in Data.Mail.TLSRPT.Reports

Methods

parseJSON :: Value -> Parser PolicyType

parseJSONList :: Value -> Parser [PolicyType]

data ResultType

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

Eq ResultType

Defined in Data.Mail.TLSRPT.Reports

Methods

(==) :: ResultType -> ResultType -> Bool

(/=) :: ResultType -> ResultType -> Bool

Read ResultType

Defined in Data.Mail.TLSRPT.Reports

Methods

readsPrec :: Int -> ReadS ResultType

readList :: ReadS [ResultType]

readPrec :: ReadPrec ResultType

readListPrec :: ReadPrec [ResultType]

Show ResultType

Defined in Data.Mail.TLSRPT.Reports

Methods

showsPrec :: Int -> ResultType -> ShowS

show :: ResultType -> String

showList :: [ResultType] -> ShowS

ToJSON ResultType

Defined in Data.Mail.TLSRPT.Reports

Methods

toJSON :: ResultType -> Value

toEncoding :: ResultType -> Encoding

toJSONList :: [ResultType] -> Value

toEncodingList :: [ResultType] -> Encoding

FromJSON ResultType

Defined in Data.Mail.TLSRPT.Reports

Methods

parseJSON :: Value -> Parser ResultType

parseJSONList :: Value -> Parser [ResultType]