Skip to content

Cross-Compatible JSON Body Exclusion Ruleset for Different ModSecurity Versions #2942

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

Open
theMiddleBlue opened this issue Aug 10, 2023 · 2 comments
Labels
2.x Related to ModSecurity version 2.x 3.x Related to ModSecurity version 3.x

Comments

@theMiddleBlue
Copy link

Hello everyone,

Description:
I've come across an issue while working with different versions of ModSecurity (v2 and v3) and their respective variable names when parsing JSON bodies using the JSON body processor.

Problem:
The crux of the problem lies in the fact that v2 and v3 of ModSecurity employ distinct variable names during JSON body parsing. This discrepancy becomes particularly challenging when attempting to create an exclusion ruleset that works seamlessly across all ModSecurity versions. Currently, the only two viable options are duplicating ctl:remove* actions or duplicating rules. However, both of these alternatives demand more CPU consumption than necessary (other than possible -still unknown- security implications/bypass).

Example:
To illustrate this issue further, consider the following JSON body:

{"foo": [{"bar":"payload"}]}

In v2, the corresponding variable name would be: ARGS:foo.foo.bar
While in v3, it becomes: ARGS:json.foo.array_0.bar

If I'm not wrong, this means that I need a rule exclusion like:

SecRule REQUEST_URI "@beginsWith /mypath" "id:1234,\
  ctl:ruleRemoveTargetByTag=OWASP_CRS;ARGS:foo.foo.bar,\
  ctl:ruleRemoveTargetByTag=OWASP_CRS;ARGS:json.foo.array_0.bar,\
  ..."

If the array within the "foo" object in my example comprises 100 entries, it's quite clear that this would necessitate either 200 ctl actions or two distinct rules.

Are there other ways to do this?

If not: Proposed Solution

  • add an ARGS:json variable like v3 on v2
  • abstract the ARGS names on rule definition in order to have only 1 syntax
  • use JSON path syntax like: $.foo[0].bar or ARGS:json.foo[0].bar and would be awesome an ARGS:json.foo[].bar to select all entries of the "foo" array
@martinhsv
Copy link
Contributor

martinhsv commented Aug 10, 2023

Hi @theMiddleBlue ,

Another option could conceivably be to structure the exclude as a regex. E.g. something like:

/^(json\.)?foo\.((foo|array_0)\.)bar$/

Just doing a quick check with v3, It looks like one cannot currently do this with ctl:ruleRemoveTargetByTag. In principle, regex exclusions are supported via SecRuleUpdateTargetByTag (although current parser restrictions mean a couple of important regex special characters are not allowed, which may limit its usefulness even here).

@theMiddleBlue
Copy link
Author

I initially considered using regex, but I came to realize that v3 doesn't currently support it with ctl:ruleRemoveBy*. Frankly, this restriction is posing quite a challenge for us when it comes to excluding rules for APIs that heavily rely on JSON bodies. I'm curious, is it completely unfeasible to align v2's JSON variable names with those in v3?

@marcstern marcstern added 2.x Related to ModSecurity version 2.x 3.x Related to ModSecurity version 3.x labels Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Related to ModSecurity version 2.x 3.x Related to ModSecurity version 3.x
Projects
None yet
Development

No branches or pull requests

3 participants