File: modsecurity2-apache-reference.xml

package info (click to toggle)
libapache-mod-security 2.5.12-1%2Bsqueeze4
  • links: PTS
  • area: main
  • in suites: squeeze-lts
  • size: 6,292 kB
  • ctags: 2,537
  • sloc: ansic: 21,266; sh: 6,512; xml: 6,320; perl: 1,653; makefile: 191
file content (6342 lines) | stat: -rw-r--r-- 255,479 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<article>
  <title><trademark class="registered">ModSecurity</trademark> Reference
  Manual</title>

  <articleinfo>
    <releaseinfo>Version 2.5.12 (Feb 3, 2010)</releaseinfo>

    <copyright>
      <year>2004-2010</year>

      <holder>Breach Security, Inc. (<ulink
      url="http://www.breach.com">http://www.breach.com</ulink>)</holder>
    </copyright>
  </articleinfo>

  <section id="introduction">
    <title>Introduction</title>

    <para>ModSecurity is a web application firewall (WAF). With over 70% of
    attacks now carried out over the web application level, organisations need
    all the help they can get in making their systems secure. WAFs are
    deployed to establish an increased external security layer to detect
    and/or prevent attacks before they reach web applications. ModSecurity
    provides protection from a range of attacks against web applications and
    allows for HTTP traffic monitoring and real-time analysis with little or
    no changes to existing infrastructure.</para>

    <section>
      <title>HTTP Traffic Logging</title>

      <para>Web servers are typically well-equipped to log traffic in a form
      useful for marketing analyses, but fall short logging traffic to web
      applications. In particular, most are not capable of logging the request
      bodies. Your adversaries know this, and that is why most attacks are now
      carried out via POST requests, rendering your systems blind. ModSecurity
      makes full HTTP transaction logging possible, allowing complete requests
      and responses to be logged. Its logging facilities also allow
      fine-grained decisions to be made about exactly what is logged and when,
      ensuring only the relevant data is recorded. As some of the request
      and/or response may contain sensitive data in certain fields,
      ModSecurity can be configured to mask these fields before they are
      written to the audit log.</para>
    </section>

    <section>
      <title>Real-Time Monitoring and Attack Detection</title>

      <para>In addition to providing logging facilities, ModSecurity can
      monitor the HTTP traffic in real time in order to detect attacks. In
      this case, ModSecurity operates as a web intrusion detection tool,
      allowing you to react to suspicious events that take place at your web
      systems.</para>
    </section>

    <section>
      <title>Attack Prevention and Just-in-time Patching</title>

      <para>ModSecurity can also act immediately to prevent attacks from
      reaching your web applications. There are three commonly used
      approaches:</para>

      <orderedlist continuation="restarts" inheritnum="ignore">
        <listitem>
          <para>Negative security model. A negative security model monitors
          requests for anomalies, unusual behaviour, and common web
          application attacks. It keeps anomaly scores for each request, IP
          addresses, application sessions, and user accounts. Requests with
          high anomaly scores are either logged or rejected altogether.</para>
        </listitem>

        <listitem>
          <para>Positive security model. When a positive security model is
          deployed, only requests that are known to be valid are accepted,
          with everything else rejected. This model requires knownledge of the
          web applications you are protecting. Therefore a positive security
          model works best with applications that are heavily used but rarely
          updated so that maintenance of the model is minimized.</para>
        </listitem>

        <listitem>
          <para>Known weaknesses and vulnerabilities. Its rule language makes
          ModSecurity an ideal external patching tool. External patching
          (sometimes referred to as Virtual Patching) is about reducing the
          window of opportunity. Time needed to patch application
          vulnerabilities often runs to weeks in many organisations. With
          ModSecurity, applications can be patched from the outside, without
          touching the application source code (and even without any access to
          it), making your systems secure until a proper patch is applied to
          the application.</para>
        </listitem>
      </orderedlist>
    </section>

    <section>
      <title>Flexible Rule Engine</title>

      <para>A flexible rule engine sits in the heart of ModSecurity. It
      implements the ModSecurity Rule Language, which is a specialised
      programming language designed to work with HTTP transaction data. The
      ModSecurity Rule Language is designed to be easy to use, yet flexible:
      common operations are simple while complex operations are possible.
      Certified ModSecurity Rules, included with ModSecurity, contain a
      comprehensive set of rules that implement general-purpose hardening,
      protocol validation and detection of common web application security
      issues. Heavily commented, these rules can be used as a learning
      tool.</para>
    </section>

    <section>
      <title>Embedded-mode Deployment</title>

      <para>ModSecurity is an embeddable web application firewall, which means
      it can be deployed as part of your existing web server infrastructure
      provided your web servers are Apache-based. This deployment method has
      certain advantages:</para>

      <orderedlist continuation="restarts" inheritnum="ignore">
        <listitem>
          <para>No changes to existing network. It only takes a few minutes to
          add ModSecurity to your existing web servers. And because it was
          designed to be completely passive by default, you are free to deploy
          it incrementally and only use the features you need. It is equally
          easy to remove or deactivate it if required.</para>
        </listitem>

        <listitem>
          <para>No single point of failure. Unlike with network-based
          deployments, you will not be introducing a new point of failure to
          your system.</para>
        </listitem>

        <listitem>
          <para>Implicit load balancing and scaling. Because it works embedded
          in web servers, ModSecurity will automatically take advantage of the
          additional load balancing and scalability features. You will not
          need to think of load balancing and scaling unless your existing
          system needs them.</para>
        </listitem>

        <listitem>
          <para>Minimal overhead. Because it works from inside the web server
          process there is no overhead for network communication and minimal
          overhead in parsing and data exchange.</para>
        </listitem>

        <listitem>
          <para>No problem with encrypted or compressed content. Many IDS
          systems have difficulties analysing SSL traffic. This is not a
          problem for ModSecurity because it is positioned to work when the
          traffic is decrypted and decompressed.</para>
        </listitem>
      </orderedlist>
    </section>

    <section>
      <title>Network-based Deployment</title>

      <para>ModSecurity works equally well when deployed as part of an
      Apache-based reverse proxy server, and many of our customers choose to
      do so. In this scenario, one installation of ModSecurity can protect any
      number of web servers (even the non-Apache ones).</para>
    </section>

    <section>
      <title>Portability</title>

      <para>ModSecurity is known to work well on a wide range of operating
      systems. Our customers are successfully running it on Linux, Windows,
      Solaris, FreeBSD, OpenBSD, NetBSD, AIX, Mac OS X, and HP-UX.</para>
    </section>

    <section id="licensing">
      <title>Licensing</title>

      <para>ModSecurity is available under two licenses. Users can choose to
      use the software under the terms of the GNU General Public License
      version 2 (licence text is included with the distribution), as an Open
      Source / Free Software product. A range of commercial licenses is also
      available, together with a range of commercial support contracts. For
      more information on commercial licensing please contact Breach
      Security.</para>

      <note>
        <para>ModSecurity, mod_security, ModSecurity Pro, and ModSecurity Core
        Rules are trademarks or registered trademarks of Breach Security,
        Inc.</para>
      </note>
    </section>
  </section>

  <section>
    <title><trademark>ModSecurity Core Rules</trademark></title>

    <section>
      <title>Overview</title>

      <para>ModSecurity is a web application firewall engine that provides
      very little protection on its own. In order to become useful,
      ModSecurity must be configured with rules. In order to enable users to
      take full advantage of ModSecurity out of the box, Breach Security, Inc.
      is providing a free certified rule set for ModSecurity 2.x. Unlike
      intrusion detection and prevention systems, which rely on signatures
      specific to known vulnerabilities, the Core Rules provide generic
      protection from unknown vulnerabilities often found in web applications,
      which are in most cases custom coded. The Core Rules are heavily
      commented to allow it to be used as a step-by-step deployment guide for
      ModSecurity. The latest Core Rules can be found at the ModSecurity
      website - <ulink
      url="http://www.modsecurity.org/projects/rules/">http://www.modsecurity.org/projects/rules/</ulink>.</para>
    </section>

    <section>
      <title>Core Rules Content</title>

      <para>In order to provide generic web applications protection, the Core
      Rules use the following techniques:</para>

      <itemizedlist>
        <listitem>
          <para>HTTP protection - detecting violations of the HTTP protocol
          and a locally defined usage policy.</para>
        </listitem>

        <listitem>
          <para>Common Web Attacks Protection - detecting common web
          application security attack.</para>
        </listitem>

        <listitem>
          <para>Automation detection - Detecting bots, crawlers, scanners and
          other surface malicious activity.</para>
        </listitem>

        <listitem>
          <para>Trojan Protection - Detecting access to Trojans horses.</para>
        </listitem>

        <listitem>
          <para>Error Hiding - Disguising error messages sent by the
          server.</para>
        </listitem>
      </itemizedlist>
    </section>
  </section>

  <section id="installation">
    <title>Installation</title>

    <para>ModSecurity installation requirements:</para>

    <orderedlist continuation="restarts" inheritnum="ignore">
      <listitem>
        <para>ModSecurity 2.x works only with Apache 2.0.x or higher. Version
        2.2.x is highly recommended.</para>
      </listitem>

      <listitem>
        <para>Make sure you have <literal
        moreinfo="none">mod_unique_id</literal> installed.</para>

        <para>mod_unique_id is packaged with Apache httpd.</para>
      </listitem>

      <listitem>
        <para>libapr and libapr-util</para>

        <para><ulink type=""
        url="http://apr.apache.org/">http://apr.apache.org/</ulink></para>
      </listitem>

      <listitem>
        <para>libpcre</para>

        <para><ulink type=""
        url="http://www.pcre.org/">http://www.pcre.org/</ulink></para>
      </listitem>

      <listitem>
        <para>libxml2</para>

        <para><ulink type=""
        url="http://xmlsoft.org/downloads.html">http://xmlsoft.org/downloads.html</ulink></para>
      </listitem>

      <listitem>
        <para>liblua v5.1.x</para>

        <para>This library is optional and only needed if you will be using
        the new Lua engine.</para>

        <para><ulink type=""
        url="http://www.lua.org/download.html">http://www.lua.org/download.html</ulink></para>

        <para>Note that ModSecurity requires the dynamic libraries. These are
        not built by default in the source distribution, so the binary
        distribution is recommended.</para>
      </listitem>

      <listitem>
        <para>libcurl v7.15.1 or higher</para>

        <para>If you will be using the ModSecurity Log Collector (mlogc) to
        send audit logs to a central repository, then you will also need the
        curl library.</para>

        <para><ulink type=""
        url="http://curl.haxx.se/libcurl/">http://curl.haxx.se/libcurl/</ulink></para>

        <note>
          <para>Many have had issues with libcurl linked with the GnuTLS
          library for SSL/TLS support. It is recommended that the openssl
          library be used for SSL/TLS support in libcurl.</para>
        </note>
      </listitem>
    </orderedlist>

    <para>ModSecurity installation consists of the following steps:</para>

    <orderedlist continuation="restarts" inheritnum="ignore">
      <listitem>
        <para>Stop Apache httpd</para>
      </listitem>

      <listitem>
        <para>Unpack the ModSecurity archive</para>
      </listitem>

      <listitem>
        <para>Building differs for UNIX (or UNIX-like) operating systems and
        Windows.</para>

        <itemizedlist>
          <listitem>
            <para>UNIX</para>

            <orderedlist>
              <listitem>
                <para>Run the configure script to generate a Makefile.
                Typically no options are needed.</para>

                <para><literal>./configure</literal></para>

                <para>Options are available for more customization (use
                <literal>./configure --help</literal> for a full list), but
                typically you will only need to specify the location of the
                <literal>apxs</literal> command installed by Apache httpd with
                the <literal>--with-apxs</literal> option.</para>

                <para><literal>./configure
                --with-apxs=/path/to/httpd-2.x.y/bin/apxs</literal></para>

                <note>
                  <para>There are certain configure options that are meant for
                  debugging an other development use. If enabled, these
                  options can substantially impact performance. These options
                  include all <literal>--debug-*</literal> options as well as
                  the <literal>--enable-performance-measurements</literal>
                  options.</para>
                </note>
              </listitem>

              <listitem>
                <para>Compile with: <literal>make</literal></para>
              </listitem>

              <listitem>
                <para>Optionally test with: <literal>make
                test</literal></para>

                <note>
                  <para>This is step is still a bit experimental. If you have
                  problems, please send the full output and error from the
                  build to the support list. Most common issues are related to
                  not finding the required headers and/or libraries.</para>
                </note>
              </listitem>

              <listitem>
                <para>Optionally build the ModSecurity Log Collector with:
                <literal>make mlogc</literal></para>
              </listitem>

              <listitem>
                <para>Optionally install <literal>mlogc</literal>: Review the
                <literal>INSTALL</literal> file included in the
                apache2/mlogc-src directory in the distribution.</para>
              </listitem>

              <listitem>
                <para>Install the ModSecurity module with: <literal>make
                install</literal></para>
              </listitem>
            </orderedlist>
          </listitem>

          <listitem>
            <para>Windows (MS VC++ 8)</para>

            <orderedlist>
              <listitem>
                <para>Edit <literal>Makefile.win</literal> to configure the
                Apache base and library paths.</para>
              </listitem>

              <listitem>
                <para>Compile with: <literal>nmake -f
                Makefile.win</literal></para>
              </listitem>

              <listitem>
                <para>Install the ModSecurity module with: <literal>nmake -f
                Makefile.win install</literal></para>
              </listitem>

              <listitem>
                <para>Copy the <literal>libxml2.dll</literal> and
                <literal>lua5.1.dll</literal> to the Apache
                <literal>bin</literal> directory. Alternatively you can follow
                the step below for using LoadFile to load these
                libraries.</para>
              </listitem>
            </orderedlist>
          </listitem>
        </itemizedlist>
      </listitem>

      <listitem>
        <para>Edit the main Apache httpd config file (usually
        <literal>httpd.conf</literal>)</para>

        <para>On UNIX (and Windows if you did not copy the DLLs as stated
        above) you must load libxml2 and lua5.1 before ModSecurity with
        something like this:</para>

        <para><programlisting>LoadFile /usr/lib/libxml2.so
LoadFile /usr/lib/liblua5.1.so</programlisting></para>

        <para>Load the ModSecurity module with:<programlisting>LoadModule security2_module modules/mod_security2.so</programlisting></para>
      </listitem>

      <listitem>
        <para>Configure ModSecurity</para>
      </listitem>

      <listitem>
        <para>Start Apache httpd</para>
      </listitem>

      <listitem>
        <para>You should now have ModSecurity 2.x up and running.</para>
      </listitem>
    </orderedlist>

    <note>
      <para>If you have compiled Apache yourself you might experience problems
      compiling ModSecurity against PCRE. This is because Apache bundles PCRE
      but this library is also typically provided by the operating system. I
      would expect most (all) vendor-packaged Apache distributions to be
      configured to use an external PCRE library (so this should not be a
      problem).</para>

      <para>You want to avoid Apache using the bundled PCRE library and
      ModSecurity linking against the one provided by the operating system.
      The easiest way to do this is to compile Apache against the PCRE library
      provided by the operating system (or you can compile it against the
      latest PCRE version you downloaded from the main PCRE distribution
      site). You can do this at configure time using the<literal
      moreinfo="none"> --with-pcre</literal> switch. If you are not in a
      position to recompile Apache, then, to compile ModSecurity successfully,
      you'd still need to have access to the bundled PCRE headers (they are
      available only in the Apache source code) and change the include path
      for ModSecurity (as you did in step 7 above) to point to them (via the
      <literal>--with-pcre</literal> ModSecurity configure option).</para>

      <para>Do note that if your Apache is using an external PCRE library you
      can compile ModSecurity with <literal
      moreinfo="none">WITH_PCRE_STUDY</literal> defined,which would possibly
      give you a slight performance edge in regular expression
      processing.</para>

      <para>Non-gcc compilers may have problems running out-of-the-box as the
      current build system was designed around the gcc compiler and some
      compiler/linker flags may differ. To use a non-gcc compiler you may need
      some manual Makefile tweaks if issues cannot be solved by exporting
      custom CFLAGS and CPPFLAGS environment variables.</para>

      <para>If you are upgrading from ModSecurity 1.x, please refer to the
      migration matrix at <ulink type=""
      url="http://www.modsecurity.org/documentation/ModSecurity-Migration-Matrix.pdf">http://www.modsecurity.org/documentation/ModSecurity-Migration-Matrix.pdf</ulink></para>
    </note>
  </section>

  <section id="configuration-directives">
    <title>Configuration Directives</title>

    <para>The following section outlines all of the ModSecurity directives.
    Most of the ModSecurity directives can be used inside the various Apache
    Scope Directives such as <literal>VirtualHost</literal>,
    <literal>Location</literal>, <literal>LocationMatch</literal>,
    <literal>Directory</literal>, etc... There are others, however, that can
    only be used once in the main configuration file. This information is
    specified in the Scope sections below. The first version to use a given
    directive is given in the Version sections below.</para>

    <para>These rules, along with the Core rules files, should be contained is
    files outside of the httpd.conf file and called up with Apache "Include"
    directives. This allows for easier updating/migration of the rules. If you
    create your own custom rules that you would like to use with the Core
    rules, you should create a file called -
    <filename>modsecurity_crs_15_customrules.conf</filename> and place it in
    the same directory as the Core rules files. By using this file name, your
    custom rules will be called up after the standard ModSecurity Core rules
    configuration file but before the other Core rules. This allows your rules
    to be evaluated first which can be useful if you need to implement
    specific "allow" rules or to correct any false positives in the Core rules
    as they are applied to your site.</para>

    <note>
      <para>It is highly encouraged that you do not edit the Core rules files
      themselves but rather place all changes (such as
      <literal>SecRuleRemoveByID</literal>, etc...) in your custom rules file.
      This will allow for easier upgrading as newer Core rules are released by
      Breach Security on the ModSecurity website.</para>
    </note>

    <section>
      <title><literal>SecAction</literal></title>

      <para><emphasis>Description:</emphasis> Unconditionally processes the
      action list it receives as the first and only parameter. It accepts one
      parameter, the syntax of which is identical to the third parameter
      of<literal moreinfo="none"> SecRule</literal>.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecAction
      action1,action2,action3</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAction
      nolog,phase:1,initcol:RESOURCE=%{REQUEST_FILENAME}</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para>SecAction is best used when you unconditionally execute an action.
      This is explicit triggering whereas the normal Actions are conditional
      based on data inspection of the request/response. This is a useful
      directive when you want to run certain actions such as
      <literal>initcol</literal> to initialize collections.</para>
    </section>

    <section>
      <title><literal>SecArgumentSeparator</literal></title>

      <para><emphasis>Description:</emphasis> Specifies which character to use
      as separator for<literal moreinfo="none">
      application/x-www-form-urlencoded</literal> content. Defaults to
      <literal moreinfo="none">&amp;</literal>. Applications are sometimes
      (very rarely) written to use a semicolon (<literal
      moreinfo="none">;</literal>).</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecArgumentSeparator character</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecArgumentSeparator ;</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Main</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para>This directive is needed if a backend web application is using a
      non-standard argument separator. If this directive is not set properly
      for each web application, then ModSecurity will not be able to parse the
      arguments appropriately and the effectiveness of the rule matching will
      be significantly decreased.</para>
    </section>

    <section>
      <title><literal>SecAuditEngine</literal></title>

      <para><emphasis>Description:</emphasis> Configures the audit logging
      engine.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecAuditEngine On|Off|RelevantOnly</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditEngine On</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Can be set/changed with
      the "<literal>ctl</literal>" action for the current transaction.</para>

      <para>Example: The following example shows the various audit directives
      used together.</para>

      <programlisting format="linespecific"><emphasis>SecAuditEngine RelevantOnly</emphasis> 
