Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Putting csp_whitelist.xml in theme does not work and creates intermittent issue #38933

Open
1 of 5 tasks
Jakhotiya opened this issue Jul 15, 2024 · 6 comments · May be fixed by #39672
Open
1 of 5 tasks

Putting csp_whitelist.xml in theme does not work and creates intermittent issue #38933

Jakhotiya opened this issue Jul 15, 2024 · 6 comments · May be fixed by #39672
Assignees
Labels
Area: Content Component: Csp Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for dev Reported on 2.4.7 Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it

Comments

@Jakhotiya
Copy link
Contributor

Jakhotiya commented Jul 15, 2024

Preconditions and environment

  • 2.4.7 and 2.4-develop

Steps to reproduce

  • Put csp_whitelist.xml under your frontend theme's etc/ directory. (You can put this in Luma theme too. Just any theme will work)
  • Clear your cache
  • Without doing anything else Open your admin page
  • now open frontend and check csp headers

Expected result

Domains listed in your custom csp_whitelist.xml under theme should have reflected on frontend

Actual result

If admin is hit first after cache flush, domains under your csp_whitelist.xml under theme are not seen on frontend.

Additional information

This bug happens because contents of csp_whitelist.xml in theme are stored in global cache.
Lets see how this works right now.
CSP cache is maintained area wise. For example, you will find 3 files in your cache

var/cache/mage--8/mage---06a_FRONTEND__CSP_WHITELIST_CONFIG
var/cache/mage--2/mage---06a_GLOBAL__CSP_WHITELIST_CONFIG
var/cache/mage--a/mage---06a_ADMINHTML__CSP_WHITELIST_CONFIG

Now the bug happens because of app/code/Magento/Csp/Model/Collector/CspWhitelistXml/FileResolver.php

public function get($filename, $scope)
    {
         $configs = $this->moduleFileResolver->get($filename, $scope);
        if ($scope === 'global') {
            $files = [];
            $theme = $this->theme;
            while ($theme) {
                /** @var CustomizationInterface $info */
                $info = $this->themeInfoFactory->create(['theme' => $theme]);
                $file = $info->getThemeFilesPath() .'/etc/' .$filename;
                if ($this->rootDir->isExist($file)) {
                    $files[] = $file;
                }
                $theme = $theme->getParentTheme();
            }
            $configs = $this->iteratorFactory->create(
                ['paths' => array_reverse($files), 'existingIterator' => $configs]
            );
        }

        return $configs;
    }

if ($scope === 'global') leads to csp_whitelist config in theme being put in global cache.
After cache flush if admin request lands on server, $theme variable is set to Magento/backend .
In this case, your file in frontend theme wont be read. Global cache is then populated according to Magento/backend

The behavior completely depends on which area request lands first, frontend or admin. This leads to poor developer experience too.

Release note

No response

Triage and priority

  • Severity: S0 - Affects critical data or functionality and leaves users without workaround.
  • Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
  • Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
  • Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
  • Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.
Copy link

m2-assistant bot commented Jul 15, 2024

Hi @Jakhotiya. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, Add a comment to the issue:


Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

@engcom-Bravo engcom-Bravo added Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it Reported on 2.4.7 Indicates original Magento version for the Issue report. labels Jul 15, 2024
@engcom-Hotel engcom-Hotel moved this to Ready for Confirmation in Issue Confirmation and Triage Board Aug 19, 2024
@engcom-Hotel engcom-Hotel self-assigned this Sep 23, 2024
Copy link

m2-assistant bot commented Sep 23, 2024

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

  • 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
  • 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
  • 4. Verify that the issue is reproducible on 2.4-develop branch
    Details- If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
    - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
  • 5. Add label Issue: Confirmed once verification is complete.
  • 6. Make sure that automatic system confirms that report has been added to the backlog.

@engcom-Hotel
Copy link
Contributor

Hello @Jakhotiya,

Thanks for the report and collaboration!

We have tried to reproduce the issue in the latest development branch i.e. 2.4-develop and the issue has been reproducible for us.

Please refer to the below screenshots for reference:

In case after clearing cache access the admin panel and then access the frontend

image

In case after clearing cache directly access the frontend
image

Hence confirming the issue.

Thanks

@engcom-Hotel engcom-Hotel added Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Component: Csp Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Area: Content and removed Issue: ready for confirmation labels Sep 23, 2024
@github-jira-sync-bot
Copy link

✅ Jira issue https://jira.corp.adobe.com/browse/AC-13069 is successfully created for this GitHub issue.

Copy link

m2-assistant bot commented Sep 23, 2024

✅ Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

@NitrogenUA
Copy link
Contributor

@magento I am working on this

NitrogenUA added a commit to NitrogenUA/magento2 that referenced this issue Feb 28, 2025
…reates intermittent issue

- Implemented caching of CSP whitelist per website area.
NitrogenUA added a commit to NitrogenUA/magento2 that referenced this issue Feb 28, 2025
…reates intermittent issue

- Updated copyright notice.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Content Component: Csp Issue: Confirmed Gate 3 Passed. Manual verification of the issue completed. Issue is confirmed Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: ready for dev Reported on 2.4.7 Indicates original Magento version for the Issue report. Reproduced on 2.4.x The issue has been reproduced on latest 2.4-develop branch Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
None yet
5 participants