https://github.com/CERT-Polska/mailgoose

A web application that allows the users to check whether their SPF, DMARC and DKIM configuration is set up correctly.
https://github.com/CERT-Polska/mailgoose

dkim dmarc security security-tools spf webapp

Last synced: about 2 months ago
JSON representation

A web application that allows the users to check whether their SPF, DMARC and DKIM configuration is set up correctly.

• Host: GitHub
• URL: https://github.com/CERT-Polska/mailgoose
• Owner: CERT-Polska
• License: bsd-3-clause
• Created: 2023-11-08T10:42:54.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-07-24T18:38:22.000Z (about 2 months ago)
• Last Synced: 2024-07-28T20:48:17.082Z (about 2 months ago)
• Topics: dkim, dmarc, security, security-tools, spf, webapp
• Language: Python
• Homepage: https://cert.pl/en/posts/2024/07/mailgoose/
• Size: 1.06 MB
• Stars: 123
• Watchers: 5
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-opensource-email - Mailgoose - A web application that allows the users to check whether their SPF, DMARC and DKIM configuration is set up correctly. - `BSD 3-Clause "New" or "Revised" License`, `Python` (Security / Security Check)

README

        


    

        

        

    



Mailgoose is a web application that allows the users to check whether their SPF, DMARC and

DKIM configuration is set up correctly. CERT PL uses it to run

bezpiecznapoczta.cert.pl, an online service

that helps Polish institutions to configure their domains to decrease the probability of successful

e-mail spoofing.

Under the hood, Mailgoose uses checkdmarc

and dkimpy, among others.

## [Quick Start 🔨](https://mailgoose.readthedocs.io/en/latest/quick-start.html) | [Docs 📚](https://mailgoose.readthedocs.io/en/latest/)

## Features

For an up-to-date list of features, please refer to [the documentation](https://mailgoose.readthedocs.io/en/latest/features.html).

## Screenshots

![Check results](.github/screenshots/check_results.png)

## Development

### Tests

To run the tests, use:

```

./scripts/test

```

### Code formatting

Mailgoose uses `pre-commit` to run linters and format the code.

`pre-commit` is executed on CI to verify that the code is formatted properly.

To run it locally, use:

```

pre-commit run --all-files

```

To setup `pre-commit` so that it runs before each commit, use:

```

pre-commit install

```

### Building the docs

To build the documentation, use:

```

cd docs

python3 -m venv venv

. venv/bin/activate

pip install -r requirements.txt

make html

```

## Contributing

Contributions are welcome! We will appreciate both ideas for improvements (added as

[GitHub issues](https://github.com/CERT-Polska/mailgoose/issues)) as well as pull requests

with new features or code improvements.

However obvious it may seem we kindly remind you that by contributing to mailgoose

you agree that the BSD 3-Clause License shall apply to your input automatically,

without the need for any additional declarations to be made.