SecAuditLog logs/audit/audit.log
SecAuditLogParts ABCFHZ
SecAuditLogType concurrent
SecAuditLogStorageDir logs/audit
<emphasis>SecAuditLogRelevantStatus ^(?:5|4\d[^4])</emphasis></programlisting>

      <para>Possible values are:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">On</literal> - log all transactions
          by default.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Off</literal> - do not log
          transactions by default.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">RelevantOnly</literal> - by default
          only log transactions that have triggered a warning or an error, or
          have a status code that is considered to be relevant (see<literal
          moreinfo="none"> SecAuditLogRelevantStatus</literal>).</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecAuditLog</literal></title>

      <para><emphasis>Description:</emphasis> Defines the path to the main
      audit log file.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecAuditLog
      /path/to/auditlog</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditLog
      /usr/local/apache/logs/audit.log</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This file is open on
      startup when the server typically still runs as<emphasis>
      root</emphasis>. You should not allow non-root users to have write
      privileges for this file or for the directory it is stored in..</para>

      <para>This file will be used to store the audit log entries if serial
      audit logging format is used. If concurrent audit logging format is used
      this file will be used as an index, and contain a record of all audit
      log files created. If you are planning to use Concurrent audit logging
      and sending your audit log data off to a remote Console host or
      commercial ModSecurity Management Appliance, then you will need to
      configure and use the ModSecurity Log Collector (mlogc) and use the
      following format for the audit log:</para>

      <para><programlisting format="linespecific">SecAuditLog "|/path/to/mlogc /path/to/mlogc.conf"</programlisting></para>
    </section>

    <section>
      <title><literal>SecAuditLog2</literal></title>

      <para><emphasis>Description:</emphasis> Defines the path to the
      secondary audit log index file when concurrent logging is enabled. See
      <literal moreinfo="none">SecAuditLog2</literal> for more details.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecAuditLog2
      /path/to/auditlog2</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditLog2
      /usr/local/apache/logs/audit2.log</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.1.2</para>

      <para><emphasis>Dependencies/Notes:</emphasis> A main audit log must be
      defined via <literal moreinfo="none">SecAuditLog</literal> before this
      directive may be used. Additionally, this log is only used for
      replicating the main audit log index file when concurrent audit logging
      is used. It will <emphasis>not</emphasis> be used for non-concurrent
      audit logging.</para>
    </section>

    <section>
      <title><literal>SecAuditLogDirMode</literal></title>

      <para><emphasis>Description:</emphasis> Configures the mode
      (permissions) of any directories created for concurrent audit logs using
      an octal mode (as used in chmod). See <literal
      moreinfo="none">SecAuditLogFileMode</literal> for controlling the mode
      of audit log files.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecAuditLogDirMode octal_mode|"default"</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditLogDirMode 02750</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.10</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This feature is not
      available on operating systems not supporting octal file modes. The
      default mode (0600) only grants read/write access to the account writing
      the file. If access from another account is needed (using mpm-itk is a
      good example), then this directive may be required. However, use this
      directive with caution to avoid exposing potentially sensitive data to
      unauthorized users. Using the value "default" will revert back to the
      default setting.</para>

      <note>
        <para>The process umask may still limit the mode if it is being more
        restrictive than the mode set using this directive.</para>
      </note>
    </section>

    <section>
      <title><literal>SecAuditLogFileMode</literal></title>

      <para><emphasis>Description:</emphasis> Configures the mode
      (permissions) of any files created for concurrent audit logs using an
      octal mode (as used in chmod). See <literal
      moreinfo="none">SecAuditLogDirMode</literal> for controlling the mode of
      created audit log directories.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecAuditLogFileMode
      octal_mode|"default"</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditLogFileMode 00640</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.10</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This feature is not
      available on operating systems not supporting octal file modes. The
      default mode (0600) only grants read/write access to the account writing
      the file. If access from another account is needed (using mpm-itk is a
      good example), then this directive may be required. However, use this
      directive with caution to avoid exposing potentially sensitive data to
      unauthorized users. Using the value "default" will revert back to the
      default setting.</para>

      <note>
        <para>The process umask may still limit the mode if it is being more
        restrictive than the mode set using this directive.</para>
      </note>
    </section>

    <section>
      <title><literal>SecAuditLogParts</literal></title>

      <para><emphasis>Description:</emphasis> Defines which part of each
      transaction are going to be recorded in audit log. Each part is assigned
      a single letter. If a letter appears in the list then the equivalent
      part of each transactions will be recorded. See below for the list of
      all parts.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecAuditLogParts PARTS</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditLogParts ABCFHZ</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> At this time ModSecurity
      does not log response bodies of stock Apache responses (e.g. <literal
      moreinfo="none">404</literal>), or the <literal
      moreinfo="none">Server</literal> and <literal
      moreinfo="none">Date</literal> response headers.</para>

      <para>Default:<literal moreinfo="none"> ABCFHZ</literal>.</para>

      <note>
        <para>Please refer to the ModSecurity Data Formats document for a
        detailed description of every available part.</para>
      </note>

      <para>Available audit log parts:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">A</literal> - audit log header
          (mandatory)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">B</literal> - request headers</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">C</literal> - request body (present
          only if the request body exists and ModSecurity is configured to
          intercept it)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">D</literal> - RESERVED for
          intermediary response headers, not implemented yet.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">E</literal> - intermediary response
          body (present only if ModSecurity is configured to intercept
          response bodies, and if the audit log engine is configured to record
          it). Intermediary response body is the same as the actual response
          body unless ModSecurity intercepts the intermediary response body,
          in which case the actual response body will contain the error
          message (either the Apache default error message, or the
          ErrorDocument page).</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">F</literal> - final response headers
          (excluding the Date and Server headers, which are always added by
          Apache in the late stage of content delivery).</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">G</literal> - RESERVED for the actual
          response body, not implemented yet.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">H</literal> - audit log
          trailer</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">I</literal> - This part is a
          replacement for part C. It will log the same data as C in all cases
          except when <literal moreinfo="none">multipart/form-data</literal>
          encoding in used. In this case it will log a fake <literal
          moreinfo="none">application/x-www-form-urlencoded</literal> body
          that contains the information about parameters but not about the
          files. This is handy if you don't want to have (often large) files
          stored in your audit logs.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">J</literal> - RESERVED. This part,
          when implemented, will contain information about the files uploaded
          using <literal>multipart/form-data</literal> encoding.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">K</literal> - This part contains a
          full list of every rule that matched (one per line) in the order
          they were matched. The rules are fully qualified and will thus show
          inherited actions and default operators. Supported as of
          v2.5.0</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Z</literal> - final boundary,
          signifies the end of the entry (mandatory)</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecAuditLogRelevantStatus</literal></title>

      <para><emphasis>Description:</emphasis> Configures which response status
      code is to be considered relevant for the purpose of audit
      logging.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecAuditLogRelevantStatus REGEX</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditLogRelevantStatus
      ^(?:5|4\d[^4])</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Must have the
      <literal>SecAuditEngine</literal> set to
      <literal>RelevantOnly</literal>. The parameter is a regular
      expression.</para>

      <para>The main purpose of this directive is to allow you to configure
      audit logging for only transactions that generate the specified HTTP
      Response Status Code. This directive is often used to the decrease the
      total size of the audit log file. Keep in mind that if this parameter is
      used, then successful attacks that result in a 200 OK status code will
      not be logged.</para>
    </section>

    <section>
      <title><literal>SecAuditLogStorageDir</literal></title>

      <para><emphasis>Description:</emphasis> Configures the storage directory
      where concurrent audit log entries are to be stored.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecAuditLogStorageDir
      /path/to/storage/dir</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditLogStorageDir
      /usr/local/apache/logs/audit</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> SecAuditLogType must be
      set to Concurrent. The directory must already be created before starting
      Apache and it must be writable by the web server user as new files are
      generated at runtime.</para>

      <para>As with all logging mechanisms, ensure that you specify a file
      system location that has adequate disk space and is not on the root
      partition.</para>
    </section>

    <section>
      <title><literal>SecAuditLogType</literal></title>

      <para><emphasis>Description:</emphasis> Configures the type of audit
      logging mechanism to be used.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecAuditLogType Serial|Concurrent</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecAuditLogType Serial</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Must specify
      <literal>SecAuditLogStorageDir</literal> if you use concurrent
      logging.</para>

      <para>Possible values are:</para>

      <orderedlist continuation="restarts" inheritnum="ignore">
        <listitem>
          <para><literal moreinfo="none">Serial</literal> - all audit log
          entries will be stored in the main audit logging file. This is more
          convenient for casual use but it is slower as only one audit log
          entry can be written to the file at any one file.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Concurrent</literal> - audit log
          entries will be stored in separate files, one for each transaction.
          Concurrent logging is the mode to use if you are going to send the
          audit log data off to a remote ModSecurity Console host.</para>
        </listitem>
      </orderedlist>
    </section>

    <section>
      <title><literal>SecCacheTransformations</literal>
      (Deprecated/Experimental)</title>

      <para><emphasis>Description:</emphasis> Controls caching of
      transformations. Caching is off by default starting with 2.5.6, when it
      was deprecated and downgraded back to experimental.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecCacheTransformations On|Off
      [options]</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecCacheTransformations On
      "minlen:64,maxlen:0"</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> N/A</para>

      <para>First parameter:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">On</literal> - cache transformations
          (per transaction, per phase) allowing identical transformations to
          be performed only once. (default)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Off</literal> - do not cache any
          transformations, forcing all transformations to be performed for
          each rule executed.</para>
        </listitem>
      </itemizedlist>

      <para>The following options are allowed (comma separated):</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">incremental:on|off</literal> -
          enabling this option will cache every transformation instead of just
          the final transformation. (default: off)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">maxitems:N</literal> - do not allow
          more than N transformations to be cached. The cache will then be
          disabled. A zero value is interpreted as "unlimited". This option
          may be useful to limit caching for a form with a large number of
          ARGS. (default: 512)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">minlen:N</literal> - do not cache the
          transformation if the value's length is less than N bytes. (default:
          32)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">maxlen:N</literal> - do not cache the
          transformation if the value's length is more than N bytes. A zero
          value is interpreted as "unlimited". (default: 1024)</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecChrootDir</literal></title>

      <para><emphasis>Description:</emphasis> Configures the directory path
      that will be used to jail the web server process.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecChrootDir
      /path/to/chroot/dir</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecChrootDir /chroot</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Main</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This feature is not
      available on Windows builds. The internal chroot functionality provided
      by ModSecurity works great for simple setups. One example of a simple
      setup is Apache serving static files only, or running scripts using
      modules.builds. Some problems you might encounter with more complex
      setups:</para>

      <orderedlist>
        <listitem>
          <para>DNS lookups do not work (this is because this feature requires
          a shared library that is loaded on demand, after chroot takes
          place).</para>
        </listitem>

        <listitem>
          <para>You cannot send email from PHP because it uses sendmail and
          sendmail is outside the jail.</para>
        </listitem>

        <listitem>
          <para>In some cases Apache graceful (reload) no longer works.</para>
        </listitem>
      </orderedlist>

      <para>You should be aware that the internal chroot feature might not be
      100% reliable. Due to the large number of default and third-party
      modules available for the Apache web server, it is not possible to
      verify the internal chroot works reliably with all of them. A module,
      working from within Apache, can do things that make it easy to break out
      of the jail. In particular, if you are using any of the modules that
      fork in the module initialisation phase (e.g.
      <literal>mod_fastcgi</literal>, <literal>mod_fcgid</literal>,
      <literal>mod_cgid</literal>), you are advised to examine each Apache
      process and observe its current working directory, process root, and the
      list of open files. Consider what your options are and make your own
      decision.</para>
    </section>

    <section>
      <title><literal>SecComponentSignature</literal></title>

      <para><emphasis>Description</emphasis>: Appends component signature to
      the ModSecurity signature.</para>

      <para><emphasis>Syntax</emphasis>: <literal>SecComponentSignature
      "COMPONENT_NAME/X.Y.Z (COMMENT)"</literal></para>

      <para><emphasis>Example usage</emphasis>: <literal>SecComponentSignature
      "Core Rules/1.2.3"</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope</emphasis>: Main</para>

      <para><emphasis>Version</emphasis>: 2.5.0</para>

      <para><emphasis>Dependencies/Notes</emphasis>: This directive should be
      used to make the presence of significant ModSecurity components known.
      The entire signature will be recorded in transaction audit log. It
      should be used by ModSecurity module and rule set writers to make
      debugging easier.</para>
    </section>

    <section>
      <title><literal>SecContentInjection</literal></title>

      <para><emphasis>Description:</emphasis> Enables content injection using
      actions <literal>append</literal> and <literal>prepend</literal>.</para>

      <para><emphasis>Syntax:</emphasis> <literal>SecContentInjection
      (On|Off)</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal>SecContentInjection
      On</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope</emphasis>: Any</para>

      <para><emphasis>Version</emphasis>: 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> N/A</para>
    </section>

    <section>
      <title><literal>SecCookieFormat</literal></title>

      <para><emphasis>Description:</emphasis> Selects the cookie format that
      will be used in the current configuration context.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecCookieFormat 0|1</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecCookieFormat 0</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para>Possible values are:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">0</literal> - use version 0
          (Netscape) cookies. This is what most applications use. It is the
          default value.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">1</literal> - use version 1
          cookies.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecDataDir</literal></title>

      <para><emphasis>Description:</emphasis> Path where persistent data (e.g.
      IP address data, session data, etc) is to be stored.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecDataDir
      /path/to/dir</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecDataDir /usr/local/apache/logs/data</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Main</para>

      <para><emphasis>Dependencies/Notes: </emphasis> This directive is needed
      when initcol, setsid an setuid are used. Must be writable by the web
      server user.</para>
    </section>

    <section>
      <title><literal>SecDebugLog</literal></title>

      <para><emphasis>Description:</emphasis> Path to the ModSecurity debug
      log file.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecDebugLog
      /path/to/modsec-debug.log</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecDebugLog
      /usr/local/apache/logs/modsec-debug.log</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>
    </section>

    <section>
      <title><literal>SecDebugLogLevel</literal></title>

      <para><emphasis>Description:</emphasis> Configures the verboseness of
      the debug log data.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecDebugLogLevel 0|1|2|3|4|5|6|7|8|9</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecDebugLogLevel 4</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Levels <literal
      moreinfo="none">1 - 3</literal> are always sent to the Apache error log.
      Therefore you can always use level <literal moreinfo="none">0</literal>
      as the default logging level in production. Level <literal
      moreinfo="none">5</literal> is useful when debugging. It is not
      advisable to use higher logging levels in production as excessive
      logging can slow down server significantly.</para>

      <para>Possible values are:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">0</literal> - no logging.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">1</literal> - errors (intercepted
          requests) only.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">2</literal> - warnings.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">3</literal> - notices.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">4</literal> - details of how
          transactions are handled.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">5</literal> - as above, but including
          information about each piece of information handled.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">9</literal> - log everything,
          including very detailed debugging information.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecDefaultAction</literal></title>

      <para><emphasis>Description:</emphasis> Defines the default action to
      take on a rule match.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecDefaultAction
      action1,action2,action3</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecDefaultAction
      log,auditlog,deny,status:403,phase:2</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Rules following a
      <literal>SecDefaultAction</literal> directive will inherit this setting
      unless a specific action is specified for an individual rule or until
      another <literal>SecDefaultAction</literal> is specified. Take special
      note that in the logging disruptive actions are not allowed, but this
      can inadvertently be inherited using a disruptive action in
      <literal>SecDefaultAction</literal>.</para>

      <para>The default value is minimal (differing from previous
      versions):</para>

      <programlisting format="linespecific">SecDefaultAction phase:2,log,auditlog,pass</programlisting>

      <note>
        <para><literal>SecDefaultAction</literal> must specify a disruptive
        action and a processing phase and cannot contain metadata
        actions.</para>
      </note>

      <warning>
        <para><literal>SecDefaultAction</literal> is <emphasis>not</emphasis>
        inherited across configuration contexts. (For an example of why this
        may be a problem for you, read the following ModSecurity Blog entry
        <ulink
        url="http://blog.modsecurity.org/2008/07/modsecurity-tri.html">http://blog.modsecurity.org/2008/07/modsecurity-tri.html</ulink>).</para>
      </warning>
    </section>

    <section>
      <title><literal>SecGeoLookupDb</literal></title>

      <para><emphasis>Description:</emphasis> Defines the path to the
      geographical database file.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecGeoLookupDb /path/to/db</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecGeoLookupDb
      /usr/local/geo/data/GeoLiteCity.dat</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Check out
      <literal>maxmind.com</literal> for free database files.</para>
    </section>

    <section>
      <title><literal>SecGuardianLog</literal></title>

      <para><emphasis>Description:</emphasis> Configuration directive to use
      the httpd-guardian script to monitor for Denial of Service (DoS)
      attacks.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecGuardianLog |/path/to/httpd-guardian</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecGuardianLog
      |/usr/local/apache/bin/httpd-guardian</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Main</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> By default httpd-guardian
      will defend against clients that send more than 120 requests in a
      minute, or more than 360 requests in five minutes.</para>

      <para>Since 1.9, ModSecurity supports a new directive, SecGuardianLog,
      that is designed to send all access data to another program using the
      piped logging feature. Since Apache is typically deployed in a
      multi-process fashion, making information sharing difficult, the idea is
      to deploy a single external process to observe all requests in a
      stateful manner, providing additional protection.</para>

      <para>Development of a state of the art external protection tool will be
      a focus of subsequent ModSecurity releases. However, a fully functional
      tool is already available as part of the <ulink type=""
      url="http://www.apachesecurity.net/tools/">Apache httpd tools
      project</ulink>. The tool is called httpd-guardian and can be used to
      defend against Denial of Service attacks. It uses the blacklist tool
      (from the same project) to interact with an iptables-based (Linux) or
      pf-based (*BSD) firewall, dynamically blacklisting the offending IP
      addresses. It can also interact with SnortSam (http://www.snortsam.net).
      Assuming httpd-guardian is already configured (look into the source code
      for the detailed instructions) you only need to add one line to your
      Apache configuration to deploy it:</para>

      <programlisting format="linespecific">SecGuardianLog |/path/to/httpd-guardian</programlisting>
    </section>

    <section>
      <title><literal>SecMarker</literal></title>

      <para><emphasis>Description:</emphasis> Adds a fixed rule marker in the
      ruleset to be used as a target in a <literal>skipAfter</literal> action.
      A <literal>SecMarker</literal> directive essentially creates a rule that
      does nothing and whose only purpose it to carry the given ID.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecMarker
      ID</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecMarker 9999</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para><programlisting format="linespecific">SecRule REQUEST_URI "^/$" \
    "chain,t:none,t:urlDecode,t:lowercase,t:normalisePath,<emphasis>skipAfter:99</emphasis>"
SecRule REMOTE_ADDR "^127\.0\.0\.1$" "chain"
SecRule REQUEST_HEADERS:User-Agent \
    "^Apache \(internal dummy connection\)$" "t:none"  
SecRule &amp;REQUEST_HEADERS:Host "@eq 0" \
    "deny,log,status:400,id:08,severity:4,msg:'Missing a Host Header'"
SecRule &amp;REQUEST_HEADERS:Accept "@eq 0" \
    "log,deny,log,status:400,id:15,msg:'Request Missing an Accept Header'"
<emphasis>
SecMarker 99</emphasis></programlisting></para>
    </section>

    <section>
      <title><literal>SecPcreMatchLimit</literal></title>

      <para><emphasis>Description:</emphasis>Sets the the match limit in the
      PCRE library. See the pcre_extra field in the pcreapi man page.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecPcreMatchLimit value</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecPcreMatchLimit 1500</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Global</para>

      <para><emphasis>Version:</emphasis> 2.5.12</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Default is set at compile
      (1500 by default)</para>

      <para>The <literal>--enable-pcre-match-limit=val</literal> configure
      option will set a custom default and the
      <literal>--disable-pcre-match-limit</literal> option will resort to the
      compiled PCRE library default.</para>
    </section>

    <section>
      <title><literal>SecPcreMatchLimitRecursion</literal></title>

      <para><emphasis>Description:</emphasis>Sets the the match limit
      recursion in the PCRE library. See the pcre_extra field in the pcreapi
      man page.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecPcreMatchLimitRecursion value</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecPcreMatchLimitRecursion 1500</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Global</para>

      <para><emphasis>Version:</emphasis> 2.5.12</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Default is set at compile
      (1500 by default)</para>

      <para>The <literal>--enable-pcre-match-limit-recursion=val</literal>
      configure option will set a custom default and the
      <literal>--disable-pcre-match-limit-recursion</literal> option will
      resort to the compiled PCRE library default.</para>
    </section>

    <section>
      <title><literal>SecPdfProtect</literal></title>

      <para><emphasis>Description:</emphasis> Enables the PDF XSS protection
      functionality. Once enabled access to PDF files is tracked. Direct
      access attempts are redirected to links that contain one-time tokens.
      Requests with valid tokens are allowed through unmodified. Requests with
      invalid tokens are also allowed through but with forced download of the
      PDF files. This implementation uses response headers to detect PDF files
      and thus can be used with dynamically generated PDF files that do not
      have the <filename>.pdf</filename> extension in the request URI.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecPdfProtect On|Off</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecPdfProtect On</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>
    </section>

    <section>
      <title><literal>SecPdfProtectMethod</literal></title>

      <para><emphasis>Description:</emphasis> Configure desired protection
      method to be used when requests for PDF files are detected. Possible
      values are <literal>TokenRedirection</literal> and
      <literal>ForcedDownload</literal>. The token redirection approach will
      attempt to redirect with tokens where possible. This allows PDF files to
      continue to be opened inline but only works for GET requests. Forced
      download always causes PDF files to be delivered as opaque binaries and
      attachments. The latter will always be used for non-GET requests. Forced
      download is considered to be more secure but may cause usability
      problems for users ("This PDF won't open anymore!").</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecPdfProtectMethod method</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecPdfProtectMethod TokenRedirection</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para><emphasis>Default:</emphasis>
      <literal>TokenRedirection</literal></para>
    </section>

    <section>
      <title><literal>SecPdfProtectSecret</literal></title>

      <para><emphasis>Description:</emphasis> Defines the secret that will be
      used to construct one-time tokens. You should use a reasonably long
      value for the secret (e.g. 16 characters is good). Once selected the
      secret should not be changed as it will break the tokens that were sent
      prior to change. But it's not a big deal even if you change it. It will
      just force download of PDF files with tokens that were issued in the
      last few seconds.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecPdfProtectSecret secret</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecPdfProtectSecret
      MyRandomSecretString</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>
    </section>

    <section>
      <title><literal>SecPdfProtectTimeout</literal></title>

      <para><emphasis>Description:</emphasis> Defines the token timeout. After
      token expires it can no longer be used to allow access to PDF file.
      Request will be allowed through but the PDF will be delivered as
      attachment.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecPdfProtectTimeout timeout</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecPdfProtectTimeout 10</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para><emphasis>Default:</emphasis> <literal>10</literal></para>
    </section>

    <section>
      <title><literal>SecPdfProtectTokenName</literal></title>

      <para><emphasis>Description:</emphasis> Defines the name of the token.
      The only reason you would want to change the name of the token is if you
      wanted to hide the fact you are running ModSecurity. It's a good reason
      but it won't really help as the adversary can look into the algorithm
      used for PDF protection and figure it out anyway. It does raise the bar
      slightly so go ahead if you want to.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecPdfProtectTokenName name</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecPdfProtectTokenName PDFTOKEN</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para><emphasis>Default:</emphasis> <literal>PDFTOKEN</literal></para>
    </section>

    <section>
      <title><literal>SecRequestBodyAccess</literal></title>

      <para><emphasis>Description:</emphasis> Configures whether request
      bodies will be buffered and processed by ModSecurity by default.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRequestBodyAccess On|Off</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRequestBodyAccess On</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This directive is
      required if you plan to inspect <literal>POST_PAYLOAD</literal>. This
      directive must be used along with the "phase:2" processing phase action
      and <literal>REQUEST_BODY</literal> variable/location. If any of these 3
      parts are not configured, you will not be able to inspect the request
      bodies.</para>

      <para>Possible values are:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">On</literal> - access request
          bodies.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Off</literal> - do not attempt to
          access request bodies.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecRequestBodyLimit</literal></title>

      <para><emphasis>Description:</emphasis> Configures the maximum request
      body size ModSecurity will accept for buffering.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRequestBodyLimit NUMBER_IN_BYTES</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRequestBodyLimit 134217728</literal></para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> 131072 KB (134217728
      bytes) is the default setting. Anything over this limit will be rejected
      with status code 413 Request Entity Too Large. There is a hard limit of
      1 GB.</para>
    </section>

    <section>
      <title><literal>SecRequestBodyNoFilesLimit</literal></title>

      <para><emphasis>Description:</emphasis> Configures the maximum request
      body size ModSecurity will accept for buffering, excluding the size of
      files being transported in the request. This directive comes handy to
      further reduce susceptibility to DoS attacks when someone is sending
      request bodies of very large sizes. Web applications that require file
      uploads must configure <literal>SecRequestBodyLimit</literal> to a high
      value. Since large files are streamed to disk file uploads will not
      increase memory consumption. However, it's still possible for someone to
      take advantage of a large request body limit and send non-upload
      requests with large body sizes. This directive eliminates that
      loophole.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRequestBodyNoFilesLimit
      NUMBER_IN_BYTES</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRequestBodyLimit 131072</literal></para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> 1 MB (1048576 bytes) is
      the default setting. This value is very conservative. For most
      applications you should be able to reduce it down to 128 KB or lower.
      Anything over the limit will be rejected with status code <literal>413
      Request Entity Too Large</literal>. There is a hard limit of 1
      GB.</para>
    </section>

    <section>
      <title><literal>SecRequestBodyInMemoryLimit</literal></title>

      <para><emphasis>Description:</emphasis> Configures the maximum request
      body size ModSecurity will store in memory.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRequestBodyInMemoryLimit
      NUMBER_IN_BYTES</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRequestBodyInMemoryLimit 131072</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para>By default the limit is 128 KB:</para>

      <programlisting format="linespecific"># Store up to 128 KB in memory
SecRequestBodyInMemoryLimit 131072</programlisting>
    </section>

    <section>
      <title><literal>SecResponseBodyLimit</literal></title>

      <para><emphasis>Description:</emphasis> Configures the maximum response
      body size that will be accepted for buffering.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecResponseBodyLimit NUMBER_IN_BYTES</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecResponseBodyLimit 524228</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Anything over this limit
      will be rejected with status code 500 Internal Server Error. This
      setting will not affect the responses with MIME types that are not
      marked for buffering. There is a hard limit of 1 GB.</para>

      <para>By default this limit is configured to 512 KB:</para>

      <programlisting format="linespecific"># Buffer response bodies of up to 512 KB in length 
SecResponseBodyLimit 524288</programlisting>
    </section>

    <section>
      <title><literal>SecResponseBodyLimitAction</literal></title>

      <para><emphasis>Description</emphasis>: Controls what happens once a
      response body limit, configured with
      <literal>SecResponseBodyLimit</literal>, is encountered. By default
      ModSecurity will reject a response body that is longer than specified.
      Some web sites, however, will produce very long responses making it
      difficult to come up with a reasonable limit. Such sites would have to
      raise the limit significantly to function properly defying the purpose
      of having the limit in the first place (to control memory consumption).
      With the ability to choose what happens once a limit is reached site
      administrators can choose to inspect only the first part of the
      response, the part that can fit into the desired limit, and let the rest
      through. Some could argue that allowing parts of responses to go
      uninspected is a weakness. This is true in theory but only applies to
      cases where the attacker controls the output (e.g. can make it arbitrary
      long). In such cases, however, it is not possible to prevent leakage
      anyway. The attacker could compress, obfuscate, or even encrypt data
      before it is sent back, and therefore bypass any monitoring
      device.</para>

      <para><emphasis>Syntax</emphasis>: <literal>SecResponseBodyLimitAction
      Reject|ProcessPartial</literal></para>

      <para><emphasis>Example Usage</emphasis>:
      <literal>SecResponseBodyLimitAction ProcessPartial</literal></para>

      <para><emphasis>Processing Phase</emphasis>: N/A</para>

      <para><emphasis>Scope</emphasis>: Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>
    </section>

    <section>
      <title><literal>SecResponseBodyMimeType</literal></title>

      <para><emphasis>Description:</emphasis> Configures which<literal
      moreinfo="none"> MIME</literal> types are to be considered for response
      body buffering.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecResponseBodyMimeType mime/type</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecResponseBodyMimeType text/plain
      text/html</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Multiple<literal
      moreinfo="none"> SecResponseBodyMimeType</literal> directives can be
      used to add<literal moreinfo="none"> MIME</literal> types.</para>

      <para>The default value is <literal
      moreinfo="none">text/plaintext/html</literal>:</para>

      <programlisting format="linespecific">SecResponseBodyMimeType text/plain text/html</programlisting>
    </section>

    <section>
      <title><literal>SecResponseBodyMimeTypesClear</literal></title>

      <para><emphasis>Description:</emphasis> Clears the list of <literal
      moreinfo="none">MIME</literal> types considered for response body
      buffering, allowing you to start populating the list from
      scratch.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecResponseBodyMimeTypesClear</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecResponseBodyMimeTypesClear</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>
    </section>

    <section>
      <title><literal>SecResponseBodyAccess</literal></title>

      <para><emphasis>Description:</emphasis> Configures whether response
      bodies are to be buffer and analysed or not.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecResponseBodyAccess On|Off</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecResponseBodyAccess On</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This directive is
      required if you plan to inspect HTML responses. This directive must be
      used along with the "phase:4" processing phase action and RESPONSE_BODY
      variable/location. If any of these 3 parts are not configured, you will
      not be able to inspect the response bodies.</para>

      <para>Possible values are:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">On</literal> - access response bodies
          (but only if the MIME type matches, see above).</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Off</literal> - do not attempt to
          access response bodies.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecRule</literal></title>

      <para><emphasis>Description:</emphasis> <literal
      moreinfo="none">SecRule</literal> is the main ModSecurity directive. It
      is used to analyse data and perform actions based on the results.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecRule
      VARIABLES OPERATOR [ACTIONS]</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRule REQUEST_URI "attack" \</literal></para>

      <para><literal>
      "phase:1,t:none,t:urlDecode,t:lowercase,t:normalisePath"</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <para>In general, the format of this rule is as follows:</para>

      <programlisting format="linespecific">SecRule VARIABLES OPERATOR [ACTIONS]</programlisting>

      <para>The second part, <literal moreinfo="none">OPERATOR</literal>,
      specifies how they are going to be checked. The third (optional) part,
      <literal moreinfo="none">ACTIONS</literal>, specifies what to do
      whenever the operator used performs a successful match against a
      variable.</para>

      <section>
        <title>Variables in rules</title>

        <para>The first part,<literal moreinfo="none"> VARIABLES</literal>,
        specifies which variables are to be checked. For example, the
        following rule will reject a transaction that has the word<emphasis>
        dirty</emphasis> in the URI:</para>

        <programlisting format="linespecific">SecRule ARGS dirty</programlisting>

        <para>Each rule can specify one or more variables:</para>

        <programlisting format="linespecific">SecRule ARGS|REQUEST_HEADERS:User-Agent dirty</programlisting>

        <para>There is a third format supported by the selection operator -
        XPath expression. XPath expressions can only used against the special
        variable XML, which is available only of the request body was
        processed as XML.</para>

        <programlisting format="linespecific">SecRule XML:/xPath/Expression dirty</programlisting>

        <note>
          <para>Not all collections support all selection operator format
          types. You should refer to the documentation of each collection to
          determine what is and isn't supported.</para>
        </note>
      </section>

      <section>
        <title>Collections</title>

        <para>A variable can contain one or many pieces of data, depending on
        the nature of the variable and the way it is used. We've seen examples
        of both approaches in the previous section. When a variable can
        contain more than one value we refer to it as a
        <emphasis>collection</emphasis>.</para>

        <para>Collections are always expanded before a rule is run. For
        example, the following rule:</para>

        <programlisting>SecRule ARGS dirty</programlisting>

        <para>will be expanded to:</para>

        <programlisting>SecRule ARGS:p dirty
SecRule ARGS:q dirty</programlisting>

        <para>in a requests that has only two parameters, named
        <literal>p</literal> and <literal>q</literal>.</para>

        <para>Collections come in several flavours:</para>

        <variablelist>
          <varlistentry>
            <term>Read-only</term>

            <listitem>
              <para>Created at runtime using transaction data. For example:
              <literal>ARGS</literal> (contains a list of all request
              parameter values) and <literal>REQUEST_HEADERS</literal>
              (contains a list of all request header values).</para>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term>Transient Read/Write</term>

            <listitem>
              <para>The <literal>TX</literal> collection is created (empty)
              for every transaction. Rules can read from it and write to it
              (using the <literal>setvar</literal> action, for example), but
              the information stored in this collection will not survive the
              end of transaction.</para>
            </listitem>
          </varlistentry>

          <varlistentry>
            <term>Persistent Read/Write</term>

            <listitem>
              <para>There are several collections that can be written to, but
              which are persisted to the storage backend. These collections
              are used to track clients across transactions. Examples of
              collections that fall into this type are <literal>IP</literal>,
              <literal>SESSION</literal> and <literal>USER</literal>.</para>
            </listitem>
          </varlistentry>
        </variablelist>
      </section>

      <section>
        <title>Operators in rules</title>

        <para>In the simplest possible case you will use a regular expression
        pattern as the second rule parameter. This is what we've done in the
        examples above. If you do this ModSecurity assumes you want to use the
        <literal moreinfo="none">rx</literal> (regular expression) operator.
        You can also explicitly specify the operator you want to use by using
        <literal moreinfo="none">@</literal>, followed by the name of an
        operator, at the beginning of the second <literal>SecRule</literal>
        parameter:</para>

        <programlisting format="linespecific">SecRule ARGS "@rx dirty"</programlisting>

        <para>Note how we had to use double quotes to delimit the second rule
        parameter. This is because the second parameter now has whitespace in
        it. Any number of whitespace characters can follow the name of the
        operator. If there are any non-whitespace characters there, they will
        all be treated as a special parameter to the operator. In the case of
        the regular expression operator the special parameter is the pattern
        that will be used for comparison.</para>

        <para>The @ can be the second character if you are using negation to
        negate the result returned by the operator:</para>

        <programlisting format="linespecific">SecRule &amp;ARGS "!@rx ^0$"</programlisting>
      </section>

      <section>
        <title>Operator negation</title>

        <para>Operator results can be negated by using an exclamation mark at
        the beginning of the second parameter. The following rule matches if
        the word <literal>dirty</literal> does <emphasis>not</emphasis> appear
        in the <literal>User-Agent</literal> request header:</para>

        <programlisting>SecRule REQUEST_HEADERS:User-Agent !dirty</programlisting>

        <para>You can use the exclamation mark in combination with any
        parameter. If you do, the exclamation mark needs to go first, followed
        by the explicit operator reference. The following rule has the same
        effect as the previous example:</para>

        <programlisting>SecRule REQUEST_HEADERS:User-Agent "!@rx dirty"</programlisting>

        <para>If you need to use negation in a rule that is going to be
        applied to several variables then it may not be immediately clear what
        will happen. Consider the following example:</para>

        <programlisting>SecRule ARGS:p|ARGS:q !dirty</programlisting>

        <para>The above rule is identical to:</para>

        <programlisting>SecRule ARGS:p !dirty
SecRule ARGS:q !dirty</programlisting>

        <warning>
          <para>Negation is applied to operations against individual
          operations, not agains the entire variable list.</para>
        </warning>
      </section>

      <section>
        <title>Actions in rules</title>

        <para>The third parameter, <literal moreinfo="none">ACTIONS</literal>,
        can be omitted only because there is a helper feature that specifies
        the default action list. If the parameter isn't omitted the actions
        specified in the parameter will be merged with the default action list
        to create the actual list of actions that will be processed on a rule
        match.</para>
      </section>
    </section>

    <section>
      <title><literal>SecRuleInheritance</literal></title>

      <para><emphasis>Description:</emphasis> Configures whether the current
      context will inherit rules from the parent context (configuration
      options are inherited in most cases - you should look up the
      documentation for every directive to determine if it is inherited or
      not).</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRuleInheritance On|Off</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRuleInheritance Off</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Resource-specific
      contexts (e.g.<literal moreinfo="none"> Location</literal>, <literal
      moreinfo="none">Directory</literal>, etc) cannot override
      <emphasis>phase1</emphasis> rules configured in the main server or in
      the virtual server. This is because phase 1 is run early in the request
      processing process, before Apache maps request to resource. Virtual host
      context can override phase 1 rules configured in the main server.</para>

      <para>Example: The following example shows where ModSecurity may be
      enabled in the main Apache configuration scope, however you might want
      to configure your VirtualHosts differently. In the first example, the
      first VirtualHost is not inheriting the ModSecurity main config
      directives and in the second one it is.</para>

      <programlisting format="linespecific">SecRuleEngine On
SecDefaultAction log,pass,phase:2
...  

&lt;VirtualHost *:80&gt;
ServerName app1.com 
ServerAlias www.app1.com<emphasis>
SecRuleInheritance Off</emphasis>
SecDefaultAction log,deny,phase:1,redirect:http://www.site2.com 
... 
&lt;/VirtualHost&gt;  

&lt;VirtualHost *:80&gt; 
ServerName app2.com 
ServerAlias www.app2.com
<emphasis>SecRuleInheritance On</emphasis> SecRule ARGS "attack" 
... 
&lt;/VirtualHost&gt;</programlisting>

      <para>Possible values are:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">On</literal> - inherit rules from the
          parent context.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Off</literal> - do not inherit rules
          from the parent context.</para>

          <note>
            <para>Configuration contexts are an Apache concept. Directives
            <literal>&lt;Directory&gt;</literal>,
            <literal>&lt;Files&gt;</literal>,
            <literal>&lt;Location&gt;</literal> and
            <literal>&lt;VirtualHost&gt;</literal> are all used to create
            configuration contexts. For more information please go to the
            Apache documentation section <ulink
            url="http://httpd.apache.org/docs/2.0/sections.html">Configuration
            Sections</ulink>.</para>
          </note>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecRuleEngine</literal></title>

      <para><emphasis>Description:</emphasis> Configures the rules
      engine.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRuleEngine On|Off|DetectionOnly</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRuleEngine On</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This directive can also
      be controlled by the ctl action (ctl:ruleEngine=off) for per rule
      processing.</para>

      <para>Possible values are:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">On</literal> - process rules.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Off</literal> - do not process
          rules.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">DetectionOnly</literal> - process
          rules but never intercept transactions, even when rules are
          configured to do so.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecRuleRemoveById</literal></title>

      <para><emphasis>Description:</emphasis> Removes matching rules from the
      parent contexts.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRuleUpdateActionById RULEID
      ACTIONLIST</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRuleRemoveByID 1 2 "9000-9010"</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This directive supports
      multiple parameters, where each parameter can either be a rule ID, or a
      range. Parameters that contain spaces must be delimited using double
      quotes.</para>

      <programlisting format="linespecific">SecRuleRemoveById 1 2 5 10-20 "400-556" 673</programlisting>
    </section>

    <section>
      <title><literal>SecRuleRemoveByMsg</literal></title>

      <para><emphasis>Description:</emphasis> Removes matching rules from the
      parent contexts.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRuleRemoveByMsg REGEX</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRuleRemoveByMsg "FAIL"</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This directive supports
      multiple parameters. Each parameter is a regular expression that will be
      applied to the message (specified using the <literal
      moreinfo="none">msg</literal> action).</para>
    </section>

    <section>
      <title><literal>SecRuleScript</literal> (Experimental)</title>

      <para><emphasis>Description:</emphasis> This directive creates a special
      rule that executes a Lua script to decide whether to match or not. The
      main difference from <literal>SecRule</literal> is that there are no
      targets nor operators. The script can fetch any variable from the
      ModSecurity context and use any (Lua) operator to test them. The second
      optional parameter is the list of actions whose meaning is identical to
      that of <literal>SecRule</literal>.</para>

      <para><emphasis>Syntax:</emphasis> <literal>SecRuleScript
      /path/to/script.lua [ACTIONS]</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRuleScript "/path/to/file.lua"
      "block"</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> None</para>

      <note>
        <para>All Lua scripts are compiled at configuration time and cached in
        memory. To reload scripts you must reload the entire ModSecurity
        configuration by restarting Apache.</para>
      </note>

      <para>Example script:</para>

      <programlisting>-- Your script must define the <emphasis>main</emphasis> entry
-- point, as below.
function main()
    -- Log something at level 1. Normally you shouldn't be
    -- logging anything, especially not at level 1, but this is
    -- just to show you can. Useful for debugging.
    m.log(1, "Hello world!");

    -- Retrieve one variable.
    local var1 = m.getvar("REMOTE_ADDR");

    -- Retrieve one variable, applying one transformation function.
    -- The second parameter is a string.
    local var2 = m.getvar("ARGS", "lowercase");

    -- Retrieve one variable, applying several transformation functions.
    -- The second parameter is now a list. You should note that m.getvar()
    -- requires the use of comma to separate collection names from
    -- variable names. This is because only one variable is returned.
    local var3 = m.getvar("ARGS.p", { "lowercase", "compressWhitespace" } );

    -- If you want this rule to match return a string
    -- containing the error message. The message <emphasis>must</emphasis> contain the name
    -- of the variable where the problem is located.
    -- return "Variable ARGS:p looks suspicious!"

    -- Otherwise, simply return nil.
    return nil;
end</programlisting>

      <para>In this first example we were only retrieving one variable at the
      time. In this case the name of the variable is known to you. In many
      cases, however, you will want to examine variables whose names you won't
      know in advance, for example script parameters.</para>

      <para>Example showing use of <literal>m.getvars()</literal> to retrieve
      many variables at once:</para>

      <programlisting>function main()
    -- Retrieve script parameters.
    local d = m.getvars("ARGS", { "lowercase", "htmlEntityDecode" } );

    -- Loop through the paramters.
    for i = 1, #d do
        -- Examine parameter value.
        if (string.find(d[i].value, "&lt;script")) then
            -- Always specify the name of the variable where the
            -- problem is located in the error message.
            return ("Suspected XSS in variable " .. d[i].name .. ".");
        end
    end

    -- Nothing wrong found.
    return nil;
end</programlisting>

      <note>
        <para>Go to <ulink
        url="http://www.lua.org/">http://www.lua.org/</ulink> to find more
        about the Lua programming language. The reference manual too is
        available online, at <ulink
        url="http://www.lua.org/manual/5.1/">http://www.lua.org/manual/5.1/</ulink>.</para>
      </note>

      <note>
        <para>Lua support is marked as <emphasis>experimental</emphasis> as
        the way the progamming interface may continue to evolve while we are
        working for the best implementation style. Any user input into the
        programming interface is appreciated.</para>
      </note>
    </section>

    <section>
      <title><literal>SecRuleUpdateActionById</literal></title>

      <para><emphasis>Description:</emphasis> Updates the action list of the
      specified rule.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecRuleRemoveById RULEID ACTIONLIST</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecRuleUpdateActionById 12345
      deny,status:403</literal></para>

      <para><emphasis>Processing Phase:</emphasis> Any</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This directive merges the
      specified action list with the rule's action list. There are two
      limitations. The rule ID cannot be changed, nor can the phase. Further
      note that actions that may be specified multiple times are appended to
      the original.</para>

      <programlisting format="linespecific">SecAction \
  "t:lowercase,phase:2,id:12345,pass,msg:'The Message',log,auditlog"
SecRuleUpdateActionById 12345 "t:compressWhitespace,deny,status:403,msg:'A new message'</programlisting>

      <para>The example above will cause the rule to be executed as if it was
      specified as follows:</para>

      <programlisting format="linespecific">SecAction \
  "t:lowercase,phase:2,id:12345,log,auditlog,t:compressWhitespace,deny,status:403,msg:'A new message'"</programlisting>
    </section>

    <section>
      <title><literal>SecServerSignature</literal></title>

      <para><emphasis>Description:</emphasis> Instructs ModSecurity to change
      the data presented in the "Server:" response header token.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecServerSignature "WEB SERVER
      SOFTWARE"</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecServerSignature
      "Netscape-Enterprise/6.0"</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Main</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> In order for this
      directive to work, you must set the Apache ServerTokens directive to
      Full. ModSecurity will overwrite the server signature data held in this
      memory space with the data set in this directive. If ServerTokens is not
      set to Full, then the memory space is most likely not large enough to
      hold the new data we are looking to insert.</para>
    </section>

    <section>
      <title><literal>SecTmpDir</literal></title>

      <para><emphasis>Description:</emphasis> Configures the directory where
      temporary files will be created.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecTmpDir
      /path/to/dir</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecTmpDir /tmp</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Needs to be writable by
      the Apache user process. This is the directory location where Apache
      will swap data to disk if it runs out of memory (more data than what was
      specified in the SecRequestBodyInMemoryLimit directive) during
      inspection.</para>
    </section>

    <section>
      <title><literal>SecUploadDir</literal></title>

      <para><emphasis>Description:</emphasis> Configures the directory where
      intercepted files will be stored.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecUploadDir
      /path/to/dir</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecUploadDir /tmp</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This directory must be on
      the same filesystem as the temporary directory defined with <literal
      moreinfo="none">SecTmpDir</literal>. This directive is used with
      <literal>SecUploadKeepFiles</literal>.</para>
    </section>

    <section>
      <title><literal>SecUploadFileLimit</literal></title>

      <para><emphasis>Description:</emphasis> Configures the maximum number of
      file uploads processed in a multipart POST.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecUploadFileLimit number</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecUploadFileLimit 10</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.5.12</para>

      <para><emphasis>Dependencies/Notes:</emphasis> The default is set to 100
      files, but you are encouraged to reduce this value. Any file over the
      limit will not be extracted and the <literal
      moreinfo="none">MULTIPART_FILE_LIMIT_EXCEEDED</literal> and <literal
      moreinfo="none">MULTIPART_STRICT_ERROR</literal> flags will be set. To
      prevent bypassing any file checks, you must check for one of these
      flags.</para>

      <note>
        <para>If the limit is exceeded, the part name and file name will still
        be recorded in <literal moreinfo="none">FILES_NAME</literal> and
        <literal moreinfo="none">FILES</literal>, the file size will be
        recorded in <literal moreinfo="none">FILES_SIZES</literal>, but there
        will be no record in <literal moreinfo="none">FILES_TMPNAMES</literal>
        as a temporary file was not created.</para>
      </note>
    </section>

    <section>
      <title><literal>SecUploadFileMode</literal></title>

      <para><emphasis>Description:</emphasis> Configures the mode
      (permissions) of any uploaded files using an octal mode (as used in
      chmod).</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecUploadFileMode octal_mode|"default"</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecUploadFileMode 0640</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.1.6</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This feature is not
      available on operating systems not supporting octal file modes. The
      default mode (0600) only grants read/write access to the account writing
      the file. If access from another account is needed (using clamd is a
      good example), then this directive may be required. However, use this
      directive with caution to avoid exposing potentially sensitive data to
      unauthorized users. Using the value "default" will revert back to the
      default setting.</para>

      <note>
        <para>The process umask may still limit the mode if it is being more
        restrictive than the mode set using this directive.</para>
      </note>
    </section>

    <section>
      <title><literal>SecUploadKeepFiles</literal></title>

      <para><emphasis>Description:</emphasis> Configures whether or not the
      intercepted files will be kept after transaction is processed.</para>

      <para><emphasis>Syntax:</emphasis> <literal
      moreinfo="none">SecUploadKeepFiles On|Off|RelevantOnly</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecUploadKeepFiles On</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> This directive requires
      the storage directory to be defined (using <literal
      moreinfo="none">SecUploadDir</literal>).</para>

      <para>Possible values are:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">On</literal> - Keep uploaded
          files.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">Off</literal> - Do not keep uploaded
          files.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">RelevantOnly</literal> - This will
          keep only those files that belong to requests that are deemed
          relevant.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>SecWebAppId</literal></title>

      <para><emphasis>Description:</emphasis> Creates a partition on the
      server that belongs to one web application.</para>

      <para><emphasis>Syntax:</emphasis> <literal moreinfo="none">SecWebAppId
      "NAME"</literal></para>

      <para><emphasis>Example Usage:</emphasis> <literal
      moreinfo="none">SecWebAppId "WebApp1"</literal></para>

      <para><emphasis>Processing Phase:</emphasis> N/A</para>

      <para><emphasis>Scope:</emphasis> Any</para>

      <para><emphasis>Version:</emphasis> 2.0.0</para>

      <para><emphasis>Dependencies/Notes:</emphasis> Partitions are used to
      avoid collisions between session IDs and user IDs. This directive must
      be used if there are multiple applications deployed on the same server.
      If it isn't used, a collision between session IDs might occur. The
      default value is<literal moreinfo="none"> default</literal>.
      Example:</para>

      <programlisting format="linespecific">&lt;VirtualHost *:80&gt; 
ServerName app1.com 
ServerAlias www.app1.com
<emphasis>SecWebAppId "App1"</emphasis>
SecRule REQUEST_COOKIES:PHPSESSID !^$ chain,nolog,pass 
SecAction setsid:%{REQUEST_COOKIES.PHPSESSID} 
... 
&lt;/VirtualHost&gt;  

&lt;VirtualHost *:80&gt; 
ServerName app2.com 
ServerAlias www.app2.com<emphasis>
SecWebAppId "App2"</emphasis>
SecRule REQUEST_COOKIES:PHPSESSID !^$ chain,nolog,pass 
SecAction setsid:%{REQUEST_COOKIES.PHPSESSID} 
... 
&lt;/VirtualHost&gt;</programlisting>

      <para>In the two examples configurations shown, SecWebAppId is being
      used in conjunction with the Apache VirtualHost directives. What this
      achieves is to create more unique collection names when being hosted on
      one server. Normally, when setsid is used, ModSecurity will create a
      collection with the name "SESSION" and it will hold the value specified.
      With using SecWebAppId as shown in the examples, however, the name of
      the collection would become "App1_SESSION" and "App2_SESSION".</para>

      <para>SecWebAppId is relevant in two cases:</para>

      <orderedlist continuation="restarts" inheritnum="ignore">
        <listitem>
          <para>You are logging transactions/alerts to the ModSecurity Console
          and you want to use the web application ID to search only the
          transactions belonging to that application.</para>
        </listitem>

        <listitem>
          <para>You are using the data persistence facility (collections
          SESSION and USER) and you need to avoid collisions between sessions
          and users belonging to different applications.</para>
        </listitem>
      </orderedlist>
    </section>
  </section>

  <section id="processing-phases">
    <title>Processing Phases</title>

    <para>ModSecurity 2.x allows rules to be placed in one of the following
    five phases:</para>

    <orderedlist continuation="restarts" inheritnum="ignore">
      <listitem>
        <para>Request headers (<literal>REQUEST_HEADERS</literal>)</para>
      </listitem>

      <listitem>
        <para>Request body (<literal>REQUEST_BODY</literal>)</para>
      </listitem>

      <listitem>
        <para>Response headers (<literal>RESPONSE_HEADERS</literal>)</para>
      </listitem>

      <listitem>
        <para>Response body (<literal>RESPONSE_BODY</literal>)</para>
      </listitem>

      <listitem>
        <para>Logging (<literal>LOGGING</literal>)</para>
      </listitem>
    </orderedlist>

    <para>Below is a diagram of the standard Apache Request Cycle. In the
    diagram, the 5 ModSecurity processing phases are shown.</para>

    <para><graphic contentwidth="5.5in"
    fileref="apache_request_cycle-modsecurity.jpg" role="" scale=""
    scalefit="" /></para>

    <para>In order to select the phase a rule executes during, use the phase
    action either directly in the rule or in using the
    <literal>SecDefaultAction</literal> directive:</para>

    <programlisting format="linespecific">SecDefaultAction "log,pass,<emphasis>phase:2</emphasis>"
SecRule REQUEST_HEADERS:Host "!^$" "deny,<emphasis>phase:1</emphasis>"</programlisting>

    <note>
      <para>Keep in mind that rules are executed according to phases, so even
      if two rules are adjacent in a configuration file, but are set to
      execute in different phases, they would not happen one after the other.
      The order of rules in the configuration file is important only within
      the rules of each phase. This is especially important when using the
      <literal>skip</literal> and <literal>skipAfter</literal> actions.</para>
    </note>

    <note>
      <para>The <literal>LOGGING</literal> phase is special. It is executed at
      the end of each transaction no matter what happened in the previous
      phases. This means it will be processed even if the request was
      intercepted or the <literal>allow</literal> action was used to pass the
      transaction through.</para>
    </note>

    <section>
      <title>Phase Request Headers</title>

      <para>Rules in this phase are processed immediately after Apache
      completes reading the request headers (post-read-request phase). At this
      point the request body has not been read yet, meaning not all request
      arguments are available. Rules should be placed in this phase if you
      need to have them run early (before Apache does something with the
      request), to do something before the request body has been read,
      determine whether or not the request body should be buffered, or decide
      how you want the request body to be processed (e.g. whether to parse it
      as XML or not).</para>

      <para><emphasis>Note</emphasis></para>

      <para>Rules in this phase can not leverage Apache scope directives
      (Directory, Location, LocationMatch, etc...) as the post-read-request
      hook does not have this information yet. The exception here is the
      VirtualHost directive. If you want to use ModSecurity rules inside
      Apache locations, then they should run in Phase 2. Refer to the Apache
      Request Cycle/ModSecurity Processing Phases diagram.</para>
    </section>

    <section>
      <title>Phase Request Body</title>

      <para>This is the general-purpose input analysis phase. Most of the
      application-oriented rules should go here. In this phase you are
      guaranteed to have received the request arguments (provided the request
      body has been read). ModSecurity supports three encoding types for the
      request body phase:</para>

      <itemizedlist>
        <listitem>
          <para><literal>application/x-www-form-urlencoded</literal> - used to
          transfer form data</para>
        </listitem>

        <listitem>
          <para><literal>multipart/form-data</literal> - used for file
          transfers</para>
        </listitem>

        <listitem>
          <para><literal>text/xml</literal> - used for passing XML data</para>
        </listitem>
      </itemizedlist>

      <para>Other encodings are not used by most web applications.</para>
    </section>

    <section>
      <title>Phase Response Headers</title>

      <para>This phase takes place just before response headers are sent back
      to the client. Run here if you want to observe the response before that
      happens, and if you want to use the response headers to determine if you
      want to buffer the response body. Note that some response status codes
      (such as 404) are handled earlier in the request cycle by Apache and my
      not be able to be triggered as expected. Additionally, there are some
      response headers that are added by Apache at a later hook (such as Date,
      Server and Connection) that we would not be able to trigger on or
      sanitize. This should work appropriately in a proxy setup or within
      phase:5 (logging).</para>
    </section>

    <section>
      <title>Phase Response Body</title>

      <para>This is the general-purpose output analysis phase. At this point
      you can run rules against the response body (provided it was buffered,
      of course). This is the phase where you would want to inspect the
      outbound HTML for information disclosure, error messages or failed
      authentication text.</para>
    </section>

    <section>
      <title>Phase Logging</title>

      <para>This phase is run just before logging takes place. The rules
      placed into this phase can only affect how the logging is performed.
      This phase can be used to inspect the error messages logged by Apache.
      You cannot deny/block connections in this phase as it is too late. This
      phase also allows for inspection of other response headers that weren't
      available during phase:3 or phase:4. Note that you must be careful not
      to inherit a disruptive action into a rule in this phase as this is a
      configuration error in ModSecurity 2.5.0 and later versions.</para>
    </section>
  </section>

  <section id="variables">
    <title>Variables</title>

    <para>The following variables are supported in ModSecurity 2.x:</para>

    <section>
      <title><literal moreinfo="none">ARGS</literal></title>

      <para><literal>ARGS</literal> is a collection and can be used on its own
      (means all arguments including the POST Payload), with a static
      parameter (matches arguments with that name), or with a regular
      expression (matches all arguments with name that matches the regular
      expression). To look at only the query string or body arguments, see the
      <literal>ARGS_GET</literal> and <literal>ARGS_POST</literal>
      collections.</para>

      <para>Some variables are actually collections, which are expanded into
      more variables at runtime. The following example will examine all
      request arguments:<programlisting format="linespecific">SecRule ARGS dirty</programlisting>
      Sometimes, however, you will want to look only at parts of a collection.
      This can be achieved with the help of the <emphasis>selection
      operator</emphasis>(colon). The following example will only look at the
      arguments named<literal moreinfo="none"> p</literal> (do note that, in
      general, requests can contain multiple arguments with the same name):
      <programlisting format="linespecific">SecRule ARGS:p dirty</programlisting>
      It is also possible to specify exclusions. The following will examine
      all request arguments for the word<emphasis> dirty</emphasis>, except
      the ones named <literal moreinfo="none">z</literal> (again, there can be
      zero or more arguments named<literal moreinfo="none"> z</literal>):
      <programlisting format="linespecific">SecRule ARGS|!ARGS:z dirty</programlisting>
      There is a special operator that allows you to count how many variables
      there are in a collection. The following rule will trigger if there is
      more than zero arguments in the request (ignore the second parameter for
      the time being): <programlisting format="linespecific">SecRule &amp;ARGS !^0$</programlisting>
      And sometimes you need to look at an array of parameters, each with a
      slightly different name. In this case you can specify a regular
      expression in the selection operator itself. The following rule will
      look into all arguments whose names begin with <literal
      moreinfo="none">id_</literal>: <programlisting format="linespecific">SecRule ARGS:/^id_/ dirty</programlisting></para>

      <note>
        <para>Using <literal>ARGS:p</literal> will not result in any
        invocations against the operator if argument p does not exist.</para>

        <para>In ModSecurity 1.X, the <literal>ARGS</literal> variable stood
        for <literal>QUERY_STRING</literal> + <literal>POST_PAYLOAD</literal>,
        whereas now it expands to individual variables.</para>
      </note>
    </section>

    <section>
      <title><literal moreinfo="none">ARGS_COMBINED_SIZE</literal></title>

      <para>This variable allows you to set more targeted evaluations on the
      total size of the Arguments as compared with normal Apache LimitRequest
      directives. For example, you could create a rule to ensure that the
      total size of the argument data is below a certain threshold (to help
      prevent buffer overflow issues). Example: Block request if the size of
      the arguments is above 25 characters.</para>

      <programlisting format="linespecific">SecRule REQUEST_FILENAME "^/cgi-bin/login\.php" \
    "chain,log,deny,phase:2,t:none,t:lowercase,t:normalisePath"
SecRule <emphasis>ARGS_COMBINED_SIZE</emphasis> "@gt 25"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">ARGS_NAMES</literal></title>

      <para>Is a collection of the argument names. You can search for specific
      argument names that you want to block. In a positive policy scenario,
      you can also whitelist (using an inverted rule with the ! character)
      only authorized argument names. Example: This example rule will only
      allow 2 argument names - p and a. If any other argument names are
      injected, it will be blocked.</para>

      <programlisting format="linespecific">SecRule REQUEST_FILENAME "/index.php" \
    "chain,log,deny,status:403,phase:2,t:none,t:lowercase,t:normalisePath"
SecRule<emphasis> ARGS_NAMES</emphasis> "!^(p|a)$" "t:none,t:lowercase"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">ARGS_GET</literal></title>

      <para><literal>ARGS_GET</literal> is similar to <literal>ARGS</literal>,
      but only contains arguments from the query string.</para>
    </section>

    <section>
      <title><literal moreinfo="none">ARGS_GET_NAMES</literal></title>

      <para><literal>ARGS_GET_NAMES</literal> is similar to
      <literal>ARGS_NAMES</literal>, but only contains argument names from the
      query string.</para>
    </section>

    <section>
      <title><literal moreinfo="none">ARGS_POST</literal></title>

      <para><literal>ARGS_POST</literal> is similar to
      <literal>ARGS</literal>, but only contains arguments from the POST
      body.</para>
    </section>

    <section>
      <title><literal moreinfo="none">ARGS_POST_NAMES</literal></title>

      <para><literal>ARGS_POST_NAMES</literal> is similar to
      <literal>ARGS_NAMES</literal>, but only contains argument names from the
      POST body.</para>
    </section>

    <section>
      <title><literal moreinfo="none">AUTH_TYPE</literal></title>

      <para>This variable holds the authentication method used to validate a
      user. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>AUTH_TYPE</emphasis> "basic" log,deny,status:403,phase:1,t:lowercase</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This data will not be available in a proxy-mode deployment as the
      authentication is not local. In a proxy-mode deployment, you would need
      to inspect the <literal>REQUEST_HEADERS:Authorization</literal>
      header.</para>
    </section>

    <section>
      <title><literal moreinfo="none">ENV</literal></title>

      <para>Collection, requires a single parameter (after colon). The
      <literal>ENV</literal> variable is set with setenv and does not give
      access to the CGI environment variables. Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_FILENAME "printenv" pass,<emphasis>setenv:tag=suspicious</emphasis>
SecRule <emphasis>ENV:tag</emphasis> "suspicious"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">FILES</literal></title>

      <para>Collection. Contains a collection of original file names (as they
      were called on the remote user's file system). Note: only available if
      files were extracted from the request body. Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> FILES</emphasis> "\.conf$" log,deny,status:403,phase:2</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">FILES_COMBINED_SIZE</literal></title>

      <para>Single value. Total size of the uploaded files. Note: only
      available if files were extracted from the request body. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>FILES_COMBINED_SIZE</emphasis> "@gt 1000" log,deny,status:403,phase:2</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">FILES_NAMES</literal></title>

      <para>Collection w/o parameter. Contains a list of form fields that were
      used for file upload. Note: only available if files were extracted from
      the request body. Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> FILES_NAMES</emphasis> "^upfile$" log,deny,status:403,phase:2</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">FILES_SIZES</literal></title>

      <para>Collection. Contains a list of file sizes. Useful for implementing
      a size limitation on individual uploaded files. Note: only available if
      files were extracted from the request body. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>FILES_SIZES</emphasis> "@gt 100" log,deny,status:403,phase:2</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">FILES_TMPNAMES</literal></title>

      <para>Collection. Contains a collection of temporary files' names on the
      disk. Useful when used together with <literal
      moreinfo="none">@inspectFile.</literal> Note: only available if files
      were extracted from the request body. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>FILES_TMPNAMES</emphasis> "@inspectFile /path/to/inspect_script.pl"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">GEO</literal></title>

      <para><literal>GEO</literal> is a collection populated by the results of
      the last <literal moreinfo="none">@geoLookup</literal> operator. The
      collection can be used to match geographical fields looked from an IP
      address or hostname.</para>

      <para>Available since ModSecurity 2.5.0.</para>

      <para>Fields:</para>

      <itemizedlist>
        <listitem>
          <para><emphasis>COUNTRY_CODE:</emphasis> Two character country code.
          EX: US, GB, etc.</para>
        </listitem>

        <listitem>
          <para><emphasis>COUNTRY_CODE3:</emphasis> Up to three character
          country code.</para>
        </listitem>

        <listitem>
          <para><emphasis>COUNTRY_NAME:</emphasis> The full country
          name.</para>
        </listitem>

        <listitem>
          <para><emphasis>COUNTRY_CONTINENT:</emphasis> The two character
          continent that the country is located. EX: EU</para>
        </listitem>

        <listitem>
          <para><emphasis>REGION:</emphasis> The two character region. For US,
          this is state. For Canada, providence, etc.</para>
        </listitem>

        <listitem>
          <para><emphasis>CITY:</emphasis> The city name if supported by the
          database.</para>
        </listitem>

        <listitem>
          <para><emphasis>POSTAL_CODE:</emphasis> The postal code if supported
          by the database.</para>
        </listitem>

        <listitem>
          <para><emphasis>LATITUDE:</emphasis> The latitude if supported by
          the database.</para>
        </listitem>

        <listitem>
          <para><emphasis>LONGITUDE:</emphasis> The longitude if supported by
          the database.</para>
        </listitem>

        <listitem>
          <para><emphasis>DMA_CODE:</emphasis> The metropolitan area code if
          supported by the database. (US only)</para>
        </listitem>

        <listitem>
          <para><emphasis>AREA_CODE:</emphasis> The phone system area code.
          (US only)</para>
        </listitem>
      </itemizedlist>

      <para>Example:</para>

      <programlisting format="linespecific">SecGeoLookupDb /usr/local/geo/data/GeoLiteCity.dat
...
SecRule REMOTE_ADDR "<emphasis>@geoLookup</emphasis>" "chain,drop,msg:'Non-GB IP address'"
SecRule GEO:COUNTRY_CODE "!@streq GB"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">HIGHEST_SEVERITY</literal></title>

      <para>This variable holds the highest severity of any rules that have
      matched so far. Severities are numeric values and thus can be used with
      comparison operators such as <literal moreinfo="none">@lt</literal>,
      etc.</para>

      <note>
        <para>Higher severities have a lower numeric value.</para>

        <para>A value of 255 indicates no severity has been set.</para>
      </note>

      <programlisting format="linespecific">SecRule HIGHEST_SEVERITY "@le 2" "phase:2,deny,status:500,msg:'severity %{HIGHEST_SEVERITY}'"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">MATCHED_VAR</literal></title>

      <para>This variable holds the value of the variable that was matched
      against. It is similar to the TX:0, except it can be used for all
      operators and does not require that the <literal
      moreinfo="none">capture</literal> action be specified.</para>

      <programlisting format="linespecific">SecRule ARGS pattern chain,deny
...
SecRule <emphasis>MATCHED_VAR</emphasis> "further scrutiny"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">MATCHED_VAR_NAME</literal></title>

      <para>This variable holds the full name of the variable that was matched
      against.</para>

      <programlisting format="linespecific">SecRule ARGS pattern setvar:tx.mymatch=%{MATCHED_VAR_NAME}
...
SecRule <emphasis>TX:MYMATCH</emphasis> "@eq ARGS:param" deny</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">MODSEC_BUILD</literal></title>

      <para>This variable holds the ModSecurity build number. This variable is
      intended to be used to check the build number prior to using a feature
      that is available only in a certain build. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>MODSEC_BUILD</emphasis> "!@ge 02050102" skipAfter:12345
SecRule ARGS "@pm some key words" id:12345,deny,status:500</programlisting>
    </section>

    <section>
      <title><literal>MULTIPART_CRLF_LF_LINES</literal></title>

      <para>This flag variable will be set to <literal>1</literal> whenever a
      multi-part request uses mixed line terminators. The
      <literal>multipart/form-data</literal> RFC requires
      <literal>CRLF</literal> sequence to be used to terminate lines. Since
      some client implementations use only <literal>LF</literal> to terminate
      lines you might want to allow them to proceed under certain
      circumstances (if you want to do this you will need to stop using
      <literal>MULTIPART_STRICT_ERROR</literal> and check each multi-part flag
      variable individually, avoiding <literal>MULTIPART_LF_LINE</literal>).
      However, mixing <literal>CRLF</literal> and <literal>LF</literal> line
      terminators is dangerous as it can allow for evasion. Therefore, in such
      cases, you will have to add a check for
      <literal>MULTIPART_CRLF_LF_LINES</literal>.</para>
    </section>

    <section>
      <title><literal>MULTIPART_STRICT_ERROR</literal></title>

      <para><literal>MULTIPART_STRICT_ERROR</literal> will be set to
      <literal>1</literal> when any of the following variables is also set to
      <literal>1</literal>: <literal>REQBODY_PROCESSOR_ERROR</literal>,
      <literal>MULTIPART_BOUNDARY_QUOTED</literal>,
      <literal>MULTIPART_BOUNDARY_WHITESPACE</literal>,
      <literal>MULTIPART_DATA_BEFORE</literal>,
      <literal>MULTIPART_DATA_AFTER</literal>,
      <literal>MULTIPART_HEADER_FOLDING</literal>,
      <literal>MULTIPART_LF_LINE</literal>,
      <literal>MULTIPART_SEMICOLON_MISSING</literal>
      <literal>MULTIPART_INVALID_QUOTING</literal>
      <literal>MULTIPART_INVALID_HEADER_FOLDING</literal>
      <literal>MULTIPART_FILE_LIMIT_EXCEEDED</literal>. Each of these
      variables covers one unusual (although sometimes legal) aspect of the
      request body in <literal>multipart/form-data format</literal>. Your
      policies should <emphasis>always</emphasis> contain a rule to check
      either this variable (easier) or one or more individual variables (if
      you know exactly what you want to accomplish). Depending on the rate of
      false positives and your default policy you should decide whether to
      block or just warn when the rule is triggered.</para>

      <para>The best way to use this variable is as in the example
      below:</para>

      <programlisting>SecRule MULTIPART_STRICT_ERROR "!@eq 0" \
"phase:2,t:none,log,deny,msg:'Multipart request body \
failed strict validation: \
PE %{REQBODY_PROCESSOR_ERROR}, \
BQ %{MULTIPART_BOUNDARY_QUOTED}, \
BW %{MULTIPART_BOUNDARY_WHITESPACE}, \
DB %{MULTIPART_DATA_BEFORE}, \
DA %{MULTIPART_DATA_AFTER}, \
HF %{MULTIPART_HEADER_FOLDING}, \
LF %{MULTIPART_LF_LINE}, \
SM %{MULTIPART_SEMICOLON_MISSING}, \
IQ %{MULTIPART_INVALID_QUOTING}, \
IQ %{MULTIPART_INVALID_HEADER_FOLDING}, \
FE %{MULTIPART_FILE_LIMIT_EXCEEDED}'"</programlisting>

      <para>The <literal>multipart/form-data</literal> parser was upgraded in
      ModSecurity v2.1.3 to actively look for signs of evasion. Many variables
      (as listed above) were added to expose various facts discovered during
      the parsing process. The <literal>MULTIPART_STRICT_ERROR</literal>
      variable is handy to check on all abnormalities at once. The individual
      variables allow detection to be fine-tuned according to your
      circumstances in order to reduce the number of false positives. Detailed
      analysis of various evasion techniques covered will be released as a
      separated document at a later date.</para>
    </section>

    <section>
      <title><literal>MULTIPART_UNMATCHED_BOUNDARY</literal></title>

      <para>Set to <literal>1</literal> when, during the parsing phase of a
      <literal>multipart/request-body</literal>, ModSecurity encounters what
      feels like a boundary but it is not. Such an event may occur when
      evasion of ModSecurity is attempted.</para>

      <para>The best way to use this variable is as in the example
      below:</para>

      <programlisting>SecRule MULTIPART_UNMATCHED_BOUNDARY "!@eq 0" \
"phase:2,t:none,log,deny,msg:'Multipart parser detected a possible unmatched boundary.'"</programlisting>

      <para>Change the rule from blocking to logging-only if many false
      positives are encountered.</para>
    </section>

    <section>
      <title><literal moreinfo="none">PATH_INFO</literal></title>

      <para>Besides passing query information to a script/handler, you can
      also pass additional data, known as extra path information, as part of
      the URL. Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> PATH_INFO</emphasis> "^/(bin|etc|sbin|opt|usr)"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">QUERY_STRING</literal></title>

      <para>This variable holds form data passed to the script/handler by
      appending data after a question mark. Warning: Not URL-decoded.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>QUERY_STRING</emphasis> "attack"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REMOTE_ADDR</literal></title>

      <para>This variable holds the IP address of the remote client.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REMOTE_ADDR</emphasis> "^192\.168\.1\.101$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REMOTE_HOST</literal></title>

      <para>If HostnameLookUps are set to On, then this variable will hold the
      DNS resolved remote host name. If it is set to Off, then it will hold
      the remote IP address. Possible uses for this variable would be to deny
      known bad client hosts or network blocks, or conversely, to allow in
      authorized hosts. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REMOTE_HOST</emphasis> "\.evil\.network\org$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REMOTE_PORT</literal></title>

      <para>This variable holds information on the source port that the client
      used when initiating the connection to our web server. Example: in this
      example, we are evaluating to see if the <literal>REMOTE_PORT</literal>
      is less than 1024, which would indicate that the user is a privileged
      user (root).</para>

      <programlisting format="linespecific">SecRule <emphasis>REMOTE_PORT</emphasis> "@lt 1024" phase:1,log,pass,setenv:remote_port=privileged</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REMOTE_USER</literal></title>

      <para>This variable holds the username of the authenticated user. If
      there are no password (basic|digest) access controls in place, then this
      variable will be empty. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REMOTE_USER</emphasis> "admin"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This data will not be available in a proxy-mode deployment as the
      authentication is not local.</para>
    </section>

    <section>
      <title><literal moreinfo="none">REQBODY_PROCESSOR</literal></title>

      <para>Built-in processors are <literal
      moreinfo="none">URLENCODED</literal>,<literal moreinfo="none">
      MULTIPART</literal>, and <literal moreinfo="none">XML</literal>.
      Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> REQBODY_PROCESSOR</emphasis> "^XML$ chain
SecRule XML "@validateDTD /opt/apache-frontend/conf/xml.dtd"</programlisting>
    </section>

    <section>
      <title><literal
      moreinfo="none">REQBODY_PROCESSOR_ERROR</literal></title>

      <para>Possible values are 0 (no error) or 1 (error). This variable will
      be set by request body processors (typically the
      <classname>multipart/request-data</classname> parser or the XML parser)
      when they fail to properly parse a request payload.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> REQBODY_PROCESSOR_ERROR</emphasis> "@eq 1" deny,phase:2</programlisting>

      <note>
        <para>Your policies <emphasis>must</emphasis> have a rule to check
        REQBODY_PROCESSOR_ERROR at the beginning of phase 2. Failure to do so
        will leave the door open for impedance mismatch attacks. It is
        possible, for example, that a payload that cannot be parsed by
        ModSecurity can be successfully parsed by more tolerant parser
        operating in the application. If your policy dictates blocking then
        you should reject the request if error is detected. When operating in
        detection-only mode your rule should alert with high severity when
        request body processing fails.</para>
      </note>
    </section>

    <section>
      <title><literal
      moreinfo="none">REQBODY_PROCESSOR_ERROR_MSG</literal></title>

      <para>Empty, or contains the error message from the processor.
      Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> REQBODY_PROCESSOR_ERROR_MSG</emphasis> "failed to parse" t:lowercase</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_BASENAME</literal></title>

      <para>This variable holds just the filename part of
      <literal>REQUEST_FILENAME</literal> (e.g. index.php).</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_BASENAME</emphasis> "^login\.php$" phase:2,t:none,t:lowercase</programlisting>

      <note>
        <para>Please note that anti-evasion transformations are not applied to
        this variable by default. <literal>REQUEST_BASENAME</literal> will
        recognise both <literal>/</literal> and <literal>\</literal> as path
        separators.</para>
      </note>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_BODY</literal></title>

      <para>This variable holds the data in the request body (including
      <literal>POST_PAYLOAD</literal> data). <literal>REQUEST_BODY</literal>
      should be used if the original order of the arguments is important
      (<literal>ARGS</literal> should be used in all other cases).
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_BODY</emphasis> "^username=\w{25,}\&amp;password=\w{25,}\&amp;Submit\=login$"</programlisting>

      <note>
        <para>This variable is only available if the
        <literal>URLENCODED</literal> request body processor parsed a request
        body. This will occur by default when an
        <literal>application/x-www-form-urlencoded</literal> is detected, or
        the <literal>URLENCODED</literal> request body parser is forced. As of
        2.5.7 it is possible to force the presence of the
        <literal>REQUEST_BODY</literal> variable, but only when there is no
        request body processor defined, using the
        <literal>ctl:forceRequestBodyVariable</literal> option in the
        <literal>REQUEST_HEADERS</literal> phase.</para>
      </note>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_COOKIES</literal></title>

      <para>This variable is a collection of all of the cookie data. Example:
      the following example is using the Ampersand special operator to count
      how many variables are in the collection. In this rule, it would trigger
      if the request does not include any Cookie headers.</para>

      <programlisting format="linespecific">SecRule<emphasis> &amp;REQUEST_COOKIES</emphasis> "@eq 0"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_COOKIES_NAMES</literal></title>

      <para>This variable is a collection of the cookie names in the request
      headers. Example: the following rule will trigger if the JSESSIONID
      cookie is not present.</para>

      <programlisting format="linespecific">SecRule<emphasis> &amp;REQUEST_COOKIES_NAMES:JSESSIONID</emphasis> "@eq 0"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_FILENAME</literal></title>

      <para>This variable holds the relative <literal>REQUEST_URI</literal>
      minus the <literal>QUERY_STRING</literal> part (e.g. /index.php).
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_FILENAME</emphasis> "^/cgi-bin/login\.php$" phase:2,t:none,t:normalisePath</programlisting>

      <note>
        <para>Please note that anti-evasion transformations are not used on
        <literal>REQUEST_FILENAME</literal> by default.</para>
      </note>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_HEADERS</literal></title>

      <para>This variable can be used as either a collection of all of the
      request headers or can be used to specify individual headers (by using
      REQUEST_HEADERS<emphasis>:Header-Name</emphasis>). Example: the first
      example uses <literal>REQUEST_HEADERS</literal> as a collection and is
      applying the <literal>validateUrlEncoding</literal> operator against all
      headers.</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_HEADERS</emphasis> "@validateUrlEncoding"</programlisting>

      <para>Example: the second example is targeting only the
      <literal>Host</literal> header.</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_HEADERS:Host</emphasis> "^[\d\.]+$" \
    "deny,log,status:400,msg:'Host header is a numeric IP address'"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_HEADERS_NAMES</literal></title>

      <para>This variable is a collection of the names of all of the request
      headers. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_HEADERS_NAMES</emphasis> "^x-forwarded-for" \
    "log,deny,status:403,t:lowercase,msg:'Proxy Server Used'"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_LINE</literal></title>

      <para>This variable holds the complete request line sent to the server
      (including the REQUEST_METHOD and HTTP version data). Example: this
      example rule will trigger if the request method is something other than
      GET, HEAD, POST or if the HTTP is something other than HTTP/0.9, 1.0 or
      1.1.</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_LINE</emphasis> "!(^((?:(?:pos|ge)t|head))|http/(0\.9|1\.0|1\.1)$)" t:none,t:lowercase</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_METHOD</literal></title>

      <para>This variable holds the request method used by the client.</para>

      <para>The following example will trigger if the request method is either
      <literal>CONNECT</literal> or TRACE.</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_METHOD</emphasis> "^((?:connect|trace))$" t:none,t:lowercase</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_PROTOCOL</literal></title>

      <para>This variable holds the request protocol version information.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_PROTOCOL</emphasis> "!^http/(0\.9|1\.0|1\.1)$" t:none,t:lowercase</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_URI</literal></title>

      <para>This variable holds the full URL including the
      <literal>QUERY_STRING</literal> data (e.g. /index.php?p=X), however it
      will never contain a domain name, even if it was provided on the request
      line. It also does not include either the
      <literal>REQUEST_METHOD</literal> or the HTTP version info.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>REQUEST_URI</emphasis> "attack" phase:1,t:none,t:urlDecode,t:lowercase,t:normalisePath</programlisting>

      <note>
        <para>Please note that anti-evasion transformations are not used on
        <literal>REQUEST_URI</literal> by default.</para>
      </note>
    </section>

    <section>
      <title><literal moreinfo="none">REQUEST_URI_RAW</literal></title>

      <para>Same as <literal>REQUEST_URI</literal> but will contain the domain
      name if it was provided on the request line (e.g.
      http://www.example.com/index.php?p=X).</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> REQUEST_URI_RAW</emphasis> "http:/" phase:1,t:none,t:urlDecode,t:lowercase,t:normalisePath</programlisting>

      <note>
        <para>Please note that anti-evasion transformations are not used on
        <literal>REQUEST_URI_RAW</literal> by default.</para>
      </note>
    </section>

    <section>
      <title><literal moreinfo="none">RESPONSE_BODY</literal></title>

      <para>This variable holds the data for the response payload.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> RESPONSE_BODY</emphasis> "ODBC Error Code"</programlisting>
    </section>

    <section>
      <title><literal>RESPONSE_CONTENT_LENGTH</literal></title>

      <para>Response body length in bytes. Can be available starting with
      phase 3 but it does not have to be (as the length of response body is
      not always known in advance.) If the size is not known this variable
      will contain a zero. If <literal>RESPONSE_CONTENT_LENGTH</literal>
      contains a zero in phase 5 that means the actual size of the response
      body was 0.</para>

      <para>The value of this variable can change between phases if the body
      is modified. For example, in embedded mode
      <literal>mod_deflate</literal> can compress the response body between
      phases 4 and 5.</para>
    </section>

    <section>
      <title><literal>RESPONSE_CONTENT_TYPE</literal></title>

      <para>Response content type. Only available starting with phase
      3.</para>
    </section>

    <section>
      <title><literal moreinfo="none">RESPONSE_HEADERS</literal></title>

      <para>This variable is similar to the REQUEST_HEADERS variable and can
      be used in the same manner. Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> RESPONSE_HEADERS</emphasis><emphasis>:X-Cache</emphasis> "MISS"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This variable may not have access to some headers when running in
      embedded-mode. Headers such as Server, Date, Connection and Content-Type
      are added during a later Apache hook just prior to sending the data to
      the client. This data should be available, however, either during
      ModSecurity phase:5 (logging) or when running in proxy-mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">RESPONSE_HEADERS_NAMES</literal></title>

      <para>This variable is a collection of the response header names.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>RESPONSE_HEADERS_NAMES</emphasis> "Set-Cookie"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Same limitations as RESPONSE_HEADERS with regards to access to
      some headers in embedded-mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">RESPONSE_PROTOCOL</literal></title>

      <para>This variable holds the HTTP response protocol information.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>RESPONSE_PROTOCOL</emphasis> "^HTTP\/0\.9"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">RESPONSE_STATUS</literal></title>

      <para>This variable holds the HTTP response status code as generated by
      Apache. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>RESPONSE_STATUS</emphasis> "^[45]"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This directive may not work as expected in embedded-mode as Apache
      handles many of the stock response codes (404, 401, etc...) earlier in
      Phase 2. This variable should work as expected in a proxy-mode
      deployment.</para>
    </section>

    <section>
      <title><literal moreinfo="none">RULE</literal></title>

      <para>This variable provides access to the <literal
      moreinfo="none">id</literal>, <literal moreinfo="none">rev</literal>,
      <literal moreinfo="none">severity</literal>, <literal
      moreinfo="none">logdata</literal>, and <literal
      moreinfo="none">msg</literal> fields of the rule that triggered the
      action. Only available for expansion in action strings (e.g.<literal
      moreinfo="none">setvar:tx.varname=%{rule.id}</literal>). Example:</para>

      <programlisting format="linespecific">SecRule &amp;REQUEST_HEADERS:Host "@eq 0" "log,deny,setvar:tx.varname=<emphasis>%{rule.id}</emphasis>"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">SCRIPT_BASENAME</literal></title>

      <para>This variable holds just the local filename part of
      SCRIPT_FILENAME. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>SCRIPT_BASENAME</emphasis> "^login\.php$"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This variable is not available in proxy mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">SCRIPT_FILENAME</literal></title>

      <para>This variable holds the full path on the server to the requested
      script. (e.g. SCRIPT_NAME plus the server path). Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>SCRIPT_FILENAME</emphasis> "^/usr/local/apache/cgi-bin/login\.php$"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This variable is not available in proxy mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">SCRIPT_GID</literal></title>

      <para>This variable holds the group id (numerical value) of the group
      owner of the script. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>SCRIPT_GID</emphasis> "!^46$"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This variable is not available in proxy mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">SCRIPT_GROUPNAME</literal></title>

      <para>This variable holds the group name of the group owner of the
      script. Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> SCRIPT_GROUPNAME</emphasis> "!^apache$"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This variable is not available in proxy mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">SCRIPT_MODE</literal></title>

      <para>This variable holds the script's permissions mode data (numerical
      - 1=execute, 2=write, 4=read and 7=read/write/execute). Example: will
      trigger if the script has the WRITE permissions set.</para>

      <programlisting format="linespecific">SecRule <emphasis>SCRIPT_MODE</emphasis> "^(2|3|6|7)$"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This variable is not available in proxy mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">SCRIPT_UID</literal></title>

      <para>This variable holds the user id (numerical value) of the owner of
      the script. Example: the example rule below will trigger if the UID is
      not 46 (the Apache user).</para>

      <programlisting format="linespecific">SecRule<emphasis> SCRIPT_UID</emphasis> "!^46$"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This variable is not available in proxy mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">SCRIPT_USERNAME</literal></title>

      <para>This variable holds the username of the owner of the script.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>SCRIPT_USERNAME</emphasis> "!^apache$"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This variable is not available in proxy mode.</para>
    </section>

    <section>
      <title><literal moreinfo="none">SERVER_ADDR</literal></title>

      <para>This variable contains the IP address of the server.
      Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> SERVER_ADDR</emphasis> "^192\.168\.1\.100$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">SERVER_NAME</literal></title>

      <para>This variable contains the server's hostname or IP address.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>SERVER_NAME</emphasis> "hostname\.com$"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This data is taken from the Host header submitted in the client
      request.</para>
    </section>

    <section>
      <title><literal moreinfo="none">SERVER_PORT</literal></title>

      <para>This variable contains the local port that the web server is
      listening on. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>SERVER_PORT</emphasis> "^80$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">SESSION</literal></title>

      <para>This variable is a collection, available only after <literal
      moreinfo="none">setsid</literal> is executed. Example: the following
      example shows how to initialize a SESSION collection with setsid, how to
      use setvar to increase the session.score values, how to set the
      session.blocked variable and finally how to deny the connection based on
      the session:blocked value.</para>

      <programlisting format="linespecific">SecRule REQUEST_COOKIES:PHPSESSID !^$ chain,nolog,pass
SecAction setsid:%{REQUEST_COOKIES.PHPSESSID}
SecRule REQUEST_URI "^/cgi-bin/finger$" \
    "phase:2,t:none,t:lowercase,t:normalisePath,pass,log,setvar:<emphasis>session.score</emphasis>=+10"
SecRule<emphasis> SESSION:SCORE</emphasis> "@gt 50" "pass,log,setvar:<emphasis>session.blocked</emphasis>=1"
SecRule<emphasis> SESSION:BLOCKED</emphasis> "@eq 1" "log,deny,status:403"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">SESSIONID</literal></title>

      <para>This variable is the value set with <literal
      moreinfo="none">setsid</literal>. Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>SESSIONID</emphasis> !^$ chain,nolog,pass
SecRule REQUEST_COOKIES:PHPSESSID !^$
SecAction setsid:%{REQUEST_COOKIES.PHPSESSID}</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME</literal></title>

      <para>This variable holds a formatted string representing the time
      (hour:minute:second). Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> TIME</emphasis> "^(([1](8|9))|([2](0|1|2|3))):\d{2}:\d{2}$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME_DAY</literal></title>

      <para>This variable holds the current date (1-31). Example: this rule
      would trigger anytime between the 10th and 20th days of the
      month.</para>

      <programlisting format="linespecific">SecRule <emphasis>TIME_DAY</emphasis> "^(([1](0|1|2|3|4|5|6|7|8|9))|20)$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME_EPOCH</literal></title>

      <para>This variable holds the time in seconds since 1970.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>TIME_EPOCH</emphasis> "@gt 1000"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME_HOUR</literal></title>

      <para>This variable holds the current hour (0-23). Example: this rule
      would trigger during "off hours".</para>

      <programlisting format="linespecific">SecRule<emphasis> TIME_HOUR</emphasis> "^(0|1|2|3|4|5|6|[1](8|9)|[2](0|1|2|3))$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME_MIN</literal></title>

      <para>This variable holds the current minute (0-59). Example: this rule
      would trigger during the last half hour of every hour.</para>

      <programlisting format="linespecific">SecRule <emphasis>TIME_MIN</emphasis> "^(3|4|5)"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME_MON</literal></title>

      <para>This variable holds the current month (0-11). Example: this rule
      would match if the month was either November (10) or December
      (11).</para>

      <programlisting format="linespecific">SecRule<emphasis> TIME_MON</emphasis> "^1"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME_SEC</literal></title>

      <para>This variable holds the current second count (0-59).
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>TIME_SEC</emphasis> "@gt 30"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME_WDAY</literal></title>

      <para>This variable holds the current weekday (0-6). Example: this rule
      would trigger only on week-ends (Saturday and Sunday).</para>

      <programlisting format="linespecific">SecRule <emphasis>TIME_WDAY</emphasis> "^(0|6)$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TIME_YEAR</literal></title>

      <para>This variable holds the current four-digit year data.
      Example:</para>

      <programlisting format="linespecific">SecRule <emphasis>TIME_YEAR</emphasis> "^2006$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">TX</literal></title>

      <para>Transaction Collection. This is used to store pieces of data,
      create a transaction anomaly score, and so on. Transaction variables are
      set for 1 request/response cycle. The scoring and evaluation will not
      last past the current request/response process. Example: In this
      example, we are using setvar to increase the tx.score value by 5 points.
      We then have a follow-up run that will evaluate the transactional score
      this request and then it will decided whether or not to allow/deny the
      request through.</para>

      <para>The following is a list of reserved names in the TX
      collection:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">TX:0</literal> - The matching value
          when using the <literal moreinfo="none">@rx</literal> or <literal
          moreinfo="none">@pm</literal> operator with the <literal
          moreinfo="none">capture</literal> action.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">TX:1-TX:9</literal> - The captured
          subexpression value when using the <literal
          moreinfo="none">@rx</literal> operator with capturing parens and the
          <literal moreinfo="none">capture</literal> action.</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">TX:MSC_.*</literal> - ModSecurity
          processing flags.</para>

          <itemizedlist>
            <listitem>
              <para><literal
              moreinfo="none">MSC_PCRE_LIMITS_EXCEEDED</literal> - Set
              non-zero if PCRE match limits are exceeded. See <literal
              moreinfo="none">SecPcreMatchLimit</literal> and <literal
              moreinfo="none">SecPcreMatchLimitRecursion</literal>.</para>
            </listitem>
          </itemizedlist>
        </listitem>
      </itemizedlist>

      <programlisting format="linespecific">SecRule WEBSERVER_ERROR_LOG "does not exist" "phase:5,pass,<emphasis>setvar:tx.score=+5</emphasis>"
SecRule<emphasis> TX:SCORE</emphasis> "@gt 20" deny,log</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">USERID</literal></title>

      <para>This variable is the value set with <literal
      moreinfo="none">setuid</literal>. Example:</para>

      <programlisting format="linespecific">SecAction setuid:%{REMOTE_USER},nolog
SecRule<emphasis> USERID</emphasis> "Admin"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">WEBAPPID</literal></title>

      <para>This variable is the value set with <literal
      moreinfo="none">SecWebAppId</literal>. Example:</para>

      <programlisting format="linespecific">SecWebAppId "WebApp1"
SecRule<emphasis> WEBAPPID</emphasis> "WebApp1" "chain,log,deny,status:403"
SecRule REQUEST_HEADERS:Transfer-Encoding "!^$"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">WEBSERVER_ERROR_LOG</literal></title>

      <para>Contains zero or more error messages produced by the web server.
      Access to this variable is in phase:5 (logging). Example:</para>

      <programlisting format="linespecific">SecRule<emphasis> WEBSERVER_ERROR_LOG</emphasis> "File does not exist" "phase:5,setvar:tx.score=+5"</programlisting>
    </section>

    <section>
      <title><literal moreinfo="none">XML</literal></title>

      <para>Can be used standalone (as a target for
      <literal>validateDTD</literal> and <literal>validateSchema</literal>) or
      with an XPath expression parameter (which makes it a valid target for
      any function that accepts plain text). Example using XPath:</para>

      <programlisting format="linespecific">SecDefaultAction log,deny,status:403,phase:2
SecRule REQUEST_HEADERS:Content-Type ^text/xml$ \
    phase:1,t:lowercase,nolog,pass,ctl:requestBodyProcessor=<emphasis>XML</emphasis>
SecRule REQBODY_PROCESSOR "<emphasis>!^XML$</emphasis>" skipAfter:12345
SecRule <emphasis>XML:/employees/employee/name/text()</emphasis> Fred
SecRule <emphasis>XML:/xq:employees/employee/name/text()</emphasis> Fred \
    id:12345,xmlns:xq=http://www.example.com/employees</programlisting>

      <para>The first XPath expression does not use namespaces. It would match
      against payload such as this one:</para>

      <programlisting>&lt;employees&gt;
    &lt;employee&gt;
        &lt;name&gt;Fred Jones&lt;/name&gt;
        &lt;address location="home"&gt;
            &lt;street&gt;900 Aurora Ave.&lt;/street&gt;
            &lt;city&gt;Seattle&lt;/city&gt;
            &lt;state&gt;WA&lt;/state&gt;
            &lt;zip&gt;98115&lt;/zip&gt;
        &lt;/address&gt;
        &lt;address location="work"&gt;
            &lt;street&gt;2011 152nd Avenue NE&lt;/street&gt;
            &lt;city&gt;Redmond&lt;/city&gt;
            &lt;state&gt;WA&lt;/state&gt;
            &lt;zip&gt;98052&lt;/zip&gt;
        &lt;/address&gt;
        &lt;phone location="work"&gt;(425)555-5665&lt;/phone&gt;
        &lt;phone location="home"&gt;(206)555-5555&lt;/phone&gt;
        &lt;phone location="mobile"&gt;(206)555-4321&lt;/phone&gt;
    &lt;/employee&gt;
&lt;/employees&gt;</programlisting>

      <para>The second XPath expression does use namespaces. It would match
      the following payload:</para>

      <programlisting>&lt;xq:employees xmlns:xq="http://www.example.com/employees"&gt;
    &lt;employee&gt;
        &lt;name&gt;Fred Jones&lt;/name&gt;
        &lt;address location="home"&gt;
            &lt;street&gt;900 Aurora Ave.&lt;/street&gt;
            &lt;city&gt;Seattle&lt;/city&gt;
            &lt;state&gt;WA&lt;/state&gt;
            &lt;zip&gt;98115&lt;/zip&gt;
        &lt;/address&gt;
        &lt;address location="work"&gt;
            &lt;street&gt;2011 152nd Avenue NE&lt;/street&gt;
            &lt;city&gt;Redmond&lt;/city&gt;
            &lt;state&gt;WA&lt;/state&gt;
            &lt;zip&gt;98052&lt;/zip&gt;
        &lt;/address&gt;
        &lt;phone location="work"&gt;(425)555-5665&lt;/phone&gt;
        &lt;phone location="home"&gt;(206)555-5555&lt;/phone&gt;
        &lt;phone location="mobile"&gt;(206)555-4321&lt;/phone&gt;
    &lt;/employee&gt;
&lt;/xq:employees&gt;</programlisting>

      <para>Note the different namespace used in the second example.</para>

      <para>To learn more about XPath we suggest the following
      resources:</para>

      <orderedlist>
        <listitem>
          <para><ulink url="http://www.w3.org/TR/xpath">XPath
          Standard</ulink></para>
        </listitem>

        <listitem>
          <para><ulink
          url="http://www.zvon.org/xxl/XPathTutorial/General/examples.html">XPath
          Tutorial</ulink></para>
        </listitem>
      </orderedlist>
    </section>
  </section>

  <section id="transformation-functions">
    <title>Transformation functions</title>

    <para>When ModSecurity receives request or response information, it makes
    a copy of this data and places it into memory. It is on this data in
    memory that transformation functions are applied. The raw request/response
    data is never altered. Transformation functions are used to transform a
    variable before testing it in a rule.</para>

    <para><emphasis>Note</emphasis></para>

    <para>There are no default transformation functions as there were in
    previous versions of ModSecurity.</para>

    <para>The following rule will ensure that an attacker does not use mixed
    case in order to evade the ModSecurity rule:</para>

    <para><programlisting format="linespecific">SecRule ARGS:p "xp_cmdshell" <emphasis>"t:lowercase"</emphasis></programlisting>
    multiple transformation actions can be used in the same rule, for example
    the following rule also ensures that an attacker does not use URL encoding
    (%xx encoding) for evasion. Note the order of the transformation
    functions, which ensures that a URL encoded letter is first decoded and
    than translated to lower case.</para>

    <para><programlisting format="linespecific">SecRule ARGS:p "xp_cmdshell" <emphasis>"t:urlDecode,t:lowercase"</emphasis></programlisting></para>

    <para>One can use the SecDefaultAction command to ensure the translation
    occurs for every rule until the next. Note that transformation actions are
    additive, so if a rule explicitly list actions, the translation actions
    set by SecDefaultAction are still performed.</para>

    <para><programlisting format="linespecific">SecDefaultAction <emphasis>t:urlDecode,t:lowercase</emphasis></programlisting></para>

    <para>The following transformation functions are supported:</para>

    <section>
      <title><literal>base64Decode</literal></title>

      <para>This function decodes a base64-encoded string.</para>
    </section>

    <section>
      <title><literal>base64Encode</literal></title>

      <para>This function encodes input string using base64 encoding.</para>
    </section>

    <section>
      <title><literal>compressWhitespace</literal></title>

      <para>It converts whitespace characters (32, \f, \t, \n, \r, \v, 160) to
      spaces (ASCII 32) and then compresses multiple consecutive space
      characters into one.</para>
    </section>

    <section>
      <title>cssDecode</title>

      <para>Decodes CSS-encoded characters, as specified at <ulink
      url="http://www.w3.org/TR/REC-CSS2/syndata.html">http://www.w3.org/TR/REC-CSS2/syndata.html</ulink>.
      This function uses only up to two bytes in the decoding process, meaning
      it is useful to uncover ASCII characters (that wouldn't normally be
      encoded) encoded using CSS encoding, or to counter evasion which is a
      combination of a backslash and non-hexadecimal characters (e.g.
      <literal>ja\vascript</literal> is equivalent to
      <literal>javascript</literal>).</para>
    </section>

    <section>
      <title><literal>escapeSeqDecode</literal></title>

      <para>This function decode ANSI C escape sequences:<literal
      moreinfo="none"> \a</literal>,<literal moreinfo="none"> \b</literal>,
      <literal moreinfo="none">\f</literal>, <literal
      moreinfo="none">\n</literal>, <literal moreinfo="none">\r</literal>,
      <literal moreinfo="none">\t</literal>, <literal
      moreinfo="none">\v</literal>, <literal moreinfo="none">\\</literal>,
      <literal moreinfo="none">\?</literal>, <literal
      moreinfo="none">\'</literal>, <literal moreinfo="none">\"</literal>,
      <literal moreinfo="none">\xHH</literal> (hexadecimal), <literal
      moreinfo="none">\0OOO</literal> (octal). Invalid encodings are left in
      the output.</para>
    </section>

    <section>
      <title><literal>hexDecode</literal></title>

      <para>This function decodes a hex-encoded string.</para>
    </section>

    <section>
      <title><literal>hexEncode</literal></title>

      <para>This function encodes input as hex-encoded string.</para>
    </section>

    <section>
      <title><literal>htmlEntityDecode</literal></title>

      <para>This function decodes HTML entities present in input. The
      following variants are supported:</para>

      <itemizedlist>
        <listitem>
          <para><literal moreinfo="none">&amp;#xHH</literal> and <literal
          moreinfo="none">&amp;#xHH;</literal> (where H is any hexadecimal
          number)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">&amp;#DDD</literal> and <literal
          moreinfo="none">&amp;#DDD;</literal> (where D is any decimal
          number)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">&amp;quot</literal> and <literal
          moreinfo="none">&amp;quot;</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">&amp;nbsp</literal> and <literal
          moreinfo="none">&amp;nbsp;</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">&amp;lt</literal> and <literal
          moreinfo="none">&amp;lt;</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">&amp;gt</literal> and <literal
          moreinfo="none">&amp;gt;</literal></para>
        </listitem>
      </itemizedlist>

      <para>This function will convert any entity into a single byte only,
      possibly resulting in a loss of information. It is thus useful to
      uncover bytes that would otherwise not need to be encoded, but it cannot
      do anything with the characters from the range above 255.</para>
    </section>

    <section>
      <title><literal>jsDecode</literal></title>

      <para>Decodes JavaScript escape sequences. If a
      <literal>\uHHHH</literal> code is in the range of
      <literal>FF01</literal>-<literal>FF5E</literal> (the full width ASCII
      codes), then the higher byte is used to detect and adjust the lower
      byte. Otherwise, only the lower byte will be used and the higher byte
      zeroed.</para>
    </section>

    <section>
      <title><literal>length</literal></title>

      <para>This function converts the input to its numeric length (count of
      bytes).</para>
    </section>

    <section>
      <title><literal>lowercase</literal></title>

      <para>This function converts all characters to lowercase using the
      current C locale.</para>
    </section>

    <section>
      <title><literal>md5</literal></title>

      <para>This function calculates an MD5 hash from input. Note that the
      computed hash is in a raw binary form and may need encoded into text to
      be usable (for example: <literal>t:md5,t:hexEncode</literal>).</para>
    </section>

    <section>
      <title><literal><literal>none</literal></literal></title>

      <para>Not an actual transformation function, but an instruction to
      ModSecurity to remove all transformation functions associated with the
      current rule.</para>
    </section>

    <section>
      <title><literal>normalisePath</literal></title>

      <para>This function will remove multiple slashes, self-references and
      directory back-references (except when they are at the beginning of the
      input).</para>
    </section>

    <section>
      <title><literal>normalisePathWin</literal></title>

      <para>Same as <literal>normalisePath</literal>, but will first convert
      backslash characters to forward slashes.</para>
    </section>

    <section>
      <title><literal>parityEven7bit</literal></title>

      <para>This function calculates even parity of 7-bit data replacing the
      8th bit of each target byte with the calculated parity bit.</para>
    </section>

    <section>
      <title><literal>parityOdd7bit</literal></title>

      <para>This function calculates odd parity of 7-bit data replacing the
      8th bit of each target byte with the calculated parity bit.</para>
    </section>

    <section>
      <title><literal>parityZero7bit</literal></title>

      <para>This function calculates zero parity of 7-bit data replacing the
      8th bit of each target byte with a zero parity bit which allows
      inspection of even/odd parity 7bit data as ASCII7 data.</para>
    </section>

    <section>
      <title><literal>removeNulls</literal></title>

      <para>This function removes NULL bytes from input.</para>
    </section>

    <section>
      <title><literal>removeWhitespace</literal></title>

      <para>This function removes all whitespace characters from input.</para>
    </section>

    <section>
      <title><literal>replaceComments</literal></title>

      <para>This function replaces each occurrence of a C-style comments
      (<literal moreinfo="none">/* ... */</literal>) with a single space
      (multiple consecutive occurrences of a space will not be compressed).
      Unterminated comments will too be replaced with a space (ASCII 32).
      However, a standalone termination of a comment (<literal
      moreinfo="none">*/</literal>) will not be acted upon.</para>
    </section>

    <section>
      <title><literal>replaceNulls</literal></title>

      <para>This function is enabled by default. It replaces NULL bytes in
      input with spaces (ASCII 32).</para>
    </section>

    <section>
      <title><literal>urlDecode</literal></title>

      <para>This function decodes an URL-encoded input string. Invalid
      encodings (i.e. the ones that use non-hexadecimal characters, or the
      ones that are at the end of string and have one or two characters
      missing) will not be converted. If you want to detect invalid encodings
      use the <literal moreinfo="none">@validateUrlEncoding</literal>
      operator. The transformation function should not be used against
      variables that have already been URL-decoded unless it is your intention
      to perform URL decoding twice!</para>
    </section>

    <section>
      <title><literal>urlDecodeUni</literal></title>

      <para>In addition to decoding <literal>%xx</literal> like <literal
      moreinfo="none">urlDecode, urlDecodeUni</literal> also decodes <literal
      moreinfo="none">%uXXXX</literal> encoding. If the code is in the range
      of <literal>FF01</literal>-<literal>FF5E</literal> (the full width ASCII
      codes), then the higher byte is used to detect and adjust the lower
      byte. Otherwise, only the lower byte will be used and the higher byte
      zeroed.</para>
    </section>

    <section>
      <title><literal>urlEncode</literal></title>

      <para>This function encodes input using URL encoding.</para>
    </section>

    <section>
      <title><literal>sha1</literal></title>

      <para>This function calculates a SHA1 hash from input. Note that the
      computed hash is in a raw binary form and may need encoded to be usable
      (for example: <literal>t:sha1,t:hexEncode</literal>).</para>
    </section>

    <section>
      <title><literal>trimLeft</literal></title>

      <para>This function removes whitespace from the left side of
      input.</para>
    </section>

    <section>
      <title><literal>trimRight</literal></title>

      <para>This function removes whitespace from the right side of
      input.</para>
    </section>

    <section>
      <title><literal>trim</literal></title>

      <para>This function removes whitespace from both the left and right
      sides of input.</para>
    </section>
  </section>

  <section id="actions">
    <title>Actions</title>

    <para>Each action belongs to one of five groups:</para>

    <variablelist>
      <varlistentry>
        <term>Disruptive actions</term>

        <listitem>
          <para>Cause ModSecurity to do something. In many cases something
          means block transaction, but not in all. For example, the allow
          action is classified as a disruptive action, but it does the
          opposite of blocking. There can only be one disruptive action per
          rule (if there are multiple disruptive actions present, or
          inherited, only the last one will take effect), or rule chain (in a
          chain, a disruptive action can only appear in the first
          rule).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>Non-disruptive actions</term>

        <listitem>
          <para>Do something, but that something does not and cannot affect
          the rule processing flow. Setting a variable, or changing its value
          is an example of a non-disruptive action. Non-disruptive action can
          appear in any rule, including each rule belonging to a chain.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>Flow actions</term>

        <listitem>
          <para>These actions affect the rule flow (for example
          <literal>skip</literal> or <literal>skipAfter</literal>).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>Meta-data actions</term>

        <listitem>
          <para>Meta-data actions are used to provide more information about
          rules. Examples include <literal>id</literal>,
          <literal>rev</literal>, <literal>severity</literal> and
          <literal>msg</literal>.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>Data actions</term>

        <listitem>
          <para>Not really actions, these are mere containers that hold data
          used by other actions. For example, the <literal>status</literal>
          action holds the status that will be used for blocking (if it takes
          place).</para>
        </listitem>
      </varlistentry>
    </variablelist>

    <section>
      <title><literal>allow</literal></title>

      <para><emphasis>Description:</emphasis> Stops rule processing on a
      successful match and allows the transaction to proceed.</para>

      <para><emphasis>Action Group:</emphasis> Disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REMOTE_ADDR "^192\.168\.1\.100$" nolog,phase:1,<emphasis>allow</emphasis></programlisting>

      <para>Prior to ModSecurity 2.5 the <literal>allow</literal> action would
      only affect the current phase. An <literal>allow</literal> in phase 1
      would skip processing the remaining rules in phase 1 but the rules from
      phase 2 would execute. Starting with v2.5.0 <literal>allow</literal> was
      enhanced to allow for fine-grained control of what is done. The
      following rules now apply:</para>

      <orderedlist>
        <listitem>
          <para>If used one its own, like in the example above,
          <literal>allow</literal> will affect the entire transaction,
          stopping processing of the current phase but also skipping over all
          other phases apart from the logging phase. (The logging phase is
          special; it is designed to always execute.)</para>
        </listitem>

        <listitem>
          <para>If used with parameter "phase", <literal>allow</literal> will
          cause the engine to stop processing the current phase. Other phases
          will continue as normal.</para>
        </listitem>

        <listitem>
          <para>If used with parameter "request", <literal>allow</literal>
          will cause the engine to stop processing the current phase. The next
          phase to be processed will be phase
          <literal>RESPONSE_HEADERS</literal>.</para>
        </listitem>
      </orderedlist>

      <para>Examples:</para>

      <programlisting># Do not process request but process response.
SecAction phase:1,allow:request

# Do not process transaction (request and response).
SecAction phase:1,allow
</programlisting>

      <para>If you want to allow a response through, put a rule in phase
      <literal>RESPONSE_HEADERS</literal> and simply use
      <literal>allow</literal> on its own:</para>

      <programlisting># Allow response through.
SecAction phase:3,allow</programlisting>
    </section>

    <section>
      <title>append</title>

      <para><emphasis>Description:</emphasis> Appends text given as parameter
      to the end of response body. For this action to work content injection
      must be enabled by setting <literal>SecContentInjection</literal> to
      <literal>On</literal>. Also make sure you check the content type of the
      response before you make changes to it (e.g. you don't want to inject
      stuff into images).</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para><emphasis>Processing Phases:</emphasis> 3 and 4.</para>

      <para>Example:</para>

      <programlisting>SecRule RESPONSE_CONTENT_TYPE "^text/html" "nolog,pass,<emphasis>append:'&lt;hr&gt;Footer'</emphasis>"</programlisting>

      <note>
        <para>While macro expansion is allowed in the additional content, you
        are strongly cautioned against inserting user defined data
        fields.</para>
      </note>
    </section>

    <section>
      <title><literal>auditlog</literal></title>

      <para><emphasis>Description:</emphasis> Marks the transaction for
      logging in the audit log.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REMOTE_ADDR "^192\.168\.1\.100$" <emphasis>auditlog</emphasis>,phase:1,allow</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The auditlog action is now explicit if log is already
      specified.</para>
    </section>

    <section>
      <title><literal>block</literal></title>

      <para><emphasis>Description:</emphasis> Performs the default disruptive
      action.</para>

      <para><emphasis>Action Group:</emphasis> Disruptive</para>

      <para>It is intended to be used by ruleset writers to signify that the
      rule was intended to block and leaves the "how" up to the administrator.
      This action is currently a placeholder which will just be replaced by
      the action from the last <literal>SecDefaultAction</literal> in the same
      context. Using the <literal>block</literal> action with the
      <literal>SecRuleUpdateActionById</literal> directive allows a rule to be
      reverted back to the previous <literal>SecDefaultAction</literal>
      disruptive action.</para>

      <para>In future versions of ModSecurity, more control and functionality
      will be added to define "how" to block.</para>

      <para>Examples:</para>

      <para>In the following example, the second rule will "deny" because of
      the SecDefaultAction disruptive action. The intent being that the
      administrator could easily change this to another disruptive action
      without editing the actual rules.</para>

      <programlisting format="linespecific">### Administrator defines "how" to block (deny,status:403)...
SecDefaultAction phase:2,deny,status:403,log,auditlog

### Included from a rulest...
# Intent is to warn for this User Agent
SecRule REQUEST_HEADERS:User-Agent "perl" "phase:2,<emphasis>pass</emphasis>,msg:'Perl based user agent identified'"
# Intent is to block for this User Agent, "how" described in SecDefaultAction
SecRule REQUEST_HEADERS:User-Agent "nikto" "phase:2,<emphasis>block</emphasis>,msg:'Nikto Scanners Identified'"</programlisting>

      <para>In the following example, The rule is reverted back to the
      <literal>pass</literal> action defined in the SecDefaultAction directive
      by using the <literal>SecRuleUpdateActionById</literal> directive in
      conjuction with the <literal>block</literal> action. This allows an
      administrator to override an action in a 3rd party rule without
      modifying the rule itself.</para>

      <programlisting format="linespecific">### Administrator defines "how" to block (deny,status:403)...
SecDefaultAction phase:2,pass,log,auditlog

### Included from a rulest...
SecRule REQUEST_HEADERS:User-Agent "nikto" "id:1,phase:2,<emphasis>deny</emphasis>,msg:'Nikto Scanners Identified'"

### Added by the administrator
SecRuleUpdateActionById 1 "<emphasis>block</emphasis>"</programlisting>
    </section>

    <section>
      <title><literal>capture</literal></title>

      <para><emphasis>Description:</emphasis> When used together with the
      regular expression operator, capture action will create copies of
      regular expression captures and place them into the transaction variable
      collection. Up to ten captures will be copied on a successful pattern
      match, each with a name consisting of a digit from 0 to 9.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_BODY "^username=(\w{25,})" phase:2,<emphasis>capture</emphasis>,t:none,chain
SecRule TX:1 "(?:(?:a(dmin|nonymous)))"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The 0 data captures the entire REGEX match and 1 captures the data
      in the first parens, etc...</para>
    </section>

    <section>
      <title><literal>chain</literal></title>

      <para><emphasis>Description:</emphasis> Chains the rule where the action
      is placed with the rule that immediately follows it. The result is
      called a<emphasis> rule chain</emphasis>. Chained rules allow for more
      complex rule matches where you want to use a number of different
      VARIABLES to create a better rule and to help prevent false
      positives.</para>

      <para><emphasis>Action Group:</emphasis> Flow</para>

      <para>Example:</para>

      <programlisting format="linespecific"># Refuse to accept POST requests that do
# not specify request body length. Do note that
# this rule should be preceeded by a rule that verifies
# only valid request methods (e.g. GET, HEAD and POST) are used.
SecRule REQUEST_METHOD ^POST$<emphasis> chain</emphasis>,t:none
SecRule REQUEST_HEADERS:Content-Length ^$ t:none</programlisting>

      <note>
        <para>In programming language concepts, think of chained rules
        somewhat similar to AND conditional statements. The actions specified
        in the first portion of the chained rule will only be triggered if all
        of the variable checks return positive hits. If one aspect of the
        chained rule is negative, then the entire rule chain is negative. Also
        note that disruptive actions, execution phases, metadata actions (id,
        rev, msg), skip and skipAfter actions can only be specified on by the
        chain starter rule.</para>
      </note>
    </section>

    <section>
      <title><literal>ctl</literal></title>

      <para><emphasis>Description:</emphasis> The ctl action allows
      configuration options to be updated for the transaction.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific"># Parse requests with Content-Type "text/xml" as XML 
SecRule REQUEST_CONTENT_TYPE ^text/xml nolog,pass,<emphasis>ctl:requestBodyProcessor=XML</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The following configuration options are supported:</para>

      <orderedlist continuation="restarts" inheritnum="ignore">
        <listitem>
          <para><literal moreinfo="none">auditEngine</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">auditLogParts</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">debugLogLevel</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">ruleRemoveById</literal> (single rule
          ID, or a single rule ID range accepted as parameter)</para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">requestBodyAccess</literal></para>
        </listitem>

        <listitem>
          <para><literal
          moreinfo="none">forceRequestBodyVariable</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">requestBodyLimit</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">requestBodyProcessor</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">responseBodyAccess</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">responseBodyLimit</literal></para>
        </listitem>

        <listitem>
          <para><literal moreinfo="none">ruleEngine</literal></para>
        </listitem>
      </orderedlist>

      <para>With the exception of<literal moreinfo="none">
      requestBodyProcessor</literal> and <literal moreinfo="none">
      forceRequestBodyVariable</literal>, each configuration option
      corresponds to one configuration directive and the usage is
      identical.</para>

      <para>The <literal>requestBodyProcessor</literal> option allows you to
      configure the request body processor. By default ModSecurity will use
      the <literal moreinfo="none">URLENCODED</literal> and<literal
      moreinfo="none"> MULTIPART</literal> processors to process an <literal
      moreinfo="none">application/x-www-form-urlencoded</literal> and a
      <literal moreinfo="none">multipart/form-data</literal> bodies,
      respectively. A third processor, <literal>XML</literal>, is also
      supported, but it is never used implicitly. Instead you must tell
      ModSecurity to use it by placing a few rules in the<literal
      moreinfo="none"> REQUEST_HEADERS</literal> processing phase. After the
      request body was processed as XML you will be able to use the
      XML-related features to inspect it.</para>

      <para>Request body processors will not interrupt a transaction if an
      error occurs during parsing. Instead they will set variables<literal
      moreinfo="none"> REQBODY_PROCESSOR_ERROR</literal> and<literal
      moreinfo="none"> REQBODY_PROCESSOR_ERROR_MSG</literal>. These variables
      should be inspected in the <literal
      moreinfo="none">REQUEST_BODY</literal> phase and an appropriate action
      taken.</para>

      <para>The <literal>forceRequestBodyVariable</literal> option allows you
      to configure the <literal>REQUEST_BODY</literal> variable to be set when
      there is no request body processor configured. This allows for
      inspection of request bodies of unknown types.</para>
    </section>

    <section>
      <title><literal>deny</literal></title>

      <para><emphasis>Description:</emphasis> Stops rule processing and
      intercepts transaction.</para>

      <para><emphasis>Action Group:</emphasis> Disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "nikto" "log,<emphasis>deny</emphasis>,msg:'Nikto Scanners Identified'"</programlisting>
    </section>

    <section>
      <title><literal>deprecatevar</literal></title>

      <para><emphasis>Description:</emphasis> Decrement counter based on its
      age.</para>

      <para><emphasis>Action Group:</emphasis> Non-Disruptive</para>

      <para>Example: The following example will decrement the counter by 60
      every 300 seconds.</para>

      <programlisting format="linespecific">SecAction deprecatevar:session.score=60/300</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Counter values are always positive, meaning the value will never
      go below zero.</para>
    </section>

    <section>
      <title><literal>drop</literal></title>

      <para><emphasis>Description:</emphasis> Immediately initiate a
      "connection close" action to tear down the TCP connection by sending a
      FIN packet.</para>

      <para><emphasis>Action Group:</emphasis> Disruptive</para>

      <para>Example: The following example initiates an IP collection for
      tracking Basic Authentication attempts. If the client goes over the
      threshold of more than 25 attempts in 2 minutes, it will DROP subsequent
      connections.</para>

      <programlisting format="linespecific">SecAction phase:1,initcol:ip=%{REMOTE_ADDR},nolog
