Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/catalyst/moodle-local_csp

Content security policy reporting and enforcing tool for Moodle
https://github.com/catalyst/moodle-local_csp

content-security-policy csp-report moodle

Last synced: 3 days ago
JSON representation

Content security policy reporting and enforcing tool for Moodle

Host: GitHub
URL: https://github.com/catalyst/moodle-local_csp
Owner: catalyst
Created: 2016-12-06T22:51:54.000Z (almost 8 years ago)
Default Branch: MOODLE_401_STABLE
Last Pushed: 2024-07-08T00:39:13.000Z (4 months ago)
Last Synced: 2024-07-09T00:08:57.569Z (4 months ago)
Topics: content-security-policy, csp-report, moodle
Language: PHP
Homepage: https://moodle.org/plugins/local_csp
Size: 156 KB
Stars: 13
Watchers: 36
Forks: 8
Open Issues: 15
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/catalyst/moodle-local_csp/ci.yml?branch=MOODLE_401_STABLE&label=ci)
# moodle-local_csp

* [Why would you want this?](#why-would-you-want-this)
* [What is this?](#what-is-this)
* [How does it work?](#how-does-it-work)
* [Branches](#branches)
* [Performance impact](#performance-impact)
* [Installation](#installation)
* [References](#references)

Why would you want this?
------------------------
Security, security, security.

This plugin helps you to detect and mitigate certain classes of security errors in your Moodle such as:

- Mixed content (https/http) after you switched to HTTPS.
- Same origin (or specified origin) policy for scripts and media data.
- Unintended iframes

What is this?
-------------
This plugin allows you to easily test and rollout [Custom Security Policy headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) across your moodle.

Examples:
- Report/enforce SSL origin for links, images etc.
- Report/enforce same-origin for links, images etc.

How does it work?
-----------------

Site admin configures CSP headers: `Content-Security-Policy` or `Content-Security-Policy-Report-Only` in the plugin settings.
Header Content-Security-Policy-Report-Only is for recording CSP violations in Moodle and reviewing them later from the plugin's report page.

Enabling of Content-Security-Policy blocks browser from showing site resources that violate defined rules.

CSP support in browsers is quite good:

https://caniuse.com/#search=CSP

To get started visit this admin settings page and enter a basic policy into csp_header_reporting and enable it with csp_header_enable.

/admin/settings.php?section=local_csp_settings

Then you will need to wait for a couple days or a week to collect statistics on what pages are violating that policy.
You can see all the violations here:

/local/csp/csp_report.php

As you discover violations you need to make the business decision of which domains should be allowed and either amend the CSP policy, or change the learning content so they do not violate the policy.

Each time you change the policy you can reset the statistics, either partially for each directives or fully.
When you gain confidence in your policy you can convert it from a 'reporting only' policy to a real policy that is enforced.

Be aware that if you prematurely set a policy which is too strict you can break your learning content and even completely break Moodle itself.

Branches
--------

| Moodle verion | Branch | PHP |
| ----------------- | --------------------- | -------- |
| Moodle 4.1+ | MOODLE_401_STABLE | 7.4 |
| Moodle 3.3 to 4.0 | master | 7.2 |
| Moodle 2.7 | MOODLE_27_STABLE | 5.5 |

Performance impact
------------------

While this plugin is relatively lightweight, if you have a reporting policy in place which has a large
number of violations then each of those violations will be reported to the collector endpoint which adds load to your server.

It is recommended to try and fix policy issues as they are identified in the summary reports, or white list the content so it is no longer reported on.

Installation
------------
Checkout or download the plugin source code into folder `local\csp` of your Moodle installation.

```sh
git clone [email protected]:catalyst/moodle-local_csp.git local\csp
```
or
```sh
wget https://github.com/catalyst/moodle-local_csp/archive/master.zip
mkdir -p local/csp
unzip master.zip -d local/csp
```
Then go to your Moodle admin interface and complete installation and configuration.
Example policy 'default-src https:;' will be reporting or enforcing the links to be HTTPS-only. Please note, the whole moodle website should be accessible via HTTPS for this to work.

For more examples of other CSP directives please read [here](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP).

References
----------