You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The ModSecurity-nginx connector is the connection point between nginx and libmodsecurity (ModSecurity v3). Said another way, this project provides a communication channel between nginx and libmodsecurity. This connector is required to use LibModSecurity with nginx.
10
9
11
10
The ModSecurity-nginx connector takes the form of an nginx module. The module simply serves as a layer of communication between nginx and ModSecurity.
@@ -17,7 +16,7 @@ Notice that this project depends on libmodsecurity rather than ModSecurity (vers
17
16
The old version uses ModSecurity standalone, which is a wrapper for
18
17
Apache internals to link ModSecurity to nginx. This current version is closer
19
18
to nginx, consuming the new libmodsecurity which is no longer dependent on
20
-
Apache. As a result, This current version has less dependencies, fewer bugs, and is faster. In addition, Some new functionality is also provided - such as the possibility of use of global rules configuration with per directory/location customizations (e.g. SecRuleRemoveById).
19
+
Apache. As a result, this current version has less dependencies, fewer bugs, and is faster. In addition, some new functionality is also provided - such as the possibility of use of global rules configuration with per directory/location customizations (e.g. SecRuleRemoveById).
21
20
22
21
23
22
# Compilation
@@ -28,12 +27,13 @@ You can download it from the [ModSecurity git repository](https://github.com/Spi
28
27
With libmodsecurity installed, you can proceed with the installation of the ModSecurity-nginx connector, which follow the nginx 3rd party module installation procedure:
Further information about nginx 3rd party add-ons support are available here:
35
34
http://wiki.nginx.org/3rdPartyModules
36
35
36
+
37
37
# Usage
38
38
39
39
ModSecurity for nginx extends your nginx configuration directives. It adds four
@@ -48,7 +48,6 @@ modsecurity_rules_remote [server-key] [<url to rules>] - This directive is used
48
48
49
49
modsecurity_rules [<modsecurityrule>] - This directive allows for the direct inclusion of a ModSecurity rule into the nginx configuration.
50
50
51
-
52
51
### Usage example: injecting rules within nginx configuration
53
52
```
54
53
...
@@ -95,12 +94,14 @@ location / {
95
94
...
96
95
```
97
96
97
+
98
98
# Contributing
99
99
100
100
As an open source project we invite (and encourage) anyone from the community to contribute to our project. This may take the form of: new
101
101
functionality, bug fixes, bug reports, beginners user support, and anything else that you
102
102
are willing to help with. Thank you.
103
103
104
+
104
105
## Providing Patches
105
106
106
107
We prefer to have your patch within the GitHub infrastructure to facilitate our
@@ -146,7 +147,7 @@ If you are facing problems getting your added functionality to pass all the ngin
146
147
### Debugging
147
148
148
149
We respect the nginx debugging schema. By using the configuration option
149
-
“--with-debug” during the nginx configuration you will also be enabling the
150
+
"--with-debug" during the nginx configuration you will also be enabling the
150
151
connector's debug messages. Core dumps and crashes are expected to be debugged
151
152
in the same fashion that is used to debug nginx. For further information,
152
153
please check the nginx debugging information: http://wiki.nginx.org/Debugging
@@ -168,11 +169,13 @@ version of your libmodsecurity and the version of the nginx connector you are ru
168
169
Please do not publicly report any security issue. Instead, contact us at:
169
170
[email protected] to report the issue. Once the problem is fixed we will provide you with credit for the discovery.
170
171
172
+
171
173
## Feature Request
172
174
173
175
We would love to discuss any ideas that you may have for a new feature. Please keep in mind this is a community driven project so be sure to contact the community via the mailing list to get feedback first. Alternatively,
174
176
feel free to open GitHub issues requesting for new features. Before opening a new issue, please check if there is an existing feature request for the desired functionality.
175
177
178
+
176
179
## Packing
177
180
178
181
Having our packages in distros on time is something we highly desire. Let us know if
0 commit comments