SecRule ARGS:login "!^$" \
    nolog,phase:1,setvar:ip.auth_attempt=+1,deprecatevar:ip.auth_attempt=20/120
SecRule IP:AUTH_ATTEMPT "@gt 25" \
    "log,<emphasis>drop</emphasis>,phase:1,msg:'Possible Brute Force Attack'"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This action is currently not available on Windows based builds.
      This action is extremely useful when responding to both Brute Force and
      Denial of Service attacks in that, in both cases, you want to minimize
      both the network bandwidth and the data returned to the client. This
      action causes error message to appear in the log "(9)Bad file
      descriptor: core_output_filter: writing data to the network"</para>
    </section>

    <section>
      <title><literal>exec</literal></title>

      <para><emphasis>Description:</emphasis> Executes an external
      script/binary supplied as parameter. As of v2.5.0, if the parameter
      supplied to <literal>exec</literal> is a Lua script (detected by the
      <filename>.lua</filename> extension) the script will be processed
      <emphasis>internally</emphasis>. This means you will get direct access
      to the internal request context from the script. Please read the
      <literal>SecRuleScript</literal> documentation for more details on how
      to write Lua scripts.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific"># The following is going to execute /usr/local/apache/bin/test.sh
# as a shell script on rule match.
SecRule REQUEST_URI "^/cgi-bin/script\.pl" \
    "phase:2,t:none,t:lowercase,t:normalisePath,log,<emphasis>exec:/usr/local/apache/bin/test.sh</emphasis>"

