fix: correct CRS 3 variable names and examples for CRS 4 - #300
Merged
Conversation
Five places contradicted crs-setup.conf.example or the current rule set: - tx.paranoia_level was renamed to tx.blocking_paranoia_level in CRS 4 and has no back-compatible alias, so the instruction to set it was a no-op - the 'executing paranoia level' is called the detection paranoia level, set with tx.detection_paranoia_level in rule 900001 - the 920160 example set tx.anomaly_score_pl1; the variable is tx.inbound_anomaly_score_pl1 - rule exclusion packages ship as plugins in CRS 4; tx.crs_exclusions_* no longer exists, and rule 900130 now initializes default collections - the sandbox sample output showed rule 980130, which is 980170 today Sandbox output and the replacement payload were captured from sandbox.coreruleset.org; posix_uname() no longer matches any rule.
Deploying crs-documentation with
|
| Latest commit: |
9a67d68
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ac54dba1.documentation-km5.pages.dev |
| Branch Preview URL: | https://docs-crs4-terminology-fixes.documentation-km5.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
what
corrects five places where the documentation contradicts
crs-setup.conf.exampleor the current rule set, all of them CRS 3 residue:2-2-paranoia_levels.md—tx.paranoia_level->tx.blocking_paranoia_level, in both the native-install and the vendor-integration paragraph2-2-paranoia_levels.md— the executing paranoia level is the detection paranoia level in CRS 4; renamed in the heading, body, example caption and image alt text, and the variable (tx.detection_paranoia_level, rule 900001) is now named so the section is actionable2-1-anomaly_scoring/index.md— the 920160 example settx.anomaly_score_pl1; the variable istx.inbound_anomaly_score_pl1.ver:in the same block said3.4.0-dev, updated to the release the site already references. The cross-reference to the paranoia level feature follows the rename2-3-false-positives-and-tuning.md— rule exclusion packages became plugins in CRS 4.tx.crs_exclusions_*no longer exists anywhere inrules/, and rule 900130 now initializes default collections, so the instructions and the three tip snippets were no-ops. Replaced with a pointer to the plugins page, which already documents the currentWebAppID/Hostscoping pattern6-4-using-the-crs-sandbox.md— sample output showed rule980130;RESPONSE-980-CORRELATION.confonly defines980170, and the message format changedwhy
each of these silently misleads. Setting
tx.paranoia_levelincrs-setup.confdoes nothing at all in CRS 4 — there is no back-compatible alias — so a reader following that paragraph stays at the default paranoia level believing they raised it. The exclusion-package instructions point at a rule ID that now controls an unrelated feature.1-1-crs-installation.mdalready states that exclusion packages were replaced by plugins, so the two pages disagreed with each other.the sandbox blocks were regenerated from live requests to sandbox.coreruleset.org rather than hand-edited. The
posix_uname()example no longer matches any rule, so that example usessystem()(933160) instead, with its real response.refs
crs-setup.conf.examplerules 900000, 900001, 900130rules/RESPONSE-980-CORRELATION.confnot changed here, but noticed while checking:
6-4-using-the-crs-sandbox.md"Default options" says the default CRS version is the latest release; the sandbox currently answers withx-backend: apache-v4-lts, and the backend table still listsapache-latest/apache-3_3_8as available valuescrs-setup.conf.exampleare not documented anywhere,tx.detection_paranoia_levelamong them — worth a reference page, but that is a bigger piece of work than this PRai disclosure
crs-setup.conf.examplesetting against the docs, the edits, and this descriptiontx.paranoia_levelandtx.crs_exclusions_*exist nowhere inrules/orcrs-setup.conf.example, that 900130 now setstx.enable_default_collections, and that 920160 setstx.inbound_anomaly_score_pl1; captured every sandbox sample from live requests, including the discovery thatposix_uname()no longer matches; ranhugo --minify,english_test.shandlycheeover the changed files, and verified in the built HTML that both newreflinks resolve and the#conditionally-enable-plugins-for-multi-application-environmentsanchor exists