Internet-Draft | DMARC Aggregate Reporting | December 2024 |
Brotman (ed) | Expires 19 June 2025 | [Page] |
Domain-based Message Authentication, Reporting, and Conformance (DMARC) allows for Domain Owners to request aggregate reports from receivers. This report is an XML document, and contains extensible elements that allow for other types of data to be specified later. The aggregate reports can be submitted to the Domain Owner's specified destination as supported by the receiver.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 19 June 2025.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
A key component of DMARC [I-D.ietf-dmarc-dmarcbis] is the ability for Domain Owners to
request that receivers provide various types of reports. These reports allow
Domain Owners to have insight into which IP addresses are sending on their
behalf, and some insight into whether or not the volume may be legitimate.
These reports expose information relating to the DMARC policy, as well as
the outcome of SPF [RFC7208] & DKIM [RFC6376] validation.¶
There are a number of terms defined in [I-D.ietf-dmarc-dmarcbis] that are used within this document. Understanding those definitions will aid in reading this document.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
Providing Domain Owners with visibility into how Mail Receivers implement and enforce the DMARC mechanism in the form of feedback is critical to establishing and maintaining accurate authentication deployments. When Domain Owners can see what effect their policies and practices are having, they are better willing and able to use quarantine and reject policies.¶
The DMARC aggregate feedback report is designed to provide Domain Owners with precise insight into:¶
Aggregate DMARC feedback provides visibility into real-world email streams that Domain Owners need in order to make informed decisions regarding the publication of a DMARC policy. When Domain Owners know what legitimate mail they are sending, what the authentication results are on that mail, and what forged mail receivers are getting, they can make better decisions about the policies they need and the steps they need to take to enable those policies. When Domain Owners set policies appropriately and understand their effects, Mail Receivers can act on them confidently.¶
Visibility comes in the form of daily (or more frequent) Mail Receiver-originated feedback reports that contain aggregate data on message streams relevant to the Domain Owner. This information includes data about messages that passed DMARC authentication as well as those that did not.¶
A separate report MUST be generated for each Policy Domain encountered during the reporting period. See below for further explanation in "Handling Domains in Reports".¶
The report may include the following data:¶
The format for these reports is defined in Appendix A, as well as the possible values for some of the elements below. Most of these values have a definition tied to [I-D.ietf-dmarc-dmarcbis].¶
DMARC Aggregate Reports MUST contain two primary sections ("metadata" & "data" below) ; one consisting of descriptive information (with two elements), and the other a set of IP address-focused row-based data. Each report MUST contain data for only one Policy Domain. A single report MUST contain data for one policy configuration. If multiple configurations were observed during a single reporting period, a reporting entity MAY choose to send multiple reports, otherwise the reporting entity SHOULD note only the final configuration observed during the period. See below for further information.¶
The informative section MUST contain two elements. One will be the metadata section which MUST contain the fields related to "org_name", "email", "report_id", and "date_range". Optional fields MAY include "extra_contact_info", an "error" field. The "date_range" field will contain "begin" and "end" fields as epoch timestamps. The other element will be the "policy_published", which will record the policy configuration observed by the receiving system. Mandatory fields are "domain", "p", "sp". Optional fields are "fo", "adkim", "aspf", "testing", and "discovery_method". There is be an optional third section, "extension".¶
Within the data section, the report will contain record(s) stating which IP addresses were seen to have delivered messages for the Author Domain to the receiving system. For each IP address that is being reported, there will be at least one "record" element. Each "record" element will have one "row", one "identifiers", and one "auth_results" sub-element. Within the "row" element, there MUST be "source_ip" and "count". There MUST also exist a "policy_evaluated", with sub-elements of "disposition", "dkim", and "spf". There MAY be an element for "reason", meant to include any notes the reporter might want to include as to why the "disposition" policy does not match the "policy_published", such as a Local Policy override (See Section 2.1.5, Policy Override Reason). The "dkim" and "spf" elements MUST be the evaluated values as they relate to DMARC, not the values the receiver may have used when overriding the policy. Within the "identifiers" element, there MUST exist the data that was used to apply policy for the given IP address. There MUST be a "header_from" element, which will contain the RFC5322.From domain from the message. There MAY be an optional "envelope_from" element, which contains the RFC5321.MailFrom domain that the SPF check has been applied to. This element MAY be existing but empty if the message had a null reverse-path ([RFC5321], Section 4.5.5). There MAY be an optional "envelope_to" element, which contains the RFC5321.RcptTo (see [RFC5598]) domain from the message.¶
There MUST be an "auth_results" element within the "record" element. This will
contain the data related to authenticating the messages associated with this sending
IP address. There MAY be a number of optional "dkim" sub-elements, one for
each checked DKIM signature. There MAY be an optional "spf" sub-element.
These elements MUST have a "domain" that was used during validation, as well as
"result". If validation is attempted for any DKIM signature, the results MUST
be included in the report (within reason, see "DKIM Signatures in Aggregate
Reports" below for handling numerous signatures). The "dkim" element MUST
include a "selector" element that was observed during validation. For the
"spf" element, the "result" element MUST contain a lower-case string where
the value is one of the results defined in [RFC8601] Section 2.7.2. The
"dkim" result MUST contain a lower-case string where the value is one of
the results defined in [RFC8601] Section 2.7.1. Both the "spf" and "dkim"
results may optionally include a "human_result" element meant for the report
to convey more descriptive information back to the Domain Owner relating to
evaluation failures. There is an optional section for extensions.¶
In the same report, there MUST be a single Policy Domain, though there could be
multiple RFC5322.From Domains. Each RFC5322.From domain will create its own "record"
within the report. Consider the case where there are three domains with traffic
volume to report: example.com, foo.example.com, and bar.example.com. There will be
explicit DMARC Policy Records for example.com and bar.example.com, with distinct policies. There
is no explicit DMARC Policy Record for foo.example.com, so it will be reliant on the
policy described for example.com. For a report period, there would now be two reports.
The first will be for bar.example.com, and contain only one "record", for
bar.example.com. The second report would be for example.com and contain multiple
"record" elements, one for example.com and one for foo.example.com (and extensibly,
other "record" elements for subdomains which likewise did not have an explicit
DMARC Policy Record).¶
Within a single message, the possibility exists that there could be multiple DKIM signatures. When validation of the message occurs, some signatures may pass, while some may not. As these pertain to DMARC, and especially to aggregate reporting, reporters may not find it clear which DKIM signatures they should include in a report. Signatures, regardless of outcome, could help the report ingester determine the source of a message. However, there is a preference as to which signatures are included.¶
A report SHOULD contain no more than 100 signatures for a given "row", in decreasing priority.¶
There are a few places where a unique identifier is specified as part of the body of the report, the subject, and so on. These unique identifiers should be consistent per each report. Specified below, the reader will see a "Report-ID" and "unique-id". These are the fields that MUST be identical when used.¶
A few examples of information contained within the error field(s):¶
Be mindful that the error field is an unbounded string, but should not contain an extremely large body. Provide enough information to assist the domain owner with understanding some issues with their authentication or DMARC declaration.¶
The reason element, indicating an override of the DMARC policy, consists of a mandatory type field and an optional comment field. The type field MUST have one of the pre-defined values listed below. The comment field is an unbounded string for providing further details.¶
Possible values for the policy override type:¶
"local_policy": The Mail Receiver's local policy exempted the message from being subjected to the Domain Owner's requested policy action.¶
"mailing_list": Local heuristics determined that the message arrived via a mailing list, and thus authentication of the original message was not expected to succeed.¶
"other": Some policy exception not covered by the other entries in this list occurred. Additional detail can be found in the PolicyOverrideReason's "comment" field.¶
"policy_test_mode": The message was exempted from application of policy by the testing mode ("t" tag) in the DMARC Policy Record.¶
"trusted_forwarder": Message authentication failure was anticipated by other evidence linking the message to a locally maintained list of known and trusted forwarders.¶
The document format supports optional elements for extensions. The absence or existence of this section SHOULD NOT create an error when processing reports. This will be covered in a separate section.¶
Note that Domain Owners or their agents may change the published DMARC Policy Record for a domain or subdomain at any time. From a Mail Receiver's perspective, this will occur during a reporting period and may be noticed during that period, at the end of that period when reports are generated, or during a subsequent reporting period, all depending on the Mail Receiver's implementation. Under these conditions, it is possible that a Mail Receiver could do any of the following:¶
Such policy changes are expected to be infrequent for any given domain, whereas more stringent policy monitoring requirements on the Mail Receiver would produce a very large burden at Internet scale. Therefore, it is the responsibility of Report Consumers (i.e., vendors) and Domain Owners to be aware of this situation and expect such mixed reports during the propagation of the new policy to Mail Receivers.¶
A Mail Receiver discovers reporting requests when it looks up a DMARC Policy Record that corresponds to an RFC5322.From domain on received mail. The presence of the "rua" tag specifies where to send feedback.¶
The Mail Receiver, after preparing a report, MUST evaluate the provided reporting URIs (See [I-D.ietf-dmarc-dmarcbis]) in the order given. Any reporting URI that includes a size limitation exceeded by the generated report (after compression and after any encoding required by the particular transport mechanism) MUST NOT be used. An attempt MUST be made to deliver an aggregate report to every remaining URI, up to the Receiver's limits on supported URIs.¶
If transport is not possible because the services advertised by the published URIs are not able to accept reports (e.g., the URI refers to a service that is unreachable, or all provided URIs specify size limits exceeded by the generated record), the Mail Receiver MAY send a short report indicating that a report is available but could not be sent. The Mail Receiver MAY cache that data and try again later, or MAY discard data that could not be sent.¶
Where the URI specified in a "rua" tag does not specify otherwise, a Mail Receiver generating a feedback report SHOULD employ a secure transport mechanism.¶
This identifier MUST be unique among reports to the same domain to aid receivers in identifying duplicate reports should they happen.¶
ridfmt = (dot-atom-text ["@" dot-atom-text]) ; from RFC5322 ridtxt = ("<" ridfmt ">") / ridfmt¶
The format specified here is not very strict as the key goal is uniqueness.¶
The message generated by the Mail Receiver MUST be a [RFC5322] message formatted per [RFC2045]. The aggregate report itself MUST be included in one of the parts of the message, as an attachment with a corresponding media type from below. A human-readable annotation MAY be included as a body part (with a human-friendly content-type, such as "text/plain" or "text/html").¶
The aggregate data MUST be an XML file that SHOULD be subjected to GZIP [RFC1952] compression. Declining to apply compression can cause the report to be too large for a receiver to process (the total message size could exceed the receiver SMTP size limit); doing the compression increases the chances of acceptance of the report at some compute cost. The aggregate data MUST be present using the media type "application/gzip" if compressed (see [RFC6713]), and "text/xml" otherwise. The attachment filename MUST be constructed using the following ABNF:¶
filename = receiver "!" policy-domain "!" begin-timestamp "!" end-timestamp [ "!" unique-id ] "." extension receiver = domain ; imported from [@!RFC5322] policy-domain = domain begin-timestamp = 1*DIGIT ; seconds since 00:00:00 UTC January 1, 1970 ; indicating start of the time range contained ; in the report end-timestamp = 1*DIGIT ; seconds since 00:00:00 UTC January 1, 1970 ; indicating end of the time range contained ; in the report unique-id = 1*(ALPHA / DIGIT) extension = "xml" / "xml.gz"¶
The extension MUST be "xml" for a plain XML file, or "xml.gz" for an XML file compressed using GZIP.¶
"unique-id" allows an optional unique ID generated by the Mail Receiver to distinguish among multiple reports generated simultaneously by different sources within the same Domain Owner. A viable option may be to explore UUIDs [RFC9562].¶
If a report generator needs to re-send a report, the system MUST use the same filename as the original report. This would allow the receiver to overwrite the data from the original, or discard second instance of the report.¶
For example, this is a sample filename for the gzip file of a report to the Domain Owner "example.com" from the Mail Receiver "mail.receiver.example":¶
mail.receiver.example!example.com!1013662812!1013749130.xml.gz¶
No specific MIME message structure is required. It is presumed that the aggregate reporting address will be equipped to extract body parts with the prescribed media type and filename and ignore the rest.¶
Email streams carrying DMARC feedback data MUST conform to the DMARC mechanism, thereby resulting in an aligned "pass" (see Section 3.1). This practice minimizes the risk of Report Consumers processing fraudulent reports.¶
The RFC5322.Subject field for individual report submissions MUST conform to the following ABNF:¶
dmarc-subject = %s"Report" 1*FWS %s"Domain:" 1*FWS domain-name 1*FWS ; policy domain %s"Submitter:" 1*FWS domain-name 1*FWS ; report generator [ %s"Report-ID:" 1*FWS ridtxt ] ; defined below¶
The first domain-name indicates the DNS domain name about which the report was generated. The second domain-name indicates the DNS domain name representing the Mail Receiver generating the report. The purpose of the Report-ID: portion of the field is to enable the Domain Owner to identify and ignore duplicate reports that might be sent by a Mail Receiver.¶
For instance, this is a possible Subject field for a report to the Domain Owner "example.com" from the Mail Receiver "mail.receiver.example". It is folded as allowed by [RFC5322]:¶
Subject: Report Domain: example.com Submitter: mail.receiver.example Report-ID: <sample-ridtxt@example.com>¶
This transport mechanism potentially encounters a problem when feedback data size exceeds maximum allowable attachment sizes for either the generator or the consumer.¶
Optionally, the report sender MAY choose to use the same "ridtxt" as a part or whole of the RFC5322.Message-Id header included with the report. Doing so may help receivers distinguish when a message is a re-transmission or duplicate report.¶
The specification as written allows for the addition of other registered URI schemes to be supported in later versions.¶
There may be a situation where the report generator attempts to deliver duplicate information to the receiver. This may manifest as an exact duplicate of the report, or as duplicate information between two reports. In these situations, the decision of how to handle the duplicate data lies with the receiver. As noted above, the sender MUST use the same unique identifiers when sending the report. This allows the receiver to better understand when duplicates happen. A few options on how to handle that duplicate information:¶
When accepting the data, that's likely in a situation where it's not yet noticed, or a one-off experience. Long term, duplicate data is not ideal. In the situation of a partial time frame overlap, there is no clear way to distinguish the impact of the overlap. The receiver would need to accept or reject the duplicate data in whole.¶
It is possible to specify destinations for the different reports that are outside the authority of the Domain Owner making the request. This allows domains that do not operate mail servers to request reports and have them go someplace that is able to receive and process them.¶
Without checks, this would allow a bad actor to publish a DMARC Policy Record that requests that reports be sent to a victim address, and then send a large volume of mail that will fail both DKIM and SPF checks to a wide variety of destinations; the victim will in turn be flooded with unwanted reports. Therefore, a verification mechanism is included.¶
When a Mail Receiver discovers a DMARC Policy Record in the DNS, and the Organizational Domain at which that record was discovered is not identical to the Organizational Domain of the host part of the authority component of a [RFC3986] specified in the "rua" tag, the following verification steps MUST be taken:¶
Extract the host portion of the authority component of the URI. Call this the "destination host", as it refers to a Report Receiver.¶
Prepend the string "_report._dmarc".¶
Prepend the domain name from which the policy was retrieved, after conversion to an A-label [RFC5890] if needed.¶
If the length of the constructed name exceed DNS limits, a positive determination of the external reporting relationship cannot be made; stop.¶
Query the DNS for a TXT record at the constructed name. If the result of this request is a temporary DNS error of some kind (e.g., a timeout), the Mail Receiver MAY elect to temporarily fail the delivery so the verification test can be repeated later.¶
For each record returned, parse the result as a series of "tag=value" pairs, i.e., the same overall format as the policy record (see Section 5.4 in [I-D.ietf-dmarc-dmarcbis]). In particular, the "v=DMARC1" tag is mandatory and MUST appear first in the list. Discard any that do not pass this test. A trailing ";" is optional.¶
If the result includes no TXT resource records that pass basic parsing, a positive determination of the external reporting relationship cannot be made; stop.¶
If at least one TXT resource record remains in the set after parsing, then the external reporting arrangement was authorized by the Report Consumer.¶
If a "rua" tag is thus discovered, replace the corresponding value extracted from the domain's DMARC Policy Record with the one found in this record. This permits the Report Consumer to override the report destination. However, to prevent loops or indirect abuse, the overriding URI MUST use the same destination host from the first step.¶
For example, if the DMARC Policy Record for "blue.example.com" contained
"rua=mailto:reports@red.example.net"
, the Organizational Domain host
extracted from the latter ("red.example.net") does not match
"blue.example.com", so this procedure is enacted. A TXT query for
"blue.example.com._report._dmarc.red.example.net" is issued. If a
single reply comes back containing a tag of "v=DMARC1", then the
relationship between the two is confirmed. Moreover,
"red.example.net" has the opportunity to override the report
destination requested by "blue.example.com" if needed.¶
Where the above algorithm fails to confirm that the external reporting was authorized by the Report Consumer, the URI MUST be ignored by the Mail Receiver generating the report. Further, if the confirming record includes a URI whose host is again different than the domain publishing that override, the Mail Receiver generating the report MUST NOT generate a report to either the original or the override URI. A Report Consumer publishes such a record in its DNS if it wishes to receive reports for other domains.¶
A Report Consumer that is willing to receive reports for any domain can use a wildcard DNS record. For example, a TXT resource record at "*._report._dmarc.example.com" containing at least "v=DMARC1" confirms that example.com is willing to receive DMARC reports for any domain.¶
If the Report Consumer is overcome by volume, it can simply remove the confirming DNS record. However, due to positive caching, the change could take as long as the time-to-live (TTL) on the record to go into effect.¶
DMARC reports allow for some extensibility, as defined by future documents that utilize DMARC as a foundation. These extensions MUST be properly formatted XML and meant to exist within the structure of a DMARC report. Two positions of type "<any>" are provided in the existing DMARC structure, one at file level, in an "<extension>" element after "<policy_published>" and one at record level, after "<auth_results>". In either case, the extensions MUST contain a URI to the definition of the extension so that the receiver understands how to interpret the data.¶
At file level:¶
<feedback xmlns="urn:ietf:params:xml:ns:dmarc-2.0" xmlns:ext="URI for an extension-supplied name space"> ... <policy_published> <domain>example.com</domain> <p>quarantine</p> <sp>none</sp> <testing>n</testing> </policy_published> <extension> <ext:arc-override>never</ext:arc-override> </extension>¶
Within the "record" element:¶
<record> <row> ... </row> <identifiers> ... </identifiers> <auth_results> ... </auth_results> <ext:arc-results> ... </ext:arc-results> </record> <record> ...¶
Here "arc-override" and "arc-results" are hypothetical element names defined in the extension's name space.¶
Extension elements are optional. Any number of extensions is allowed. If a processor is unable to handle an extension in a report, it SHOULD ignore the data and continue to the next extension.¶
This document uses URNs to describe XML namespaces and XML schemas conforming to a registry mechanism described in [RFC3688]. Two URI assignments will be registered by the IANA.¶
URI: urn:ietf:params:xml:ns:dmarc-2.0¶
Registrant Contact: See the "Author's Address" section of this document.¶
XML: None. Namespace URIs do not represent an XML specification.¶
URI: urn:ietf:params:xml:schema:dmarc-2.0¶
Registrant Contact: See the "Author's Address" section of this document.¶
XML: See Appendix A. DMARC XML Schema in this document.¶
This section will discuss exposure related to DMARC aggregate reporting.¶
A DMARC Policy Record can specify that reports should be sent to an intermediary operating on behalf of the Domain Owner. This is done when the Domain Owner contracts with an entity to monitor mail streams for abuse and performance issues. Receipt by third parties of such data may or may not be permitted by the Mail Receiver's privacy policy, terms of use, or other similar governing document. Domain Owners and Mail Receivers should both review and understand if their own internal policies constrain the use and transmission of DMARC reporting.¶
Some potential exists for report recipients to perform traffic analysis, making it possible to obtain metadata about the Receiver's traffic. In addition to verifying compliance with policies, Receivers need to consider that before sending reports to a third party.¶
Aggregate feedback reports contain aggregated data relating to messages purportedly originating from the Domain Owner. The data does not contain any identifying characteristics about individual users. No personal information such as individual email addresses, IP addresses of individuals, or the content of any messages, is included in reports.¶
Mail Receivers should have no concerns in sending reports as they do not contain personal information. In all cases, the data within the reports relates to the domain-level authentication information provided by mail servers sending messages on behalf of the Domain Owner. This information is necessary to assist Domain Owners in implementing and maintaining DMARC.¶
Domain Owners should have no concerns in receiving reports as they do not contain personal information. The reports only contain aggregated data related to the domain-level authentication details of messages claiming to originate from their domain. This information is essential for the proper implementation and operation of DMARC. Domain Owners who are unable to receive reports for organizational reasons, can choose to exclusively direct the reports to an external processor.¶
Providing feedback reporting to PSOs for a PSD [I-D.ietf-dmarc-dmarcbis] can, in some cases, cause information to leak out of an organization to the PSO. This leakage could potentially be utilized as part of a program of pervasive surveillance (see [RFC7624]]). There are roughly three cases to consider:¶
Single Organization PSDs (e.g., ".mil")¶
Aggregate reports based on PSD DMARC have the potential to contain information about emails related to entities managed by the organization. Since both the PSO and the Organizational Domain Owners are common, there is no additional privacy risk for either normal or non-existent domain reporting due to PSD DMARC.¶
Multi-organization PSDs requiring DMARC usage (e.g., ".bank")¶
Aggregate reports based on PSD DMARC will only be generated for domains that do not publish a DMARC Policy Record at the Organizational Domain or host level. For domains that do publish the required DMARC Policy Records, the feedback reporting addresses of the Organizational Domain (or hosts) will be used. The only direct risk of feedback leakage for these PSDs are for Organizational Domains that are out of compliance with PSD policy. Data on non-existent domains would be sent to the PSO.¶
Multi-organization PSDs not requiring DMARC usage (e.g., ".com")¶
Privacy risks for Organizational Domains that have not deployed DMARC within such PSDs can be significant. For non-DMARC Organizational Domains, all DMARC feedback will be directed to the PSO if that PSO itself has a DMARC Policy Record that specifies a "rua" tag. Any non-DMARC Organizational Domain would have its Feedback Reports redirected to the PSO. The content of such reports, particularly for existing domains, is privacy sensitive.¶
PSOs will receive feedback on non-existent domains, which may be similar to existing Organizational Domains. Feedback related to such domains have a small risk of carrying information related to an actual Organizational Domain. To minimize this potential concern, PSD DMARC feedback MUST be limited to Aggregate Reports. Failure Reports carry more detailed information and present a greater risk.¶
While reviewing this document and its Security Considerations, it is ideal that the reader would also review Privacy Considerations above, as well as the Security Considerations and Privacy Considerations in the I-D.ietf-dmarc-dmarcbis.¶
Aggregate reports are supposed to be processed automatically. An attacker might attempt to compromise the integrity or availability of the report processor by sending malformed reports. In particular, the archive decompressor and XML parser are at risk to resource exhaustion attacks (zip bomb or XML bomb).¶
The data contained within aggregate reports may be forged. An attacker might attempt to interfere with or influence policy decisions by submitting false reports in large volume. The attacker could also be attempting to influence platform architecture decisions. A volume-based attack may also impact the ability for a report receiver to accept reports from other entities.¶
While not specified in this document itself, the availability of extensions could enable the report generator to disclose information about message placement (Inbox/Spam/etc). This is very much discouraged as it could relay this information to a malicious party, allowing them to understand more about filtering methodologies at a receiving entity.¶
<?xml version="1.0"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="urn:ietf:params:xml:ns:dmarc-2.0" xmlns="urn:ietf:params:xml:ns:dmarc-2.0" elementFormDefault="qualified"> <!-- The time range in UTC covered by messages in this report, specified in seconds since epoch. --> <xs:complexType name="DateRangeType"> <xs:all> <xs:element name="begin" type="xs:integer" minOccurs="1" maxOccurs="1"/> <xs:element name="end" type="xs:integer" minOccurs="1" maxOccurs="1"/> </xs:all> </xs:complexType> <!-- Report generator metadata. --> <xs:complexType name="ReportMetadataType"> <xs:all> <!-- Reporting Organization --> <xs:element name="org_name" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- Contact to use when contacting the Reporting Organization --> <xs:element name="email" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- Additional contact details --> <xs:element name="extra_contact_info" type="xs:string" minOccurs="0" maxOccurs="1"/> <!-- Unique Report-ID --> <xs:element name="report_id" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- Timestamps used when forming report data --> <xs:element name="date_range" type="DateRangeType" minOccurs="1" maxOccurs="1"/> <!-- Optional error messages when processing DMARC policy --> <xs:element name="error" type="xs:string" minOccurs="0" maxOccurs="1"/> <!-- Optional information about the generating software --> <xs:element name="generator" type="xs:string" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> <!-- Alignment mode (relaxed or strict) for DKIM and SPF. --> <xs:simpleType name="AlignmentType"> <xs:restriction base="xs:string"> <xs:enumeration value="r"/> <xs:enumeration value="s"/> </xs:restriction> </xs:simpleType> <!-- The policy actions specified by p, sp and np in the DMARC Policy Record. --> <xs:simpleType name="DispositionType"> <xs:restriction base="xs:string"> <xs:enumeration value="none"/> <xs:enumeration value="quarantine"/> <xs:enumeration value="reject"/> </xs:restriction> </xs:simpleType> <!-- The policy actions utilized on messages for this record. --> <!-- "none": No action taken "pass": No action, passing DMARC w/enforcing policy "quarantine": Failed DMARC, message marked for quarantine "reject": Failed DMARC, marked as reject --> <xs:simpleType name="ActionDispositionType"> <xs:restriction base="xs:string"> <xs:enumeration value="none"/> <xs:enumeration value="pass"/> <xs:enumeration value="quarantine"/> <xs:enumeration value="reject"/> </xs:restriction> </xs:simpleType> <!-- The methods used to discovery the policy used during evaluation. The available values are "psl" and "treewalk", where "psl" is the method from [@?RFC7489] and the "treewalk" is described in [@?RefNeeded]. --> <xs:simpleType name="DiscoveryType"> <xs:restriction base="xs:string"> <xs:enumeration value="psl"/> <xs:enumeration value="treewalk"/> </xs:restriction> </xs:simpleType> <!-- The published DMARC policy. Unspecified tags have their default values. --> <xs:complexType name="PolicyPublishedType"> <xs:all> <!-- The domain at which the DMARC record was found. --> <xs:element name="domain" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- The policy published for messages from: --> <!-- * the domain. --> <xs:element name="p" type="DispositionType" minOccurs="1" maxOccurs="1"/> <!-- * subdomains. --> <xs:element name="sp" type="DispositionType" minOccurs="1" maxOccurs="1"/> <!-- * non-existent subdomains. --> <xs:element name="np" type="DispositionType" minOccurs="0" maxOccurs="1"/> <!-- The DKIM alignment mode. --> <xs:element name="adkim" type="AlignmentType" minOccurs="0" maxOccurs="1"/> <!-- The SPF alignment mode. --> <xs:element name="aspf" type="AlignmentType" minOccurs="0" maxOccurs="1"/> <!-- Method used to find/obtain DMARC policy --> <xs:element name="discovery_method" type="DiscoveryType" minOccurs="0" maxOccurs="1"/> <!-- Failure reporting options in effect. --> <xs:element name="fo" type="xs:string" minOccurs="0" maxOccurs="1"/> <!-- Whether testing mode was declared in the DMARC Record --> <xs:element name="testing" type="TestingType" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> <!-- Values for Testing mode attached to Policy --> <xs:simpleType name="TestingType"> <xs:restriction base="xs:string"> <xs:enumeration value="n"/> <xs:enumeration value="y"/> </xs:restriction> </xs:simpleType> <!-- The DMARC-aligned authentication result. --> <xs:simpleType name="DMARCResultType"> <xs:restriction base="xs:string"> <xs:enumeration value="pass"/> <xs:enumeration value="fail"/> </xs:restriction> </xs:simpleType> <!-- Reasons that may affect DMARC disposition or execution. --> <xs:simpleType name="PolicyOverrideType"> <xs:restriction base="xs:string"> <xs:enumeration value="local_policy"/> <xs:enumeration value="mailing_list"/> <xs:enumeration value="other"/> <xs:enumeration value="policy_test_mode"/> <xs:enumeration value="trusted_forwarder"/> </xs:restriction> </xs:simpleType> <!-- Override reason consists of pre-defined override type and free-text comment. --> <xs:complexType name="PolicyOverrideReason"> <xs:all> <xs:element name="type" type="PolicyOverrideType" minOccurs="1" maxOccurs="1"/> <xs:element name="comment" type="xs:string" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> <!-- Taking into account everything else in the record, the results of applying DMARC. If alignment fails and the policy applied does not match the domain's configured policy, the reason element MUST be specified --> <xs:complexType name="PolicyEvaluatedType"> <xs:sequence> <xs:element name="disposition" type="ActionDispositionType"/> <xs:element name="dkim" type="DMARCResultType"/> <xs:element name="spf" type="DMARCResultType"/> <xs:element name="reason" type="PolicyOverrideReason" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:complexType name="RowType"> <xs:sequence> <!-- The connecting IP. IPv4address or IPv6address as defined in RFC 3986 section 3.2.2 --> <xs:element name="source_ip" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- The number of messages for which the PolicyEvaluatedType was applied. --> <xs:element name="count" type="xs:integer" minOccurs="1" maxOccurs="1"/> <!-- The DMARC disposition applied to matching messages. --> <xs:element name="policy_evaluated" type="PolicyEvaluatedType" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:complexType> <xs:complexType name="IdentifierType"> <xs:all> <!-- The RFC5322.From domain. --> <xs:element name="header_from" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- The RFC5321.MailFrom domain --> <xs:element name="envelope_from" type="xs:string" minOccurs="0" maxOccurs="1"/> <!-- The envelope recipient domain. --> <xs:element name="envelope_to" type="xs:string" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> <!-- DKIM verification result, see RFC 8601 Section 2.7.1. --> <xs:simpleType name="DKIMResultType"> <xs:restriction base="xs:string"> <xs:enumeration value="none"/> <xs:enumeration value="pass"/> <xs:enumeration value="fail"/> <xs:enumeration value="policy"/> <xs:enumeration value="neutral"/> <xs:enumeration value="temperror"/> <xs:enumeration value="permerror"/> </xs:restriction> </xs:simpleType> <xs:complexType name="DKIMAuthResultType"> <xs:all> <!-- The "d=" parameter in the signature. --> <xs:element name="domain" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- The "s=" parameter in the signature. --> <xs:element name="selector" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- The DKIM verification result. --> <xs:element name="result" type="DKIMResultType" minOccurs="1" maxOccurs="1"/> <!-- Any extra information (e.g., from Authentication-Results). --> <xs:element name="human_result" type="xs:string" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> <!-- SPF domain scope. --> <xs:simpleType name="SPFDomainScope"> <xs:restriction base="xs:string"> <xs:enumeration value="mfrom"/> </xs:restriction> </xs:simpleType> <!-- SPF verification result, see RFC 8601 Section 2.7.2. --> <xs:simpleType name="SPFResultType"> <xs:restriction base="xs:string"> <xs:enumeration value="none"/> <xs:enumeration value="pass"/> <xs:enumeration value="fail"/> <xs:enumeration value="softfail"/> <xs:enumeration value="policy"/> <xs:enumeration value="neutral"/> <xs:enumeration value="temperror"/> <xs:enumeration value="permerror"/> </xs:restriction> </xs:simpleType> <xs:complexType name="SPFAuthResultType"> <xs:all> <!-- The checked domain. --> <xs:element name="domain" type="xs:string" minOccurs="1" maxOccurs="1"/> <!-- The scope of the checked domain. --> <xs:element name="scope" type="SPFDomainScope" minOccurs="0" maxOccurs="1"/> <!-- The SPF verification result. --> <xs:element name="result" type="SPFResultType" minOccurs="1" maxOccurs="1"/> <!-- Any extra information (e.g., from Authentication-Results). The information in the field below should be for a person to be provided with additional information that may be useful when debugging SPF authentication issues. This could include broken records, invalid DNS responses, etc. --> <xs:element name="human_result" type="xs:string" minOccurs="0" maxOccurs="1"/> </xs:all> </xs:complexType> <!-- This element contains DKIM and SPF results, uninterpreted with respect to DMARC. --> <xs:complexType name="AuthResultType"> <xs:sequence> <!-- There may be zero or more DKIM signatures. --> <xs:element name="dkim" type="DKIMAuthResultType" minOccurs="0" maxOccurs="unbounded"/> <!-- There may be zero or one SPF result. --> <xs:element name="spf" type="SPFAuthResultType" minOccurs="0" maxOccurs="1"/> </xs:sequence> </xs:complexType> <!-- This element contains all the authentication results that were evaluated by the receiving system for the given set of messages. --> <xs:complexType name="RecordType"> <xs:sequence> <xs:element name="row" type="RowType" minOccurs="1" maxOccurs="1"/> <xs:element name="identifiers" type="IdentifierType" minOccurs="1" maxOccurs="1"/> <xs:element name="auth_results" type="AuthResultType" minOccurs="1" maxOccurs="1"/> <!-- Extension at record level --> <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:complexType name="ExtensionType"> <xs:sequence> <xs:any processContents="lax" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- Parent --> <xs:element name="feedback"> <xs:complexType> <xs:sequence> <xs:element name="version" type="xs:decimal" minOccurs="0" maxOccurs="1"/> <xs:element name="report_metadata" type="ReportMetadataType" minOccurs="1" maxOccurs="1"/> <xs:element name="policy_published" type="PolicyPublishedType" minOccurs="1" maxOccurs="1"/> <!-- Extension at top level --> <xs:element name="extension" type="ExtensionType" minOccurs="0" maxOccurs="1"/> <!-- One record per (IP, result, IDs Auths) tuples --> <xs:element name="record" type="RecordType" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>¶
<feedback xmlns="urn:ietf:params:xml:ns:dmarc-2.0"> <version>1.0</version> <report_metadata> <org_name>Sample Reporter</org_name> <email>report_sender@example-reporter.com</email> <extra_contact_info>...</extra_contact_info> <report_id>3v98abbp8ya9n3va8yr8oa3ya</report_id> <date_range> <begin>302832000</begin> <end>302918399</end> </date_range> <generator>Example DMARC Aggregate Reporter v1.2</generator> </report_metadata> <policy_published> <domain>example.com</domain> <p>quarantine</p> <sp>none</sp> <np>none</np> <testing>n</testing> <discovery_method>treewalk</discovery_method> </policy_published> <record> <row> <source_ip>192.168.4.4</source_ip> <count>123</count> <policy_evaluated> <disposition>pass</disposition> <dkim>pass</dkim> <spf>fail</spf> </policy_evaluated> </row> <identifiers> <envelope_from>example.com</envelope_from> <header_from>example.com</header_from> </identifiers> <auth_results> <dkim> <domain>example.com</domain> <result>pass</result> <selector>abc123</selector> </dkim> <spf> <domain>example.com</domain> <result>fail</result> </spf> </auth_results> </record> </feedback>¶
Acknowledgements¶
Many thanks are deserved to those that helped create this document. Much of the content was created from the original [RFC7489], and has now been updated to be more clear and correct some outstanding issues. The IETF DMARC Working Group has spent much time working to finalize this effort, and significant contributions were made by Seth Blank, Todd Herr, Steve Jones, Murray S. Kucherawy, Barry Leiba, John Levine, Scott Kitterman, Daniel Kvå (U+00E5)l, Martijn van der Lee, Alessandro Veseley, and Matthä (U+00E4)us Wander.¶