# The following is going to process /usr/local/apache/conf/exec.lua
# internally as a Lua script on rule match.
SecRule ARGS:p attack log,<emphasis>exec:/usr/local/apache/conf/exec.lua</emphasis></programlisting>

      <note>
        <para>The exec action is executed independently from any disruptive
        actions. External scripts will always be called with no parameters.
        Some transaction information will be placed in environment variables.
        All the usual CGI environment variables will be there. You should be
        aware that forking a threaded process results in all threads being
        replicated in the new process. Forking can therefore incur larger
        overhead in multi-threaded operation. The script you execute must
        write something (anything) to stdout. If it doesn't ModSecurity will
        assume execution didn't work.</para>
      </note>
    </section>

    <section>
      <title><literal>expirevar</literal></title>

      <para><emphasis>Description:</emphasis> Configures a collection variable
      to expire after the given time in seconds.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_COOKIES:JSESSIONID "!^$" nolog,phase:1,pass,chain
SecAction setsid:%{REQUEST_COOKIES:JSESSIONID}
SecRule REQUEST_URI "^/cgi-bin/script\.pl" \
    "phase:2,t:none,t:lowercase,t:normalisePath,log,allow,\
setvar:session.suspicious=1,<emphasis>expirevar:session.suspicious=3600</emphasis>,phase:1"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>You should use expirevar actions at the same time that you use
      setvar actions in order to keep the indented expiration time. If they
      are used on their own (perhaps in a SecAction directive) the expire time
      could get re-set. When variables are removed from collections, and there
      are no other changes, collections are not written to disk at the end of
      request. This is because the variables can always be expired again when
      the collection is read again on a subsequent request.</para>
    </section>

    <section>
      <title><literal>id</literal></title>

      <para><emphasis>Description:</emphasis> Assigns a unique ID to the rule
      or chain.</para>

      <para><emphasis>Action Group:</emphasis> Meta-data</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule &amp;REQUEST_HEADERS:Host "@eq 0" \
    "log,<emphasis>id:60008</emphasis>,severity:2,msg:'Request Missing a Host Header'"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>These are the reserved ranges:</para>

      <itemizedlist>
        <listitem>
          <para>1-99,999; reserved for local (internal) use. Use as you see
          fit but do not use this range for rules that are distributed to
          others.</para>
        </listitem>

        <listitem>
          <para>100,000-199,999; reserved for internal use of the engine, to
          assign to rules that do not have explicit IDs.</para>
        </listitem>

        <listitem>
          <para>200,000-299,999; reserved for rules published at
          modsecurity.org.</para>
        </listitem>

        <listitem>
          <para>300,000-399,999; reserved for rules published at
          gotroot.com.</para>
        </listitem>

        <listitem>
          <para>400,000-419,999; unused (available for reservation).</para>
        </listitem>

        <listitem>
          <para>420,000-429,999; reserved for <ulink type=""
          url="http://projects.otaku42.de/wiki/ScallyWhack">ScallyWhack</ulink>.</para>
        </listitem>

        <listitem>
          <para>430,000-699,999; unused (available for reservation).</para>
        </listitem>

        <listitem>
          <para>700,000-799,999; reserved for Ivan Ristic.</para>
        </listitem>

        <listitem>
          <para>900,000-999,999; reserved for the <ulink
          url="http://www.modsecurity.org/projects/rules/">Core Rules</ulink>
          project.</para>
        </listitem>

        <listitem>
          <para>1,000,000 and above; unused (available for
          reservation).</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>initcol</literal></title>

      <para><emphasis>Description:</emphasis> Initialises a named persistent
      collection, either by loading data from storage or by creating a new
      collection in memory.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example: The following example initiates IP address
      tracking.</para>

      <programlisting format="linespecific">SecAction <emphasis>phase:1,initcol:ip=%{REMOTE_ADDR}</emphasis>,nolog</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Normally you will want to use <emphasis>phase:1</emphasis> along
      with <emphasis>initcol</emphasis> so that the collection is available in
      all phases.</para>

      <para>Collections are loaded into memory when the initcol action is
      encountered. The collection in storage will be persisted (and the
      appropriate counters increased) <emphasis>only</emphasis> if it was
      changed during transaction processing.</para>

      <para>See the "Persistant Storage" section for further details.</para>
    </section>

    <section>
      <title><literal>log</literal></title>

      <para><emphasis>Description:</emphasis> Indicates that a successful
      match of the rule needs to be logged.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecAction phase:1,initcol:ip=%{REMOTE_ADDR},<emphasis>log</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This action will log matches to the Apache error log file and the
      ModSecurity audit log.</para>
    </section>

    <section>
      <title><literal>logdata</literal></title>

      <para><emphasis>Description:</emphasis> Allows a data fragment to be
      logged as part of the alert message.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule &amp;ARGS:p "@eq 0" "log,<emphasis>logdata:'%{TX.0}'"</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The logdata information appears in the error and/or audit log
      files and is not sent back to the client in response headers. Macro
      expansion is preformed so you may use variable names such as %{TX.0},
      etc. The information is properly escaped for use with logging binary
      data.</para>
    </section>

    <section>
      <title><literal>msg</literal></title>

      <para><emphasis>Description:</emphasis> Assigns a custom message to the
      rule or chain.</para>

      <para><emphasis>Action Group:</emphasis> Meta-data</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule &amp;REQUEST_HEADERS:Host "@eq 0" \
    "log,id:60008<emphasis>,</emphasis>severity:2,<emphasis>msg:'Request Missing a Host Header'"</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The msg information appears in the error and/or audit log files
      and is not sent back to the client in response headers.</para>
    </section>

    <section>
      <title><literal>multiMatch</literal></title>

      <para><emphasis>Description:</emphasis> If enabled ModSecurity will
      perform multiple operator invocations for every target, before and after
      every anti-evasion transformation is performed.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecDefaultAction log,deny,phase:1,t:removeNulls,t:lowercase
