Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f6df989e67 | ||
|
|
f33d0a4fce | ||
|
|
0a2b2d809f |
No files matched your search
@@ -304,7 +304,7 @@ Every setting the code reads, with its default:
|
|||||||
| `SWW_RPROXY_MAX_REQUEST_TIME_MS` | `60000` | Two time limits, each this long, in milliseconds or `off`: one for the visitor to send its request line and headers, then one for the whole request to reach the app. |
|
| `SWW_RPROXY_MAX_REQUEST_TIME_MS` | `60000` | Two time limits, each this long, in milliseconds or `off`: one for the visitor to send its request line and headers, then one for the whole request to reach the app. |
|
||||||
| `SWW_RPROXY_MAX_RESPONSE_TIME_MS` | `1800000` | How long the answer may take, from the end of the request to its last byte reaching the visitor, in milliseconds or `off`. |
|
| `SWW_RPROXY_MAX_RESPONSE_TIME_MS` | `1800000` | How long the answer may take, from the end of the request to its last byte reaching the visitor, in milliseconds or `off`. |
|
||||||
| `SWW_WAF_LISTEN_ADDR` | `:8080` | Where `waf` listens; leave the host part empty. |
|
| `SWW_WAF_LISTEN_ADDR` | `:8080` | Where `waf` listens; leave the host part empty. |
|
||||||
| `SWW_WAF_INSTANCE_NAME` | the container's host name | The name in every line `waf` logs, and in every alert and metric, such as `fsn1/waf`. |
|
| `SWW_WAF_INSTANCE_NAME` | the container's host name | The name in every line `waf` logs, and in every alert and metric, such as `host1/waf`. |
|
||||||
| `SWW_WAF_MODE` | `enforce` | `observe` refuses nothing and makes no ban; each log line says what `enforce` would have done. |
|
| `SWW_WAF_MODE` | `enforce` | `observe` refuses nothing and makes no ban; each log line says what `enforce` would have done. |
|
||||||
| `SWW_WAF_IPV6_GROUP_PREFIX` | `64` | The prefix length of the IPv6 netblock that counts as one client, from 32 to 128. |
|
| `SWW_WAF_IPV6_GROUP_PREFIX` | `64` | The prefix length of the IPv6 netblock that counts as one client, from 32 to 128. |
|
||||||
| `SWW_WAF_MAX_TRACKED_CLIENTS` | `20000` | The most clients kept, in memory and in `clients.json`; the least recently seen is dropped first. |
|
| `SWW_WAF_MAX_TRACKED_CLIENTS` | `20000` | The most clients kept, in memory and in `clients.json`; the least recently seen is dropped first. |
|
||||||
@@ -348,7 +348,7 @@ Every setting the code reads, with its default:
|
|||||||
| `SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD` | `5` | The Core Rule Set score at which a request is a match, a whole number or `off`; one critical rule scores 5. |
|
| `SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD` | `5` | The Core Rule Set score at which a request is a match, a whole number or `off`; one critical rule scores 5. |
|
||||||
| `SWW_WAF_CORE_RULE_SET_DISABLED_RULES` | `920340,920420,920440,920640,930130,930140` | Core Rule Set rule ids switched off; a list you give replaces the default, so repeat these six to keep them off. |
|
| `SWW_WAF_CORE_RULE_SET_DISABLED_RULES` | `920340,920420,920440,920640,930130,930140` | Core Rule Set rule ids switched off; a list you give replaces the default, so repeat these six to keep them off. |
|
||||||
| `SWW_WAF_CORE_RULE_SET_EXEMPT_PATHS` | empty | Path prefixes the Core Rule Set does not inspect. |
|
| `SWW_WAF_CORE_RULE_SET_EXEMPT_PATHS` | empty | Path prefixes the Core Rule Set does not inspect. |
|
||||||
| `SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` | `off` | How much of a request body the Core Rule Set reads, a size up to `64K`; `off` reads none. |
|
| `SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` | `off` | How much of a request body the Core Rule Set reads, a size up to `8K`; `off` reads none. |
|
||||||
| `SWW_WAF_CORE_RULE_SET_EXCLUSIONS_FILE` | unset | A file of Core Rule Set exclusions, as Coraza directives, that switch rules off for some fields or paths only. |
|
| `SWW_WAF_CORE_RULE_SET_EXCLUSIONS_FILE` | unset | A file of Core Rule Set exclusions, as Coraza directives, that switch rules off for some fields or paths only. |
|
||||||
| `SWW_WAF_APPS` | unset | The apps each hostname serves, such as `git.example.com:gitea;blog.example.com:wordpress`; only those apps' fixes apply there. "Attack detection" lists the apps. Listing `forgejo` brings gitea's fixes too. Unset, every app's fixes apply to every hostname. |
|
| `SWW_WAF_APPS` | unset | The apps each hostname serves, such as `git.example.com:gitea;blog.example.com:wordpress`; only those apps' fixes apply there. "Attack detection" lists the apps. Listing `forgejo` brings gitea's fixes too. Unset, every app's fixes apply to every hostname. |
|
||||||
| `SWW_WAF_BLOCKLIST_URLS` | empty | Blocklists to fetch, text files of addresses and netblocks one to a line, such as `https://www.spamhaus.org/drop/drop.txt`. |
|
| `SWW_WAF_BLOCKLIST_URLS` | empty | Blocklists to fetch, text files of addresses and netblocks one to a line, such as `https://www.spamhaus.org/drop/drop.txt`. |
|
||||||
@@ -530,7 +530,7 @@ services:
|
|||||||
image: smallwebwaf
|
image: smallwebwaf
|
||||||
environment:
|
environment:
|
||||||
SWW_COMMAND: waf
|
SWW_COMMAND: waf
|
||||||
SWW_WAF_INSTANCE_NAME: fsn1/waf
|
SWW_WAF_INSTANCE_NAME: host1/waf
|
||||||
# Refuse nothing yet; log what enforce mode would have done.
|
# Refuse nothing yet; log what enforce mode would have done.
|
||||||
SWW_WAF_MODE: observe
|
SWW_WAF_MODE: observe
|
||||||
# Look addresses up in a local IPinfo Lite database, never GeoJS.
|
# Look addresses up in a local IPinfo Lite database, never GeoJS.
|
||||||
@@ -818,10 +818,9 @@ on the host.
|
|||||||
- `script/docker`: builds the image, whose build runs the tests and the linter
|
- `script/docker`: builds the image, whose build runs the tests and the linter
|
||||||
first. `make docker`.
|
first. `make docker`.
|
||||||
- `script/publish`: runs `script/docker`, whose build happens on the Docker host
|
- `script/publish`: runs `script/docker`, whose build happens on the Docker host
|
||||||
named by `DOCKER_HOST` (`ssh://root@fsn1app1` unless set). It then pushes the
|
named by `DOCKER_HOST`, then pushes the image to `PUBLISH_IMAGE`, such as
|
||||||
image to `PUBLISH_IMAGE` (`git.eeqj.de/sneak/smallwebwaf` unless set). It
|
`registry.example.com/smallwebwaf`. Both variables are required. It refuses a
|
||||||
refuses a working tree with uncommitted changes. `make publish`. It pushes
|
working tree with uncommitted changes. `make publish`. It pushes four tags:
|
||||||
four tags:
|
|
||||||
- the UTC date as `YYYY-MM-DD`;
|
- the UTC date as `YYYY-MM-DD`;
|
||||||
- the short commit hash;
|
- the short commit hash;
|
||||||
- the branch name;
|
- the branch name;
|
||||||
|
|||||||
@@ -704,11 +704,12 @@ files, the limits and the bans still apply to the client that sends it.
|
|||||||
rules is loaded yet.
|
rules is loaded yet.
|
||||||
|
|
||||||
- `SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` switches body inspection on, up
|
- `SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` switches body inspection on, up
|
||||||
to that size. It takes at most `64K`, since `waf` gets no more of a body than
|
to that size. It takes at most `8K`, so that `waf` answers in time (see
|
||||||
that (see "The answer"). Form data and multipart bodies are read up to the
|
"Answering in time"). Form data and multipart bodies are read up to the size.
|
||||||
size. JSON and XML bodies are read only when no larger than the size, since
|
JSON and XML bodies are read only when no larger than the size, since those
|
||||||
those cannot be read in part. Any other body is not read: the Core Rule Set
|
cannot be read in part. A JSON body over 1 KiB is not read either, whatever
|
||||||
would read it as form data, where binary content such as a git push trips
|
the size (see "Answering in time"). Any other body is not read: the Core Rule
|
||||||
|
Set would read it as form data, where binary content such as a git push trips
|
||||||
rules written for text. A body the Core Rule Set cannot parse adds 5 to the
|
rules written for text. A body the Core Rule Set cannot parse adds 5 to the
|
||||||
score, and so does a multipart body cut by the limit in the middle of a part's
|
score, and so does a multipart body cut by the limit in the middle of a part's
|
||||||
header. Body inspection suits apps whose forms carry no code.
|
header. Body inspection suits apps whose forms carry no code.
|
||||||
@@ -2397,9 +2398,7 @@ In `observe` mode a request that `enforce` mode would refuse is answered
|
|||||||
answered `404`.
|
answered `404`.
|
||||||
|
|
||||||
The Core Rule Set inspects the body a question carries only while
|
The Core Rule Set inspects the body a question carries only while
|
||||||
`SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` is set. It inspects at most 64 KiB
|
`SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` is set, and at most 8 KiB of it.
|
||||||
less one byte. So it does not inspect a JSON or XML body of 64 KiB or more,
|
|
||||||
which may have been cut short.
|
|
||||||
|
|
||||||
### Answering in time
|
### Answering in time
|
||||||
|
|
||||||
@@ -2474,12 +2473,26 @@ client in `SWW_WAF_ALLOW_NETS` skips them, as it skips the Core Rule Set. In
|
|||||||
`observe` mode such a request is answered `allow` with `would_action`, and no
|
`observe` mode such a request is answered `allow` with `would_action`, and no
|
||||||
other check runs on it.
|
other check runs on it.
|
||||||
|
|
||||||
The Core Rule Set runs each of its rules on each cookie, so thousands of small
|
The Core Rule Set is the one check a visitor can keep busy for long. It runs
|
||||||
cookies would keep it busy for over a second. One 30 KB cookie or query string
|
each of its rules on each part of a request, so thousands of small cookies would
|
||||||
would keep it busy for a third of a second or more. A request with several long
|
keep it busy for over a second. These fixed limits bound what it reads:
|
||||||
`Cookie` lines, each within the limits, can keep it as busy. Enough such
|
|
||||||
requests at once can still overload `waf` past
|
- the header limits above;
|
||||||
`SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`.
|
- `rproxy`'s limit of 32 KiB on the request line and headers together (see
|
||||||
|
"`rproxy`'s limits");
|
||||||
|
- 8 KiB of a body, the most `SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` takes,
|
||||||
|
or 1 KiB of a JSON body.
|
||||||
|
|
||||||
|
Coraza names each value in a JSON body by the whole path to it, such as
|
||||||
|
`json.users.0.name`. So the names and values the Core Rule Set reads in a JSON
|
||||||
|
body can add up to more than the body. From 1 KiB of JSON, Coraza makes at most
|
||||||
|
8 KiB of them, no more than the largest body of another kind.
|
||||||
|
|
||||||
|
A request can reach all of these at once. At paranoia level 4, with no rule
|
||||||
|
switched off, the Core Rule Set takes under a second on one core of a current
|
||||||
|
server to inspect it. So `waf` answers it within the default 2 seconds, even
|
||||||
|
after the default 800 milliseconds of waiting for GeoJS. Enough such requests at
|
||||||
|
once can still overload `waf` past `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`.
|
||||||
|
|
||||||
### The report
|
### The report
|
||||||
|
|
||||||
|
|||||||
+2
-2
@@ -34,7 +34,7 @@ on one line:
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"instance": "fsn1/waf",
|
"instance": "host1/waf",
|
||||||
"time": "2026-10-06T12:00:50.123461Z",
|
"time": "2026-10-06T12:00:50.123461Z",
|
||||||
"event": "ban",
|
"event": "ban",
|
||||||
"host": "app.example",
|
"host": "app.example",
|
||||||
@@ -109,7 +109,7 @@ on one line:
|
|||||||
## Slack and ntfy
|
## Slack and ntfy
|
||||||
|
|
||||||
Slack and ntfy get a message with a title and a text. The title is the instance
|
Slack and ntfy get a message with a title and a text. The title is the instance
|
||||||
and the event, such as `fsn1/waf: ban`. The text is the `reason`, then one line
|
and the event, such as `host1/waf: ban`. The text is the `reason`, then one line
|
||||||
for each of these that the alert has:
|
for each of these that the alert has:
|
||||||
|
|
||||||
- the host, the client, the netblock and the country;
|
- the host, the client, the netblock and the country;
|
||||||
|
|||||||
+1
-1
@@ -26,7 +26,7 @@ These questions write no line:
|
|||||||
A `report` line:
|
A `report` line:
|
||||||
|
|
||||||
```
|
```
|
||||||
{"type":"request","waf_line":"report","time":"2026-10-03T12:00:00.123Z","instance":"fsn1/waf","client_ip":"203.0.113.9","method":"GET","scheme":"https","host":"app.example","path":"/","query":"","protocol":"HTTP/1.1","status":200,"request_bytes":0,"response_bytes":5120,"referer":"","user_agent":"curl/8.9.1","request_id":"7Q2NHZ4KJ3VXW5YB6R3MEFTD2A","peer_ip":"172.18.0.2","forwarded_for":"203.0.113.9","client_group":"203.0.113.9/32","asn":"AS64496","as_name":"Example Net","country":"DE","request_headers":{"accept":"*/*"},"action":"forward","counts":{"minute":1,"hour":12,"day":40,"minute_bytes":5120,"hour_bytes":61440,"day_bytes":204800},"core_rule_set_score":0,"duration_total_ms":3.217,"duration_checks_ms":0.041,"duration_core_rule_set_ms":0.029,"duration_upstream_total_ms":3.104}
|
{"type":"request","waf_line":"report","time":"2026-10-03T12:00:00.123Z","instance":"host1/waf","client_ip":"203.0.113.9","method":"GET","scheme":"https","host":"app.example","path":"/","query":"","protocol":"HTTP/1.1","status":200,"request_bytes":0,"response_bytes":5120,"referer":"","user_agent":"curl/8.9.1","request_id":"7Q2NHZ4KJ3VXW5YB6R3MEFTD2A","peer_ip":"172.18.0.2","forwarded_for":"203.0.113.9","client_group":"203.0.113.9/32","asn":"AS64496","as_name":"Example Net","country":"DE","request_headers":{"accept":"*/*"},"action":"forward","counts":{"minute":1,"hour":12,"day":40,"minute_bytes":5120,"hour_bytes":61440,"day_bytes":204800},"core_rule_set_score":0,"duration_total_ms":3.217,"duration_checks_ms":0.041,"duration_core_rule_set_ms":0.029,"duration_upstream_total_ms":3.104}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Every line
|
### Every line
|
||||||
|
|||||||
+4
-5
@@ -34,7 +34,7 @@ chooses between the two (see "The image's command" below).
|
|||||||
such as `:9000`. Leave the host out (see "Ports" in [`SPEC.md`](../SPEC.md)).
|
such as `:9000`. Leave the host out (see "Ports" in [`SPEC.md`](../SPEC.md)).
|
||||||
- `SWW_WAF_INSTANCE_NAME` (default: the container's host name): the `instance`
|
- `SWW_WAF_INSTANCE_NAME` (default: the container's host name): the `instance`
|
||||||
name in each line `waf` logs, and in each alert and metric, such as
|
name in each line `waf` logs, and in each alert and metric, such as
|
||||||
`fsn1/waf`. Valid UTF-8. No control character while `SWW_WAF_ALERT_NTFY_URL`
|
`host1/waf`. Valid UTF-8. No control character while `SWW_WAF_ALERT_NTFY_URL`
|
||||||
is set. 1 to 48 printable ASCII characters without a space while
|
is set. 1 to 48 printable ASCII characters without a space while
|
||||||
`SWW_WAF_LOG_REMOTE_URL` is set and `SWW_WAF_LOG_REMOTE_APP_NAME` is not.
|
`SWW_WAF_LOG_REMOTE_URL` is set and `SWW_WAF_LOG_REMOTE_APP_NAME` is not.
|
||||||
- `SWW_WAF_MODE` (default `enforce`): `enforce` or `observe`.
|
- `SWW_WAF_MODE` (default `enforce`): `enforce` or `observe`.
|
||||||
@@ -251,10 +251,9 @@ tag that no request can get stops the start. A request can get only these:
|
|||||||
- `SWW_WAF_CORE_RULE_SET_EXEMPT_PATHS` (default empty): path prefixes the Core
|
- `SWW_WAF_CORE_RULE_SET_EXEMPT_PATHS` (default empty): path prefixes the Core
|
||||||
Rule Set does not inspect.
|
Rule Set does not inspect.
|
||||||
- `SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` (default `off`): `off`, or how
|
- `SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` (default `off`): `off`, or how
|
||||||
much of a request body the Core Rule Set reads, a size of at most `64K`. A
|
much of a request body the Core Rule Set reads, a size of at most `8K`. A
|
||||||
question carries no more of a body than 64 KiB, and the Core Rule Set reads at
|
larger size would let one request keep it busy past `rproxy`'s timeout (see
|
||||||
most 64 KiB less one byte of it, whatever the value (see "The answer" in
|
"Answering in time" in [`SPEC.md`](../SPEC.md)).
|
||||||
[`SPEC.md`](../SPEC.md)).
|
|
||||||
- `SWW_WAF_CORE_RULE_SET_EXCLUSIONS_FILE` (default unset): a file of Core Rule
|
- `SWW_WAF_CORE_RULE_SET_EXCLUSIONS_FILE` (default unset): a file of Core Rule
|
||||||
Set exclusions, written as Coraza directives. It is loaded before the Core
|
Set exclusions, written as Coraza directives. It is loaded before the Core
|
||||||
Rule Set's rules, so it holds only `SecAction` and `SecRule` lines that
|
Rule Set's rules, so it holds only `SecAction` and `SecRule` lines that
|
||||||
|
|||||||
@@ -12,6 +12,7 @@ require (
|
|||||||
github.com/oschwald/maxminddb-golang/v2 v2.7.0
|
github.com/oschwald/maxminddb-golang/v2 v2.7.0
|
||||||
github.com/prometheus/client_golang v1.24.1
|
github.com/prometheus/client_golang v1.24.1
|
||||||
github.com/spf13/viper v1.21.0
|
github.com/spf13/viper v1.21.0
|
||||||
|
golang.org/x/sys v0.48.0
|
||||||
)
|
)
|
||||||
|
|
||||||
require (
|
require (
|
||||||
@@ -47,7 +48,6 @@ require (
|
|||||||
go4.org/netipx v0.0.0-20231129151722-fdeea329fbba // indirect
|
go4.org/netipx v0.0.0-20231129151722-fdeea329fbba // indirect
|
||||||
golang.org/x/net v0.60.0 // indirect
|
golang.org/x/net v0.60.0 // indirect
|
||||||
golang.org/x/sync v0.23.0 // indirect
|
golang.org/x/sync v0.23.0 // indirect
|
||||||
golang.org/x/sys v0.48.0 // indirect
|
|
||||||
golang.org/x/text v0.42.0 // indirect
|
golang.org/x/text v0.42.0 // indirect
|
||||||
google.golang.org/protobuf v1.36.11 // indirect
|
google.golang.org/protobuf v1.36.11 // indirect
|
||||||
rsc.io/binaryregexp v0.2.0 // indirect
|
rsc.io/binaryregexp v0.2.0 // indirect
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ const (
|
|||||||
ntfyURL = "https://ntfy.example/sww-alerts"
|
ntfyURL = "https://ntfy.example/sww-alerts"
|
||||||
ntfyToken = "tk_0123456789abcdefghijklmnopq"
|
ntfyToken = "tk_0123456789abcdefghijklmnopq"
|
||||||
// instance is the instance name every alert gives.
|
// instance is the instance name every alert gives.
|
||||||
instance = "fsn1app1/blog"
|
instance = "host1/blog"
|
||||||
// started is when each test starts, as an alert gives it, and
|
// started is when each test starts, as an alert gives it, and
|
||||||
// anHourOn an hour later.
|
// anHourOn an hour later.
|
||||||
started = "2000-01-01T00:00:00Z"
|
started = "2000-01-01T00:00:00Z"
|
||||||
@@ -1160,8 +1160,8 @@ func TestEachDestinationIsSentOnlyTheAlertsWaitingForIt(t *testing.T) {
|
|||||||
synctest.Wait()
|
synctest.Wait()
|
||||||
|
|
||||||
wantBodies(t, standIns[alerts.DestinationSlack],
|
wantBodies(t, standIns[alerts.DestinationSlack],
|
||||||
`{"text":"*fsn1app1/blog: file_error*\nsecond"}`,
|
`{"text":"*host1/blog: file_error*\nsecond"}`,
|
||||||
`{"text":"*fsn1app1/blog: file_error*\nthird"}`)
|
`{"text":"*host1/blog: file_error*\nthird"}`)
|
||||||
wantBodies(t, standIns[alerts.DestinationNtfy], "fourth")
|
wantBodies(t, standIns[alerts.DestinationNtfy], "fourth")
|
||||||
|
|
||||||
// alerts.json then lists Slack and ntfy alone, with no alert waiting.
|
// alerts.json then lists Slack and ntfy alone, with no alert waiting.
|
||||||
@@ -1477,7 +1477,7 @@ func anAlertForEachEvent() []eventMessage {
|
|||||||
Reason: "requests per hour over the limit of 10000",
|
Reason: "requests per hour over the limit of 10000",
|
||||||
Detail: map[string]any{"mode": "observe"},
|
Detail: map[string]any{"mode": "observe"},
|
||||||
},
|
},
|
||||||
"fsn1app1/blog: ban", "default no_entry",
|
"host1/blog: ban", "default no_entry",
|
||||||
"requests per hour over the limit of 10000\nclient: 203.0.113.9\n" +
|
"requests per hour over the limit of 10000\nclient: 203.0.113.9\n" +
|
||||||
"netblock: 203.0.113.0/24\ncountry: DE\nmode: observe",
|
"netblock: 203.0.113.0/24\ncountry: DE\nmode: observe",
|
||||||
},
|
},
|
||||||
@@ -1489,7 +1489,7 @@ func anAlertForEachEvent() []eventMessage {
|
|||||||
), Country: "FR",
|
), Country: "FR",
|
||||||
Reason: "matched the rule env-file",
|
Reason: "matched the rule env-file",
|
||||||
},
|
},
|
||||||
"fsn1app1/blog: permanent_ban", "high no_entry",
|
"host1/blog: permanent_ban", "high no_entry",
|
||||||
"matched the rule env-file\nclient: 198.51.100.7\n" +
|
"matched the rule env-file\nclient: 198.51.100.7\n" +
|
||||||
"netblock: 198.51.100.7/32\ncountry: FR",
|
"netblock: 198.51.100.7/32\ncountry: FR",
|
||||||
},
|
},
|
||||||
@@ -1500,7 +1500,7 @@ func anAlertForEachEvent() []eventMessage {
|
|||||||
Reason: "refused by the Core Rule Set",
|
Reason: "refused by the Core Rule Set",
|
||||||
Host: "app.example",
|
Host: "app.example",
|
||||||
},
|
},
|
||||||
"fsn1app1/blog: core_rule_set_match", "default shield",
|
"host1/blog: core_rule_set_match", "default shield",
|
||||||
"refused by the Core Rule Set\nhost: app.example\nclient: 192.0.2.1\n" +
|
"refused by the Core Rule Set\nhost: app.example\nclient: 192.0.2.1\n" +
|
||||||
"netblock: 192.0.2.1/32",
|
"netblock: 192.0.2.1/32",
|
||||||
},
|
},
|
||||||
@@ -1509,7 +1509,7 @@ func anAlertForEachEvent() []eventMessage {
|
|||||||
Event: alerts.EventAnomaly, Netblock: netip.MustParsePrefix("192.0.2.0/24"),
|
Event: alerts.EventAnomaly, Netblock: netip.MustParsePrefix("192.0.2.0/24"),
|
||||||
Reason: "requests per minute over the threshold of 5000",
|
Reason: "requests per minute over the threshold of 5000",
|
||||||
},
|
},
|
||||||
"fsn1app1/blog: anomaly", "high chart_with_upwards_trend",
|
"host1/blog: anomaly", "high chart_with_upwards_trend",
|
||||||
"requests per minute over the threshold of 5000\nnetblock: 192.0.2.0/24",
|
"requests per minute over the threshold of 5000\nnetblock: 192.0.2.0/24",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -1518,7 +1518,7 @@ func anAlertForEachEvent() []eventMessage {
|
|||||||
Netblock: netip.MustParsePrefix("192.0.2.2/32"),
|
Netblock: netip.MustParsePrefix("192.0.2.2/32"),
|
||||||
Reason: "listed by a DNS blocklist",
|
Reason: "listed by a DNS blocklist",
|
||||||
},
|
},
|
||||||
"fsn1app1/blog: reputation_hit", "low label",
|
"host1/blog: reputation_hit", "low label",
|
||||||
"listed by a DNS blocklist\nclient: 192.0.2.2\nnetblock: 192.0.2.2/32",
|
"listed by a DNS blocklist\nclient: 192.0.2.2\nnetblock: 192.0.2.2/32",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -1526,7 +1526,7 @@ func anAlertForEachEvent() []eventMessage {
|
|||||||
Event: alerts.EventSourceFailure, Reason: "asking GeoJS failed",
|
Event: alerts.EventSourceFailure, Reason: "asking GeoJS failed",
|
||||||
Detail: map[string]any{"source": "geojs"},
|
Detail: map[string]any{"source": "geojs"},
|
||||||
},
|
},
|
||||||
"fsn1app1/blog: source_failure", "high warning",
|
"host1/blog: source_failure", "high warning",
|
||||||
"asking GeoJS failed\nsource: geojs",
|
"asking GeoJS failed\nsource: geojs",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
@@ -1537,7 +1537,7 @@ func anAlertForEachEvent() []eventMessage {
|
|||||||
"file": "/etc/sww/rules.d/50-app.rules", "error": "line 2: no action",
|
"file": "/etc/sww/rules.d/50-app.rules", "error": "line 2: no action",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
"fsn1app1/blog: file_error", "high warning",
|
"host1/blog: file_error", "high warning",
|
||||||
"a rule file has an error, and the rules stay as they were\n" +
|
"a rule file has an error, and the rules stay as they were\n" +
|
||||||
"file: /etc/sww/rules.d/50-app.rules\nerror: line 2: no action",
|
"file: /etc/sww/rules.d/50-app.rules\nerror: line 2: no action",
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -365,8 +365,8 @@ var (
|
|||||||
"it names the file to look clients up in",
|
"it names the file to look clients up in",
|
||||||
)
|
)
|
||||||
errDBPathUnused = errors.New("only file reads it")
|
errDBPathUnused = errors.New("only file reads it")
|
||||||
errOver64K = errors.New(
|
errOver8K = errors.New(
|
||||||
"is more than 64K, the most waf gets of a body")
|
"is more than 8K, the most the Core Rule Set can read in time")
|
||||||
errNotDurationAboveZero = errors.New(
|
errNotDurationAboveZero = errors.New(
|
||||||
"is not a duration above zero, such as 1h or 7d")
|
"is not a duration above zero, such as 1h or 7d")
|
||||||
errNotNumberAboveZero = errors.New(
|
errNotNumberAboveZero = errors.New(
|
||||||
@@ -1601,16 +1601,16 @@ func durationOrDays(value string) (time.Duration, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// parseCoreRuleSetBodyInspectionSize reads the most of a request body the Core Rule Set
|
// parseCoreRuleSetBodyInspectionSize reads the most of a request body the Core Rule Set
|
||||||
// reads: a size as parseSize reads it, or off, but at most 64K, since waf
|
// reads: a size as parseSize reads it, or off, but at most 8K, so that one
|
||||||
// gets no more of a body than that.
|
// request cannot keep the Core Rule Set busy past rproxy's timeout.
|
||||||
func parseCoreRuleSetBodyInspectionSize(value string) (int64, error) {
|
func parseCoreRuleSetBodyInspectionSize(value string) (int64, error) {
|
||||||
limit, err := parseSize(value)
|
limit, err := parseSize(value)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return 0, err
|
return 0, err
|
||||||
}
|
}
|
||||||
|
|
||||||
if limit > 64*kibibyte {
|
if limit > 8*kibibyte {
|
||||||
return 0, fmt.Errorf("%q %w", value, errOver64K)
|
return 0, fmt.Errorf("%q %w", value, errOver8K)
|
||||||
}
|
}
|
||||||
|
|
||||||
return limit, nil
|
return limit, nil
|
||||||
|
|||||||
+19
-17
@@ -218,7 +218,7 @@ const (
|
|||||||
// instance is an SWW_WAF_INSTANCE_NAME that is a valid app name too, and
|
// instance is an SWW_WAF_INSTANCE_NAME that is a valid app name too, and
|
||||||
// remoteURL an SWW_WAF_LOG_REMOTE_URL, for the tests that send the lines.
|
// remoteURL an SWW_WAF_LOG_REMOTE_URL, for the tests that send the lines.
|
||||||
const (
|
const (
|
||||||
instance = "fsn1app1/blog"
|
instance = "host1/blog"
|
||||||
remoteURL = "syslog+udp://192.0.2.1:514"
|
remoteURL = "syslog+udp://192.0.2.1:514"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -616,7 +616,7 @@ func TestCoreRuleSetSettings(t *testing.T) {
|
|||||||
coreRuleSetScoreThreshold: "10",
|
coreRuleSetScoreThreshold: "10",
|
||||||
coreRuleSetDisabledRules: "942100, 920350",
|
coreRuleSetDisabledRules: "942100, 920350",
|
||||||
coreRuleSetExemptPaths: "/api/, /static/",
|
coreRuleSetExemptPaths: "/api/, /static/",
|
||||||
coreRuleSetBodyInspectionSize: "32K",
|
coreRuleSetBodyInspectionSize: "4K",
|
||||||
exclusionsFile: "/etc/sww/crs-exclusions.conf",
|
exclusionsFile: "/etc/sww/crs-exclusions.conf",
|
||||||
},
|
},
|
||||||
config.WAF{
|
config.WAF{
|
||||||
@@ -625,7 +625,7 @@ func TestCoreRuleSetSettings(t *testing.T) {
|
|||||||
CoreRuleSetScoreThreshold: 10,
|
CoreRuleSetScoreThreshold: 10,
|
||||||
CoreRuleSetDisabledRules: []int{942100, 920350},
|
CoreRuleSetDisabledRules: []int{942100, 920350},
|
||||||
CoreRuleSetExemptPaths: []string{"/api/", "/static/"},
|
CoreRuleSetExemptPaths: []string{"/api/", "/static/"},
|
||||||
CoreRuleSetBodyInspectionSize: 32 << 10,
|
CoreRuleSetBodyInspectionSize: 4 << 10,
|
||||||
CoreRuleSetExclusionsFile: "/etc/sww/crs-exclusions.conf",
|
CoreRuleSetExclusionsFile: "/etc/sww/crs-exclusions.conf",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -762,15 +762,15 @@ func TestInvalidAppsStopsTheStart(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCoreRuleSetBodyInspectionSizeOf64K(t *testing.T) {
|
func TestCoreRuleSetBodyInspectionSizeOf8K(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
cfg := wafFromEnvironment(
|
cfg := wafFromEnvironment(
|
||||||
t,
|
t,
|
||||||
environment{coreRuleSetBodyInspectionSize: "64K"},
|
environment{coreRuleSetBodyInspectionSize: "8K"},
|
||||||
)
|
)
|
||||||
if cfg.CoreRuleSetBodyInspectionSize != 64<<10 {
|
if cfg.CoreRuleSetBodyInspectionSize != 8<<10 {
|
||||||
t.Errorf("64K read as %d", cfg.CoreRuleSetBodyInspectionSize)
|
t.Errorf("8K read as %d", cfg.CoreRuleSetBodyInspectionSize)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -819,11 +819,13 @@ func TestInvalidCoreRuleSetSettingStopsTheStart(t *testing.T) {
|
|||||||
coreRuleSetBodyInspectionSize, "128KB",
|
coreRuleSetBodyInspectionSize, "128KB",
|
||||||
`"128KB" is not a size such as 512K, 100M or 5G, or off`,
|
`"128KB" is not a size such as 512K, 100M or 5G, or off`,
|
||||||
},
|
},
|
||||||
{coreRuleSetBodyInspectionSize, "65K", `"65K" is more than 64K, the most waf ` +
|
|
||||||
`gets of a body`},
|
|
||||||
{
|
{
|
||||||
coreRuleSetBodyInspectionSize, "65537",
|
coreRuleSetBodyInspectionSize, "9K",
|
||||||
`"65537" is more than 64K, the most waf gets of a body`,
|
`"9K" is more than 8K, the most the Core Rule Set can read in time`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
coreRuleSetBodyInspectionSize, "8193",
|
||||||
|
`"8193" is more than 8K, the most the Core Rule Set can read in time`,
|
||||||
},
|
},
|
||||||
} {
|
} {
|
||||||
t.Run(tc.name+"="+tc.value, func(t *testing.T) {
|
t.Run(tc.name+"="+tc.value, func(t *testing.T) {
|
||||||
@@ -845,11 +847,11 @@ func TestInstanceNameAndLoggedHeadersAsSet(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
cfg := wafFromEnvironment(t, environment{
|
cfg := wafFromEnvironment(t, environment{
|
||||||
instanceName: "fsn1app1/blog",
|
instanceName: "host1/blog",
|
||||||
logRequestHeaders: " Accept , X-Custom",
|
logRequestHeaders: " Accept , X-Custom",
|
||||||
})
|
})
|
||||||
|
|
||||||
if cfg.InstanceName != "fsn1app1/blog" ||
|
if cfg.InstanceName != "host1/blog" ||
|
||||||
!slices.Equal(
|
!slices.Equal(
|
||||||
cfg.LogRequestHeaders,
|
cfg.LogRequestHeaders,
|
||||||
[]string{"accept", "x-custom"},
|
[]string{"accept", "x-custom"},
|
||||||
@@ -1022,14 +1024,14 @@ func TestInstanceNameNotAnAppNameStopsTheStartOnlyWhileSending(
|
|||||||
) {
|
) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const spaced = "fsn1 app1"
|
const spaced = "host1 blog"
|
||||||
|
|
||||||
sending := environment{logRemoteURL: remoteURL, instanceName: spaced}
|
sending := environment{logRemoteURL: remoteURL, instanceName: spaced}
|
||||||
|
|
||||||
_, err := config.WAFFromEnvironment(sending.viper())
|
_, err := config.WAFFromEnvironment(sending.viper())
|
||||||
|
|
||||||
want := logRemoteAppName + `: is unset, and ` + instanceName +
|
want := logRemoteAppName + `: is unset, and ` + instanceName +
|
||||||
` "fsn1 app1", its default, is not 1 to 48 printable ASCII characters ` +
|
` "host1 blog", its default, is not 1 to 48 printable ASCII characters ` +
|
||||||
`without a space, such as blog`
|
`without a space, such as blog`
|
||||||
if err == nil || err.Error() != want {
|
if err == nil || err.Error() != want {
|
||||||
t.Errorf("error %v, want %s", err, want)
|
t.Errorf("error %v, want %s", err, want)
|
||||||
@@ -1331,13 +1333,13 @@ func TestInstanceNameWithAControlCharacterStopsTheStartOnlyWithNtfySet(
|
|||||||
) {
|
) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const name = "fsn1app1\r"
|
const name = "host1\r"
|
||||||
|
|
||||||
_, err := config.WAFFromEnvironment(environment{
|
_, err := config.WAFFromEnvironment(environment{
|
||||||
instanceName: name, alertNtfyURL: "https://ntfy.example/sww-alerts",
|
instanceName: name, alertNtfyURL: "https://ntfy.example/sww-alerts",
|
||||||
}.viper())
|
}.viper())
|
||||||
|
|
||||||
want := instanceName + `: "fsn1app1\r" holds a control character, such as the ` +
|
want := instanceName + `: "host1\r" holds a control character, such as the ` +
|
||||||
`carriage return of a Windows line end, and is sent to ntfy in a header ` +
|
`carriage return of a Windows line end, and is sent to ntfy in a header ` +
|
||||||
`while ` + alertNtfyURL + ` is set`
|
`while ` + alertNtfyURL + ` is set`
|
||||||
if err == nil || err.Error() != want {
|
if err == nil || err.Error() != want {
|
||||||
|
|||||||
@@ -481,12 +481,21 @@ func (c *CoreRuleSet) Inspect(
|
|||||||
return Result{RuleIDs: ids, Score: score(tx)}, read, err
|
return Result{RuleIDs: ids, Score: score(tx)}, read, err
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// mostJSONRead is the largest JSON body the Core Rule Set reads, even while
|
||||||
|
// SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE is larger. Coraza names each
|
||||||
|
// value in a JSON body by the whole path to it, so what it gives the Core
|
||||||
|
// Rule Set to read can outgrow the body: up to 8 times its size, and up to
|
||||||
|
// 4 KiB for a small body. 1 KiB of JSON thus gives at most 8 KiB, no more
|
||||||
|
// than the largest body of another kind.
|
||||||
|
const mostJSONRead = 1 << 10
|
||||||
|
|
||||||
// readBody reads body, the body of the request in tx, which has run on
|
// readBody reads body, the body of the request in tx, which has run on
|
||||||
// the request's headers, while SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE is
|
// the request's headers, while SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE is
|
||||||
// set and the body is of a kind the Core Rule Set reads: form data and
|
// set and the body is of a kind the Core Rule Set reads: form data and
|
||||||
// multipart, of which it reads the first c.bodyInspectionSize bytes, and
|
// multipart, of which it reads the first c.bodyInspectionSize bytes, and
|
||||||
// JSON and XML, which it reads only when they are no longer than that,
|
// JSON and XML, which it reads only when they are no longer than that,
|
||||||
// since they cannot be read in part.
|
// since they cannot be read in part. The Core Rule Set reads no JSON body
|
||||||
|
// longer than mostJSONRead either.
|
||||||
// readBody reads one byte past c.bodyInspectionSize, to tell which they
|
// readBody reads one byte past c.bodyInspectionSize, to tell which they
|
||||||
// are, gives the Core Rule Set what it reads, and returns what it read and
|
// are, gives the Core Rule Set what it reads, and returns what it read and
|
||||||
// the error that ended the reading early, if one did.
|
// the error that ended the reading early, if one did.
|
||||||
@@ -499,6 +508,8 @@ func (c *CoreRuleSet) readBody(
|
|||||||
}
|
}
|
||||||
|
|
||||||
inPart := false
|
inPart := false
|
||||||
|
// largest is the largest JSON or XML body the Core Rule Set reads.
|
||||||
|
largest := c.bodyInspectionSize
|
||||||
// How the body is read is a variable of the transaction, which only
|
// How the body is read is a variable of the transaction, which only
|
||||||
// Coraza's interface for plugins reads.
|
// Coraza's interface for plugins reads.
|
||||||
state := tx.(plugintypes.TransactionState) //nolint:forcetypeassert // every one is
|
state := tx.(plugintypes.TransactionState) //nolint:forcetypeassert // every one is
|
||||||
@@ -506,14 +517,16 @@ func (c *CoreRuleSet) readBody(
|
|||||||
switch state.Variables().RequestBodyProcessor().Get() {
|
switch state.Variables().RequestBodyProcessor().Get() {
|
||||||
case "URLENCODED", "MULTIPART":
|
case "URLENCODED", "MULTIPART":
|
||||||
inPart = true
|
inPart = true
|
||||||
case "JSON", "XML":
|
case "JSON":
|
||||||
|
largest = min(largest, mostJSONRead)
|
||||||
|
case "XML":
|
||||||
default:
|
default:
|
||||||
return nil, nil
|
return nil, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
read, err := io.ReadAll(io.LimitReader(body, c.bodyInspectionSize+1))
|
read, err := io.ReadAll(io.LimitReader(body, c.bodyInspectionSize+1))
|
||||||
|
|
||||||
if inPart || (err == nil && int64(len(read)) <= c.bodyInspectionSize) {
|
if inPart || (err == nil && int64(len(read)) <= largest) {
|
||||||
// Coraza holds what it reads of the body in memory, up to the
|
// Coraza holds what it reads of the body in memory, up to the
|
||||||
// limit, so this cannot fail.
|
// limit, so this cannot fail.
|
||||||
_, _, _ = tx.WriteRequestBody(read)
|
_, _, _ = tx.WriteRequestBody(read)
|
||||||
|
|||||||
@@ -390,22 +390,15 @@ func TestMoreParametersThanCorazaKeepsIsAMatch(t *testing.T) {
|
|||||||
matched(900300),
|
matched(900300),
|
||||||
)
|
)
|
||||||
|
|
||||||
// So it is with the fields of a form data or JSON body.
|
// So it is with the fields of a form data body. A JSON body the Core
|
||||||
|
// Rule Set reads, of at most mostJSONRead bytes, cannot hold that many.
|
||||||
crs = readingBodies(t)
|
crs = readingBodies(t)
|
||||||
|
|
||||||
for _, tc := range []struct{ header, body string }{
|
body := strings.Repeat("a=1&", 999) + attack
|
||||||
{formData, strings.Repeat("a=1&", 999) + attack},
|
wantBody(t, crs, post(formData), body, matched(942100), body)
|
||||||
{jsonBody, `{"a":[` + strings.Repeat("1,", 998) + `1],"id":"` + injection + `"}`},
|
|
||||||
} {
|
|
||||||
wantBody(t, crs, post(tc.header), tc.body, matched(942100), tc.body)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range []struct{ header, body string }{
|
body = strings.Repeat("a=1&", 1000) + attack
|
||||||
{formData, strings.Repeat("a=1&", 1000) + attack},
|
wantBody(t, crs, post(formData), body, matched(900300), body)
|
||||||
{jsonBody, `{"a":[` + strings.Repeat("1,", 999) + `1],"id":"` + injection + `"}`},
|
|
||||||
} {
|
|
||||||
wantBody(t, crs, post(tc.header), tc.body, matched(900300), tc.body)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestRedirectURIMayNameALocalAddress(t *testing.T) {
|
func TestRedirectURIMayNameALocalAddress(t *testing.T) {
|
||||||
@@ -1512,13 +1505,15 @@ const (
|
|||||||
wpTags = "/wp-json/wp/v2/tags"
|
wpTags = "/wp-json/wp/v2/tags"
|
||||||
)
|
)
|
||||||
|
|
||||||
// readingBodiesUpTo64K returns the Core Rule Set as sww runs it by default,
|
// readingBodiesUpTo8K returns the Core Rule Set as sww runs it by default,
|
||||||
// but reading bodies up to the largest SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE.
|
// but reading bodies up to the largest SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE.
|
||||||
func readingBodiesUpTo64K(t *testing.T) *coreruleset.CoreRuleSet {
|
func readingBodiesUpTo8K(t *testing.T) *coreruleset.CoreRuleSet {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
return shared(t, coreruleset.Params{
|
return shared(t, coreruleset.Params{
|
||||||
ParanoiaLevel: 1, DisabledRules: defaultDisabledRules, BodyInspectionSize: 64<<10 - 1,
|
ParanoiaLevel: 1,
|
||||||
|
DisabledRules: defaultDisabledRules,
|
||||||
|
BodyInspectionSize: mostBodyRead,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1582,7 +1577,7 @@ func TestWordPressAttacksAreRefused(t *testing.T) {
|
|||||||
|
|
||||||
const threshold = 5 // SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD's default
|
const threshold = 5 // SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD's default
|
||||||
|
|
||||||
defaults, bodies := atDefaults(t), readingBodiesUpTo64K(t)
|
defaults, bodies := atDefaults(t), readingBodiesUpTo8K(t)
|
||||||
|
|
||||||
for _, attack := range []string{
|
for _, attack := range []string{
|
||||||
sqlInjection,
|
sqlInjection,
|
||||||
@@ -1693,7 +1688,7 @@ func wordpressRESTAddresses(route string) []string {
|
|||||||
func TestWordPressExclusionsFollowEveryRESTAddress(t *testing.T) {
|
func TestWordPressExclusionsFollowEveryRESTAddress(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
crs := readingBodiesUpTo64K(t)
|
crs := readingBodiesUpTo8K(t)
|
||||||
content := `{"content":"` + wordpressBlock + `"}`
|
content := `{"content":"` + wordpressBlock + `"}`
|
||||||
|
|
||||||
for _, route := range []string{
|
for _, route := range []string{
|
||||||
@@ -1919,7 +1914,7 @@ func TestWordPressCommandAfterASeparatorIsRefusedOnSearchesAndNames(
|
|||||||
wantResult(t, crs, get(target+command), matched(932235))
|
wantResult(t, crs, get(target+command), matched(932235))
|
||||||
}
|
}
|
||||||
|
|
||||||
bodies := readingBodiesUpTo64K(t)
|
bodies := readingBodiesUpTo8K(t)
|
||||||
|
|
||||||
for _, p := range wordpressBodyFields(command) {
|
for _, p := range wordpressBodyFields(command) {
|
||||||
r := request{http.MethodPost, p.target, []string{p.contentType}}
|
r := request{http.MethodPost, p.target, []string{p.contentType}}
|
||||||
@@ -2143,7 +2138,7 @@ func TestWordPressBodyFieldsAreCheckedInTheQuery(t *testing.T) {
|
|||||||
func TestWordPressBodyNamesAndAddressesAreExcludedOnlyThere(t *testing.T) {
|
func TestWordPressBodyNamesAndAddressesAreExcludedOnlyThere(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
crs := readingBodiesUpTo64K(t)
|
crs := readingBodiesUpTo8K(t)
|
||||||
|
|
||||||
for _, v := range wordpressWords() {
|
for _, v := range wordpressWords() {
|
||||||
for _, field := range []string{"title", "excerpt", "name"} {
|
for _, field := range []string{"title", "excerpt", "name"} {
|
||||||
@@ -2262,7 +2257,7 @@ func TestWordPressExclusionsAreNarrow(t *testing.T) {
|
|||||||
length = "Content-Length: 2"
|
length = "Content-Length: 2"
|
||||||
)
|
)
|
||||||
|
|
||||||
crs := readingBodiesUpTo64K(t)
|
crs := readingBodiesUpTo8K(t)
|
||||||
saving := request{
|
saving := request{
|
||||||
http.MethodPost,
|
http.MethodPost,
|
||||||
wpPost,
|
wpPost,
|
||||||
@@ -2473,19 +2468,35 @@ func TestFormDataAndMultipartAreReadUpToTheLimit(t *testing.T) {
|
|||||||
func TestJSONAndXMLAreReadOnlyWhenNoLargerThanTheLimit(t *testing.T) {
|
func TestJSONAndXMLAreReadOnlyWhenNoLargerThanTheLimit(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
crs := readingBodies(t)
|
// The limit is the body inspection size, but at most mostJSONRead for
|
||||||
|
// JSON. smallSize is a body inspection size under mostJSONRead.
|
||||||
|
const smallSize = 512
|
||||||
|
|
||||||
for _, tc := range []struct{ header, head, tail string }{
|
bodies, smallBodies := readingBodies(t), shared(t, coreruleset.Params{
|
||||||
{jsonBody, `{"q":"` + injection + `","pad":"`, `"}`},
|
ParanoiaLevel: 1, DisabledRules: defaultDisabledRules,
|
||||||
{xmlBody, "<r><q>" + injection + "</q><pad>", "</pad></r>"},
|
BodyInspectionSize: smallSize,
|
||||||
|
})
|
||||||
|
jsonHead, jsonTail := `{"q":"`+injection+`","pad":"`, `"}`
|
||||||
|
|
||||||
|
for _, tc := range []struct {
|
||||||
|
crs *coreruleset.CoreRuleSet
|
||||||
|
header, head, tail string
|
||||||
|
limit int
|
||||||
|
}{
|
||||||
|
{bodies, jsonBody, jsonHead, jsonTail, mostJSONRead},
|
||||||
|
{smallBodies, jsonBody, jsonHead, jsonTail, smallSize},
|
||||||
|
{
|
||||||
|
bodies, xmlBody, "<r><q>" + injection + "</q><pad>", "</pad></r>",
|
||||||
|
bodyInspectionSize,
|
||||||
|
},
|
||||||
} {
|
} {
|
||||||
fits := padded(tc.head, tc.tail, bodyInspectionSize)
|
fits := padded(tc.head, tc.tail, tc.limit)
|
||||||
wantBody(t, crs, post(tc.header), fits, matched(942100), fits)
|
wantBody(t, tc.crs, post(tc.header), fits, matched(942100), fits)
|
||||||
|
|
||||||
larger := padded(tc.head, tc.tail, bodyInspectionSize+1)
|
larger := padded(tc.head, tc.tail, tc.limit+1)
|
||||||
wantBody(
|
wantBody(
|
||||||
t,
|
t,
|
||||||
crs,
|
tc.crs,
|
||||||
post(tc.header),
|
post(tc.header),
|
||||||
larger,
|
larger,
|
||||||
coreruleset.Result{},
|
coreruleset.Result{},
|
||||||
|
|||||||
@@ -0,0 +1,395 @@
|
|||||||
|
package coreruleset_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"maps"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/netip"
|
||||||
|
"runtime"
|
||||||
|
"slices"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"golang.org/x/sys/unix"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/coreruleset"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The bounds on what a visitor can send, as SPEC.md gives them.
|
||||||
|
const (
|
||||||
|
// lineLimit is the longest request line or header line.
|
||||||
|
lineLimit = 8 << 10
|
||||||
|
// headerLimit is the most bytes rproxy reads of a request line and
|
||||||
|
// headers together.
|
||||||
|
headerLimit = 32 << 10
|
||||||
|
// mostCookies and mostHeaderFields are waf's limits on cookies and header
|
||||||
|
// fields.
|
||||||
|
mostCookies = 50
|
||||||
|
mostHeaderFields = 100
|
||||||
|
// mostBodyRead is the largest SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE.
|
||||||
|
mostBodyRead = 8 << 10
|
||||||
|
// mostJSONRead is the largest JSON body the Core Rule Set reads.
|
||||||
|
mostJSONRead = 1 << 10
|
||||||
|
)
|
||||||
|
|
||||||
|
// inspectionTimeLimit is the most time the Core Rule Set may take on one
|
||||||
|
// request. It is the default of rproxy's SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS, 2
|
||||||
|
// seconds, less the default of SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS, 800
|
||||||
|
// milliseconds, which a question can also wait for GeoJS, and less 200
|
||||||
|
// milliseconds for waf's other checks.
|
||||||
|
const inspectionTimeLimit = time.Second
|
||||||
|
|
||||||
|
// text returns n bytes of letters, digits and spaces, which the Core Rule Set
|
||||||
|
// takes longer over than one letter repeated.
|
||||||
|
func text(n int) string {
|
||||||
|
const words = "select 0x2f from tbl_1 where name like abc_9 "
|
||||||
|
|
||||||
|
return strings.Repeat(words, n/len(words)+1)[:n]
|
||||||
|
}
|
||||||
|
|
||||||
|
// visitorRequest is a request a visitor can send, at the most of one or more
|
||||||
|
// of the bounds above.
|
||||||
|
type visitorRequest struct {
|
||||||
|
name string
|
||||||
|
target string
|
||||||
|
// header holds the headers besides Host.
|
||||||
|
header http.Header
|
||||||
|
// contentType is the body's type, "" for no body.
|
||||||
|
contentType string
|
||||||
|
body string
|
||||||
|
}
|
||||||
|
|
||||||
|
// longestTarget returns a target whose request line, "POST <target>
|
||||||
|
// HTTP/1.1", is lineLimit bytes long.
|
||||||
|
func longestTarget() string {
|
||||||
|
const around = len("POST /?q= HTTP/1.1")
|
||||||
|
|
||||||
|
return "/?q=" + strings.ReplaceAll(text(lineLimit-around), " ", "+")
|
||||||
|
}
|
||||||
|
|
||||||
|
// cookieLine returns a Cookie value whose line, "Cookie: <value>", is
|
||||||
|
// lineLimit bytes long, made of count cookies.
|
||||||
|
func cookieLine(count int) string {
|
||||||
|
const linePrefix = len("Cookie: ")
|
||||||
|
|
||||||
|
cookies := make([]string, count)
|
||||||
|
for i := range cookies {
|
||||||
|
cookies[i] = "c" + strconv.Itoa(i) + "="
|
||||||
|
}
|
||||||
|
|
||||||
|
// Each cookie is followed by "; ", but for the last.
|
||||||
|
room := lineLimit - linePrefix - len(strings.Join(cookies, "; "))
|
||||||
|
for i := range cookies {
|
||||||
|
share := room / count
|
||||||
|
if i == 0 {
|
||||||
|
share += room % count
|
||||||
|
}
|
||||||
|
|
||||||
|
cookies[i] += strings.ReplaceAll(text(share), " ", "_")
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.Join(cookies, "; ")
|
||||||
|
}
|
||||||
|
|
||||||
|
// headerValue returns a value whose line, "<name>: <value>", is n bytes long.
|
||||||
|
func headerValue(name string, n int) string {
|
||||||
|
return text(n - len(name) - len(": "))
|
||||||
|
}
|
||||||
|
|
||||||
|
// formFields returns a form body of mostBodyRead bytes holding count fields.
|
||||||
|
func formFields(count int) string {
|
||||||
|
fields := make([]string, count)
|
||||||
|
for i := range fields {
|
||||||
|
fields[i] = "f" + strconv.Itoa(i) + "="
|
||||||
|
}
|
||||||
|
|
||||||
|
room := mostBodyRead - len(strings.Join(fields, "&"))
|
||||||
|
for i := range fields {
|
||||||
|
share := room / count
|
||||||
|
if i == 0 {
|
||||||
|
share += room % count
|
||||||
|
}
|
||||||
|
|
||||||
|
fields[i] += strings.ReplaceAll(text(share), " ", "+")
|
||||||
|
}
|
||||||
|
|
||||||
|
return strings.Join(fields, "&")
|
||||||
|
}
|
||||||
|
|
||||||
|
// multipartBody returns a multipart body of mostBodyRead bytes, with the
|
||||||
|
// boundary "b", holding fields of about size bytes each.
|
||||||
|
func multipartBody(size int) string {
|
||||||
|
var body strings.Builder
|
||||||
|
|
||||||
|
const end = "--b--\r\n"
|
||||||
|
|
||||||
|
for i := 0; ; i++ {
|
||||||
|
head := "--b\r\nContent-Disposition: form-data; name=\"f" +
|
||||||
|
strconv.Itoa(i) + "\"\r\n\r\n"
|
||||||
|
|
||||||
|
room := mostBodyRead - body.Len() - len(
|
||||||
|
end,
|
||||||
|
) - len(
|
||||||
|
head,
|
||||||
|
) - len(
|
||||||
|
"\r\n",
|
||||||
|
)
|
||||||
|
if room <= 0 {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
body.WriteString(head + text(min(size, room)) + "\r\n")
|
||||||
|
}
|
||||||
|
|
||||||
|
body.WriteString(end)
|
||||||
|
|
||||||
|
return body.String()
|
||||||
|
}
|
||||||
|
|
||||||
|
// jsonArrayOfMostElements returns a JSON array of at most mostJSONRead bytes
|
||||||
|
// holding as many elements as fit, each the number 1.
|
||||||
|
func jsonArrayOfMostElements() string {
|
||||||
|
return "[1" + strings.Repeat(
|
||||||
|
",1",
|
||||||
|
(mostJSONRead-len("[1]"))/len(",1"),
|
||||||
|
) + "]"
|
||||||
|
}
|
||||||
|
|
||||||
|
// jsonOfMostElementsUnderAKey returns a JSON body of mostJSONRead bytes
|
||||||
|
// holding as many elements as fit, each the number 1, in an array under a
|
||||||
|
// key of 6 bytes. Coraza names each element "json.<key>.<index>", so a
|
||||||
|
// longer key makes longer names. 6 bytes is the longest key that keeps the
|
||||||
|
// names and values of this body within the 8 KiB Coraza allows.
|
||||||
|
func jsonOfMostElementsUnderAKey() string {
|
||||||
|
head := `{"` + text(6) + `":[1`
|
||||||
|
|
||||||
|
return head + strings.Repeat(
|
||||||
|
",1",
|
||||||
|
(mostJSONRead-len(head+"]}"))/len(",1"),
|
||||||
|
) + "]}"
|
||||||
|
}
|
||||||
|
|
||||||
|
// The kinds of body the Core Rule Set reads, and the header that names a
|
||||||
|
// request's cookies.
|
||||||
|
const (
|
||||||
|
formType = "application/x-www-form-urlencoded"
|
||||||
|
jsonType = "application/json"
|
||||||
|
multipartType = "multipart/form-data; boundary=b"
|
||||||
|
cookieHeader = "Cookie"
|
||||||
|
)
|
||||||
|
|
||||||
|
// fullLine is the length of each of the request line and the three or four
|
||||||
|
// header lines that together fill rproxy's limit, with room for the line
|
||||||
|
// endings and the other headers.
|
||||||
|
const fullLine = lineLimit - 64
|
||||||
|
|
||||||
|
// worstCaseRequests are, for each kind of thing a visitor sends, the requests
|
||||||
|
// that keep the Core Rule Set busiest, within the bounds above. The last
|
||||||
|
// holds the most of everything at once: Cookie lines keep it busier than
|
||||||
|
// other header lines, and the JSON body of the most elements under a key
|
||||||
|
// keeps it busier than the other bodies.
|
||||||
|
func worstCaseRequests() []visitorRequest {
|
||||||
|
fullCookieLine := cookieLine(1)[:fullLine-len("Cookie: ")]
|
||||||
|
|
||||||
|
return append(
|
||||||
|
append(worstCaseHeaders(), worstCaseBodies()...),
|
||||||
|
visitorRequest{
|
||||||
|
name: "the longest request line, three Cookie lines and body",
|
||||||
|
target: longestTarget()[:fullLine-len("POST HTTP/1.1")],
|
||||||
|
header: http.Header{cookieHeader: {
|
||||||
|
fullCookieLine, fullCookieLine, fullCookieLine,
|
||||||
|
}},
|
||||||
|
contentType: jsonType, body: jsonOfMostElementsUnderAKey(),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// worstCaseHeaders are the requests of worstCaseRequests with no body.
|
||||||
|
func worstCaseHeaders() []visitorRequest {
|
||||||
|
headerFields := http.Header{}
|
||||||
|
|
||||||
|
for i := range mostHeaderFields - 1 {
|
||||||
|
name := "X-Field-" + strconv.Itoa(i)
|
||||||
|
headerFields.Set(
|
||||||
|
name,
|
||||||
|
headerValue(name, headerLimit/mostHeaderFields),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return []visitorRequest{
|
||||||
|
{name: "the longest request line", target: longestTarget()},
|
||||||
|
{
|
||||||
|
name: "the longest request line, as query parameters",
|
||||||
|
target: "/?" + strings.Repeat(
|
||||||
|
"a=1&",
|
||||||
|
(lineLimit-len("POST /? HTTP/1.1"))/len("a=1&"),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "the longest Cookie line, as one cookie",
|
||||||
|
target: "/",
|
||||||
|
header: http.Header{cookieHeader: {cookieLine(1)}},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "the longest Cookie line, as the most cookies",
|
||||||
|
target: "/",
|
||||||
|
header: http.Header{cookieHeader: {cookieLine(mostCookies)}},
|
||||||
|
},
|
||||||
|
{name: "the most header fields", target: "/", header: headerFields},
|
||||||
|
{
|
||||||
|
name: "the longest header lines",
|
||||||
|
target: "/",
|
||||||
|
header: http.Header{
|
||||||
|
"User-Agent": {headerValue("User-Agent", fullLine)},
|
||||||
|
"Referer": {headerValue("Referer", fullLine)},
|
||||||
|
"Accept": {headerValue("Accept", fullLine)},
|
||||||
|
"X-Long": {headerValue("X-Long", fullLine)},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// worstCaseBodies are the requests of worstCaseRequests whose body holds
|
||||||
|
// the most the Core Rule Set reads.
|
||||||
|
func worstCaseBodies() []visitorRequest {
|
||||||
|
const nested = (mostJSONRead - len(`{"a":1}`)) / len(`{"a":}`)
|
||||||
|
|
||||||
|
return []visitorRequest{
|
||||||
|
{
|
||||||
|
name: "a form body of one field", target: "/",
|
||||||
|
contentType: formType, body: formFields(1),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "a form body of the most fields Coraza keeps", target: "/",
|
||||||
|
contentType: formType, body: formFields(1000),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "a JSON body of one string", target: "/",
|
||||||
|
contentType: jsonType,
|
||||||
|
body: `{"a":"` + text(
|
||||||
|
mostJSONRead-len(`{"a":""}`),
|
||||||
|
) + `"}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "a JSON body of the most elements", target: "/",
|
||||||
|
contentType: jsonType, body: jsonArrayOfMostElements(),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "a JSON body of the most elements under a key", target: "/",
|
||||||
|
contentType: jsonType, body: jsonOfMostElementsUnderAKey(),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "a JSON body nested deep", target: "/",
|
||||||
|
contentType: jsonType,
|
||||||
|
body: strings.Repeat(`{"a":`, nested) + "1" +
|
||||||
|
strings.Repeat("}", nested),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "an XML body of many elements", target: "/",
|
||||||
|
contentType: "application/xml",
|
||||||
|
body: "<a>" + strings.Repeat(
|
||||||
|
"<b>x</b>",
|
||||||
|
(mostBodyRead-len("<a></a>"))/len("<b>x</b>"),
|
||||||
|
) + "</a>",
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "a multipart body of one field", target: "/",
|
||||||
|
contentType: multipartType, body: multipartBody(mostBodyRead),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "a multipart body of many fields", target: "/",
|
||||||
|
contentType: multipartType, body: multipartBody(1),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// threadCPUTime returns the processor time the calling thread has used.
|
||||||
|
func threadCPUTime(t *testing.T) time.Duration {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
var now unix.Timespec
|
||||||
|
|
||||||
|
err := unix.ClockGettime(unix.CLOCK_THREAD_CPUTIME_ID, &now)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read the thread's processor time: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return time.Duration(now.Nano())
|
||||||
|
}
|
||||||
|
|
||||||
|
// inspectionTime returns the processor time crs takes to inspect tc, and
|
||||||
|
// fails t unless it reads all of tc's body and Coraza parses it. Inspect does
|
||||||
|
// its work on the calling goroutine, which stays on one thread meanwhile, so
|
||||||
|
// that thread's processor time is the inspection's.
|
||||||
|
func inspectionTime(
|
||||||
|
t *testing.T, crs *coreruleset.CoreRuleSet, tc visitorRequest,
|
||||||
|
) time.Duration {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
req := httptest.NewRequestWithContext(
|
||||||
|
t.Context(), http.MethodPost, tc.target, nil,
|
||||||
|
)
|
||||||
|
maps.Copy(req.Header, tc.header)
|
||||||
|
|
||||||
|
if tc.contentType != "" {
|
||||||
|
req.Header.Set("Content-Type", tc.contentType)
|
||||||
|
}
|
||||||
|
|
||||||
|
runtime.LockOSThread()
|
||||||
|
defer runtime.UnlockOSThread()
|
||||||
|
|
||||||
|
began := threadCPUTime(t)
|
||||||
|
result, read, _ := crs.Inspect(
|
||||||
|
req, netip.MustParseAddr("192.0.2.1"), strings.NewReader(tc.body),
|
||||||
|
)
|
||||||
|
took := threadCPUTime(t) - began
|
||||||
|
|
||||||
|
if string(read) != tc.body {
|
||||||
|
t.Errorf("read %d bytes of %d", len(read), len(tc.body))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rule 900440 matches a body Coraza could not parse.
|
||||||
|
if slices.Contains(result.RuleIDs, 900440) {
|
||||||
|
t.Errorf("Coraza could not parse the body")
|
||||||
|
}
|
||||||
|
|
||||||
|
return took
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestTheCoreRuleSetInspectsEachWorstCaseRequestInTime measures processor
|
||||||
|
// time, not time on the clock, so that the time other work on the host holds
|
||||||
|
// the processor does not count. It runs one at a time, so that the tests
|
||||||
|
// running in parallel do not slow it. Other work can still slow one try a
|
||||||
|
// little, by sharing the processor's caches, so a request fails only when
|
||||||
|
// three tries in a row take too long.
|
||||||
|
//
|
||||||
|
//nolint:paralleltest // one at a time, as above
|
||||||
|
func TestTheCoreRuleSetInspectsEachWorstCaseRequestInTime(t *testing.T) {
|
||||||
|
const tries = 3
|
||||||
|
|
||||||
|
// The settings that make the Core Rule Set slowest: the highest paranoia
|
||||||
|
// level, no rule switched off, and the most of a body read.
|
||||||
|
crs := shared(t, coreruleset.Params{
|
||||||
|
ParanoiaLevel: 4, BodyInspectionSize: mostBodyRead,
|
||||||
|
})
|
||||||
|
|
||||||
|
for _, tc := range worstCaseRequests() {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
var took time.Duration
|
||||||
|
|
||||||
|
for range tries {
|
||||||
|
took = inspectionTime(t, crs, tc)
|
||||||
|
if took <= inspectionTimeLimit {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
t.Errorf(
|
||||||
|
"took %s on the last of %d tries, over %s",
|
||||||
|
took, tries, inspectionTimeLimit,
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -44,7 +44,7 @@ import (
|
|||||||
const (
|
const (
|
||||||
// started is the time a record made as a test starts gives.
|
// started is the time a record made as a test starts gives.
|
||||||
started = "2000-01-01T00:00:00.000Z"
|
started = "2000-01-01T00:00:00.000Z"
|
||||||
appName = "fsn1app1/blog"
|
appName = "host1/blog"
|
||||||
// local0 is the number of the default facility, and local0Info the
|
// local0 is the number of the default facility, and local0Info the
|
||||||
// priority of its records.
|
// priority of its records.
|
||||||
local0 = 16
|
local0 = 16
|
||||||
|
|||||||
@@ -140,7 +140,7 @@ func TestProcessLinesAreMarkedProcessAndGiveTheInstance(t *testing.T) {
|
|||||||
|
|
||||||
var out bytes.Buffer
|
var out bytes.Buffer
|
||||||
|
|
||||||
requestlog.NewProcessLogger(&out, "fsn1app1/blog", slog.LevelInfo).
|
requestlog.NewProcessLogger(&out, "host1/blog", slog.LevelInfo).
|
||||||
Info("starting",
|
Info("starting",
|
||||||
"version", "v1")
|
"version", "v1")
|
||||||
|
|
||||||
@@ -152,7 +152,7 @@ func TestProcessLinesAreMarkedProcessAndGiveTheInstance(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if fields["type"] != "process" ||
|
if fields["type"] != "process" ||
|
||||||
fields["instance"] != "fsn1app1/blog" ||
|
fields["instance"] != "host1/blog" ||
|
||||||
fields["msg"] != "starting" ||
|
fields["msg"] != "starting" ||
|
||||||
fields["level"] != "INFO" ||
|
fields["level"] != "INFO" ||
|
||||||
fields["version"] != "v1" {
|
fields["version"] != "v1" {
|
||||||
@@ -187,7 +187,7 @@ func TestProcessLoggerWritesTheMessagesAtItsLevelOrMoreSevere(t *testing.T) {
|
|||||||
|
|
||||||
processLog := requestlog.NewProcessLogger(
|
processLog := requestlog.NewProcessLogger(
|
||||||
&out,
|
&out,
|
||||||
"fsn1app1/blog",
|
"host1/blog",
|
||||||
level,
|
level,
|
||||||
)
|
)
|
||||||
for _, at := range levels {
|
for _, at := range levels {
|
||||||
|
|||||||
@@ -159,7 +159,7 @@ const filledAlertsJSON = `{
|
|||||||
"waiting": {
|
"waiting": {
|
||||||
"webhook": [
|
"webhook": [
|
||||||
{
|
{
|
||||||
"instance": "fsn1app1/blog",
|
"instance": "host1/blog",
|
||||||
"time": "2026-10-06T00:00:00Z",
|
"time": "2026-10-06T00:00:00Z",
|
||||||
"event": "ban",
|
"event": "ban",
|
||||||
"client": "203.0.113.9",
|
"client": "203.0.113.9",
|
||||||
@@ -174,7 +174,7 @@ const filledAlertsJSON = `{
|
|||||||
"suppressed_repeats": 0
|
"suppressed_repeats": 0
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"instance": "fsn1app1/blog",
|
"instance": "host1/blog",
|
||||||
"time": "2026-10-06T00:00:00Z",
|
"time": "2026-10-06T00:00:00Z",
|
||||||
"event": "file_error",
|
"event": "file_error",
|
||||||
"client": "",
|
"client": "",
|
||||||
@@ -2398,7 +2398,7 @@ func newParams(dir string) state.Params {
|
|||||||
Events: alerts.Events(),
|
Events: alerts.Events(),
|
||||||
Cooldown: 15 * time.Minute,
|
Cooldown: 15 * time.Minute,
|
||||||
MaxPerHour: 2,
|
MaxPerHour: 2,
|
||||||
Instance: "fsn1app1/blog",
|
Instance: "host1/blog",
|
||||||
Now: midnight,
|
Now: midnight,
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
+14
-14
@@ -52,7 +52,7 @@ const (
|
|||||||
adminSecret = "fedcba9876543210fedcba9876543210"
|
adminSecret = "fedcba9876543210fedcba9876543210"
|
||||||
// instance is the SWW_WAF_INSTANCE_NAME the tests set where they look at
|
// instance is the SWW_WAF_INSTANCE_NAME the tests set where they look at
|
||||||
// it.
|
// it.
|
||||||
instance = "fsn1app1/blog"
|
instance = "host1/blog"
|
||||||
// greeting is what the tests' app answers.
|
// greeting is what the tests' app answers.
|
||||||
greeting = "hello from the app"
|
greeting = "hello from the app"
|
||||||
// placed is the client the tests' lookup databases place.
|
// placed is the client the tests' lookup databases place.
|
||||||
@@ -386,8 +386,8 @@ func TestEveryLogLineAndMetricCarriesTheInstanceName(t *testing.T) {
|
|||||||
// the comments.
|
// the comments.
|
||||||
for line := range strings.Lines(metrics) {
|
for line := range strings.Lines(metrics) {
|
||||||
if !strings.HasPrefix(line, "#") &&
|
if !strings.HasPrefix(line, "#") &&
|
||||||
!strings.Contains(line, `instance="fsn1app1/blog"`) {
|
!strings.Contains(line, `instance="host1/blog"`) {
|
||||||
t.Errorf("series %q, without instance=\"fsn1app1/blog\"", line)
|
t.Errorf("series %q, without instance=\"host1/blog\"", line)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -734,12 +734,12 @@ func TestLookupDatabaseReplacedWhileRunningTakesEffect(t *testing.T) {
|
|||||||
t,
|
t,
|
||||||
url+"_sww/metrics",
|
url+"_sww/metrics",
|
||||||
token,
|
token,
|
||||||
`sww_lookup_database_read_failures_total{instance="fsn1app1/blog"} 1`,
|
`sww_lookup_database_read_failures_total{instance="host1/blog"} 1`,
|
||||||
)
|
)
|
||||||
lastRead = seriesValue(
|
lastRead = seriesValue(
|
||||||
t,
|
t,
|
||||||
metrics,
|
metrics,
|
||||||
`sww_lookup_database_last_read_timestamp_seconds{instance="fsn1app1/blog"}`,
|
`sww_lookup_database_last_read_timestamp_seconds{instance="host1/blog"}`,
|
||||||
)
|
)
|
||||||
|
|
||||||
wantStatus(t, url, placed, http.StatusOK)
|
wantStatus(t, url, placed, http.StatusOK)
|
||||||
@@ -801,7 +801,7 @@ func TestBlocklistTriesAndCopiesKeptInListsJSONAcrossRestarts(t *testing.T) {
|
|||||||
// too.
|
// too.
|
||||||
rateLimitExemptNets: placed + "," + localhost,
|
rateLimitExemptNets: placed + "," + localhost,
|
||||||
}
|
}
|
||||||
failures := `sww_reputation_failures_total{instance="fsn1app1/blog",` +
|
failures := `sww_reputation_failures_total{instance="host1/blog",` +
|
||||||
`source="` + torURL + `"} `
|
`source="` + torURL + `"} `
|
||||||
|
|
||||||
// tor.txt cannot be fetched at first, which is counted.
|
// tor.txt cannot be fetched at first, which is counted.
|
||||||
@@ -984,8 +984,8 @@ func TestStalledRemoteLogEndpointHoldsUpNoRequest(t *testing.T) {
|
|||||||
// last.
|
// last.
|
||||||
metrics := metricsText(t, url+"_sww/metrics", token)
|
metrics := metricsText(t, url+"_sww/metrics", token)
|
||||||
for _, series := range []string{
|
for _, series := range []string{
|
||||||
`sww_remote_log_lines_sent_total{instance="fsn1app1/blog"} 0`,
|
`sww_remote_log_lines_sent_total{instance="host1/blog"} 0`,
|
||||||
`sww_remote_log_lines_waiting{instance="fsn1app1/blog"} 1`,
|
`sww_remote_log_lines_waiting{instance="host1/blog"} 1`,
|
||||||
} {
|
} {
|
||||||
if !strings.Contains(metrics, "\n"+series+"\n") {
|
if !strings.Contains(metrics, "\n"+series+"\n") {
|
||||||
t.Errorf("no %q in the metrics:\n%s", series, metrics)
|
t.Errorf("no %q in the metrics:\n%s", series, metrics)
|
||||||
@@ -993,7 +993,7 @@ func TestStalledRemoteLogEndpointHoldsUpNoRequest(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const dropped = "\nsww_remote_log_lines_dropped_total" +
|
const dropped = "\nsww_remote_log_lines_dropped_total" +
|
||||||
`{instance="fsn1app1/blog"} `
|
`{instance="host1/blog"} `
|
||||||
if strings.Contains(metrics, dropped+"0\n") ||
|
if strings.Contains(metrics, dropped+"0\n") ||
|
||||||
!strings.Contains(metrics, dropped) {
|
!strings.Contains(metrics, dropped) {
|
||||||
t.Errorf("no line dropped in the metrics:\n%s", metrics)
|
t.Errorf("no line dropped in the metrics:\n%s", metrics)
|
||||||
@@ -1089,7 +1089,7 @@ func TestBanIsAlertedAndAnAlertNotSentIsKeptAcrossARestart(t *testing.T) {
|
|||||||
runUntilStopped(t, env, func(url string) {
|
runUntilStopped(t, env, func(url string) {
|
||||||
webhook.waitFor(t, "permanent_ban", true)
|
webhook.waitFor(t, "permanent_ban", true)
|
||||||
|
|
||||||
const ofWebhook = `{destination="webhook",instance="fsn1app1/blog"}`
|
const ofWebhook = `{destination="webhook",instance="host1/blog"}`
|
||||||
|
|
||||||
metrics := metricsWith(t, url+"_sww/metrics", token,
|
metrics := metricsWith(t, url+"_sww/metrics", token,
|
||||||
"\nsww_alerts_sent_total"+ofWebhook+" 1\n")
|
"\nsww_alerts_sent_total"+ofWebhook+" 1\n")
|
||||||
@@ -1176,13 +1176,13 @@ func TestBanIsAlertedToSlackAndNtfy(t *testing.T) {
|
|||||||
err := json.Unmarshal([]byte(slackPost.body), &message)
|
err := json.Unmarshal([]byte(slackPost.body), &message)
|
||||||
|
|
||||||
if err != nil ||
|
if err != nil ||
|
||||||
!strings.HasPrefix(message.Text, "*fsn1app1/blog: ban*\n") ||
|
!strings.HasPrefix(message.Text, "*host1/blog: ban*\n") ||
|
||||||
!strings.Contains(message.Text, "\nclient: "+client+"\n") {
|
!strings.Contains(message.Text, "\nclient: "+client+"\n") {
|
||||||
t.Errorf("Slack was sent %s", slackPost.body)
|
t.Errorf("Slack was sent %s", slackPost.body)
|
||||||
}
|
}
|
||||||
|
|
||||||
ntfyPost := ntfy.firstPost(t)
|
ntfyPost := ntfy.firstPost(t)
|
||||||
if ntfyPost.header.Get("Title") != "fsn1app1/blog: ban" ||
|
if ntfyPost.header.Get("Title") != "host1/blog: ban" ||
|
||||||
ntfyPost.header.Get("Authorization") != "Bearer "+ntfyToken ||
|
ntfyPost.header.Get("Authorization") != "Bearer "+ntfyToken ||
|
||||||
!strings.Contains(ntfyPost.body, "\nclient: "+client+"\n") {
|
!strings.Contains(ntfyPost.body, "\nclient: "+client+"\n") {
|
||||||
t.Errorf("ntfy was sent %s, with the headers %v", ntfyPost.body,
|
t.Errorf("ntfy was sent %s, with the headers %v", ntfyPost.body,
|
||||||
@@ -1194,9 +1194,9 @@ func TestBanIsAlertedToSlackAndNtfy(t *testing.T) {
|
|||||||
// test process cannot fail the test.
|
// test process cannot fail the test.
|
||||||
sent := []string{
|
sent := []string{
|
||||||
"\nsww_alerts_sent_total{destination=\"slack\"," +
|
"\nsww_alerts_sent_total{destination=\"slack\"," +
|
||||||
"instance=\"fsn1app1/blog\"} 1\n",
|
"instance=\"host1/blog\"} 1\n",
|
||||||
"\nsww_alerts_sent_total{destination=\"ntfy\"," +
|
"\nsww_alerts_sent_total{destination=\"ntfy\"," +
|
||||||
"instance=\"fsn1app1/blog\"} 1\n",
|
"instance=\"host1/blog\"} 1\n",
|
||||||
}
|
}
|
||||||
|
|
||||||
metrics := metricsWith(t, url+"_sww/metrics", token, sent...)
|
metrics := metricsWith(t, url+"_sww/metrics", token, sent...)
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ const (
|
|||||||
alertWebhookURL = "SWW_WAF_ALERT_WEBHOOK_URL"
|
alertWebhookURL = "SWW_WAF_ALERT_WEBHOOK_URL"
|
||||||
alertMaxPerHour = "SWW_WAF_ALERT_MAX_PER_HOUR"
|
alertMaxPerHour = "SWW_WAF_ALERT_MAX_PER_HOUR"
|
||||||
// alertInstance is the instance every alert of these tests gives.
|
// alertInstance is the instance every alert of these tests gives.
|
||||||
alertInstance = "fsn1app1/blog"
|
alertInstance = "host1/blog"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestBanForABrokenLimitRaisesABanAlertWithItsNotes(t *testing.T) {
|
func TestBanForABrokenLimitRaisesABanAlertWithItsNotes(t *testing.T) {
|
||||||
|
|||||||
+8
-14
@@ -228,12 +228,9 @@ func newReputation(
|
|||||||
// without the rules SWW_WAF_CORE_RULE_SET_DISABLED_RULES switches off, reading bodies
|
// without the rules SWW_WAF_CORE_RULE_SET_DISABLED_RULES switches off, reading bodies
|
||||||
// up to SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE, with the exclusions in
|
// up to SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE, with the exclusions in
|
||||||
// SWW_WAF_CORE_RULE_SET_EXCLUSIONS_FILE and the fixes of the apps in SWW_WAF_APPS,
|
// SWW_WAF_CORE_RULE_SET_EXCLUSIONS_FILE and the fixes of the apps in SWW_WAF_APPS,
|
||||||
// or nil while SWW_WAF_CORE_RULE_SET_MODE is off. It
|
// or nil while SWW_WAF_CORE_RULE_SET_MODE is off. An exclusions file that
|
||||||
// reads at most QuestionBodyMaxBytes less one byte: a question's body of
|
// coreruleset.New refuses is an error in every mode. While the mode is off, a
|
||||||
// QuestionBodyMaxBytes may be cut short, and the Core Rule Set does not read a
|
// set file is loaded with the Core Rule Set only to check it.
|
||||||
// JSON or XML body over its limit. An exclusions file that coreruleset.New refuses is
|
|
||||||
// an error in every mode. While the mode is off, a set file is loaded with the
|
|
||||||
// Core Rule Set only to check it.
|
|
||||||
func NewCoreRuleSet(cfg *config.WAF) (*coreruleset.CoreRuleSet, error) {
|
func NewCoreRuleSet(cfg *config.WAF) (*coreruleset.CoreRuleSet, error) {
|
||||||
if cfg.CoreRuleSetMode == config.CoreRuleSetModeOff &&
|
if cfg.CoreRuleSetMode == config.CoreRuleSetModeOff &&
|
||||||
cfg.CoreRuleSetExclusionsFile == "" {
|
cfg.CoreRuleSetExclusionsFile == "" {
|
||||||
@@ -241,14 +238,11 @@ func NewCoreRuleSet(cfg *config.WAF) (*coreruleset.CoreRuleSet, error) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
coreRuleSet, err := coreruleset.New(coreruleset.Params{
|
coreRuleSet, err := coreruleset.New(coreruleset.Params{
|
||||||
ParanoiaLevel: cfg.CoreRuleSetParanoiaLevel,
|
ParanoiaLevel: cfg.CoreRuleSetParanoiaLevel,
|
||||||
DisabledRules: cfg.CoreRuleSetDisabledRules,
|
DisabledRules: cfg.CoreRuleSetDisabledRules,
|
||||||
BodyInspectionSize: min(
|
BodyInspectionSize: cfg.CoreRuleSetBodyInspectionSize,
|
||||||
cfg.CoreRuleSetBodyInspectionSize,
|
ExclusionsFile: cfg.CoreRuleSetExclusionsFile,
|
||||||
QuestionBodyMaxBytes-1,
|
Apps: cfg.Apps,
|
||||||
),
|
|
||||||
ExclusionsFile: cfg.CoreRuleSetExclusionsFile,
|
|
||||||
Apps: cfg.Apps,
|
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, fmt.Errorf(
|
return nil, fmt.Errorf(
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ const (
|
|||||||
// requestIDHeader carries the request's id.
|
// requestIDHeader carries the request's id.
|
||||||
requestIDHeader = "X-Request-ID"
|
requestIDHeader = "X-Request-ID"
|
||||||
// instance is the SWW_WAF_INSTANCE_NAME a test sets.
|
// instance is the SWW_WAF_INSTANCE_NAME a test sets.
|
||||||
instance = "fsn1app1/blog"
|
instance = "host1/blog"
|
||||||
// ipv6Client is a client on IPv6, and ipv6Group the netblock the rate
|
// ipv6Client is a client on IPv6, and ipv6Group the netblock the rate
|
||||||
// limits count it as.
|
// limits count it as.
|
||||||
ipv6Client = "2001:db8::7"
|
ipv6Client = "2001:db8::7"
|
||||||
|
|||||||
@@ -1787,7 +1787,7 @@ func TestCoreRuleSetReadsTheBodyAQuestionCarries(t *testing.T) {
|
|||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
s := startWAF(t, "", map[string]string{
|
s := startWAF(t, "", map[string]string{
|
||||||
coreRuleSetMode: block, coreRuleSetBodyInspectionSize: "64K",
|
coreRuleSetMode: block, coreRuleSetBodyInspectionSize: "8K",
|
||||||
})
|
})
|
||||||
|
|
||||||
ask := func(contentType, body string) answer {
|
ask := func(contentType, body string) answer {
|
||||||
@@ -1802,10 +1802,10 @@ func TestCoreRuleSetReadsTheBodyAQuestionCarries(t *testing.T) {
|
|||||||
got := ask(formData, "id=1'%20OR%20'1'='1")
|
got := ask(formData, "id=1'%20OR%20'1'='1")
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
||||||
|
|
||||||
// The first 64 KiB of a longer JSON body cannot be parsed, which is no
|
// The first 8 KiB of a longer JSON body cannot be parsed, which is no
|
||||||
// attack, so the Core Rule Set does not read it.
|
// attack, so the Core Rule Set does not read it.
|
||||||
cut := `{"text":"` + strings.Repeat("x", waf.QuestionBodyMaxBytes)
|
cut := `{"text":"` + strings.Repeat("x", 8<<10)
|
||||||
got = ask("application/json", cut[:waf.QuestionBodyMaxBytes])
|
got = ask("application/json", cut)
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+12
-6
@@ -2,8 +2,9 @@
|
|||||||
# script/publish: build the image on the Docker host and push it to the
|
# script/publish: build the image on the Docker host and push it to the
|
||||||
# registry under four tags: the UTC date (YYYY-MM-DD), the short commit
|
# registry under four tags: the UTC date (YYYY-MM-DD), the short commit
|
||||||
# hash, the branch name and latest. The build is script/docker's, so the
|
# hash, the branch name and latest. The build is script/docker's, so the
|
||||||
# tests and the linter run first. The host and the registry name are
|
# tests and the linter run first. DOCKER_HOST names the Docker host and
|
||||||
# environment variables with defaults, for running it against another.
|
# PUBLISH_IMAGE the image in the registry. Both must be set; neither has
|
||||||
|
# a default.
|
||||||
#
|
#
|
||||||
# The working tree must be clean: the hash tag names a commit, and an
|
# The working tree must be clean: the hash tag names a commit, and an
|
||||||
# image built from uncommitted changes would carry a hash that does not
|
# image built from uncommitted changes would carry a hash that does not
|
||||||
@@ -13,11 +14,16 @@ set -eu
|
|||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
|
|
||||||
: "${DOCKER_HOST:=ssh://root@fsn1app1}"
|
|
||||||
: "${PUBLISH_IMAGE:=git.eeqj.de/sneak/smallwebwaf}"
|
|
||||||
export DOCKER_HOST
|
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
|
if [ -z "${DOCKER_HOST:-}" ]; then
|
||||||
|
echo "script/publish: DOCKER_HOST is not set; set it to the Docker host that builds the image, such as ssh://user@build.example.com" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
if [ -z "${PUBLISH_IMAGE:-}" ]; then
|
||||||
|
echo "script/publish: PUBLISH_IMAGE is not set; set it to the image name in the registry, such as registry.example.com/smallwebwaf" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
|
|
||||||
# Own line: a failing command substitution inside an argument does
|
# Own line: a failing command substitution inside an argument does
|
||||||
|
|||||||
Reference in new issue
Block a user