Adding ModSecurity parameter for audit log format. #2583
+20
−0
Conversation
This file contains 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
Tamerz
requested review from
bastelfreak,
ekohl,
smortex and
a team
as code owners
smortex
reviewed
Dec 5, 2024
| @@ -36,6 +36,7 @@ | |||
|
|
|||
| $modsec_audit_log_parts = 'ABIJDEFHZ' | |||
| $modsec_audit_log_type = 'Serial' | |||
| $modsec_audit_log_format = 'Native' | |||
There was a problem hiding this comment.
Don't put the default value in params.pp
| @@ -143,6 +146,7 @@ | |||
| String $audit_log_relevant_status = '^(?:5|4(?!04))', | |||
| String $audit_log_parts = $apache::params::modsec_audit_log_parts, | |||
| String $audit_log_type = $apache::params::modsec_audit_log_type, | |||
| Enum['Native', 'JSON'] $audit_log_format = $apache::params::modsec_audit_log_format, | |||
There was a problem hiding this comment.
Put the default value here instead.
That way, the default value is correctly documented in the generated documentation.
| @@ -32,6 +32,9 @@ | |||
| # | |||
| # @param audit_log_type | |||
| # Defines the type of audit logging mechanism to be used. | |||
| # | |||
| # @param audit_log_format | |||
| # Defines what format the logs should be written in. Accepts `Native` and `JSON`. | |||
There was a problem hiding this comment.
No need to list accepted values, as the documentation include the data type (and the default value).
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.
Summary
Adds a parameter to set the audit log format to
JSONhttps://github.com/owasp-modsecurity/ModSecurity/wiki/Reference-Manual-(v2.x)#user-content-SecAuditLogFormat
Additional Context
Since as of the current version of ModSecurity, this can only have two values
NativeandJSON, andNativeis default, I decided only add the line if someone specifically sets the value toJSON. This means it shouldn't touch any existing config, especially on versions where this parameter may not exist.Checklist
puppet apply)