SecRule ARGS "attack" <emphasis>multiMatch</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Normally, variables are evaluated once, only after all
      transformation functions have completed. With multiMatch, variables are
      checked against the operator before and after every transformation
      function that changes the input.</para>
    </section>

    <section>
      <title><literal>noauditlog</literal></title>

      <para><emphasis>Description:</emphasis> Indicates that a successful
      match of the rule should not be used as criteria whether the transaction
      should be logged to the audit log.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "Test" allow,<emphasis>noauditlog</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>If the SecAuditEngine is set to On, all of the transactions will
      be logged. If it is set to RelevantOnly, then you can control it with
      the noauditlog action. Even if the noauditlog action is applied to a
      specific rule and a rule either before or after triggered an audit
      event, then the transaction will be logged to the audit log. The correct
      way to disable audit logging for the entire transaction is to use
      "<literal moreinfo="none">ctl:auditEngine=Off</literal>"</para>
    </section>

    <section>
      <title><literal>nolog</literal></title>

      <para><emphasis>Description:</emphasis> Prevents rule matches from
      appearing in both the error and audit logs.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "Test" allow,<emphasis>nolog</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The nolog action also implies noauditlog.</para>
    </section>

    <section>
      <title><literal>pass</literal></title>

      <para><emphasis>Description:</emphasis> Continues processing with the
      next rule in spite of a successful match.</para>

      <para><emphasis>Action Group:</emphasis> Disruptive</para>

      <para>Example1:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "Test" log,<emphasis>pass</emphasis></programlisting>

      <para>When using <emphasis>pass</emphasis> with SecRule with multiple
      targets, <emphasis>all</emphasis> targets will be processed and
      <emphasis>all</emphasis> non-disruptive actions will trigger for
      <emphasis>every</emphasis> match found. In the second example the
      TX:test target would be incremented by 1 for each matching
      argument.</para>

      <para>Example2:</para>

      <programlisting format="linespecific">SecRule ARGS "test" log,<emphasis>pass</emphasis>,setvar:TX.test=+1</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The transaction will not be interrupted but a log will be
      generated for each matching target (unless logging has been
      suppressed).</para>
    </section>

    <section>
      <title><literal>pause</literal></title>

      <para><emphasis>Description:</emphasis> Pauses transaction processing
      for the specified number of milliseconds.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "Test" log,deny,status:403,<emphasis>pause:5000</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This feature can be of limited benefit for slowing down Brute
      Force Scanners, however use with care. If you are under a Denial of
      Service type of attack, the pause feature may make matters worse as this
      feature will cause child processes to sit idle until the pause is
      completed.</para>
    </section>

    <section>
      <title><literal>phase</literal></title>

      <para><emphasis>Description:</emphasis> Places the rule (or the rule
      chain) into one of five available processing phases.</para>

      <para><emphasis>Action Group:</emphasis> Meta-data</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecDefaultAction log,deny,<emphasis>phase:1</emphasis>,t:removeNulls,t:lowercase
