https://github.com/aeyoll/morbo

Morbo, a CSP Reporter
https://github.com/aeyoll/morbo

csp rust tide

Last synced: 11 days ago
JSON representation

Morbo, a CSP Reporter

• Host: GitHub
• URL: https://github.com/aeyoll/morbo
• Owner: aeyoll
• License: mit
• Created: 2021-03-15T07:15:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-23T08:56:19.000Z (about 2 years ago)
• Last Synced: 2024-10-11T00:45:42.054Z (about 1 month ago)
• Topics: csp, rust, tide
• Language: Rust
• Homepage:
• Size: 244 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Morbo, a CSP Reporter

[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[![Build Status](https://github.com/aeyoll/morbo/actions/workflows/ci.yml/badge.svg)](https://github.com/aeyoll/morbo/actions/workflows/ci.yml)

[![Crates.io Version](https://img.shields.io/crates/v/morbo.svg)](https://crates.io/crates/morbo)

[![Minimum rustc version](https://img.shields.io/badge/rustc-1.49.0+-lightgray.svg)](#rust-version-requirements)

![Morbo, a CSP Reporter](https://github.com/aeyoll/morbo/blob/main/.github/logo.jpg?raw=true)

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

[email protected]

MORBO_MAILER_TO_NAME=Example

[email protected]

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.

Rust version requirements

---

Rust >= 1.49.0+