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
Copy file name to clipboardExpand all lines: README.md
+11-9Lines changed: 11 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -57,15 +57,15 @@ As a dynamic library, don’t forget that libmodsecurity must be installed to a
57
57
58
58
### Unix (Linux, MacOS, FreeBSD, …)
59
59
60
-
On unix the project uses autotools to help the compilation process. Please note that if you work with `git`, do not forget to initialize submodules and update them. Here is a brief howto:
60
+
On unix the project uses autotools to help the compilation process. Please note that if you are working with `git`, don't forget to initialize and update the submodules. Here's a quick how-to:
The source tree has a Benchmark tool which can help to measure the library's performance. The tool is under the `test/benchmark/` directory. The build process also makes the binary here, so after the end of compiling you will have the tool.
248
+
The source tree includes a Benchmark tool that can help measure library performance. The tool is located in the test/benchmark/ directory. The build process also creates the binary here, so you will have the tool after the compilation is finished.
249
+
250
+
The source tree includes a Benchmark tool that can help measure library performance. The tool is located in the `test/benchmark/` directory. The build process also creates the binary here, so you will have the tool after the compilation is finished.
249
251
250
252
To run, just type:
251
253
@@ -273,7 +275,7 @@ user 0m0.337s
273
275
sys 0m0.022s
274
276
```
275
277
276
-
This is very fast because the benchmark uses the minimal `modsecurity.conf.default` configuration, which has not so much rules:
278
+
This is very fast because the benchmark uses the minimal `modsecurity.conf.default` configuration, which doesn't not too much rules:
277
279
278
280
```shell
279
281
$ cat basic_rules.conf
@@ -282,7 +284,7 @@ Include "../../modsecurity.conf-recommended"
282
284
283
285
```
284
286
285
-
To measure it with real rules, you should run one of the download scripts in the same directory:
287
+
To measure with real rules, run one of the download scripts in the same directory:
286
288
287
289
```shell
288
290
$ ./download-owasp-v3-rules.sh
@@ -309,13 +311,13 @@ Now the command will give much higher value.
309
311
310
312
#### How the benchark works
311
313
312
-
The tool is a simple embedding application which uses the library. It creates a ModSecurity and a RuleSet instance, then runs a loop with number of you passed. Creates a Transaction (object) and emulates real HTTP transactions.
314
+
The tool is a simple wrapper application that uses the library. Creates a ModSecurity instance and a RuleSet instance, then runs a loop with the passed number. Creates a Transaction (object) and emulates real HTTP transactions.
313
315
314
-
A transaction is a HTTP/1.1 GET request with a few GET parameters. Added common headers then the response: headers and an XML body. Between the phases it checks did any intervention happen or not. Every transaction is created with same data.
316
+
The transaction is an HTTP/1.1 GET request with some GET parameters. Added common headers then the response: headers and an XML body. Between phases it checks whether an intervention has taken place or not. All transactions are created with same data.
315
317
316
-
Note, that the tool does not call the last phase (logging).
318
+
Note that the tool does not call the last phase (logging).
317
319
318
-
Please don't forget to reset the `basic_rules.conf`content if you want to try it with another rule set.
320
+
Please remember to reset `basic_rules.conf` if you want to try with a different ruleset.
0 commit comments