nswdpc/silverstripe-csp

SilverStripe Content Security Policy module

v1.0.0 2024-03-28 03:38 UTC

Requires

• ext-xml: *
• silverstripe/cms: ^5
• symbiote/silverstripe-multivaluefield: ^6
• symbiote/silverstripe-queuedjobs: ^5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3
• phpunit/phpunit: ^9.5

BSD-3-Clause

• James Ellis

• silverstripe
• csp
• content security policy

README

Content Security Policy (CSP) is an added layer of security that helps to detect and mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks. These attacks are used for everything from data theft to site defacement to distribution of malware.

Source: https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP

This module provides the ability to:

• Create one or more CSP records within the administration area of your website and make one of those the base policy for use on the website
• Set a CSP record to be report only
• Collect CSP Violation reports internally via a controller or via a specific URL/service
• Add page specific CSP records, which work with or without the base policy
• Add a per-request nonce

Once a CSP is in place and working, any assets loads that do not meet policy requirements will be blocked from loading, with warnings similar to this in the browser dev console:

Refused to load the script 'https://badactor.example.com/eval.js' because it violates the following Content Security Policy directive: "script-src 'self' 'nonce-example' https://cdnjs.cloudflare.com/".

Versioning

For Silverstripe 5.x, use version constraint ^1

For Silverstripe 4.x, use version constraint ^0.4.3

Installation

The only supported method of installing this module is via composer:

composer require nswdpc/silverstripe-csp

Instructions

⚠️ An incorrectly implemented CSP can have negative effects for valid visitors to your website.

1. Read the initial documentation
2. Read the good-to-know section
3. Install the module on a development instance of your website and configure it
4. Add at least one Policy record in the "CSP" administration section.
   • Set it to 'report only'
   • Mark it as the 'base policy'
   • Optionally, make it available on your draft site only
5. Set the policy to be delivered via a HTTP headers (you can use meta tags but this method limits the feature you can use).
6. Add some Directives
7. Mark the Policy 'Enabled', save it and
8. Watch for violation reports or look at your browser dev console

When you are pleased with the settings, check the "Use on published website" setting and save.

After UAT is complete, implement the same process on your production website. You should run the policy as report-only and monitor reports, initially.

Page specific policies

By default Pages can define an extra Policy for delivery when requested with the following caveat:

Adding additional policies can only further restrict the capabilities of the protected resource

MDN provides some useful information on this process:

This means that you can't (currently) relax the base policy restrictions from within your page policy.

Using a nonce

See using a nonce

Good-to-know

See good-to-know

Violation Reports

See reporting

Minimum CSP Level

Refer to the following for changes between levels:

• Changes from Level 1 to 2
• Changes from Level 2 to 3

Additional Help

See further reading

Browser Compatibility

See browser support

Maintainers

• dpcdigital@NSWDPC:~$

Bugtracker

We welcome bug reports, pull requests and feature requests on the Github Issue tracker for this project.

Please review the code of conduct prior to opening a new issue.

Security

If you have found a security issue with this module, please email digital[@]dpc.nsw.gov.au in the first instance, detailing your findings.

Development and contribution

If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

Please review the code of conduct prior to completing a pull request.