- Introduction
- Import automations
- Import a sample DMARC report
- Testing the interaction
- Enable IP geolocation maps
- References
Introduction
A DMARC1 (Domain-based Message Authentication, Reporting, and Conformance) report is a feedback mechanism used in email authentication to provide organizations with information about the successful and blocked deliveries of their emails using their own domain name (hostname) from various sender IP addresses. These reports help organizations monitor and enhance their email security and authentication practices.
DMARC reports include details about email authentication results, such as whether an email passed or failed SPF (Sender Policy Framework) and DKIM (DomainKeys Identified Mail) checks. They also provide insights into the source IP addresses of email senders and whether their emails were accepted, rejected, or marked as suspicious. This information is valuable for organizations to identify and address potential email spoofing, phishing, or unauthorized use of their domain names.
DMARC reports are delivered as an email attachment containing a compressed XML file (zip or gzip are most common). You can use automations in Cerb to automatically parse and visualize DMARC report attachments.
In this guide we’ll demonstrate how to read a DMARC report file attachment and display its contents. As a bonus, we’ll use the ipstack API to geolocate the IPs found in the report and display them on a world map.
Import automations
In Cerb, navigate to Setup » Packages » Import and paste the following package:
{
"package": {
"requires": {
"cerb_version": "10.3"
},
"configure": {
"placeholders": [],
"prompts": []
}
},
"records": [
{
"uid": "automation_dmarc_parse",
"_context": "automation",
"name": "example.function.dmarcReportParse",
"extension_id": "cerb.trigger.automation.function",
"description": "Parse DMARC report attachments",
"script": "inputs:\r\n record/file:\r\n record_type: attachment\r\n required@bool: yes\r\n\r\nstart:\r\n decision/format:\r\n # .xml.gz\r\n outcome/gzipXml:\r\n if@bool: {{inputs.file.name ends with '.xml.gz'}}\r\n then:\r\n file.read:\r\n inputs:\r\n uri: cerb:attachment:{{inputs.file.id}}\r\n filters:\r\n gzip.decompress:\r\n output: file_contents\r\n \r\n # .zip\r\n outcome/zip:\r\n then:\r\n # Look inside the ZIP for the first XML file\r\n data.query/zip:\r\n inputs:\r\n query@text:\r\n type:attachment.manifest\r\n id:{{inputs.file.id}}\r\n filter:*.xml\r\n limit:1\r\n format:dictionaries\r\n output: results\r\n on_success:\r\n outcome/notFound:\r\n if@bool: {{1 != results.data.cursor.num_files}}\r\n then:\r\n return:\r\n \r\n # Extract the XML file from the ZIP\r\n file.read:\r\n inputs:\r\n uri: cerb:attachment:{{inputs.file.id}}\r\n extract: {{results.data.files[0].name}}\r\n output: file_contents\r\n on_success:\r\n outcome/notXml:\r\n # Must be XML\r\n if@bool:\r\n {{\r\n not file_contents.bytes \r\n or 'text/xml' != file_contents.mime_type\r\n }}\r\n then:\r\n return:\r\n \r\n set/json:\r\n file_contents@json: {{xml_decode(file_contents.bytes)|json_encode}}\r\n \r\n outcome/notJson:\r\n # Must be JSON\r\n if@bool: {{not file_contents}}\r\n then:\r\n return:\r\n \r\n # If there's only one row, make a list for consistency\r\n outcome/oneRow:\r\n if@bool: {{file_contents.record.row is not empty}}\r\n then:\r\n var.set:\r\n inputs:\r\n key: file_contents:record\r\n value:\r\n 0@key: file_contents:record\r\n \r\n return:\r\n report@key: file_contents\r\n ",
"policy_kata": "commands:\r\n data.query:\r\n deny/type@bool: {{query.type != 'attachment.manifest'}}\r\n allow@bool: yes\r\n file.read:\r\n deny/uri@bool: {{inputs.uri is not prefixed ('cerb:attachment:')}}\r\n allow@bool: yes",
"created_at": 1695171444,
"updated_at": 1695171444
},
{
"uid": "automation_dmarc_interaction",
"_context": "automation",
"name": "example.interaction.dmarcReport",
"extension_id": "cerb.trigger.interaction.worker",
"description": "Interaction for quick review of DMARC reports",
"script": "inputs:\r\n record/file:\r\n required@bool: yes\r\n record_type: attachment\r\n\r\nstart:\r\n function/dmarc:\r\n uri: cerb:automation:example.function.dmarcReportParse\r\n output: results\r\n inputs:\r\n file: {{inputs.file.id}}\r\n on_success:\r\n await:\r\n form:\r\n title: DMARC results\r\n elements:\r\n sheet/prompt_sheet:\r\n data@key: results:report:record\r\n schema:\r\n layout:\r\n columns:\r\n interaction/ip:\r\n params:\r\n #uri: cerb:automation:wgm.interaction.ipstack.location\r\n text_template@raw: {{row.source_ip}}\r\n inputs:\r\n ip@raw: {{row.source_ip}}\r\n text/domain:\r\n params:\r\n value_template@raw: {{identifiers.header_from}}\r\n text/count:\r\n params:\r\n value_template@raw: {{row.count}}\r\n icon/spf:\r\n params:\r\n image_template@raw: {{'pass' == row.policy_evaluated.spf ? 'circle-ok' : 'remove-2'}}\r\n icon/dkim:\r\n params:\r\n image_template@raw: {{'pass' == row.policy_evaluated.dkim ? 'circle-ok' : 'remove-2'}}\r\n text/disposition:\r\n params:\r\n value_template@raw: {{row.policy_evaluated.disposition}}",
"policy_kata": "commands:\r\n function:\r\n deny/uri@bool: {{uri != 'cerb:automation:example.function.dmarcReportParse'}}\r\n allow@bool: yes",
"created_at": 1695171511,
"updated_at": 1695171511
},
{
"uid": "card_widget_dmarc",
"_context": "card_widget",
"name": "Actions",
"record_type": "attachment",
"pos": 100,
"width_units": 4,
"extension_id": "cerb.card.widget.form_interaction",
"extension_params": {
"interactions_kata": "interaction/zx78jf:\n label: DMARC Report\n uri: cerb:automation:example.interaction.dmarcReport\n icon: briefcase\n hidden@bool:\n {{\n not (\n record_mime_type in ['application/zip','application/gzip','application/octet-stream'] \n and record_name is pattern ('*!*!*.zip','*!*!*.xml.gz')\n )\n }}\n inputs:\n file: {{record_id}}",
"is_popup": 0
}
}
]
}
Click the Import button.
Import a sample DMARC report
From Setup » Packages » Import paste the following package to create a sample ticket with a sample DMARC report attachment:
{
"package": {
"requires": {
"cerb_version": "10.3"
},
"configure": {
"placeholders": [],
"prompts": [],
"options": {
"disable_events": true
}
}
},
"records": [
{
"uid": "ticket_dmarc",
"_context": "ticket",
"group_id": "{{{default.group_id}}}",
"subject": "Report Domain: cerb.example Submitter: customer.example Report-ID: <a1b2c3d4e5f6@customer.example>"
},
{
"uid": "message_dmarc",
"_context": "message",
"ticket_id": "{{{uid.ticket_dmarc}}}",
"sender": "dmarc-report@customer.example",
"headers": "To: support@cerb.example\r\nFrom: dmarc-reports@customer.example",
"content": "Find attached the DMARC Aggregate Report."
},
{
"uid": "attachment_dmarc",
"_context": "attachment",
"name": "customer.example!cerb.example!1695078003!1695164407.xml.gz",
"mime_type": "application/gzip",
"attach": [
"message:{{{uid.message_dmarc}}}"
],
"content": "data:application/zip;base64,H4sICI+NC2UAA2N1c3RvbWVyLmV4YW1wbGUhY2VyYi5leGFtcGxlITE2OTUwNzgwMDMhMTY5NTE2NDQwNy54bWwA7VbbjtsgFHzfr4jyXl9y21Ri2T71C9pni8BxQtcGBDhN/75gwPYm2TbqbqWqWuUhZs6YOWcYO0GPp7aZHUEbLsXDvMyK+QwElYyL/cP865fPH7bz2SO+QzUA2xH6hO9mMxT52NFRnha+oEFJbasWLGHEEo85VOp9JUgLmHbGyhZ0BifSqgZQPpQCE1rCG8xaoumnS3KoRubJalJRKSyhtuKili/fdkkNe8RuOcOk3C3okq1gXW+u7DASw41uNqg0EfvYt4N2sOfOkM3HdXG/LYolygOS6iBYXy03q1Vx75oSabP8+W6D2tREpGTD6Y9KdbuGmwMMjUhnicAU9G7sNoKBQdgTb7FBebiIoFF1j/nvACms4RtQi3IVETNCJmGKWlwW7tD9Rd/stcacsVTq1KOW3wcXjOw0hYorvMqW2SIr3d4DlEhUdsLLoDxcJTxKwZE0nbOMpYL3gRslDbc+h0IKb8IEmfC8B4oYN/toR5y2joXBk8l4Z5rujNJQiDMQltfcPQXDbQcgDHRVa9menc20MkbjCI1UcI3/vBbFLyQR6eyh0mC6xo5dnE3426wEH6BxRy51z3NmpOXICDLRrLgY/JpqoomTt+tTNy1u/bhOvV/cKD1mOT+3w5NTIm8J5zrrP78I59/KZu3ecO/ZfG02g4v/ZzbLYpEtt9liXfgf37cOaHrj/0lEQ+E9ov96RK9L3xRRlA//A38Cx2teijoKAAA="
}
]
}
Click the Import button.
Testing the interaction
Open the profile page for the sample ticket with the subject Report Domain: cerb.example Submitter: customer.example Report-ID: <a1b2c3d4e5f6@customer.example>.
You can find it in the package import results, or from Search » Tickets.
Click on the attachment:
Click the new DMARC Report button. This will only show up for attachments matching the filename pattern.
You’ll see a visual summary of the DMARC report:
Enable IP geolocation maps
Right now our report just shows IP addresses. It would be useful to be able to see the hostname and general location of each IP.
Follow the Cerb + ipstack guide if you haven’t already. This will create a connected account to use the free ipstack geolocation IP, as well as sample automations.
Then navigate to Search » Automations and edit the example.interaction.dmarcReport automation.
Around line 24, change:
#uri: cerb:automation:wgm.interaction.ipstack.location
To: (remove the # prefix)
uri: cerb:automation:wgm.interaction.ipstack.location
Click the Save Changes button at the bottom of the automation editor.
Now when you view a DMARC report, you can click on an IP to see its location. The hostname will also be displayed if a DNS PTR record exists.
References
-
Wikipedia - DMARC https://en.wikipedia.org/wiki/DMARC ↩