====== cspheader Plugin ======

---- plugin ----
description: Injects the Content Security Policy (CSP) header in DokuWiki pages.
author     : Damien Regad (original author: Matthias Schulte)
email      : dregad@mantisbt.org 
type       : action
lastupdate : 2024-04-13
compatible : Rincewind, Frusterick Manners, Greebo, Hogfather, Igor, Jack Jackrum, Kaos+
depends    : 
conflicts  : 
similar    : 
tags       : header, http, security, policy

downloadurl: https://github.com/dregad/dokuwiki-plugin-cspheader/tarball/master
bugtracker : https://github.com/dregad/dokuwiki-plugin-cspheader/issues
sourcerepo : https://github.com/dregad/dokuwiki-plugin-cspheader
donationurl: 

screenshot_img : 
----

===== Installation =====

Download and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Description =====

[[wp>Content_Security_Policy|Content Security Policy]] helps preventing cross-site scripting (XSS) attacks. With the CSP header enabled, Firefox won't execute JavaScript code which is embedded in HTML documents. It also denies loading code from external places which are not authorized by the CSP header.

For further information, visit the following pages:

  * https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP
  * https://content-security-policy.com/

===== Configuration and Settings =====

Define your Policy as appropriate via your site's [[config|Configuration Manager]], under the //Cspheader// section.

Details for each CSP Directive can be found on [[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy|MDN Web Docs]].
A direct link to each Directive's documentation is provided in the config page.

Please note that DokuWiki (and possibly at least some plugins) require the use of inline scripts. This means you should not create policies that completely forbid their use.

In [[devel:develonly]] you can make use of a [[https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/nonce|NONCE]] to authorize scripts created by DokuWiki only, while still be protected from maliciously injected inline scripts. To do so, you can use the ''NONCE'' placeholder in your configuration. It will be automatically replaced by a one-time code on each request.

Eg. the //script-src// directive might use ''nonce-NONCE'' resulting in a header ''script-src: 'nonce-1cccd1f6fb2939edd9fa9372b67017b3';'' or similar.
===== Development =====

=== Revision history (Github releases) ===

{{rss>https://github.com/dregad/dokuwiki-plugin-cspheader/releases.atom 5}}

The complete [[https://github.com/dregad/dokuwiki-plugin-cspheader/releases|list of releases and change log]] is available on Github.


=== Recent commits ===

{{rss>https://github.com/dregad/dokuwiki-plugin-cspheader/commits/master.atom 5 author date}}

Full [[https://github.com/dregad/dokuwiki-plugin-cspheader/commits/master|Git log]].

=== Known Bugs and Issues ===

Please refer to the plugin's [[https://github.com/dregad/dokuwiki-plugin-cspheader/issues|Issue tracker on Github]].


=== ToDo/Wish List ===

Requests for new features and enhancements should be filed on [[https://github.com/dregad/dokuwiki-plugin-cspheader/issues|Github]].

===== History / Credits =====

This plugin's original version was released in 2011 by **Matthias Schulte**, a.k.a lupo49. His last recorded maintenance activity on the project was in 2016, after which he stopped responding to submitted issues and pull requests.

In January 2021, Damien Regad decided to take over the plugin's maintenance, and integrate the changes he and Andi Gohr had submitted as pull requests.