Files
EndGame/dependencies/naxsi/docs/old/whitelists-bnf.md
T

55 lines
1.9 KiB
Markdown

# Whitelists
Whitelists are meant to instruct naxsi to ignore specific patterns in specific context(s) to avoid false positives.
ie. Allow the ' character in the field named `term` at url /search :
`BasicRule wl:1013 "mz:$ARGS_VAR:term|$URL:/search";`
Whitelists can be present at `location` level (BasicRule) or at `http` level (MainRule).
Whitelists have the following syntax :
![whitelist-diagram](Images/whitelist.png)
Everything must be quoted with double quotes, except the wl part.
### Whitelisted ID (wl:...)
Which rule ID(s) are whitelisted. Possible syntax are:
![wl-diagram](Images/wl.png)
* `wl:0` : Whitelist all rules
* `wl:42` : Whitelist rule `#42`
* `wl:42,41,43` : Whitelist rules `42`, `41` and `43`
* `wl:-42` : Whitelist all user rules (`>= 1000`), excepting rule `42`
_note: you can't mix negative and positive ID(s) in whitelists_
### MatchZone (mz:...)
Please refer to [Match Zones](matchzones-bnf.md) for details.
*mz* is the match-zone, specifying in which part(s) of the request the specified ID(s) must be ignored.
In whitelist context, all conditions specificied in the *mz* must be satisfied :
```
BasicRule wl:4242 "mz:$ARGS_VAR:foo|$URL:/x";
```
_ignore id 4242 in GET var named `foo` only on URL `/x`_
As for rules, `$URL*` in match-zone is not enough to specify the target zone.
### Notes
- A zone (ARGS,BODY,HEADERS) can be suffixed with `|NAME`, meaning the rule matched in the name of the variable, but not its content.
- `RAW_BODY` whitelists are written just as any `BODY` whitelist, see [Whitelists Examples](whitelists-examples.md)
- A whitelist can't mix `_X` elements with `_VAR` or `$URL` items. ie:
```
$URL_X:/foo|$ARGS_VAR:bar : WRONG
$URL_X:^/foo$|$ARGS_VAR_X:^bar$ : GOOD
```
You can also whitelist by IP/CIDR and all the rules will not be blocked for these ips but logs will be generated.
For more details look here: [IgnoreIP and IgnoreCIDR](IgnoreIP-and-IgnoreCIDR.md)