@mrtc0/csp-html-webpack-plugin
v1.0.2
Published
## About
Downloads
2,005
Maintainers
mrtc0Readme
CSP HTML Webpack Plugin
About
@mrtc0/csp-html-webpack-plugin is a webpack plugin that helps to automatically add CSP(Level 3) to meta tags in projects like Single Page Application.
This project is inspired by strict-csp-html-webpack-plugin and allows for more flexible CSP directives.
Installation
with npm:
npm i --save-dev @mrtc0/csp-html-webpack-pluginBasic Usage
In your webpack config file:
const HtmlWebpackPlugin = require("html-webpack-plugin");
const { CspHtmlWebpackPlugin } = require("@mrtc0/csp-html-webpack-plugin");
module.exports = {
// ...
plugins: [
new HtmlWebpackPlugin(),
new CspHtmlWebpackPlugin(HtmlWebpackPlugin),
],
};Will generate the following HTML:
<html>
<head>
<meta
http-equiv="Content-Security-Policy"
content="base-uri 'self'; object-src 'none'; script-src 'strict-dynamic' 'sha256-...';"
/>
</head>
<body>
<script>
var scripts = ["/static/js/index.js"];
scripts.forEach(function (scriptUrl) {
var s = document.createElement("script");
s.src = scriptUrl;
s.async = false;
document.body.appendChild(s);
});
</script>
</body>
</html>How does this plugin work?
This plugin is referencing the strict-csp library as a source of inspiration.
- It replaces sourced scripts with an inline script that dynamically loads all sourced scripts. It calculates the hash of this script.
- It calculates the hash of other inline scripts.
- It creates a strict hash-based CSP, that includes the hashes calculated in (1) and (2).
Configuration
By default, @mrtc0/csp-html-webpack-plugin applies Strict-CSP as follows:
base-uri 'self'; object-src 'none'; script-src 'strict-dynamic' 'sha256-...';By specifying directives, you can modify the default directives. The script-src directive is automatically generated.
module.exports = {
// ...
plugins: [
new HtmlWebpackPlugin(),
new CspHtmlWebpackPlugin(HtmlWebpackPlugin, {
"base-uri": [`'self'`],
"object-src": [`'none'`],
// Add img-src directive
"img-src": [`'self'`, `https://example.com`],
// script-src will auto generate
}),
],
};If you need to provide fallbacks for older browsers that do not support CSP Level 3, you can specify the script-src directive.
module.exports = {
// ...
plugins: [
new HtmlWebpackPlugin(),
new CspHtmlWebpackPlugin(HtmlWebpackPlugin, {
"base-uri": [`'self'`],
"object-src": [`'none'`],
// If CSP Level 3 is not supported, then fallback.
// Will be generated: "script-src 'strict-dynamic' sha256-... 'unsafe-inline' 'unsafe-eval' http: https:;"
script-src": [`'unsafe-inline'`, `'unsafe-eval'`, 'http:', 'https:']
}),
],
};