diff --git a/.buildinfo b/.buildinfo index e5a7157..798802d 100644 --- a/.buildinfo +++ b/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: f1b0b48da421bfdbbc6a87a3d0573f7d +config: a1168b776b620d01471713ec4f5cfa87 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_modules/index.html b/_modules/index.html index 1f0ef80..fa44567 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -8,7 +8,7 @@ - Overview: module code — parsedmarc 1.0.0 documentation + Overview: module code — parsedmarc 1.0.2 documentation @@ -35,7 +35,7 @@ - + @@ -64,7 +64,7 @@
- 1.0.0 + 1.0.2
@@ -187,7 +187,7 @@ @@ -65,7 +65,7 @@
- 1.0.0 + 1.0.2
@@ -218,7 +218,7 @@ @@ -64,7 +64,7 @@
- 1.0.0 + 1.0.2
@@ -90,7 +90,7 @@
@@ -169,9 +172,8 @@

Welcome to parsedmarc’s documentation!

Build Status

pasedmarc is a Python module and CLI utility for parsing aggregate DMARC reports.

-
-

Features

+

Features

-

CLI help

+

CLI help

usage: parsedmarc.py [-h] [-f FORMAT] [-o OUTPUT]
                      [-n NAMESERVER [NAMESERVER ...]] [-t TIMEOUT] [-v]
                      file_path [file_path ...]
@@ -209,7 +211,7 @@
 
-

Sample output

+

Sample output

Here are the results from parsing the example report from the dmarc.org wiki. It’s actually an older draft of the the 1.0 report schema standardized in @@ -217,7 +219,7 @@ report schema standardized in This draft schema is still in wide use.

parsedmarc produces consistent, normalized output, regardless of the report schema.

-

JSON

+

JSON

{
   "xml_schema": "draft",
   "report_metadata": {
@@ -281,7 +283,7 @@ This draft schema is still in wide use.

-

CSV

+

CSV

xml_schema,org_name,org_email,org_extra_contact_info,report_id,begin_date,end_date,errors,domain,adkim,aspf,p,sp,pct,fo,source_ip_address,source_country,source_reverse_dns,source_base_domain,count,disposition,dkim_alignment,spf_alignment,policy_override_reasons,policy_override_comments,envelope_from,header_from,envelope_to,dkim_domains,dkim_selectors,dkim_results,spf_domains,spf_scopes,spf_results
 draft,acme.com,noreply-dmarc-support@acme.com,http://acme.com/dmarc/support,9391651994964116463,2012-04-27 20:00:00,2012-04-28 19:59:59,[],example.com,r,r,none,none,100,0,72.150.241.94,US,adsl-72-150-241-94.shv.bellsouth.net,bellsouth.net,2,none,fail,pass,,,example.com,example.com,,example.com,none,fail,example.com,mfrom,pass
 
@@ -289,21 +291,43 @@ This draft schema is still in wide use.

-

What about forensic DMARC reports?

+

What about forensic DMARC reports?

Forensic DMARC reports are emails with an attached email sample that failed a DMARC check. You can parse them with any email message parser, such as mail-parser.

-

Very few recipients send forensic reports, and even those who do will only -provide the message headers, and not the message’s content, for privacy +

Very few recipients send forensic reports, and even those who do will often +provide only the message headers, and not the message’s content, for privacy reasons.

-

Bug reports

+

Bug reports

Please report bugs on the GitHub issue tracker

https://github.com/domainaware/parsedmarc/issues

+
+

Installation

+

parsedmarc works with Python 2 or 3, but Python 3 is preferred.

+

On Debian or Ubuntu systems, run:

+
$ sudo apt-get install python3-pip
+
+
+

Python 3 installers for Windows and macOS can be found at https://www.python.org/downloads/

+

To install or upgrade to the latest stable release of parsedmarc on macOS or Linux, run

+
$ sudo -H pip3 install -U checkdmarc
+
+
+

Or, install the latest development release directly from GitHub:

+
$ sudo -H pip3 install -U git+https://github.com/domainaware/parsedmarc.git
+
+
+
+

Note

+

On Windows, pip3 is pip, even with Python 3. So on Windows, simply +substitute pip as an administrator in place of sudo pip3, in the above commands.

+
+
-

API

+

API

A Python module and CLI for parsing aggregate DMARC reports

@@ -385,12 +409,13 @@ headers

-

Indices and tables

+

Indices and tables

+
@@ -428,7 +453,7 @@ headers

@@ -64,7 +64,7 @@
- 1.0.0 + 1.0.2
@@ -195,7 +195,7 @@