This is a content security policy violation collector written in Golang.
It has been designed to listen on port 8080 and accept POST payloads containing the violation report. It captures the report and will write it to STDOUT via Go's logger.
A neat little feature of this tool is that it automatically ignores unactionable reports. Check out the default list if you're interested.
Installation
$ go get github.com/jacobbednarz/go-csp-collectorAlternatively, you can download the binaries from the release page.
Running
$ go build main.go -p csp-collector
$ ./csp-collectorEndpoints
POST /: accepts a CSP violation report (recommended to use/cspfor future proofing though).POST /csp: accepts a CSP violation report.POST /csp/report-only: same as/cspbut appends areport-onlyattribute to the log line. Helpful if you have enforced and report only violations and wish to separate them.
Building for Docker
You will either need to build within a docker container for the purpose, or use CGO_ENABLED=0 flag
to make the build compatible with alpine linux in a docker container.
$ CGO_ENABLED=0 go build main.go -p csp-collectorCommand Line Options
| Flag | Description |
|---|---|
| version | Shows the version string before exiting |
| debug | Runs in debug mode producing more verbose output |
| port | Port to run on, default 8080 |
| filter-file | Reads the blocked URI filter list from the specified file. Note one filter per line |
| health-check-path | Sets path for health checkers to use, default /_healthcheck |
| log-client-ip | Include a field in the log with the IP delivering the report, or the value of the X-Forwarded-For header, if present. |
| log-truncated-client-ip | Include a field in the log with the truncated IP (to /24 for IPv4, /64 for IPv6) delivering the report, or the value of the X-Forwarded-For header, if present. Conflicts with log-client-ip. |
| truncate-query-fragment | Remove all query strings and fragments (if set) from all URLs transmitted by the client |
| query-params-metadata | Log all query parameters of the report URL as a map in the metadata field |
See the sample.filterlist.txt file as an example of the filter list in a file
Request metadata
Additional information can be attached to each report by adding a metadata
url parameter to each report. That value will be copied verbatim into the
logged report.
For example a report sent to https://collector.example.com/?metadata=foobar
will include field metadata with value foobar.
If query-params-metadata is set, instead all query parameters are logged as a
map, e.g. https://collector.example.com/?env=production&mode=enforce will
result in "metadata": {"env": "production", "mode": "enforce"} in JSON
format, and metadata="map[env:production mode:enforce]" in default format.
report-only mode
If you'd like to recieve report only violations on a different URL
Output formats
The output format can be controlled by passing --output-format <type>
to the executable. Available formats are:
- Text: A key/value output that quotes all the values. Example:
blocked_uri="about:blank" ... - JSON: Single line, compressed JSON object. Example:
{"blocked_uri":"about:blank"}
The default formatter is text.
Writing to a file instead of just STDOUT
If you'd rather have these violations end up in a file, I suggest just redirecting the output into a file like so:
$ ./csp-collector 2>> /path/to/violations.logVisualisation
This project purposely doesn't try to solve the problem of visualing the violation data because there are already a bunch of great solutions out there. Once you have your violations being collected, be sure to slurp them into your favourite log aggregation tool.
Deployments
Currently supported deployment mechanisms: