https://github.com/maxwellmatthis/dmarc-report-analysis
This tool helps analyse large amounts of DMARC reports.
https://github.com/maxwellmatthis/dmarc-report-analysis
aggregated-reports dmarc dmarc-reports python
Last synced: 22 days ago
JSON representation
This tool helps analyse large amounts of DMARC reports.
- Host: GitHub
- URL: https://github.com/maxwellmatthis/dmarc-report-analysis
- Owner: maxwellmatthis
- License: mit
- Created: 2020-10-06T20:31:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-08T15:03:34.000Z (about 3 years ago)
- Last Synced: 2025-02-09T10:21:47.499Z (3 months ago)
- Topics: aggregated-reports, dmarc, dmarc-reports, python
- Language: Python
- Homepage:
- Size: 48.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dmarc-report-analysis
## Warning
This program uses an XML parser (Minidom) that creates DOM objects. Minidom is one of the safer libraries but still vulnerable to some attacks. Malicious XML may be able to steal data, crash python or even your machine. Make sure this script does not have too many permissions.
### Useful References:
- https://docs.python.org/3/library/xml.html#xml-vulnerabilities
- https://www.netsparker.com/blog/web-security/xxe-xml-external-entity-attacks/
## add.py
### About
add.py helps with adding new data from a varienty of sources to the buffer. The package inx contains all input sources.
### Requirements
- Python2.7 or later (python 3 recommended)
- scripts
- in_gmail.py
### Usage
```bash
# bash
$ python3 add.py [input type]
# input types: gmail
```
## query.py
### About
query.py filters records by query. The package outx contains all output methods.
### Requirements
- Python2.7 or later (python 3 recommended)
- scripts
- out_cli.py
- out_gmail.py
### Usage
```bash
# bash
$ python3 query.py [output type] [optional: query, query...]
# output types: cli, gmail
# query syntax: key=value
```
## rua_parser.py
### About
rua_parser.py takes XML as input and outputs a list of dictionaries.
### Requirements
- Python2.7 or later (python 3 recommended)
### Usage
```python
# python
# import "rua_parser.py" from package "parser"
from parser import rua_parser
# parse XML-String
parsed = rua_parser.parse('...')
```
or
```bash
# bash
$ python3 rua_parser.py ["..."]
```
## gmail_service.py
### About
gmail_service.py builds a Gmail API Service Object and returns it to be used in another Gmail API script.
### Requirements
- Python2.7 or later (python 3 recommended)
- pip
- google-api-python-client
- google-auth-httplib2
- google-auth-oauthlib
- credentials.json file from Gmail API
```bash
# bash
# run the following command to quickly install the google libraries
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
```
### Helpful Resources
- Python Gmail API Quickstart: https://developers.google.com/gmail/api/quickstart/python
- Gmail API: https://console.developers.google.com/apis/library/gmail.googleapis.com?q=gmail
### Usage
```python
# python
# import service builder
from services import gmail_service
# build service object
service = gmail_service.buildService()
```
## in_gmail.py
### About
in_gmail.py fetches email attachments from the inbox and makes them readable.
### Requirements
- Python 2.7 or later (python 3 recommended)
- scripts
- gmail_service.py
### Usage
```python
# python
# import gmail input
from inx import in_gmail
# get dictionary of files and contents
filesContents = in_gmail.get()
```
## out_cli.py
### About
out_cli.py "pretty prints" lists of dictionaries containing DMARC record data.
### Requirements
- Python 2.7 or later (python 3 recommended)
### Usage
```python
# python
# import cli output
from outx import out_cli
# print out records
out_cli.printOut(records)
```
## out_gmail.py
### About
out_gmail.py sends HTML versions of lists of dictionaries containing DMARC record data.
### Requirements
- Python 2.7 or later (python 3 recommended)
- scripts
- gmail_service.py
### Usage
```python
# python
# import gmail output
from outx import out_gmail
# build service object
out_gmail.send(records)
```