Skip to content

Django based web-app to visually analyze DMARC aggregate reports

License

Notifications You must be signed in to change notification settings

luzfcb/dmarc-viewer

 
 

Repository files navigation

DMARC viewer

Version v0.19.0

DMARC viewer is a Django-based web application that lets you visually analyze DMARC aggregate reports, providing unique insights into how your mailing domains are used and abused. Moreover, with DMARC viewer you can create and store custom analysis views that filter reports based on the criteria you are interested in.

Live Demo

A DMARC viewer demo is available at dmarc-viewer.abteil.org.

Configure DNS

To receive DMARC aggregate reports for your domains all you need to do is to add a DMARC entry to your DNS records. Read "Anatomy of a DMARC resource record in the DNS" for initial guidance.

Start Analyzing!

To analyze your own DMARC aggregate reports you need to deploy an instance of DMARC viewer. Follow these steps to get you started:

  1. Deploy your own instance of DMARC viewer,
  2. import DMARC aggregate reports,
  3. and create analysis views.

Alternatively you can deploy DMARC viewer using docker.

You'll find further usage instructions on the DMARC viewer help page and plenty of contextual help throughout the website (look out for "?" symbols).

Contribute

DMARC viewer is an open source project (MIT). If you want a new feature, discover a bug or have some general feedback, feel free to file an issue. You can also fork this repository, start coding and submit pull requests.

Configuration

This is a fork from the orgina Project which means that this project can load emails from a mailbox and analyze them automatically. This project also works with the modified GeoLite2 Database. To use this project you need a free license key from maxmind.com (To download the GeoLite2 City database)

Configuration Variables

  • DMARC_VIEWER_ALLOWED_HOSTS=127.0.0.1;localhost
  • DMARC_VIEWER_SECRET_KEY=arandomkey
  • DMARC_VIEWER_DB_HOST=database
  • DMARC_VIEWER_DB_NAME=dmarc-viewer
  • DMARC_VIEWER_DB_USER=dmarc-viewer
  • DMARC_VIEWER_DB_PASS=NOTASECRET
  • DMARC_VIEWER_DB_ENGINE=django.db.backends.mysql
  • DMARC_VIEWER_IMAP_HOST=mailhost.com
  • DMARC_VIEWER_IMAP_USER=dmarcreports@mail.com
  • DMARC_VIEWER_IMAP_PASS=NOTASECRET
  • DMARC_VIEWER_IMAP_FOLDER=INBOX
  • GEOIP_LICENSE_IP

About

Django based web-app to visually analyze DMARC aggregate reports

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 51.4%
  • Python 27.2%
  • JavaScript 11.6%
  • HTML 8.7%
  • Other 1.1%