SecRule REQUEST_HEADERS:User-Agent "Test" log,deny,status:403</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Keep in mind that is you specify the incorrect phase, the target
      variable that you specify may be empty. This could lead to a false
      negative situation where your variable and operator (RegEx) may be
      correct, but it misses malicious data because you specified the wrong
      phase.</para>
    </section>

    <section>
      <title>prepend</title>

      <para><emphasis>Description:</emphasis> Prepends text given as parameter
      to the response body. For this action to work content injection must be
      enabled by setting <literal>SecContentInjection</literal> to
      <literal>On</literal>. Also make sure you check the content type of the
      response before you make changes to it (e.g. you don't want to inject
      stuff into images).</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para><emphasis>Processing Phases:</emphasis> 3 and 4.</para>

      <para>Example:</para>

      <programlisting>SecRule RESPONSE_CONTENT_TYPE ^text/html "phase:3,nolog,pass,<emphasis>prepend:'Header&lt;br&gt;'</emphasis>"</programlisting>

      <note>
        <para>While macro expansion is allowed in the additional content, you
        are strongly cautioned against inserting user defined data
        fields.</para>
      </note>
    </section>

    <section>
      <title><literal>proxy</literal></title>

      <para><emphasis>Description:</emphasis> Intercepts transaction by
      forwarding request to another web server using the proxy backend.</para>

      <para><emphasis>Action Group:</emphasis> Disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "Test" log,<emphasis>proxy:http://www.honeypothost.com/</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>For this action to work, mod_proxy must also be installed. This
      action is useful if you would like to proxy matching requests onto a
      honeypot webserver.</para>
    </section>

    <section>
      <title><literal>redirect</literal></title>

      <para><emphasis>Description:</emphasis> Intercepts transaction by
      issuing a redirect to the given location.</para>

      <para><emphasis>Action Group:</emphasis> Disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "Test" \
    log,<emphasis>redirect:http://www.hostname.com/failed.html</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>If the <literal moreinfo="none">status</literal> action is present
      and its value is acceptable (301, 302, 303, or 307) it will be used for
      the redirection. Otherwise status code 302 will be used.</para>
    </section>

    <section>
      <title><literal>rev</literal></title>

      <para><emphasis>Description:</emphasis> Specifies rule revision.</para>

      <para><emphasis>Action Group:</emphasis> Meta-data</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_METHOD "^PUT$" "id:340002,<emphasis>rev:1</emphasis>,severity:2,msg:'Restricted HTTP function'"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This action is used in combination with the <literal
      moreinfo="none">id</literal> action to allow the same rule ID to be used
      after changes take place but to still provide some indication the rule
      changed.</para>
    </section>

    <section>
      <title><literal>sanitiseArg</literal></title>

      <para><emphasis>Description:</emphasis> Sanitises (replaces each byte
      with an asterisk) a named request argument prior to audit
      logging.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecAction nolog,phase:2,<emphasis>sanitiseArg:password</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The sanitize actions do not sanitize any data within the actual
      raw requests but only on the copy of data within memory that is set to
      log to the audit log. It will not sanitize the data in the
      modsec_debug.log file (if the log level is set high enough to capture
      this data).</para>
    </section>

    <section>
      <title><literal>sanitiseMatched</literal></title>

      <para><emphasis>Description:</emphasis> Sanitises the variable (request
      argument, request header, or response header) that caused a rule
      match.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example: This action can be used to sanitise arbitrary transaction
      elements when they match a condition. For example, the example below
      will sanitise any argument that contains the word<emphasis>
      password</emphasis> in the name.</para>

      <programlisting format="linespecific">SecRule ARGS_NAMES password nolog,pass,<emphasis>sanitiseMatched</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Same note as sanitiseArg.</para>
    </section>

    <section>
      <title><literal>sanitiseRequestHeader</literal></title>

      <para><emphasis>Description:</emphasis> Sanitises a named request
      header.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example: This will sanitise the data in the Authorization
      header.</para>

      <programlisting format="linespecific">SecAction log,phase:1,<emphasis>sanitiseRequestHeader:Authorization</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Same note as sanitiseArg.</para>
    </section>

    <section>
      <title><literal>sanitiseResponseHeader</literal></title>

      <para><emphasis>Description:</emphasis> Sanitises a named response
      header.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example: This will sanitise the Set-Cookie data sent to the
      client.</para>

      <programlisting format="linespecific">SecAction log,phase:3,<emphasis>sanitiseResponseHeader:Set-Cookie</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Same note as sanitiseArg.</para>
    </section>

    <section>
      <title><literal>severity</literal></title>

      <para><emphasis>Description:</emphasis> Assigns severity to the rule it
      is placed with.</para>

      <para><emphasis>Action Group:</emphasis> Meta-data</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_METHOD "^PUT$" "id:340002,rev:1,<emphasis>severity:CRITICAL</emphasis>,msg:'Restricted HTTP function'"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Severity values in ModSecurity follow those of syslog, as
      below:</para>

      <itemizedlist>
        <listitem>
          <para>0 - EMERGENCY</para>
        </listitem>

        <listitem>
          <para>1 - ALERT</para>
        </listitem>

        <listitem>
          <para>2 - CRITICAL</para>
        </listitem>

        <listitem>
          <para>3 - ERROR</para>
        </listitem>

        <listitem>
          <para>4 - WARNING</para>
        </listitem>

        <listitem>
          <para>5 - NOTICE</para>
        </listitem>

        <listitem>
          <para>6 - INFO</para>
        </listitem>

        <listitem>
          <para>7 - DEBUG</para>
        </listitem>
      </itemizedlist>

      <para>It is possible to specify severity levels using either the
      numerical values or the text values. You should always specify severity
      levels using the text values. The use of the numerical values is
      deprecated (as of v2.5.0) and may be removed in one of the susequent
      major updates.</para>
    </section>

    <section>
      <title><literal>setuid</literal></title>

      <para><emphasis>Description:</emphasis> Special-purpose action that
      initialises the <literal moreinfo="none">USER</literal>
      collection.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecAction <emphasis>setuid:%{REMOTE_USER}</emphasis>,nolog</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>After initialisation takes place the variable <literal
      moreinfo="none">USERID</literal> will be available for use in the
      subsequent rules.</para>
    </section>

    <section>
      <title><literal>setsid</literal></title>

      <para><emphasis>Description:</emphasis> Special-purpose action that
      initialises the <literal moreinfo="none">SESSION</literal>
      collection.</para>

      <para><emphasis>Action Group: </emphasis>Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific"># Initialise session variables using the session cookie value 
