Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keltia/dmarc-cat
Small utility to decode the report sent by various email providers following the DMARC spec
https://github.com/keltia/dmarc-cat
dmarc-parser dmarc-reports golang
Last synced: 9 days ago
JSON representation
Small utility to decode the report sent by various email providers following the DMARC spec
- Host: GitHub
- URL: https://github.com/keltia/dmarc-cat
- Owner: keltia
- License: other
- Created: 2018-02-24T19:31:30.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T13:38:02.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T02:29:26.736Z (about 2 months ago)
- Topics: dmarc-parser, dmarc-reports, golang
- Language: Go
- Size: 117 KB
- Stars: 62
- Watchers: 7
- Forks: 13
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# README.md
## Status
[](https://github.com/keltia/dmarc-cat/releases/)
[](https://github.com/keltia/dmarc-cat/issues)
[](https://golang.org/dl/)
[](https://travis-ci.org/keltia/dmarc-cat)
[](http://godoc.org/github.com/keltia/dmarc-cat)
[](https://semver.org/spec/v2.0.0.html)
[](https://opensource.org/licenses/BSD-2-Clause)
[](https://goreportcard.com/report/github.com/keltia/dmarc-cat)
## Summary
`dmarc-cat` is a small command-line utility to analyze and display in a usable manner the content of the DMARC XML reports sent by the various email providers around the globe. Should work properly on UNIX (FreeBSD, Linux, etc.) and now Windows systems.
## Installation
As with many Go utilities, a simple
go get github.com/keltia/dmarc-cat
is enough to fetch, build and install. On some systems you may need to add some environment variables to enable the Go and C compilers to find the `gpgme` include files and libraries.
CGO_CFLAGS="-I/usr/local/include" CGO_LDFLAGS="-L/usr/local/lib" go get ...
On Windows systems, GPG support is disabled in the `archive` module so you don't need to compile any non-Go code and the above `go get` command should work directly in a Powershell window.
### Linux
#### Arch Linux
[](https://aur.archlinux.org/packages/dmarc-cat/)
[](https://aur.archlinux.org/packages/dmarc-cat-git/)
Dmarc-cat is available on the [AUR](https://wiki.archlinux.org/index.php/Arch_User_Repository):
- [dmarc-cat](https://aur.archlinux.org/packages/dmarc-cat/) (release package)
- [dmarc-cat-git](https://aur.archlinux.org/packages/dmarc-cat-git/) (git package)
You can install it using your [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) of choice.
Example:
```console
$ yay -Sy dmarc-cat
```
## Dependencies
Aside from the standard library, I use `github.com/intel/tfortools` to generate tables.
go get -u github.com/intel/tfortools
It also use my own module `github.com/keltia/archive` to handle the various archive types.
If you use Go modules, it should all work automatically.
## Usage
SYNOPSIS
```
dmarc-cat -hvDN [-j N] [-t type] [-S sort] [-version]
Usage of ./dmarc-cat:
-D Debug mode
-N Do not resolve IPs
-S string
Sort results (default "\"Count\" \"dsc\"")
-j int
Parallel jobs (default 8)
-t string
File type for stdin mode
-v Verbose mode
-version
Display version
Example:
$ dmarc-cat /tmp/yahoo.com\!keltia.net\!1518912000\!1518998399.xml
Reporting by: Yahoo! Inc. — [email protected]
From 2018-02-18 01:00:00 +0100 CET to 2018-02-19 00:59:59 +0100 CET
Domain: keltia.net
Policy: p=none; dkim=r; spf=r
Reports(1):
IP Count From RFrom RDKIM RSPF
88.191.250.24 1 keltia.net keltia.net neutral pass
```
## Columns
The full XML grammar is available [here](https://tools.ietf.org/html/rfc7489#appendix-C)
The report has several columns:
- `IP` is matching IP address
- `Count` is the number of times this IP was present
- `From` is the `From:` header value
- `RFrom` is the envelope `From` value
- `RDKIM` is the result from DKIM checking
- `RSPF` is the result from SPF checking
## Supported formats
The file sent by MTAs can differ in format, some providers send zip files with both csv and XML files, some directly send compressed XML files. The `archive` module should support all these, please open an issue if not.
## Tests
Getting close to 90% coverage.
## License
This is released under the BSD 2-Clause license. See `LICENSE.md`.
## References
- [DMARC](https://dmarc.org/)
- [SPF](http://www.rfc-editor.org/info/rfc7208)
- [DKIM](http://www.rfc-editor.org/info/rfc6376)
- [archive](https://github.com/keltia/archive/)
## Contributing
I use Git Flow for this package so please use something similar or the usual github workflow.
1. Fork it ( https://github.com/keltia/dmarc-cat/fork )
2. Checkout the develop branch (`git checkout develop`)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request