Merge pull request #105 from cisagov/improvement/add-header-from-to-csv

Add "header from" to CSV

README.md

@@ -30,7 +30,7 @@ expects the secrets in a different location.
 To run the `cisagov/trustymail_reporter` image via Docker:
 
 ```console
-docker run cisagov/trustymail_reporter:1.4.12
+docker run cisagov/trustymail_reporter:1.5.0
 ```
 
 ### Running with Docker Compose ###
@@ -43,7 +43,7 @@ docker run cisagov/trustymail_reporter:1.4.12
 
     services:
       trustymail_reporter:
-        image: cisagov/trustymail_reporter:1.4.12
+        image: cisagov/trustymail_reporter:1.5.0
         volumes:
           - type: bind
             source: <your_log_dir>
@@ -102,7 +102,7 @@ environment variables.  See the
 
     services:
       trustymail_reporter:
-        image: cisagov/trustymail_reporter:1.4.12
+        image: cisagov/trustymail_reporter:1.5.0
         volumes:
           - type: bind
             source: <your_log_dir>
@@ -141,7 +141,7 @@ environment variables.  See the
 1. Pull the new image:
 
     ```console
-    docker pull cisagov/trustymail_reporter:1.4.12
+    docker pull cisagov/trustymail_reporter:1.5.0
     ```
 
 1. Recreate and run the container by following the [previous instructions](#running-with-docker).
@@ -151,12 +151,12 @@ environment variables.  See the
 The images of this container are tagged with [semantic
 versions](https://semver.org) of the underlying example project that they
 containerize.  It is recommended that most users use a version tag (e.g.
-`:1.4.12`).
+`:1.5.0`).
 
 | Image:tag | Description |
 |-----------|-------------|
-|`cisagov/trustymail_reporter:1.4.12`| An exact release version. |
-|`cisagov/trustymail_reporter:1.4`| The most recent release matching the major and minor version numbers. |
+|`cisagov/trustymail_reporter:1.5.0`| An exact release version. |
+|`cisagov/trustymail_reporter:1.5`| The most recent release matching the major and minor version numbers. |
 |`cisagov/trustymail_reporter:1`| The most recent release matching the major version number. |
 |`cisagov/trustymail_reporter:edge` | The most recent image built from a merge into the `develop` branch of this repository. |
 |`cisagov/trustymail_reporter:nightly` | A nightly build of the `develop` branch of this repository. |
@@ -220,7 +220,7 @@ Build the image locally using this git repository as the [build context](https:/
 
 ```console
 docker build \
-  --tag cisagov/trustymail_reporter:1.4.12 \
+  --tag cisagov/trustymail_reporter:1.5.0 \
   https://github.com/cisagov/trustymail_reporter.git#develop
 ```
 
@@ -251,7 +251,7 @@ Docker:
       --file Dockerfile-x \
       --platform linux/amd64 \
       --output type=docker \
-      --tag cisagov/trustymail_reporter:1.4.12 .
+      --tag cisagov/trustymail_reporter:1.5.0 .
     ```
 
 ## Contributing ##

src/report/generate_trustymail_report.py

@@ -1104,6 +1104,7 @@ def process_record(domain, record, policy_published):
 
             # This field is required in the XSD
             header_from = record["identifiers"]["header_from"]
+            x["Header From"] = header_from
 
             # DKIM
             auth_results = record["auth_results"]
@@ -1286,6 +1287,7 @@ def process_record(domain, record, policy_published):
             "Policy Applied",
             "Override Reason",
             "Count",
+            "Header From",
             "DKIM Alignment Result",
             "DKIM Result",
             "DKIM Domain",

src/report/trustymail_report.mustache

@@ -771,15 +771,18 @@ The fields in the \texttt{dmarc\_failures.csv} CSV are as follows:
   \href{https://cyber.dhs.gov/bod/18-01/#alignment-and-conformance}{message-From}
   address (the email address that is represented as From: in email
   clients), or b) the organizational domain corresponding to that.
+\item[Policy Applied] The DMARC policy that was applied by the
+  reporter.
 \item[Override Reason] The reason (if any) that the reporter chose to
   override the DMARC policy published by the domain.  This sometimes happens
   when mail providers observe traffic from known mailing lists or forwarders.
   If you observe overrides, it typically means the message has been delivered
   to spam, not to a user’s inbox.
 \item[Count] The number of emails that failed DMARC processing and are
   being reported.
-\item[Policy Applied] The DMARC policy that was applied by the
-  reporter.
+\item[Header From] The address in the message-FROM header of the email
+  message.  This is the From: address represented to the end user in
+  an email client.
 \item[DKIM Alignment Result] \hfill
   \begin{itemize}
     \item \texttt{aligned} if DKIM passed and the DKIM domain aligned

src/version.txt

@@ -1 +1 @@
-__version__ = "1.4.12"
+__version__ = "1.5.0"