SecRule REQUEST_COOKIES:PHPSESSID !^$ chain,nolog,pass
SecAction <emphasis>setsid:%{REQUEST_COOKIES.PHPSESSID}</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>On first invocation of this action the collection will be empty
      (not taking the predefined variables into account - see <literal
      moreinfo="none">initcol</literal> for more information). On subsequent
      invocations the contents of the collection (session, in this case) will
      be retrieved from storage. After initialisation takes place the
      variable<literal moreinfo="none"> SESSIONID</literal> will be available
      for use in the subsequent rules.This action understands each application
      maintains its own set of sessions. It will utilise the current web
      application ID to create a session namespace.</para>
    </section>

    <section>
      <title><literal>setenv</literal></title>

      <para><emphasis>Description:</emphasis> Creates, removes, or updates an
      environment variable.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Examples:</para>

      <para>To create a new variable (if you omit the value <literal
      moreinfo="none">1</literal> will be used):</para>

      <programlisting format="linespecific">setenv:name=value</programlisting>

      <para>To remove a variable:</para>

      <programlisting format="linespecific">setenv:!name</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>This action can be used to establish communication with other
      Apache modules.</para>
    </section>

    <section>
      <title><literal>setvar</literal></title>

      <para><emphasis>Description:</emphasis> Creates, removes, or updates a
      variable in the specified collection.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Examples:</para>

      <para>To create a new variable:</para>

      <programlisting format="linespecific">setvar:tx.score=10</programlisting>

      <para>To remove a variable prefix the name with exclamation mark:</para>

      <programlisting format="linespecific">setvar:!tx.score</programlisting>

      <para>To increase or decrease variable value use <literal
      moreinfo="none">+</literal> and <literal moreinfo="none">-</literal>
      characters in front of a numerical value:</para>

      <programlisting format="linespecific">setvar:tx.score=+5</programlisting>
    </section>

    <section>
      <title><literal>skip</literal></title>

      <para><emphasis>Description:</emphasis> Skips one or more rules (or
      chains) on successful match.</para>

      <para><emphasis>Action Group:</emphasis> Flow</para>

      <para>Example:</para>

      <para><programlisting format="linespecific">SecRule REQUEST_URI "^/$" \
"phase:2,chain,t:none<emphasis>,skip:2</emphasis>"
SecRule REMOTE_ADDR "^127\.0\.0\.1$" "chain"
SecRule REQUEST_HEADERS:User-Agent "^Apache \(internal dummy connection\)$" "t:none"  
SecRule &amp;REQUEST_HEADERS:Host "@eq 0" \
    "deny,log,status:400,id:960008,severity:4,msg:'Request Missing a Host Header'"
SecRule &amp;REQUEST_HEADERS:Accept "@eq 0" \
    "log,deny,log,status:400,id:960015,msg:'Request Missing an Accept Header'"</programlisting></para>

      <para><emphasis>Note</emphasis></para>

      <para>Skip only applies to the current processing phase and not
      necessarily the order in which the rules appear in the configuration
      file. If you group rules by processing phases, then skip should work as
      expected. This action can not be used to skip rules within one chain.
      Accepts a single parameter denoting the number of rules (or chains) to
      skip.</para>
    </section>

    <section>
      <title><literal>skipAfter</literal></title>

      <para><emphasis>Description:</emphasis> Skips rules (or chains) on
      successful match resuming rule execution after the specified rule ID or
      marker (see <literal>SecMarker</literal>) is found.</para>

      <para><emphasis>Action Group:</emphasis> Flow</para>

      <para>Example:</para>

      <para><programlisting format="linespecific">SecRule REQUEST_URI "^/$" "chain,t:none,<emphasis>skipAfter:960015</emphasis>"
SecRule REMOTE_ADDR "^127\.0\.0\.1$" "chain"
SecRule REQUEST_HEADERS:User-Agent "^Apache \(internal dummy connection\)$" "t:none"  
SecRule &amp;REQUEST_HEADERS:Host "@eq 0" \
    "deny,log,status:400,id:960008,severity:4,msg:'Request Missing a Host Header'"
SecRule &amp;REQUEST_HEADERS:Accept "@eq 0" \
    "log,deny,log,status:400,id:960015,msg:'Request Missing an Accept Header'"</programlisting></para>

      <para><emphasis>Note</emphasis></para>

      <para><literal>SkipAfter</literal> only applies to the current
      processing phase and not necessarily the order in which the rules appear
      in the configuration file. If you group rules by processing phases, then
      skip should work as expected. This action can not be used to skip rules
      within one chain. Accepts a single parameter denoting the last rule ID
      to skip.</para>
    </section>

    <section>
      <title><literal>status</literal></title>

      <para><emphasis>Description:</emphasis> Specifies the response status
      code to use with actions<literal moreinfo="none"> deny</literal>
      and<literal moreinfo="none"> redirect</literal>.</para>

      <para><emphasis>Action Group:</emphasis> Data</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecDefaultAction log,deny,<emphasis>status:403</emphasis>,phase:1</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Status actions defined in Apache scope locations (such as
      Directory, Location, etc...) may be superseded by phase:1 action
      settings. The Apache ErrorDocument directive will be triggered if
      present in the configuration. Therefore if you have previously defined a
      custom error page for a given status then it will be executed and its
      output presented to the user.</para>
    </section>

    <section>
      <title><literal>t</literal></title>

      <para><emphasis>Description:</emphasis> This action can be used which
      transformation function should be used against the specified variables
      before they (or the results, rather) are run against the operator
      specified in the rule.</para>

      <para><emphasis>Action Group:</emphasis> Non-disruptive</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecDefaultAction log,deny,phase:1,t:removeNulls,t:lowercase 
SecRule REQUEST_COOKIES:SESSIONID "47414e81cbbef3cf8366e84eeacba091" \
    log,deny,status:403,<emphasis>t:md5,t:hexEncode</emphasis></programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Any transformation functions that you specify in a SecRule will be
      in addition to previous ones specified in SecDefaultAction. Use of
      "t:none" will remove all transformation functions for the specified
      rule.</para>
    </section>

    <section>
      <title><literal>tag</literal></title>

      <para><emphasis>Description:</emphasis> Assigns custom text to a rule or
      chain.</para>

      <para><emphasis>Action Group:</emphasis> Meta-data</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_FILENAME "\b(?:n(?:map|et|c)|w(?:guest|sh)|cmd(?:32)?|telnet|rcmd|ftp)\.exe\b" \
    "t:none,t:lowercase,deny,msg:'System Command Access',id:'950002',<emphasis>\
tag:'WEB_ATTACK/FILE_INJECTION',tag:'OWASP/A2'</emphasis>,severity:'2'"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>The tag information appears in the error and/or audit log files.
      Its intent is to be used to automate classification of rules and the
      alerts generated by rules. Multiple tags can be used per
      rule/chain.</para>
    </section>

    <section>
      <title><literal>xmlns</literal></title>

      <para><emphasis>Description:</emphasis> This action should be used
      together with an XPath expression to register a namespace.</para>

      <para><emphasis>Action Group:</emphasis> Data</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:Content-Type "text/xml" \
    "phase:1,pass,ctl:requestBodyProcessor=XML,ctl:requestBodyAccess=On,<emphasis> \
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"</emphasis>
SecRule XML:/soap:Envelope/soap:Body/q1:getInput/id() "123" phase:2,deny</programlisting>
    </section>
  </section>

  <section id="operators">
    <title>Operators</title>

    <para>A number of operators can be used in rules, as documented below. The
    operator syntax uses the <literal>@</literal> symbol followed by the
    specific operator name.</para>

    <section>
      <title><literal>beginsWith</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a string
      comparison and returns true if the parameter value is found at the
      beginning of the input. Macro expansion is performed so you may use
      variable names such as <literal>%{TX.1}</literal>, etc.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_LINE "!<emphasis>@beginsWith GET</emphasis>" t:none,deny,status:403
