PageCache/AccessList: Add CIDR support #37809

tdgroot · 2023-07-27T15:08:19Z

Description (*)

When accepting purge requests within a network, it's easier to just supply a CIDR range.

Related Pull Requests

None.

Fixed Issues (if relevant)

None.

Manual testing scenarios (*)

Go to Advanced -> System -> Full Page Cache -> Varnish Configuration
Configure a CIDR range like 172.16.0.1/24
Value should be valid and saved

Questions or comments

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

Resolved issues:

resolves [Issue] PageCache/AccessList: Add CIDR support #39953: PageCache/AccessList: Add CIDR support

m2-assistant · 2023-07-27T15:08:25Z

Hi @tdgroot. Thank you for your contribution!
Here are some useful tips on how you can test your changes using Magento test environment.

Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names.

Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

engcom-Hotel · 2025-05-30T03:55:51Z

@magento run all tests

engcom-Hotel · 2025-05-30T12:16:11Z

@magento create issue

engcom-Hotel · 2025-05-30T12:39:08Z

Hello @tdgroot,

Thanks for the contribution!

But as this is feature enhancement, we need a PO confirmation to proceed with this PR. We have started the process for the same. Meanwhile we are moving this PR On Hold.

Thanks

engcom-Hotel · 2025-06-02T04:43:01Z

@magento run all tests

engcom-Hotel · 2025-06-03T13:42:03Z

Hello @tdgroot,

We have received an approval for this PR for further evaluation. Hence moving it to appropriate bucket.

Thanks

engcom-Hotel

Hello @tdgroot,

Thank you for your contribution to add CIDR notation support to PageCache access lists. This is a valuable enhancement that would allow for more flexible IP-based access control.

However, the PR currently only modifies the validation pattern without implementing the actual CIDR functionality. For full CIDR support, we need changes in:

The component that performs IP matching against the access list
A utility method to properly compare an IP against a CIDR range

Thanks

engcom-Hotel · 2025-06-03T13:39:18Z

app/code/Magento/PageCache/Model/System/Config/Backend/AccessList.php

@@ -24,7 +24,7 @@ public function beforeSave()
        parent::beforeSave();

        $value = $this->getValue();
