Skip to main content

Displays a nicely formatted report in your terminal from a DMARC XML report.

Project description

DMARC Report Tool

Displays a nicely formatted report in your terminal from a DMARC XML report.

Installation

This works best when installed with uv tool or pipx.

# With uv:
uv tool install dmarc-report

# Or with pipx:

pipx install dmarc-report

You can also run the tool without installing it:

# With uvx:
uvx dmarc-report long-dmarc-report-filename.xml

Usage

Run the dmarc-report command-line utility followed by a DMARC report file. The DMARC report can have one of the following file extensions:

  • .xml.gz
  • .zip
  • .xml
dmarc-report long-dmarc-report-filename.xml.gz
# or
dmarc-report long-dmarc-report-filename.xml
# or
dmarc-report long-dmarc-report-filename.zip

Note: if using a zip file, it will only parse the first xml file found in the zip file.

You'll see a nicely formatted report in your terminal:

╭──────────────────────────────────── DMARC Report for example.com ─────────────────────────────────────╮
│                                                                                                       │
│ Domain: example.com                                                                                   │
│ Report Period: 2020-01-01 00:00:00 UTC to 2020-01-01 23:59:59 UTC                                     │
│                                                                                                       │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────╯
   Summary Statistics
╭────────────────┬──────╮
│ Total Messages │ 2    │
│ Unique Sources │ 1    │
│ DKIM Pass Rate │ 0.0% │
│ SPF Pass Rate  │ 0.0% │
╰────────────────┴──────╯
                           DMARC Report Metadata
╭────────────────────┬────────────────────────────────────────────────────╮
│ Org name           │ Google, Inc.                                       │
│ Email              │ noreply-dmarc-support@google.com                   │
│ Extra contact info │ https://support.google.com/a/answer/2466580        │
│ Report ID          │ 1234567890                                         │
│ Date range         │ 2020-01-01 00:00:00 UTC to 2020-01-01 23:59:59 UTC │
╰────────────────────┴────────────────────────────────────────────────────╯

       DMARC Policy Details
╭──────────────────┬─────────────╮
│ Domain           │ example.com │
│ DKIM Alignment   │ r           │
│ SPF Alignment    │ r           │
│ Policy           │ quarantine  │
│ Subdomain Policy │ reject      │
│ Percent          │ 100         │
╰──────────────────┴─────────────╯

                                      Message Records
╭─────────────┬───────┬─────────────┬──────┬──────┬─────────────┬──────────────────────────╮
│ Source IP   │ Count │ Disposition │ DKIM │ SPF  │ Header From │ Auth Results             │
├─────────────┼───────┼─────────────┼──────┼──────┼─────────────┼──────────────────────────┤
│ 203.0.113.1 │ 2     │ none        │ pass │ pass │             │ dkim: example.com (pass) │
│             │       │             │      │      │             │ spf: example.com (pass)  │
╰─────────────┴───────┴─────────────┴──────┴──────┴─────────────┴──────────────────────────╯

 🚀 End of report
─────────────────────────────────────────────────────────────────────────────────────────────────────────

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dmarc_report-1.0.2.tar.gz (27.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dmarc_report-1.0.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file dmarc_report-1.0.2.tar.gz.

File metadata

  • Download URL: dmarc_report-1.0.2.tar.gz
  • Upload date:
  • Size: 27.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for dmarc_report-1.0.2.tar.gz
Algorithm Hash digest
SHA256 568feabfe7f53e10d6525d70d6a9a089f2747e5227a46ac8b1f1680fcab7862e
MD5 f0ebf45f32f992e2f37d10b06a4a6982
BLAKE2b-256 55a9ea85b6adcc7944148a5fb5af41b76e697fff930b42e5d47973a0e6ec0b59

See more details on using hashes here.

Provenance

The following attestation bundles were made for dmarc_report-1.0.2.tar.gz:

Publisher: ci.yml on stuartmaxwell/dmarc-report

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dmarc_report-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: dmarc_report-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for dmarc_report-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 51902b9cecbf1a237172dba30bbafe7ae589013c9b49179efb7b3db026aa5d39
MD5 2ccb5dd6cfc24e65613c37ebfb6cd20c
BLAKE2b-256 4f3cb2fc3dd630052d7fd78d849ef8b1c53f5c0a68c8ee5cf133ef7b2c5e91c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for dmarc_report-1.0.2-py3-none-any.whl:

Publisher: ci.yml on stuartmaxwell/dmarc-report

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page