grgras71 / trustymail Goto Github PK

trustymail is a tool that evaluates SPF/DMARC records set in a domain's DNS. It saves its results to CSV or JSON.

Clone the repo, then

pip3 install -e .

trustymail [options] INPUT

trustymail dhs.gov
trustymail --output=homeland.csv --debug dhs.gov us-cert.gov usss.gov
trustymail agencies.csv

Note: if INPUT ends with .csv, domains will be read from CSV. CSV output will always be written to disk, defaulting to results.csv.

  -h --help                   Show this message.
  -o --output=OUTFILE         Name of output file. (Default results)
  -t --timeout=TIMEOUT        Override timeout of DNS lookup in seconds. (Default 5)
  --mx                        Only check mx records
  --spf                       Only check spf records
  --dmarc                     Only check dmarc records
  --debug                     Output should include error messages.

For a given domain, MX records, SPF records (TXT), and DMARC (TXT, at _dmarc.) are checked.

The following values are returned in results.csv:

• Domain - The domain you're scanning!
• Base Domain - The base domain of Domain. For example, for a Domain of sub.example.gov, the Base Domain will be example.gov. Usually this is the second-level domain, but trustymail will download and factor in the Public Suffix List when calculating the base domain.
• Live - The domain is actually published in the DNS.

• MX Record - If an MX record was found that contains at least a single mail server.
• Mail Servers - The list of hosts found in the MX record.

• SPF Record - Whether or not a SPF record was found.
• Valid SPF - Whether the SPF record found is syntactically correct, per RFC 4408 .
• SPF Results - The textual representation of any SPF record found for the domain.

• DMARC Record - True/False whether or not a DMARC record was found.
• Valid DMARC - Whether the DMARC record found is syntactically correct.
• DMARC Results - The DMARC record that was discovered when querying DNS.
• DMARC Record on Base Domain, Valid DMARC Record on Base Domain, DMARC Results on Base Domain - Same definition as above, but returns the result for the Base Domain. This is important in DMARC because if there isn't a DMARC record at the domain, the base domain (or "Organizational Domain", per RFC 7489, is checked and applied.)
• DMARC Policy - An adjudication, based on any policies found in DMARC Results and DMARC Results on Base Domain, of the relevant DMARC policy that applies.

• Syntax Errors - A list of syntax errors that were detected when scanning either DMARC or SPF records.

This project is in the worldwide public domain.

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.