-        if (!is_string($value) || !preg_match('/^[\w\s\.\-\,\:]+$/', $value)) {
+        if (!is_string($value) || !preg_match('/^[\w\s\.\-\,\:(\/\d+)?]+$/', $value)) {


The pattern places (\/\d+)? inside a character class ([...]), which means these are treated as individual characters rather than a sequence.

The pattern remains overly permissive and would validate strings like "this is: a more / or less, valid string.... oh, lets add numbers 12345" which aren't valid IP addresses or CIDR notations

The extra CIDR validation regex should indeed be moved outside of the character class, so should become something like this: ^[\w\s\.\-\,\:]+(\/\d+)?$
Good remark!

Updated. The suffix is now outside of the character class and the regex is now applied for each item in the CSV list. Instead of accepting any /\d+, it is now limited from 0-32.

hostep · 2025-06-07T06:24:18Z

However, the PR currently only modifies the validation pattern without implementing the actual CIDR functionality. For full CIDR support, we need changes in:

The component that performs IP matching against the access list
A utility method to properly compare an IP against a CIDR range

That's not really true, the only place where we use this configuration value is over here:

magento2/app/code/Magento/PageCache/Model/Varnish/VclGenerator.php

Line 164 in 7da46f5

$this->getAccessList(),

Which is used to output the access list into the VCL file that Magento generates for Varnish.
Varnish already supports CIDR notation in ACL's, so there is no need for extra matching or parsing.

One thing that I'm not sure about, but maybe @tdgroot can clarify, is that the Varnish docs say to put the IP address in double quotes and the CIDR part outside of those quotes: https://varnish-cache.org/docs/trunk/users-guide/vcl-example-acls.html#acls
In this Magento code, the CIDR part would be included inside the double quotes. I have no idea if this will cause issues or will just work as expected?

engcom-Charlie · 2025-09-29T07:28:50Z

@magento run all tests

engcom-Charlie · 2025-09-29T09:32:45Z

@magento run all tests

engcom-Charlie · 2025-09-29T11:35:53Z

@magento run all tests

engcom-Charlie · 2025-10-06T10:35:11Z

@magento run all tests

engcom-Charlie · 2025-10-06T14:18:28Z

@magento run Functional Tests B2B, Functional Tests EE

engcom-Charlie · 2025-10-07T06:09:54Z

I have fixed all the static test failures, moving it to review again.

engcom-Bravo · 2025-10-08T08:50:39Z

@magento run all tests

engcom-Bravo · 2025-10-08T11:32:19Z

Hi @tdgroot,

Thanks for the collaboration & contribution!

✔️ QA Passed

Preconditions:

Install fresh Magento 2.4-develop

Manual testing scenarios

Go to Advanced -> System -> Full Page Cache -> Varnish Configuration
Configure a CIDR range like 172.16.0.1/24
Value should be valid and saved

Before: ✖️

After: ✔️

Configuration-Settings-Stores-Magento-Admin-10-08-2025_02_19_PM

Builds are failed. Hence, moving this PR to Extended Testing.

Thanks.

engcom-Charlie · 2025-10-08T12:46:44Z

@magento run Functional Tests B2B, Functional Tests EE, Functional Tests CE, WebAPI Tests

engcom-Charlie · 2025-10-09T12:09:54Z

Few Functional B2B, EE and CE failures in recent 2 builds are not consistent. They are neither part of this PR nor failing because of the PR changes, seems to be flaky. The consistent once are known issues hence moving it to Merge In Progress.

Functional B2B: Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37809/b46792f8f79789f47d0f5252d4f44669/Functional/allure-report-b2b/index.html#categories

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37809/54f64a76950f197112a7a5be56ff0d4d/Functional/allure-report-b2b/index.html#categories/39d2dfa67879cc2330ab48837fcc9a69/552cf7be275f72ba/

Functional CE: Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37809/280d82586ce776949380cc37509dd54b/Functional/allure-report-ce/index.html#categories/39d2dfa67879cc2330ab48837fcc9a69/503c1569de7685a8/

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37809/e5536f7d07e188433c76f75a1a4e9b05/Functional/allure-report-ce/index.html#categories/39d2dfa67879cc2330ab48837fcc9a69/a3314de085c9558c/

Functional EE: Run 1:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37809/3e148d881a5ec2d65f14fd60123f41b0/Functional/allure-report-ee/index.html#categories

Run 2:
https://public-results-storage-prod.magento-testing-service.engineering/reports/magento/magento2/pull/37809/70cd03d4a607d8bdb79df6d03d333af6/Functional/allure-report-ee/index.html#categories/3418275ac42b7ca8566f7871b42bcde6/1c61058d681db22b/

Known Issues:

ACQE-8846:StorefrontGuestCreateOrderWithConfigurableProductCustomStockTest
ACQE-8852:StorefrontReviewAndPaymentPageWithSimpleProductCustomStockTest
ACQE-8845:StorefrontGuestCreateOrderWithBundleProductCustomStockTest
ACQE-8847:StorefrontGuestCreateOrderWithGroupedProductCustomStockTest
ACQE-8655:AdminRmaSettingsConfigurationTest

tdgroot force-pushed the page_cache_acl_cidr branch from 24526c2 to 1c7183c Compare July 27, 2023 15:10

m2-community-project bot added the Progress: pending review label Jul 27, 2023

engcom-Hotel added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Aug 1, 2023

m2-assistant bot mentioned this pull request May 30, 2025

[Issue] PageCache/AccessList: Add CIDR support #39953

Closed

5 tasks

engcom-Hotel added the feature request label May 30, 2025

engcom-Hotel added this to Pull Requests Dashboard May 30, 2025

github-project-automation bot moved this to Pending Review in Pull Requests Dashboard May 30, 2025

engcom-Hotel moved this from Pending Review to On Hold in Pull Requests Dashboard May 30, 2025

ct-prd-projects-boards-automation bot added the Progress: on hold label May 30, 2025

engcom-Hotel added Triage: Need PO Confirmation Requirements should be clarified/approved/confirmed with Product Manager. Not ready for fix/delivery and removed Progress: on hold labels May 30, 2025

engcom-Hotel added Progress: on hold and removed Progress: pending review labels May 30, 2025

engcom-Hotel added Progress: review and removed Progress: on hold labels Jun 3, 2025

engcom-Hotel moved this from On Hold to Review in Progress in Pull Requests Dashboard Jun 3, 2025

engcom-Hotel requested changes Jun 3, 2025

View reviewed changes

engcom-Hotel removed the Triage: Need PO Confirmation Requirements should be clarified/approved/confirmed with Product Manager. Not ready for fix/delivery label Jun 3, 2025

engcom-Hotel moved this from Review in Progress to Changes Requested in Pull Requests Dashboard Jun 3, 2025

ct-prd-projects-boards-automation bot added Progress: needs update and removed Progress: review labels Jun 3, 2025

sinhaparul added the Project: Community Picked PRs upvoted by the community label Jun 10, 2025

ct-prd-projects-boards-automation bot added this to Community Dashboard Jun 10, 2025

Merge branch '2.4-develop' into page_cache_acl_cidr

de8645c

Fixed the static test failure

778a540

Fixed the statis failure

05be4fb

engcom-Charlie removed the Progress: needs update label Oct 7, 2025

ct-prd-projects-boards-automation bot added the Progress: review label Oct 7, 2025

ct-prd-projects-boards-automation bot moved this from Changes Requested to Review in Progress in Community Dashboard Oct 7, 2025

engcom-Hotel approved these changes Oct 7, 2025

View reviewed changes

ct-prd-projects-boards-automation bot removed the Progress: review label Oct 7, 2025

ct-prd-projects-boards-automation bot moved this from Review in Progress to Ready for Testing in Community Dashboard Oct 7, 2025

ct-prd-projects-boards-automation bot added the Progress: ready for testing label Oct 7, 2025

Merge branch '2.4-develop' into page_cache_acl_cidr

7c95825

engcom-Bravo moved this from Ready for Testing to Extended testing (optional) in Community Dashboard Oct 8, 2025

engcom-Charlie removed the Progress: ready for testing label Oct 9, 2025

engcom-Charlie moved this from Extended testing (optional) to Merge in Progress in Community Dashboard Oct 9, 2025

engcom-Charlie added the Progress: deployment queue label Oct 10, 2025

Merge branch '2.4-develop' into page_cache_acl_cidr

725d333

magento-devops-reposync-svc merged commit b62122d into magento:2.4-develop Nov 4, 2025
1 check passed

ct-prd-projects-boards-automation bot moved this from Merge in Progress to Recently Merged in Community Dashboard Nov 4, 2025

tdgroot deleted the page_cache_acl_cidr branch November 4, 2025 08:38

engcom-Charlie removed the Progress: deployment queue label Nov 4, 2025

PageCache/AccessList: Add CIDR support #37809

PageCache/AccessList: Add CIDR support #37809

Uh oh!

Conversation

tdgroot commented Jul 27, 2023 • edited by m2-assistant bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

Resolved issues:

Uh oh!

m2-assistant bot commented Jul 27, 2023

Uh oh!

engcom-Hotel commented May 30, 2025

Uh oh!

engcom-Hotel commented May 30, 2025

Uh oh!

engcom-Hotel commented May 30, 2025

Uh oh!

engcom-Hotel commented Jun 2, 2025

Uh oh!

engcom-Hotel commented Jun 3, 2025

Uh oh!

engcom-Hotel left a comment

Choose a reason for hiding this comment

Uh oh!

engcom-Hotel Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

hostep Jun 7, 2025

Choose a reason for hiding this comment

Uh oh!

tdgroot Aug 24, 2025

Choose a reason for hiding this comment

Uh oh!

hostep commented Jun 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

engcom-Charlie commented Sep 29, 2025

Uh oh!

engcom-Charlie commented Sep 29, 2025

Uh oh!

engcom-Charlie commented Sep 29, 2025

Uh oh!

engcom-Charlie commented Oct 6, 2025

Uh oh!

engcom-Charlie commented Oct 6, 2025

Uh oh!

engcom-Charlie commented Oct 7, 2025

Uh oh!

engcom-Bravo commented Oct 8, 2025

Uh oh!

engcom-Bravo commented Oct 8, 2025

✔️ QA Passed

Uh oh!

engcom-Charlie commented Oct 8, 2025

Uh oh!

engcom-Charlie commented Oct 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

tdgroot commented Jul 27, 2023 •

edited by m2-assistant bot

Loading

hostep commented Jun 7, 2025 •

edited

Loading

engcom-Charlie commented Oct 9, 2025 •

edited

Loading