https://github.com/cherry/report-to

Middleware for setting the Report-To HTTP response header
https://github.com/cherry/report-to

express hacktoberfest middleware report-to reportto

Last synced: about 1 month ago
JSON representation

Middleware for setting the Report-To HTTP response header

• Host: GitHub
• URL: https://github.com/cherry/report-to
• Owner: Cherry
• License: mit
• Created: 2018-11-16T18:39:04.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-14T19:16:30.000Z (3 months ago)
• Last Synced: 2024-11-20T11:29:12.781Z (about 2 months ago)
• Topics: express, hacktoberfest, middleware, report-to, reportto
• Language: JavaScript
• Homepage:
• Size: 1.2 MB
• Stars: 7
• Watchers: 3
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
Report To

==============

[![npm version](https://badge.fury.io/js/report-to.svg)](https://badge.fury.io/js/report-to)

[![dependencies Status](https://david-dm.org/Cherry/report-to/status.svg)](https://david-dm.org/Cherry/report-to)

[![Actions Status](https://github.com/Cherry/Report-to/workflows/Test/badge.svg)](https://github.com/Cherry/Report-to/actions)

[![Coverage Status](https://coveralls.io/repos/github/Cherry/report-to/badge.svg?branch=main)](https://coveralls.io/github/Cherry/report-to?branch=main)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FCherry%2Freport-to.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FCherry%2Freport-to?ref=badge_shield)

This is Express middleware to set the `Report-To` HTTP response header. You can read more about it [here](https://www.w3.org/TR/reporting) and [here](https://scotthelme.co.uk/network-error-logging-deep-dive/).

To use:

```javascript

const reportTo = require('report-to')

// ...

app.use(reportTo({

  groups: [

    {

      group: "endpoint-1",

      max_age: 10_886_400,

      include_subdomains: true,

      endpoints: [

        {

          url: "https://example.com/reports",

          priority: 1

        },

        {

          url: "https://backup.com/reports",

          priority: 2

        }

      ]

    }

  ]

}))

```

When set alone, this header doesn't do anything and will need to be set with a header that allows reporting, such as `Content-Security-Policy`, `NEL`, etc.

For example, using the above definition, a `NEL` header may look like the following, using `endpoint-1` as its `report-to` parameter:

```NEL: {"report_to":"endpoint-1","max_age":31536000,"include_subdomains":true}```

You can use [this module](https://github.com/Cherry/network-error-logging) to set an `NEL` header easily with express.

https://report-uri.com/ is a great reporting platform for monitoring CSP, NEL, etc. error logs.

## License

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FCherry%2Freport-to.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2FCherry%2Freport-to?ref=badge_large)