# yireo/magento2-csp-whitelist-inline-js > Magento module to automatically add inline JS script to CSP whitelist `composer require yireo/magento2-csp-whitelist-inline-js` Canonical URL: https://packagento.com/yireo/magento2-csp-whitelist-inline-js ## At a glance - **Vendor**: yireo (https://packagento.com/yireo.md) - **Latest version**: 0.1.1 — released 2024-10-02 - **Pricing**: Free - **Package type**: Magento 2 module - **Status**: active, accepting new buyers ## Installation Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them. 1. **Sign in or create an account** at https://packagento.com/customer/account/. 2. **Add the package to your account.** Open https://packagento.com/yireo/magento2-csp-whitelist-inline-js and complete the free checkout. A licence is minted automatically. 3. **Create or pick a project, then activate the licence on it.** - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/. - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project. 4. **Add the project credentials to your Magento codebase.** Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`: ```json { "http-basic": { "packagento.com": { "username": "ppk_live_...", "password": "psk_live_..." } } } ``` Add the Packagento Composer repository to `composer.json`: ```json { "repositories": [ { "type": "composer", "url": "https://packagento.com" } ] } ``` 5. **Install and apply.** ```bash composer require yireo/magento2-csp-whitelist-inline-js:* bin/magento setup:upgrade bin/magento setup:di:compile bin/magento cache:flush ``` ## What it does Magento module to automatically add inline JS script to CSP whitelist ## README **When, in Magento 2, the CSP policy to disallow inline scripts is enabled, any script requires either a hash or a nonce (or something similar). This module scans any PHTML template for scripts on the fly and adds a nonce where needed, depending on your configuration.** ### Installation ```bash composer require yireo/magento2-csp-whitelist-inline-js bin/magento module:enable Yireo_CspWhitelistInlineJs ``` ### Configuration - **Mode** - `Custom whitelisting` (recommended) - `Whitelist everything` (dangerous) - **Logging**: See below ### Mode: Custom whitelisting A block can be whitelisted automatically by this module, using one of the following techniques: #### 1. Custom whitelisting by XML layout You can whitelist a specific `block` via the XML layout, by adding an argument `csp_whitelist`: ```xml true ``` **Note that there is still a security issue here, because the layout could be updated via the database as well (which could be hijacked via SQL injection).** #### 2. Via DI plugin You could also create a DI plugin `afterAllow` on `\Yireo\CspWhitelistInlineJs\Util\AllowBlock::allow(Template $block)`. ### Mode: Whitelist everything With this mode, any inline script is simply allowed. It defeats the purpose of CSP, in general, but gets the job done. Do make sure to log things, so that you can use a different mode after a while. If you keep using this mode in production, you don't get it. ### Mode: Whitelist everything #### Important note on whitelisting everything & security Note that automatically fixing inline scripts with this module does **not** take away the security risk that was meant to be fixed with CSP. The best solution is to apply this module to make sure CSP is not causing harm in production. And next, go through all of the inline scripts that don't have CSP-support yet and add CSP-support to it. **And then remove this module again.** #### What about CMS content? Whenever content is added to the HTML output of Magento, security checks would need to be in place. For instance, the content of CMS pages or CMS blocks might be compromised by hackers and with that, XSS attacks might be initiated by adding inline scripts to that content. By default, this module does **not** do anything specific for that CMS content. However, in a default situation, CMS pages and CMS blocks are not being outputted via templates and therefore an inline script in CMS content is not nonced by this module (which is a good thing). While the default is safe, any modification (custom theming, 3rd party modules, etc) could lead into compromised CMS content being outputted with nonced scripts anyway. ### Logging This module also allows logging of these inline scripts. Just enable logging via **Yireo > Yireo CspWhitelistInlineJs > Settings > Logging** (`csp_whitelist_inline_js/settings/logging`). Next, monitor the logfile `var/log/yireo-csp-whitelist-inline-js.log`. The log contains a listing of all block templates that have been picked up upon by this module. The recommendation is to go through this file and make sure that each template is whitelisted by the extension or theme that is offering that template, so that - one day in the future - you are able to remove this `Yireo_CspWhitelistInlineJs` module. Note that this file is regenerated at the end of every request by combining all existing lines with new lines. ### Compatibility - Luma theme - Hyvä Themes - Hyvä Checkout ## Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ### [Unreleased] ### [0.1.1] - 2 October 2024 #### Fixed - Prevent null HTML from causing errors ### [0.1.0] - 4 September 2024 #### Added - New default mode `custom` to only allow blocks that are explicitly whitelisted - Change logging so that entries are de-duplicated and sorted ### [0.0.3] - 2 August 2024 #### Fixed - Add a logger for analysing which scripts are fixed ### [0.0.2] - 4 July 2024 #### Fixed - Extend from SecureHtmlRenderer\Proxy to delay the instantiation @hostep ### [0.0.1] - 28 June 2024 #### Added - Initial release ## Recent Versions | Version | Released | |---|---| | 0.1.1 | 2024-10-02 | | 0.1.0 | 2024-09-04 | | 0.0.3 | 2024-08-02 | | 0.0.2 | 2024-07-04 | | 0.0.1 | 2024-06-28 | ## Dependencies ### Require | Package | Constraint | |---|---| | magento/framework | ^102.0 \|\| ^103.0 | | yireo/magento2-csp-utilities | ^1.0 | ## Quality Latest release (0.1.1) passes the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers. ### Compatibility Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`. | Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |---|---|---|---|---| | 2.4.7 | Pass | Pass | – | – | | 2.4.8 | – | Pass | Pass | – | | 2.4.9 | – | – | Pass | Pass | ### Code Quality Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible. #### Static Analysis Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module. | Tool | Status | Findings | Summary | |---|---|---|---| | PHPCS | Warning | 14 | 14 warnings (ruleset: Magento2) | | PHPMD | Warning | 1 | 1 rule violation (UnusedFormalParameter:1) | | Cpd | Pass | 0 | | | Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) | #### PHPStan Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases. | Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |---|---|---|---|---| | 2.4.7 | Pass | Pass | – | – | | 2.4.8 | – | Pass | Pass | – | | 2.4.9 | – | – | Pass | Pass | ### Tests Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately. #### Unit Tests | Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |---|---|---|---|---| | 2.4.7 | N/A | N/A | – | – | | 2.4.8 | – | N/A | N/A | – | | 2.4.9 | – | – | N/A | N/A | #### Integration Tests | Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 | |---|---|---|---|---| | 2.4.7 | N/A | N/A | – | – | | 2.4.8 | – | N/A | N/A | – | | 2.4.9 | – | – | N/A | N/A | ### Security Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright. | Tool | Status | Findings | Summary | |---|---|---|---| | Composer audit | Pass | 0 | | | Malware scan | Pass | 0 | | ## Licence and pricing Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step. Refundable within 14 days of first purchase via https://packagento.com/account/refunds/. ## Install via Claude Code or any MCP client The Packagento MCP server can run the licence + project + Composer steps above in one tool call: ``` purchase_and_install_packages( composer_names=["yireo/magento2-csp-whitelist-inline-js"], project_id="proj_xxx" ) ``` This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup. ## Vendor yireo is a Magento 2 vendor on Packagento. See https://packagento.com/yireo.md for their full catalogue.