5 releases

0.2.0 Aug 23, 2022
0.1.3 Jan 7, 2022
0.1.2 Oct 2, 2021
0.1.1 Aug 26, 2021
0.1.0 Aug 25, 2021

#187 in Email

MIT license

29KB
655 lines

Morbo, a CSP Reporter

LICENSE Build Status Crates.io Version Minimum rustc version

Morbo, a CSP Reporter

The HTTP Content-Security-Policy report-to (and the deprecated report-uri) response header directive instructs the user agent to report attempts to violate the Content Security Policy. These violation reports consist of JSON documents sent via an HTTP POST request to the specified URI.

This Rust crate is an endpoint to receive those reports and send them to an email address.

Install

First, install using cargo. You must choose the channels you want to receive notifications on, using the --features command line arg.

mail and sentry are currently available.

cargo install morbo --features=mail,sentry

Then, setup some environment variables:

MORBO_MAILER_FROM_NAME=Example
MORBO_MAILER_FROM_EMAIL=example@example.org
MORBO_MAILER_TO_NAME=Example
MORBO_MAILER_TO_EMAIL=example@example.org
MORBO_MAILER_SMTP_HOSTNAME=localhost
MORBO_MAILER_SMTP_PORT=1025
MORBO_MAILER_SMTP_USERNAME=
MORBO_MAILER_SMTP_PASSWORD=

MORBO_SENTRY_DSN=

Usage

morbo --port=8080 # (port is optionnal, default 8080)

Then, setup a reverse proxy in your webserver. For example, in nginx:

location /_/csp-reports {
    proxy_pass http://127.0.0.1:8080;
}

In the website you want to report CPS, set the following headers:

Report-To: {"group": "csp-endpoint","max_age": 10886400,"endpoints": [{ "url": "http://example.org/_/csp-reports" }]});
Content-Security-Policy: default-src 'self'; report-to csp-endpoint; report-uri http://example.org/_/csp-reports;');

Event though report-uri is deprecated, report-to is not supported in every browser.

Dependencies

~17–33MB
~459K SLoC