Add modsecurity log vars#374
Open
meirdev wants to merge 7 commits into
Open
Conversation
Adds two nginx variables usable in log_format / access_log: - $modsecurity_intervention: "1" if ModSecurity intervened, "0" otherwise - $modsecurity_triggered_rules: comma-separated IDs of all matched rules
Member
|
@meirdev: could you merge your branch with the current master? @Easton97-Jens fixed the workflow test, probably your PR will be okay now. |
There was a problem hiding this comment.
Pull request overview
Adds two nginx variables to the ModSecurity-nginx connector to improve correlation between nginx access logs and ModSecurity activity: $modsecurity_intervention (disruptive intervention flag) and $modsecurity_triggered_rules (matched rule IDs).
Changes:
- Registers two new nginx variables and exposes per-request values from the ModSecurity transaction/context.
- Tracks whether an intervention was triggered and formats triggered rule IDs into a comma-separated string.
- Adds a dedicated nginx-tests Perl test and documents the variables in README.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
src/ngx_http_modsecurity_module.c |
Adds variable registration + variable getters; sets ctx->intervention_triggered on intervention. |
tests/modsecurity-log-vars.t |
New nginx-tests coverage for both variables across pass/log-only/multi/allow/deny/redirect scenarios. |
README.md |
Documents the new variables and provides a sample log_format usage snippet. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
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
Add two variables to the module:
$modsecurity_interventionand$modsecurity_triggered_rules.$modsecurity_intervention: set to 1 if ModSecurity triggered a disruptive intervention.$modsecurity_triggered_rules: a comma-separated list of matched rule IDs.why
NGINX logs already contain a lot of useful data, but they don't include ModSecurity events. That makes it hard to correlate what you see in NGINX logs with what shows up in ModSecurity audit logs.
If you're sending logs to an "append-only" databsae, theres no easy way to correlate the two later. And trying to sync them beforehand usually means building a complex buffering and matching system.