SecRule REQUEST_ADDR "^(.*)\.\d+$" deny,status:403,capture,chain
SecRule ARGS:gw "!<emphasis>@beginsWith %{TX.1}</emphasis>"</programlisting>
    </section>

    <section>
      <title><literal>contains</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a string
      comparison and returns true if the parameter value is found anywhere in
      the input. Macro expansion is performed so you may use variable names
      such as %{TX.1}, etc.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_LINE "!<emphasis>@contains .php</emphasis>" t:none,deny,status:403
SecRule REQUEST_ADDR "^(.*)$" deny,status:403,capture,chain
SecRule ARGS:ip "!<emphasis>@contains %{TX.1}</emphasis>"</programlisting>
    </section>

    <section>
      <title><literal>endsWith</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a string
      comparison and returns true if the parameter value is found at the end
      of the input. Macro expansion is performed so you may use variable names
      such as %{TX.1}, etc.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_LINE "!<emphasis>@endsWith HTTP/1.1</emphasis>" t:none,deny,status:403
SecRule ARGS:route "!<emphasis>@endsWith %{REQUEST_ADDR}</emphasis>" t:none,deny,status:403</programlisting>
    </section>

    <section>
      <title><literal>eq</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a numerical
      comparison and stands for "equal to."</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule &amp;REQUEST_HEADERS_NAMES "<emphasis>@eq</emphasis> 15"</programlisting>

      <para>Macro expansion is performed so you may use variable names such as
      <literal>%{TX.1}</literal>, etc.</para>
    </section>

    <section>
      <title><literal>ge</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a numerical
      comparison and stands for "greater than or equal to."</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule &amp;REQUEST_HEADERS_NAMES "<emphasis>@ge</emphasis> 15"</programlisting>

      <para>Macro expansion is performed so you may use variable names such as
      <literal>%{TX.1}</literal>, etc.</para>
    </section>

    <section>
      <title><literal>geoLookup</literal></title>

      <para><emphasis>Description:</emphasis> This operator looks up various
      data fields from an IP address or hostname in the target data. The
      results will be captured in the <literal moreinfo="none">GEO</literal>
      collection.</para>

      <para>You must provide a database via <literal
      moreinfo="none">SecGeoLookupDb</literal> before this operator can be
      used.</para>

      <note>
        <para>This operator matches and the action is executed on a <emphasis>
        successful</emphasis> lookup. For this reason, you probably want to
        use the <emphasis>pass,nolog</emphasis> actions. This allows for
        <literal moreinfo="none">setvar</literal> and other non-disruptive
        actions to be executed on a match. If you wish to block on a failed
        lookup, then do something like this (look for an empty GEO
        collection):</para>

        <programlisting format="linespecific">SecGeoLookupDb /usr/local/geo/data/GeoLiteCity.dat
...
SecRule REMOTE_ADDR "@geoLookup" "pass,nolog"
SecRule &amp;GEO "@eq 0" "deny,status:403,msg:'Failed to lookup IP'"</programlisting>
      </note>

      <para>See the <literal moreinfo="none">GEO</literal> variable for an
      example and more information on various fields available.</para>
    </section>

    <section>
      <title><literal>gt</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a numerical
      comparison and stands for "greater than."</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule &amp;REQUEST_HEADERS_NAMES "<emphasis>@gt</emphasis> 15"</programlisting>

      <para>Macro expansion is performed so you may use variable names such as
      <literal>%{TX.1}</literal>, etc.</para>
    </section>

    <section>
      <title><literal>inspectFile</literal></title>

      <para><emphasis>Description:</emphasis> Executes the external
      script/binary given as parameter to the operator against every file
      extracted from the request. As of v2.5.0, if the supplied filename is
      not absolute it is treated as relative to the directory in which the
      configuration file resides. Also as of v2.5.0, if the filename is
      determined to be a Lua script (based on its extension) the script will
      be processed by the internal engine. As such it will have full access to
      the ModSecurity context.</para>

      <para>Example of using an external binary/script:</para>

      <programlisting format="linespecific"># Execute external script to validate uploaded files.
SecRule FILES_TMPNAMES "<emphasis>@inspectFile</emphasis> /opt/apache/bin/inspect_script.pl"</programlisting>

      <para>Example of using Lua script:</para>

      <programlisting>SecRule FILES_TMPNANMES "@inspectFile <emphasis>inspect.lua</emphasis>"</programlisting>

      <para>Script <filename>inspect.lua</filename>:</para>

      <programlisting>function main(filename)
    -- Do something to the file to verify it. In this example, we
    -- read up to 10 characters from the beginning of the file.
    local f = io.open(filename, "rb");
    local d = f:read(10);
    f:close();
   
    -- Return null if there is no reason to believe there is ansything
    -- wrong with the file (no match). Returning any text will be taken
    -- to mean a match should be trigerred.
    return null;
end</programlisting>
    </section>

    <section>
      <title><literal>le</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a numerical
      comparison and stands for "less than or equal to."</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule &amp;REQUEST_HEADERS_NAMES "<emphasis>@le</emphasis> 15"</programlisting>

      <para>Macro expansion is performed so you may use variable names such as
      <literal>%{TX.1}</literal>, etc.</para>
    </section>

    <section>
      <title><literal>lt</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a numerical
      comparison and stands for "less than."</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule &amp;REQUEST_HEADERS_NAMES "<emphasis>@lt</emphasis> 15"</programlisting>

      <para>Macro expansion is performed so you may use variable names such as
      <literal>%{TX.1}</literal>, etc.</para>
    </section>

    <section>
      <title><literal>pm</literal></title>

      <para><emphasis>Description:</emphasis> Phrase Match operator. This
      operator uses a set based matching engine (Aho-Corasick) for faster
      matches of keyword lists. It will match any one of its arguments
      anywhere in the target value. The match is case insensitive.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "<emphasis>@pm</emphasis> WebZIP WebCopier Webster WebStripper SiteSnagger ProWebWalker CheeseBot" "deny,status:403</programlisting>

      <para>The above would deny access with 403 if any of the words matched
      within the User-Agent HTTP header value.</para>
    </section>

    <section>
      <title><literal>pmFromFile</literal></title>

      <para><emphasis>Description:</emphasis> Phrase Match operator. This
      operator uses a set based matching engine (Aho-Corasick) for faster
      matches of keyword lists. This operator is the same as
      <literal>@pm</literal> except that it takes a list of files as
      arguments. It will match any one of the phrases listed in the file(s)
      anywhere in the target value.</para>

      <para>Notes:</para>

      <orderedlist continuation="restarts" inheritnum="ignore">
        <listitem>
          <para>The contents of the files should be one phrase per line. End
          of line markers will be stripped from the phrases (LF and CRLF), and
          whitespace is trimmed from both sides of the phrases. Empty lines
          and comment lines (beginning with a '#') are ignored.</para>
        </listitem>

        <listitem>
          <para>To allow easier inclusion of phrase files with rulesets,
          relative paths may be used to the phrase files. In this case, the
          path of the file containing the rule is prepended to the phrase file
          path.</para>
        </listitem>

        <listitem>
          <para>To allow easier matching of whole IP addresses, you can add
          boundary characters to the phrases. For example, use "/1.2.3.4/"
          instead of "1.2.3.4". You can then insert these characters into the
          target prior to a match:</para>

          <programlisting format="linespecific">SecAction "phase:1,pass,nolog,setvar:tx.remote_addr=/%{REMOTE_ADDR}/"
SecRule TX:REMOTE_ADDR "<emphasis>@pmFromFile ip-blacklist.txt</emphasis>" "deny,status:403

# ip-blacklist.txt contents:
# NOTE: All IPs must be prefixed/suffixed with "/" as the rules
#       will add in this character as a boundary to ensure
#       the entire IP is matched.
# SecAction "phase:1,pass,nolog,setvar:tx.remote_addr='/%{REMOTE_ADDR}/'"
/1.2.3.4/
/5.6.7.8/</programlisting>
        </listitem>
      </orderedlist>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "<emphasis>@pm</emphasis> /path/to/blacklist1 blacklist2" "deny,status:403</programlisting>

      <para>The above would deny access with 403 if any of the patterns in the
      two files matched within the User-Agent HTTP header value. The
      <literal>blacklist2</literal> file would need to be placed in the same
      path as the file containing the rule.</para>
    </section>

    <section>
      <title><literal>rbl</literal></title>

      <para><emphasis>Description:</emphasis> Look up the parameter in the RBL
      given as parameter. Parameter can be an IPv4 address, or a
      hostname.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REMOTE_ADDR "<emphasis>@rbl</emphasis> sc.surbl.org"</programlisting>
    </section>

    <section>
      <title><literal>rx</literal></title>

      <para><emphasis>Description:</emphasis> Regular expression operator.
      This is the default operator, so if the "@" operator is not defined, it
      is assumed to be rx.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_HEADERS:User-Agent "<emphasis>@rx</emphasis> nikto"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>Regular expressions are handled by the PCRE library (<ulink
      url="http://www.pcre.org">http://www.pcre.org</ulink>). ModSecurity
      compiles its regular expressions with the following settings:</para>

      <orderedlist continuation="restarts" inheritnum="ignore">
        <listitem>
          <para>The entire input is treated as a single line, even when there
          are newline characters present.</para>
        </listitem>

        <listitem>
          <para>All matches are case-sensitive. If you do not care about case
          sensitivity you either need to implement the <literal
          moreinfo="none">lowercase</literal> transformation function, or use
          the per-pattern<literal moreinfo="none">(?i)</literal>modifier, as
          allowed by PCRE.</para>
        </listitem>

        <listitem>
          <para>The <literal moreinfo="none">PCRE_DOTALL</literal> and
          <literal moreinfo="none">PCRE_DOLLAR_ENDONLY</literal> flags are set
          during compilation, meaning a single dot will match any character,
          including the newlines and a <literal moreinfo="none">$</literal>
          end anchor will not match a trailing newline character.</para>
        </listitem>
      </orderedlist>
    </section>

    <section>
      <title><literal>streq</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a string
      comparison and returns true if the parameter value matches the input
      exactly. Macro expansion is performed so you may use variable names such
      as %{TX.1}, etc.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule ARGS:foo "!<emphasis>@streq bar</emphasis>" t:none,deny,status:403
SecRule REQUEST_ADDR "^(.*)$" deny,status:403,capture,chain
SecRule REQUEST_HEADERS:Ip-Address "!<emphasis>@streq %{TX.1}</emphasis>"</programlisting>
    </section>

    <section>
      <title><literal>validateByteRange</literal></title>

      <para><emphasis>Description:</emphasis> Validates the byte range used in
      the variable falls into the specified range.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule ARGS:text "<emphasis>@validateByteRange</emphasis> 10, 13, 32-126"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>You can force requests to consist only of bytes from a certain
      byte range. This can be useful to avoid stack overflow attacks (since
      they usually contain "random" binary content). Default range values are
      0 and 255, i.e. all byte values are allowed. This directive does not
      check byte range in a POST payload when
      <literal>multipart/form-data</literal> encoding (file upload) is used.
      Doing so would prevent binary files from being uploaded. However, after
      the parameters are extracted from such request they are checked for a
      valid range.</para>

      <para>validateByteRange is similar to the ModSecurity 1.X
      SecFilterForceByteRange Directive however since it works in a rule
      context, it has the following differences:</para>

      <itemizedlist>
        <listitem>
          <para>You can specify a different range for different
          variables.</para>
        </listitem>

        <listitem>
          <para>It has an "event" context (id, msg....)</para>
        </listitem>

        <listitem>
          <para>It is executed in the flow of rules rather than being a built
          in pre-check.</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>validateDTD</literal></title>

      <para><emphasis>Description:</emphasis> Validates the DOM tree generated
      by the XML request body processor against the supplied DTD.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecDefaultAction log,deny,status:403,phase:2
SecRule REQUEST_HEADERS:Content-Type ^text/xml$ \
    phase:1,t:lowercase,nolog,pass,ctl:requestBodyProcessor=XML
SecRule REQBODY_PROCESSOR "!^XML$" nolog,pass,skipAfter:12345
SecRule XML "<emphasis>@validateDTD /path/to/apache2/conf/xml.dtd</emphasis>" "deny,id:12345"</programlisting>

      <note>
        <para>This operator requires request body to be processed as
        XML.</para>
      </note>
    </section>

    <section>
      <title><literal>validateSchema</literal></title>

      <para><emphasis>Description:</emphasis> Validates the DOM tree generated
      by the XML request body processor against the supplied XML
      Schema.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecDefaultAction log,deny,status:403,phase:2
SecRule REQUEST_HEADERS:Content-Type ^text/xml$ \
    phase:1,t:lowercase,nolog,pass,ctl:requestBodyProcessor=XML
SecRule REQBODY_PROCESSOR "!^XML$" nolog,pass,skipAfter:12345
SecRule XML "<emphasis>@validateSchema /path/to/apache2/conf/xml.xsd</emphasis>" "deny,id:12345"</programlisting>

      <note>
        <para>This operator requires request body to be processed as
        XML.</para>
      </note>
    </section>

    <section>
      <title><literal>validateUrlEncoding</literal></title>

      <para><emphasis>Description:</emphasis> Verifies the encodings used in
      the variable (if any) are valid.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule ARGS "<emphasis>@validateUrlEncoding</emphasis>"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>URL encoding is an HTTP standard for encoding byte values within a
      URL. The byte is escaped with a % followed by two hexadecimal values
      (0-F). This directive does not check encoding in a POST payload when the
      <literal>multipart/form-data</literal> encoding (file upload) is used.
      It is not necessary to do so because URL encoding is not used for this
      encoding.</para>
    </section>

    <section>
      <title><literal>validateUtf8Encoding</literal></title>

      <para><emphasis>Description:</emphasis> Verifies the variable is a valid
      UTF-8 encoded string.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule ARGS "<emphasis>@validateUtf8Encoding</emphasis>"</programlisting>

      <para><emphasis>Note</emphasis></para>

      <para>UTF-8 encoding is valid on most web servers. Integer values
      between 0-65535 are encoded in a UTF-8 byte sequence that is escaped by
      percents. The short form is two bytes in length.</para>

      <para>check for three types of errors:</para>

      <itemizedlist>
        <listitem>
          <para>Not enough bytes. UTF-8 supports two, three, four, five, and
          six byte encodings. ModSecurity will locate cases when a byte or
          more is missing.</para>
        </listitem>

        <listitem>
          <para>Invalid encoding. The two most significant bits in most
          characters are supposed to be fixed to 0x80. Attackers can use this
          to subvert Unicode decoders.</para>
        </listitem>

        <listitem>
          <para>Overlong characters. ASCII characters are mapped directly into
          the Unicode space and are thus represented with a single byte.
          However, most ASCII characters can also be encoded with two, three,
          four, five, and six characters thus tricking the decoder into
          thinking that the character is something else (and, presumably,
          avoiding the security check).</para>
        </listitem>
      </itemizedlist>
    </section>

    <section>
      <title><literal>verifyCC</literal></title>

      <para><emphasis>Description:</emphasis> This operator verifies a given
      regular expression as a potential credit card number. It first matches
      with a single generic regular expression then runs the resulting match
      through a Luhn checksum algorithm to further verify it as a potential
      credit card number.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule ARGS "<emphasis>@verifyCC \d{13,16}</emphasis>" \
              "phase:2,sanitiseMatched,log,auditlog,pass,msg:'Potential credit card number'"</programlisting>
    </section>

    <section>
      <title><literal>within</literal></title>

      <para><emphasis>Description:</emphasis> This operator is a string
      comparison and returns true if the input value is found anywhere within
      the parameter value. Note that this is similar to
      <literal>@contains</literal>, except that the target and match values
      are reversed. Macro expansion is performed so you may use variable names
      such as %{TX.1}, etc.</para>

      <para>Example:</para>

      <programlisting format="linespecific">SecRule REQUEST_METHOD "!<emphasis>@within get,post,head</emphasis>" t:lowercase,deny,status:403

SecAction "pass,setvar:'tx.allowed_methods=get,post,head'"
SecRule REQUEST_METHOD "!<emphasis>@within %{tx.allowed_methods}</emphasis>" t:lowercase,deny,status:403</programlisting>
    </section>
  </section>

  <section>
    <title>Macro Expansion</title>

    <para>Macros allow for using place holders in rules that will be expanded
    out to their values at runtime. Currently only variable expansion is
    supported, however more options may be added in future versions of
    ModSecurity.</para>

    <para>Format:</para>

    <programlisting format="linespecific">%{VARIABLE}
%{COLLECTION.VARIABLE}</programlisting>

    <para>Macro expansion can be used in actions such as initcol, setsid,
    setuid, setvar, setenv, logdata. Operators that are evaluated at runtime
    support expansion and are noted above. Such operators include @beginsWith,
    @endsWith, @contains, @within and @streq. You cannot use macro expansion
    for operators that are "compiled" such as @pm, @rx, etc. as these
    operators have their values fixed at configure time for efficiency.</para>

    <para>Some values you may want to expand include: TX, REMOTE_ADDR, USERID,
    HIGHEST_SEVERITY, MATCHED_VAR, MATCHED_VAR_NAME, MULTIPART_STRICT_ERROR,
    RULE, SESSION, USERID, among others.</para>
  </section>

  <section>
    <title>Persistant Storage</title>

    <para>At this time it is only possible to have three collections in which
    data is stored persistantly (i.e. data available to multiple requests).
    These are: <literal moreinfo="none">IP</literal>, <literal
    moreinfo="none"> SESSION</literal> and <literal
    moreinfo="none">USER</literal>.</para>

    <para>Every collection contains several built-in variables that are
    available and are read-only unless otherwise specified:</para>

    <orderedlist continuation="restarts" inheritnum="ignore">
      <listitem>
        <para><literal moreinfo="none">CREATE_TIME</literal> - date/time of
        the creation of the collection.</para>
      </listitem>

      <listitem>
        <para><literal moreinfo="none">IS_NEW</literal> - set to 1 if the
        collection is new (not yet persisted) otherwise set to 0.</para>
      </listitem>

      <listitem>
        <para><literal moreinfo="none">KEY</literal> - the value of the
        initcol variable (the client's IP address in the example).</para>
      </listitem>

      <listitem>
        <para><literal moreinfo="none">LAST_UPDATE_TIME</literal> - date/time
        of the last update to the collection.</para>
      </listitem>

      <listitem>
        <para><literal moreinfo="none">TIMEOUT</literal> - date/time in
        seconds when the collection will be updated on disk from memory (if no
        other updates occur). This variable may be set if you wish to specifiy
        an explicit expiration time (default is 3600 seconds).</para>
      </listitem>

      <listitem>
        <para><literal moreinfo="none">UPDATE_COUNTER</literal> - how many
        times the collection has been updated since creation.</para>
      </listitem>

      <listitem>
        <para><literal moreinfo="none">UPDATE_RATE</literal> - is the average
        rate updates per minute since creation.</para>
      </listitem>
    </orderedlist>

    <para>To create a collection to hold session variables (<literal
    moreinfo="none">SESSION</literal>) use action <literal
    moreinfo="none">setsid</literal>. To create a collection to hold user
    variables (<literal moreinfo="none">USER</literal>) use action <literal
    moreinfo="none">setuid</literal>. To create a collection to hold client
    address variables (<literal moreinfo="none">IP</literal>) use action
    <literal moreinfo="none">initcol</literal>.</para>

    <note>
      <para>ModSecurity implements atomic updates of persistent variables only
      for integer variables (counters) at this time. Variables are read from
      storage whenever <literal>initcol</literal> is encountered in the rules
      and persisted at the end of request processing. Counters are adjusted by
      applying a delta generated by re-reading the persisted data just before
      being persisted. This keeps counter data consistent even if the counter
      was modified and persisted by another thread/process during the
      transaction.</para>
    </note>

    <note>
      <para>ModSecurity uses a Berkley Database (SDBM) for persistant storage.
      This type of database is generally limited to storing a maximum of 1008
      bytes per key. This may be a limitation if you are attempting to store a
      considerable amount of data in variables for a single key. Some of this
      limitation is planned to be reduced in a future version of
      ModSecurity.</para>
    </note>
  </section>

  <section>
    <title>Miscellaneous Topics</title>

    <para></para>

    <section>
      <title>Impedance Mismatch</title>

      <para>Web application firewalls have a difficult job trying to make
      sense of data that passes by, without any knowledge of the application
      and its business logic. The protection they provide comes from having an
      independent layer of security on the outside. Because data validation is
      done twice, security can be increased without having to touch the
      application. In some cases, however, the fact that everything is done
      twice brings problems. Problems can arise in the areas where the
      communication protocols are not well specified, or where either the
      device or the application do things that are not in the specification.
      In such cases it may be possible to design payload that will be
      interpreted in one way by one device and in another by the other device.
      This problem is better known as Impedance Mismatch. It can be exploited
      to evade the security devices.</para>

      <para>While we will continue to enhance ModSecurity to deal with various
      evasion techniques the problem can only be minimized, but never solved.
      With so many different application backend chances are some will always
      do something completely unexpected. The only solution is to be aware of
      the technologies in the backend when writing rules, adapting the rules
      to remove the mismatch. See the next section for some examples.</para>

      <section>
        <title>PHP Peculiarities for ModSecurity Users</title>

        <para>When writing rules to protect PHP applications you need to pay
        attention to the following facts:</para>

        <orderedlist>
          <listitem>
            <para>When "register_globals" is set to "On" request parameters
            are automatically converted to script variables. In some PHP
            versions it is even possible to override the $GLOBALS
            array.</para>
          </listitem>

          <listitem>
            <para>Whitespace at the beginning of parameter names is ignored.
            (This is very dangerous if you are writing rules to target
            specific named variables.)</para>
          </listitem>

          <listitem>
            <para>The remaining whitespace (in parameter names) is converted
            to underscores. The same applies to dots and to a "[" if the
            variable name does not contain a matching closing bracket.
            (Meaning that if you want to exploit a script through a variable
            that contains an underscore in the name you can send a parameter
            with a whitespace or a dot instead.)</para>
          </listitem>

          <listitem>
            <para>Cookies can be treated as request parameters.</para>
          </listitem>

          <listitem>
            <para>The discussion about variable names applies equally to the
            cookie names.</para>
          </listitem>

          <listitem>
            <para>The order in which parameters are taken from the request and
            the environment is EGPCS (environment, GET, POST, Cookies,
            built-in variables). This means that a POST parameter will
            overwrite the parameters transported on the request line (in
            QUERY_STRING).</para>
          </listitem>

          <listitem>
            <para>When "magic_quotes_gpc" is set to "On" PHP will use
            backslash to escape the following characters: single quote, double
            quote, backslash, and the nul byte.</para>
          </listitem>

          <listitem>
            <para>If "magic_quotes_sybase" is set to "On" only the single
            quote will be escaped using another single quote. In this case the
            "magic_quotes_gpc" setting becomes irrelevant. The
            "magic_quotes_sybase" setting completely overrides the
            "magic_quotes_gpc" behaviour but "magic_quotes_gpc" still must be
            set to "On" for the Sybase-specific quoting to be work.</para>
          </listitem>

          <listitem>
            <para>PHP will also automatically create nested arrays for you.
            For example "p[x][y]=1" results in a total of three
            variables.</para>
          </listitem>
        </orderedlist>
      </section>
    </section>
  </section>
</article>