Compare commits

..
Author SHA1 Message Date
sneak 969383894c rproxy: circuit breaker for asks to waf (closes #392)
check / check (push) Successful in 5m31s
Five asks that get no answer in time within five seconds open the
breaker. While open, a request takes
SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION without asking waf, except
one ask a second; the first answer closes it. Slow answers count as
failures. SPEC.md describes it.

The sww test that stops and restarts waf now waits for the breaker to
close before it expects the ban again.

Model: opus-5-5
2026-11-15 13:49:26 +00:00
42 changed files with 671 additions and 1401 deletions

No files matched your search

+12 -11
View File
@@ -298,13 +298,13 @@ Every setting the code reads, with its default:
| `SWW_RPROXY_LISTEN_ADDR` | `:8080` | Where `rproxy` listens; leave the host part empty. | | `SWW_RPROXY_LISTEN_ADDR` | `:8080` | Where `rproxy` listens; leave the host part empty. |
| `SWW_RPROXY_TRUSTED_PROXIES` | `10.0.0.0/8,172.16.0.0/12,192.168.0.0/16` | The netblocks whose `X-Forwarded-For` `rproxy` believes; set but empty, it believes none. | | `SWW_RPROXY_TRUSTED_PROXIES` | `10.0.0.0/8,172.16.0.0/12,192.168.0.0/16` | The netblocks whose `X-Forwarded-For` `rproxy` believes; set but empty, it believes none. |
| `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS` | `2000` | How long `rproxy` waits for `waf`'s answer to a question and to a report, in milliseconds. | | `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS` | `2000` | How long `rproxy` waits for `waf`'s answer to a question and to a report, in milliseconds. |
| `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` | `allow` | What `rproxy` does with a request when `waf` gives no answer in time, and while the circuit breaker for asks to `waf` is open: `allow` passes it to the app, `deny` answers `503`. | | `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` | `allow` | What `rproxy` does with a request when `waf` cannot be reached or does not answer in time: `allow` passes it to the app, `deny` answers `503`. |
| `SWW_RPROXY_MAX_REQUEST_SIZE` | `100M` | The largest request body, a size or `off`; a larger one is answered `413`. | | `SWW_RPROXY_MAX_REQUEST_SIZE` | `100M` | The largest request body, a size or `off`; a larger one is answered `413`. |
| `SWW_RPROXY_MAX_RESPONSE_SIZE` | `1G` | The largest response body, a size or `off`. The visitor gets `502` in place of a larger one, or it is cut off if it has already started. | | `SWW_RPROXY_MAX_RESPONSE_SIZE` | `1G` | The largest response body, a size or `off`. The visitor gets `502` in place of a larger one, or it is cut off if it has already started. |
| `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 `host1/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 `fsn1/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. |
@@ -329,7 +329,7 @@ Every setting the code reads, with its default:
| `SWW_WAF_BAN_SCOPE_V4_PREFIX` | `32` | The prefix length of the netblock a ban on an IPv4 client covers, from 0 to 32. | | `SWW_WAF_BAN_SCOPE_V4_PREFIX` | `32` | The prefix length of the netblock a ban on an IPv4 client covers, from 0 to 32. |
| `SWW_WAF_LOOKUP_SOURCE` | `geojs` | Where each client's AS number and country come from: `geojs` (a web service), `file` (a local database) or `off`. | | `SWW_WAF_LOOKUP_SOURCE` | `geojs` | Where each client's AS number and country come from: `geojs` (a web service), `file` (a local database) or `off`. |
| `SWW_WAF_LOOKUP_DB_PATH` | empty | The IPinfo Lite database file, in its `.mmdb` form, read while the source is `file`. | | `SWW_WAF_LOOKUP_DB_PATH` | empty | The IPinfo Lite database file, in its `.mmdb` form, read while the source is `file`. |
| `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS` | `800` | How long a request waits for its client's first GeoJS answer when a setting needs it, in milliseconds. The request to GeoJS goes on, and a later answer is kept. | | `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS` | `800` | How long a request waits for its client's first GeoJS answer when a setting needs it, and how long a request to GeoJS may take, in milliseconds. |
| `SWW_WAF_ADD_LOOKUP_HEADERS` | `true`, or `false` while the lookup source is `off` | `true` passes the app the client's AS number and country in `X-Client-ASN` and `X-Client-Country`. | | `SWW_WAF_ADD_LOOKUP_HEADERS` | `true`, or `false` while the lookup source is `off` | `true` passes the app the client's AS number and country in `X-Client-ASN` and `X-Client-Country`. |
| `SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES` | empty | When set, the only countries whose clients get through; a client the lookup cannot place is refused too. | | `SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES` | empty | When set, the only countries whose clients get through; a client the lookup cannot place is refused too. |
| `SWW_WAF_TAG_LISTS` | empty | Address lists that each add a tag to their clients' requests, as `name=URL` pairs, such as `torexit=https://example.com/tor.txt`. | | `SWW_WAF_TAG_LISTS` | empty | Address lists that each add a tag to their clients' requests, as `name=URL` pairs, such as `torexit=https://example.com/tor.txt`. |
@@ -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 `8K`; `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 `64K`; `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: host1/waf SWW_WAF_INSTANCE_NAME: fsn1/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.
@@ -749,9 +749,9 @@ stops the running process (see [`docs/state-files.md`](docs/state-files.md)).
- `internal/waf`: `waf`'s server, which runs the checks and answers its own - `internal/waf`: `waf`'s server, which runs the checks and answers its own
endpoints. endpoints.
- `internal/ratelimit`, `internal/bans`, `internal/rules`, - `internal/ratelimit`, `internal/bans`, `internal/rules`,
`internal/coreruleset`, `internal/geojs`, `internal/lookup`, `internal/coreruleset`, `internal/lookup`, `internal/reputation`,
`internal/reputation`, `internal/routewatch`, `internal/anomaly` and `internal/routewatch`, `internal/anomaly` and `internal/alerts`: one check or
`internal/alerts`: one check or source each. source each.
- `internal/state`, `internal/requestlog`, `internal/remotelog` and - `internal/state`, `internal/requestlog`, `internal/remotelog` and
`internal/metrics`: the state and cache files, the log lines, the syslog `internal/metrics`: the state and cache files, the log lines, the syslog
sender and the metrics. sender and the metrics.
@@ -818,9 +818,10 @@ 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`, then pushes the image to `PUBLISH_IMAGE`, such as named by `DOCKER_HOST` (`ssh://root@fsn1app1` unless set). It then pushes the
`registry.example.com/smallwebwaf`. Both variables are required. It refuses a image to `PUBLISH_IMAGE` (`git.eeqj.de/sneak/smallwebwaf` unless set). It
working tree with uncommitted changes. `make publish`. It pushes four tags: refuses a working tree with uncommitted changes. `make publish`. It pushes
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;
+46 -65
View File
@@ -87,10 +87,8 @@ never as a time.
change, and tells which rules a request matches. change, and tells which rules a request matches.
- `internal/coreruleset`: the Core Rule Set, with the five changes and the - `internal/coreruleset`: the Core Rule Set, with the five changes and the
apps' fixes listed under "Attack detection", as Coraza directives. apps' fixes listed under "Attack detection", as Coraza directives.
- `internal/geojs`: looks clients up through GeoJS and keeps the answers. It - `internal/lookup`: looks clients up through GeoJS or in the lookup
imports no other package of this repository: `waf` gives it what it needs database.
to count and report failures.
- `internal/lookup`: looks clients up in the lookup database.
- `internal/reputation`: fetches the lists, asks the DNS blocklists and - `internal/reputation`: fetches the lists, asks the DNS blocklists and
AbuseIPDB in the background, and keeps their answers. AbuseIPDB in the background, and keeps their answers.
- `internal/routewatch`: asks a routewatch instance about clients in the - `internal/routewatch`: asks a routewatch instance about clients in the
@@ -509,25 +507,19 @@ service that keeps its visitors' addresses on its own host.
dropped from that table. The answer reaches the client's history and ban notes dropped from that table. The answer reaches the client's history and ban notes
when it comes. when it comes.
- `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS` is how long a visitor's request - `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS` is how long a visitor's request
waits for its client's first answer, when a setting needs it (see step 6). A waits for its client's first answer, when a setting needs it (see step 6). It
client whose answer has not come in time counts as unknown until it comes, and also bounds each request to GeoJS. A client whose answer has not come in time
its later requests do not wait. counts as unknown until it comes, and its later requests do not wait. Its
- A request to GeoJS may take up to 10 seconds, however long visitors wait. It address is asked about again in the background.
goes on after the visitor's request ends, and its answer is kept. Say GeoJS
answers after 5 seconds. The visitor's request is decided after 800
milliseconds, without a country. A request from the same client 6 seconds
later gets the answer.
- Requests from one client that come together share one request to GeoJS.
- A client the lookup cannot place has an unknown country and AS number, which - A client the lookup cannot place has an unknown country and AS number, which
the country list and the biased thresholds treat as described there. Nothing the country list and the biased thresholds treat as described there. Nothing
else treats it differently. else treats it differently.
- GeoJS publishes no rate limit, but its terms forbid "an excessive amount of - GeoJS publishes no rate limit, but its terms forbid "an excessive amount of
API requests", judged by GeoJS alone, and let it block a caller. A request to API requests", judged by GeoJS alone, and let it block a caller. While GeoJS
GeoJS fails when it takes over 10 seconds or GeoJS answers with an error. is slow, down or refusing `waf`, new clients count as unknown. GeoJS is then
While GeoJS is slow, down or refusing `waf`, new clients count as unknown. left alone for a second, and twice as long after each further failure, up to
After a failure GeoJS is left alone for a second, and twice as long after each five minutes. Each failure raises a `source_failure` alert (see "Alerting"). A
further failure, up to five minutes. Each failure raises a `source_failure` service that cannot accept this uses the file.
alert (see "Alerting"). A service that cannot accept this uses the file.
- The file is the free IPinfo Lite database (`ipinfo_lite.mmdb`), whose `asn`, - The file is the free IPinfo Lite database (`ipinfo_lite.mmdb`), whose `asn`,
`as_name` and `country_code` fields are read. The operator downloads it with a `as_name` and `country_code` fields are read. The operator downloads it with a
free IPinfo account and mounts it read-only; `waf` never fetches it and holds free IPinfo account and mounts it read-only; `waf` never fetches it and holds
@@ -712,12 +704,11 @@ 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 `8K`, so that `waf` answers in time (see to that size. It takes at most `64K`, since `waf` gets no more of a body than
"Answering in time"). Form data and multipart bodies are read up to the size. that (see "The answer"). Form data and multipart bodies are read up to the
JSON and XML bodies are read only when no larger than the size, since those size. JSON and XML bodies are read only when no larger than the size, since
cannot be read in part. A JSON body over 1 KiB is not read either, whatever those cannot be read in part. Any other body is not read: the Core Rule Set
the size (see "Answering in time"). Any other body is not read: the Core Rule would read it as form data, where binary content such as a git push trips
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.
@@ -2406,7 +2397,9 @@ 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, and at most 8 KiB of it. `SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE` is set. It inspects at most 64 KiB
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
@@ -2419,9 +2412,8 @@ within that time.
GeoJS is the only outside source a question can wait on. A question waits only GeoJS is the only outside source a question can wait on. A question waits only
when step 6 says so, and for at most when step 6 says so, and for at most
`SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS`, by default 800 milliseconds. A `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS`, by default 800 milliseconds. A
client without an answer by then counts as unknown. The setting bounds only the client without an answer by then counts as unknown. No question waits on these,
question's wait: the request to GeoJS goes on, and its answer is kept for later which run in the background:
questions. No question waits on these, which run in the background:
- the DNS blocklists and AbuseIPDB; - the DNS blocklists and AbuseIPDB;
- fetching the blocklists, the tag lists and the file - fetching the blocklists, the tag lists and the file
@@ -2482,26 +2474,12 @@ 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 is the one check a visitor can keep busy for long. It runs The Core Rule Set runs each of its rules on each cookie, so thousands of small
each of its rules on each part of a request, so thousands of small cookies would cookies would keep it busy for over a second. One 30 KB cookie or query string
keep it busy for over a second. These fixed limits bound what it reads: would keep it busy for a third of a second or more. A request with several long
`Cookie` lines, each within the limits, can keep it as busy. Enough such
- the header limits above; requests at once can still overload `waf` past
- `rproxy`'s limit of 32 KiB on the request line and headers together (see `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`.
"`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
@@ -2606,10 +2584,11 @@ request and ban notes name the site by its host.
`sww rproxy` is the reverse proxy in front of one app. It asks `waf` about each `sww rproxy` is the reverse proxy in front of one app. It asks `waf` about each
request, and passes on what `waf` allows. It writes nothing to disk. The only request, and passes on what `waf` allows. It writes nothing to disk. The only
thing it keeps between requests is its circuit breaker for asks to `waf`. thing it keeps between requests is its circuit breaker for asks to `waf`. When
`SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` decides what is done with a `waf` cannot be connected to, does not answer at all, or does not answer within
request when `waf` gives no answer in time, and while the circuit breaker is `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`,
open. Its default, `allow`, keeps the site answering. `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` decides. Its default, `allow`,
keeps the site answering.
`rproxy` reads only its `SWW_RPROXY_` settings, which `docs/settings.md` lists. `rproxy` reads only its `SWW_RPROXY_` settings, which `docs/settings.md` lists.
One of them is required: `SWW_RPROXY_WAF_BACKEND`, `waf`'s URL. It has no One of them is required: `SWW_RPROXY_WAF_BACKEND`, `waf`'s URL. It has no
@@ -2627,8 +2606,7 @@ only. The image runs it by default (see "Deployment").
4. It refuses a request with a method it does not pass on, or one it cannot put 4. It refuses a request with a method it does not pass on, or one it cannot put
to `waf` as the visitor sent it (see "Requests `rproxy` refuses itself"). to `waf` as the visitor sent it (see "Requests `rproxy` refuses itself").
5. It reads up to the first 64 KiB of the body into memory. 5. It reads up to the first 64 KiB of the body into memory.
6. It sends `waf` the question (see "The question"), unless the circuit breaker 6. It sends `waf` the question (see "The question"). It speaks HTTP/1.1 to
keeps it from asking (see "The circuit breaker"). It speaks HTTP/1.1 to
`waf`, whatever `waf` offers. Go's HTTP/2 client would refuse to send a `waf`, whatever `waf` offers. Go's HTTP/2 client would refuse to send a
visitor's `Upgrade` header, and most `Connection` headers. The question never visitor's `Upgrade` header, and most `Connection` headers. The question never
carries the visitor's `Trailer`. carries the visitor's `Trailer`.
@@ -2716,10 +2694,10 @@ decides, without asking `waf`, while the circuit breaker is open.
Either way `rproxy` writes a process warning, its log line has Either way `rproxy` writes a process warning, its log line has
`waf_backend_no_answer`, and it sends no report. `waf_backend_no_answer`, and it sends no report.
`waf` taking longer than `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS` to decide a request A visitor can make `waf` slow. A request that keeps `waf` busy past
is a bug in `waf`. Such a request gets `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`, like any request while `waf` is overloaded,
`SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION`, like any request while `waf` is gets `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION`. With `deny`, such a request
overloaded. With `deny`, it gets `503` instead of reaching the app. gets `503` instead of reaching the app.
A path under `/_sww/` that `allow` would pass on is answered `404` instead, so A path under `/_sww/` that `allow` would pass on is answered `404` instead, so
that the app never sees that prefix. that the app never sees that prefix.
@@ -2737,10 +2715,10 @@ status `0` and no `disposition`.
### The circuit breaker ### The circuit breaker
`rproxy` stops asking `waf` for a while when `waf` keeps failing to answer. An `rproxy` stops asking `waf` for a while when `waf` keeps failing to answer. An
ask fails when `waf` gives no answer in time (see "Without an answer from ask fails when `waf` cannot be connected to, does not answer at all, or does not
`waf`"), or an answer `rproxy` cannot pass on. Any other answer in time answer within `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`. Any answer in time succeeds,
succeeds, whatever it decides. A visitor that goes away while `waf` is being whatever it decides, and so does an answer `rproxy` cannot pass on. A visitor
asked counts as neither. that goes away while `waf` is being asked counts as neither.
The breaker works like this: The breaker works like this:
@@ -2750,8 +2728,11 @@ The breaker works like this:
It gets the same process warning and `waf_backend_no_answer` as a request It gets the same process warning and `waf_backend_no_answer` as a request
whose ask failed. whose ask failed.
- While it is open, one request a second still asks `waf`. - While it is open, one request a second still asks `waf`.
- Each ask that succeeds clears the failures counted so far, and closes the - The first ask that succeeds closes it, and the failures before it no longer
breaker if it is open. count.
A request that `waf` cannot decide within `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`
counts as a failure too. Such a request is a bug in `waf`.
The breaker lives in memory, and a restart of `rproxy` closes it. It has no The breaker lives in memory, and a restart of `rproxy` closes it. It has no
settings. settings.
+2 -2
View File
@@ -34,7 +34,7 @@ on one line:
```json ```json
{ {
"instance": "host1/waf", "instance": "fsn1/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 `host1/waf: ban`. The text is the `reason`, then one line and the event, such as `fsn1/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;
+2 -3
View File
@@ -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":"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} {"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}
``` ```
### Every line ### Every line
@@ -238,8 +238,7 @@ meanings where they differ:
- `disposition`: what was done with the request: `allow`, `deny` or `close`. It - `disposition`: what was done with the request: `allow`, `deny` or `close`. It
is `waf`'s answer, or the value of is `waf`'s answer, or the value of
`SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION`. It is left out when: `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION`. It is left out when:
- `waf` was not asked and `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` did - `waf` was not asked, as for the health check;
not apply, as for the health check;
- the visitor went away while `waf` was being asked; - the visitor went away while `waf` was being asked;
- `waf`'s answer had no valid `X-Sww-Disposition`; - `waf`'s answer had no valid `X-Sww-Disposition`;
- `rproxy` could not pass on `waf`'s answer, and answered `502`. - `rproxy` could not pass on `waf`'s answer, and answered `502`.
+12 -10
View File
@@ -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
`host1/waf`. Valid UTF-8. No control character while `SWW_WAF_ALERT_NTFY_URL` `fsn1/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`.
@@ -159,9 +159,8 @@ cut off; the client is banned.
- `SWW_WAF_LOOKUP_DB_PATH` (default empty): the IPinfo Lite database file, in - `SWW_WAF_LOOKUP_DB_PATH` (default empty): the IPinfo Lite database file, in
its `.mmdb` form, for `SWW_WAF_LOOKUP_SOURCE=file`. its `.mmdb` form, for `SWW_WAF_LOOKUP_SOURCE=file`.
- `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS` (default `800`): how long a - `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS` (default `800`): how long a
request waits for its client's first answer from GeoJS. A time in request waits for its client's first answer from GeoJS, and how long a request
milliseconds; never `off`. It does not cut off the request to GeoJS, whose to GeoJS may take. A time in milliseconds; never `off`.
answer is kept when it comes later.
- `SWW_WAF_ADD_LOOKUP_HEADERS` (default `true`): `true` has `rproxy` pass the - `SWW_WAF_ADD_LOOKUP_HEADERS` (default `true`): `true` has `rproxy` pass the
app the client's AS number in `X-Client-ASN` and its country in app the client's AS number in `X-Client-ASN` and its country in
`X-Client-Country`. The default is `false` while `SWW_WAF_LOOKUP_SOURCE` is `X-Client-Country`. The default is `false` while `SWW_WAF_LOOKUP_SOURCE` is
@@ -252,9 +251,10 @@ 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 `8K`. A much of a request body the Core Rule Set reads, a size of at most `64K`. A
larger size would let one request keep it busy past `rproxy`'s timeout (see question carries no more of a body than 64 KiB, and the Core Rule Set reads at
"Answering in time" in [`SPEC.md`](../SPEC.md)). most 64 KiB less one byte of it, whatever the value (see "The answer" in
[`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
@@ -453,9 +453,11 @@ start, and an invalid value stops the start. Any can be given as a file, as a
for `waf`'s answer, to a question and to a report. A time in milliseconds; for `waf`'s answer, to a question and to a report. A time in milliseconds;
never `off`. never `off`.
- `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` (default `allow`): what is done - `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` (default `allow`): what is done
with a request when `waf` gives no answer in time, and while the circuit with a request when `waf` cannot be connected to, does not answer at all, or
breaker for asks to `waf` is open. `allow` passes it to the app, and `deny` does not answer within `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`, and while the
answers `503`. It does not apply to an answer `waf` gives, such as an error. circuit breaker for asks to `waf` is open. `allow` passes it to the app, and
`deny` answers `503`. It does not apply to an answer `waf` gives, such as an
error.
- `SWW_RPROXY_MAX_REQUEST_SIZE` (default `100M`): the largest request body. A - `SWW_RPROXY_MAX_REQUEST_SIZE` (default `100M`): the largest request body. A
size or `off`. size or `off`.
- `SWW_RPROXY_MAX_RESPONSE_SIZE` (default `1G`): the largest response body. A - `SWW_RPROXY_MAX_RESPONSE_SIZE` (default `1G`): the largest response body. A
+1 -1
View File
@@ -12,7 +12,6 @@ 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 (
@@ -48,6 +47,7 @@ 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
+10 -10
View File
@@ -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 = "host1/blog" instance = "fsn1app1/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":"*host1/blog: file_error*\nsecond"}`, `{"text":"*fsn1app1/blog: file_error*\nsecond"}`,
`{"text":"*host1/blog: file_error*\nthird"}`) `{"text":"*fsn1app1/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"},
}, },
"host1/blog: ban", "default no_entry", "fsn1app1/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",
}, },
"host1/blog: permanent_ban", "high no_entry", "fsn1app1/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",
}, },
"host1/blog: core_rule_set_match", "default shield", "fsn1app1/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",
}, },
"host1/blog: anomaly", "high chart_with_upwards_trend", "fsn1app1/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",
}, },
"host1/blog: reputation_hit", "low label", "fsn1app1/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"},
}, },
"host1/blog: source_failure", "high warning", "fsn1app1/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",
}, },
}, },
"host1/blog: file_error", "high warning", "fsn1app1/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",
}, },
+6 -6
View File
@@ -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")
errOver8K = errors.New( errOver64K = errors.New(
"is more than 8K, the most the Core Rule Set can read in time") "is more than 64K, the most waf gets of a body")
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 8K, so that one // reads: a size as parseSize reads it, or off, but at most 64K, since waf
// request cannot keep the Core Rule Set busy past rproxy's timeout. // gets no more of a body than that.
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 > 8*kibibyte { if limit > 64*kibibyte {
return 0, fmt.Errorf("%q %w", value, errOver8K) return 0, fmt.Errorf("%q %w", value, errOver64K)
} }
return limit, nil return limit, nil
+17 -19
View File
@@ -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 = "host1/blog" instance = "fsn1app1/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: "4K", coreRuleSetBodyInspectionSize: "32K",
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: 4 << 10, CoreRuleSetBodyInspectionSize: 32 << 10,
CoreRuleSetExclusionsFile: "/etc/sww/crs-exclusions.conf", CoreRuleSetExclusionsFile: "/etc/sww/crs-exclusions.conf",
}, },
}, },
@@ -762,15 +762,15 @@ func TestInvalidAppsStopsTheStart(t *testing.T) {
} }
} }
func TestCoreRuleSetBodyInspectionSizeOf8K(t *testing.T) { func TestCoreRuleSetBodyInspectionSizeOf64K(t *testing.T) {
t.Parallel() t.Parallel()
cfg := wafFromEnvironment( cfg := wafFromEnvironment(
t, t,
environment{coreRuleSetBodyInspectionSize: "8K"}, environment{coreRuleSetBodyInspectionSize: "64K"},
) )
if cfg.CoreRuleSetBodyInspectionSize != 8<<10 { if cfg.CoreRuleSetBodyInspectionSize != 64<<10 {
t.Errorf("8K read as %d", cfg.CoreRuleSetBodyInspectionSize) t.Errorf("64K read as %d", cfg.CoreRuleSetBodyInspectionSize)
} }
} }
@@ -819,13 +819,11 @@ 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, "9K", coreRuleSetBodyInspectionSize, "65537",
`"9K" is more than 8K, the most the Core Rule Set can read in time`, `"65537" is more than 64K, the most waf gets of a body`,
},
{
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) {
@@ -847,11 +845,11 @@ func TestInstanceNameAndLoggedHeadersAsSet(t *testing.T) {
t.Parallel() t.Parallel()
cfg := wafFromEnvironment(t, environment{ cfg := wafFromEnvironment(t, environment{
instanceName: "host1/blog", instanceName: "fsn1app1/blog",
logRequestHeaders: " Accept , X-Custom", logRequestHeaders: " Accept , X-Custom",
}) })
if cfg.InstanceName != "host1/blog" || if cfg.InstanceName != "fsn1app1/blog" ||
!slices.Equal( !slices.Equal(
cfg.LogRequestHeaders, cfg.LogRequestHeaders,
[]string{"accept", "x-custom"}, []string{"accept", "x-custom"},
@@ -1024,14 +1022,14 @@ func TestInstanceNameNotAnAppNameStopsTheStartOnlyWhileSending(
) { ) {
t.Parallel() t.Parallel()
const spaced = "host1 blog" const spaced = "fsn1 app1"
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 +
` "host1 blog", its default, is not 1 to 48 printable ASCII characters ` + ` "fsn1 app1", 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)
@@ -1333,13 +1331,13 @@ func TestInstanceNameWithAControlCharacterStopsTheStartOnlyWithNtfySet(
) { ) {
t.Parallel() t.Parallel()
const name = "host1\r" const name = "fsn1app1\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 + `: "host1\r" holds a control character, such as the ` + want := instanceName + `: "fsn1app1\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 {
+3 -16
View File
@@ -481,21 +481,12 @@ 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. The Core Rule Set reads no JSON body // since they cannot be read in part.
// 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.
@@ -508,8 +499,6 @@ 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
@@ -517,16 +506,14 @@ 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": case "JSON", "XML":
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)) <= largest) { if inPart || (err == nil && int64(len(read)) <= c.bodyInspectionSize) {
// 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)
+29 -40
View File
@@ -390,15 +390,22 @@ func TestMoreParametersThanCorazaKeepsIsAMatch(t *testing.T) {
matched(900300), matched(900300),
) )
// So it is with the fields of a form data body. A JSON body the Core // So it is with the fields of a form data or JSON body.
// Rule Set reads, of at most mostJSONRead bytes, cannot hold that many.
crs = readingBodies(t) crs = readingBodies(t)
body := strings.Repeat("a=1&", 999) + attack for _, tc := range []struct{ header, body string }{
wantBody(t, crs, post(formData), body, matched(942100), body) {formData, strings.Repeat("a=1&", 999) + attack},
{jsonBody, `{"a":[` + strings.Repeat("1,", 998) + `1],"id":"` + injection + `"}`},
} {
wantBody(t, crs, post(tc.header), tc.body, matched(942100), tc.body)
}
body = strings.Repeat("a=1&", 1000) + attack for _, tc := range []struct{ header, body string }{
wantBody(t, crs, post(formData), body, matched(900300), body) {formData, strings.Repeat("a=1&", 1000) + attack},
{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) {
@@ -1505,15 +1512,13 @@ const (
wpTags = "/wp-json/wp/v2/tags" wpTags = "/wp-json/wp/v2/tags"
) )
// readingBodiesUpTo8K returns the Core Rule Set as sww runs it by default, // readingBodiesUpTo64K 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 readingBodiesUpTo8K(t *testing.T) *coreruleset.CoreRuleSet { func readingBodiesUpTo64K(t *testing.T) *coreruleset.CoreRuleSet {
t.Helper() t.Helper()
return shared(t, coreruleset.Params{ return shared(t, coreruleset.Params{
ParanoiaLevel: 1, ParanoiaLevel: 1, DisabledRules: defaultDisabledRules, BodyInspectionSize: 64<<10 - 1,
DisabledRules: defaultDisabledRules,
BodyInspectionSize: mostBodyRead,
}) })
} }
@@ -1577,7 +1582,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), readingBodiesUpTo8K(t) defaults, bodies := atDefaults(t), readingBodiesUpTo64K(t)
for _, attack := range []string{ for _, attack := range []string{
sqlInjection, sqlInjection,
@@ -1688,7 +1693,7 @@ func wordpressRESTAddresses(route string) []string {
func TestWordPressExclusionsFollowEveryRESTAddress(t *testing.T) { func TestWordPressExclusionsFollowEveryRESTAddress(t *testing.T) {
t.Parallel() t.Parallel()
crs := readingBodiesUpTo8K(t) crs := readingBodiesUpTo64K(t)
content := `{"content":"` + wordpressBlock + `"}` content := `{"content":"` + wordpressBlock + `"}`
for _, route := range []string{ for _, route := range []string{
@@ -1914,7 +1919,7 @@ func TestWordPressCommandAfterASeparatorIsRefusedOnSearchesAndNames(
wantResult(t, crs, get(target+command), matched(932235)) wantResult(t, crs, get(target+command), matched(932235))
} }
bodies := readingBodiesUpTo8K(t) bodies := readingBodiesUpTo64K(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}}
@@ -2138,7 +2143,7 @@ func TestWordPressBodyFieldsAreCheckedInTheQuery(t *testing.T) {
func TestWordPressBodyNamesAndAddressesAreExcludedOnlyThere(t *testing.T) { func TestWordPressBodyNamesAndAddressesAreExcludedOnlyThere(t *testing.T) {
t.Parallel() t.Parallel()
crs := readingBodiesUpTo8K(t) crs := readingBodiesUpTo64K(t)
for _, v := range wordpressWords() { for _, v := range wordpressWords() {
for _, field := range []string{"title", "excerpt", "name"} { for _, field := range []string{"title", "excerpt", "name"} {
@@ -2257,7 +2262,7 @@ func TestWordPressExclusionsAreNarrow(t *testing.T) {
length = "Content-Length: 2" length = "Content-Length: 2"
) )
crs := readingBodiesUpTo8K(t) crs := readingBodiesUpTo64K(t)
saving := request{ saving := request{
http.MethodPost, http.MethodPost,
wpPost, wpPost,
@@ -2468,35 +2473,19 @@ func TestFormDataAndMultipartAreReadUpToTheLimit(t *testing.T) {
func TestJSONAndXMLAreReadOnlyWhenNoLargerThanTheLimit(t *testing.T) { func TestJSONAndXMLAreReadOnlyWhenNoLargerThanTheLimit(t *testing.T) {
t.Parallel() t.Parallel()
// The limit is the body inspection size, but at most mostJSONRead for crs := readingBodies(t)
// JSON. smallSize is a body inspection size under mostJSONRead.
const smallSize = 512
bodies, smallBodies := readingBodies(t), shared(t, coreruleset.Params{ for _, tc := range []struct{ header, head, tail string }{
ParanoiaLevel: 1, DisabledRules: defaultDisabledRules, {jsonBody, `{"q":"` + injection + `","pad":"`, `"}`},
BodyInspectionSize: smallSize, {xmlBody, "<r><q>" + injection + "</q><pad>", "</pad></r>"},
})
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, tc.limit) fits := padded(tc.head, tc.tail, bodyInspectionSize)
wantBody(t, tc.crs, post(tc.header), fits, matched(942100), fits) wantBody(t, crs, post(tc.header), fits, matched(942100), fits)
larger := padded(tc.head, tc.tail, tc.limit+1) larger := padded(tc.head, tc.tail, bodyInspectionSize+1)
wantBody( wantBody(
t, t,
tc.crs, crs,
post(tc.header), post(tc.header),
larger, larger,
coreruleset.Result{}, coreruleset.Result{},
-436
View File
@@ -1,436 +0,0 @@
package coreruleset_test
import (
"maps"
"net/http"
"net/http/httptest"
"net/netip"
"regexp"
"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
)
// The Core Rule Set has 1 second for one request. That 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, and less 200
// milliseconds for waf's other checks.
//
// A busy host slows all work, so the test does not compare an inspection with
// 1 second. It compares it with referenceTime, timed on the same thread just
// before and after. inspectionTimeLimitMultiple is how many times
// referenceTime an inspection may take.
//
// On the host that runs our checks, referenceTime took at least 78
// milliseconds, so 13 times it is about 1 second. With that host fully busy,
// no try of the slowest request took more than 9.5 times referenceTime.
const inspectionTimeLimitMultiple = 13
// referencePattern is what referenceTime matches. Like the Core Rule Set's
// rules, it is a regular expression with alternatives and repeats.
var referencePattern = regexp.MustCompile(
`(?i)(union|select|insert|delete)\s+\w+\s+(from|into)\s+\w+[0-9]+;`,
)
// referenceTime returns the processor time the calling thread takes to do a
// fixed amount of work unrelated to the Core Rule Set, so that a change to the
// rules does not change it. referencePattern matches nowhere in the text, so
// each match reads all of it.
func referenceTime(t *testing.T) time.Duration {
t.Helper()
referenceText := text(4 << 10)
began := threadCPUTime(t)
for range 200 {
if referencePattern.MatchString(referenceText) {
t.Fatal("the reference pattern matched")
}
}
return threadCPUTime(t) - began
}
// 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 the
// mean of referenceTime just before and after. It fails t unless crs reads all
// of tc's body and Coraza parses it.
//
// All of it runs on this goroutine, kept on one thread, so the thread's
// processor time measures it. Time other work holds the processor does not
// count.
func inspectionTime(
t *testing.T, crs *coreruleset.CoreRuleSet, tc visitorRequest,
) (time.Duration, 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()
before := referenceTime(t)
began := threadCPUTime(t)
result, read, _ := crs.Inspect(
req, netip.MustParseAddr("192.0.2.1"), strings.NewReader(tc.body),
)
took := threadCPUTime(t) - began
reference := (before + referenceTime(t)) / 2
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, reference
}
// TestTheCoreRuleSetInspectsEachWorstCaseRequestInTime runs one at a time, so
// that the tests running in parallel do not slow it. Other work on the host
// can still slow one try more than the reference work around it, 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, reference time.Duration
for range tries {
took, reference = inspectionTime(t, crs, tc)
if took <= inspectionTimeLimitMultiple*reference {
return
}
}
t.Errorf(
"took %s on the last of %d tries, over %d times the %s "+
"of the reference work",
took, tries, inspectionTimeLimitMultiple, reference,
)
})
}
}
@@ -1,4 +1,4 @@
package geojs package lookup
import "net/http" import "net/http"
+2 -6
View File
@@ -1,6 +1,3 @@
// Package lookup looks up each client's AS number and country in the lookup
// database, the IPinfo Lite file SWW_WAF_LOOKUP_DB_PATH names. Its answers
// take the form of GeoJS's, so that waf handles both alike.
package lookup package lookup
import ( import (
@@ -17,7 +14,6 @@ import (
"github.com/oschwald/maxminddb-golang/v2" "github.com/oschwald/maxminddb-golang/v2"
"sneak.berlin/go/smallwebwaf/internal/alerts" "sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/geojs"
) )
// quietTime is how long the lookup database must go without a change // quietTime is how long the lookup database must go without a change
@@ -81,7 +77,7 @@ func OpenFile(params FileParams) (*File, error) {
// each "" when the database does not give it, as for an address missing // each "" when the database does not give it, as for an address missing
// from it. The database is asked about the client's first address, as // from it. The database is asked about the client's first address, as
// GeoJS is. // GeoJS is.
func (f *File) LookUp(client netip.Prefix) geojs.Answer { func (f *File) LookUp(client netip.Prefix) Answer {
f.mu.Lock() f.mu.Lock()
reader := f.reader reader := f.reader
f.mu.Unlock() f.mu.Unlock()
@@ -95,7 +91,7 @@ func (f *File) LookUp(client netip.Prefix) geojs.Answer {
found = record{} found = record{}
} }
return geojs.Answer{ return Answer{
Client: client, Client: client,
ASN: found.ASN, ASN: found.ASN,
ASName: found.ASName, ASName: found.ASName,
+1 -2
View File
@@ -16,7 +16,6 @@ import (
"github.com/maxmind/mmdbwriter/mmdbtype" "github.com/maxmind/mmdbwriter/mmdbtype"
"sneak.berlin/go/smallwebwaf/internal/alerts" "sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/geojs"
"sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest" "sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest"
) )
@@ -69,7 +68,7 @@ func TestFilePlacesClientsAndCountsAnAddressMissingFromItAsUnknown(
prefix := netip.MustParsePrefix(client) prefix := netip.MustParsePrefix(client)
got := f.LookUp(prefix) got := f.LookUp(prefix)
if got != (geojs.Answer{ if got != (Answer{
Client: prefix, ASN: want.ASN, ASName: want.ASName, Country: want.Country, Client: prefix, ASN: want.ASN, ASName: want.ASName, Country: want.Country,
Answered: now, Answered: now,
}) { }) {
@@ -1,9 +1,9 @@
// Package geojs looks up clients' AS numbers and countries through the GeoJS // Package lookup looks up each client's AS number and country, through
// web service. Its answers are kept in memory, for at most 100,000 clients and // the GeoJS web service or in the lookup database, the IPinfo Lite file
// for 7 days each. A caller waits for an answer as long as it says. A request to // SWW_WAF_LOOKUP_DB_PATH names. GeoJS's answers are kept in memory, for at
// GeoJS goes on after its callers stop waiting, and its answer is kept. The // most 100,000 clients and for 7 days each, and are written to
// package imports no other package of this repository. // lookups.json and read from it by the state package.
package geojs package lookup
import ( import (
"context" "context"
@@ -11,6 +11,7 @@ import (
"errors" "errors"
"fmt" "fmt"
"io" "io"
"log/slog"
"net/http" "net/http"
"net/netip" "net/netip"
"slices" "slices"
@@ -20,6 +21,8 @@ import (
"time" "time"
"github.com/hashicorp/golang-lru/v2/simplelru" "github.com/hashicorp/golang-lru/v2/simplelru"
"sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/metrics"
) )
// URL is GeoJS's endpoint for an address's place and network. Asked about // URL is GeoJS's endpoint for an address's place and network. Asked about
@@ -40,9 +43,6 @@ const (
maxWaiting = 10000 maxWaiting = 10000
// maxPerRequest is how many addresses one request to GeoJS asks about. // maxPerRequest is how many addresses one request to GeoJS asks about.
maxPerRequest = 200 maxPerRequest = 200
// requestTimeout is how long a request to GeoJS may take before it is
// abandoned, which is a failure. It is apart from how long callers wait.
requestTimeout = 10 * time.Second
// unknownASN is the AS number GeoJS gives when it knows none. // unknownASN is the AS number GeoJS gives when it knows none.
unknownASN = 64512 unknownASN = 64512
// After a failure GeoJS is not asked again for a second, and for // After a failure GeoJS is not asked again for a second, and for
@@ -64,32 +64,39 @@ var (
type Params struct { type Params struct {
// URL is where GeoJS is asked, normally URL. // URL is where GeoJS is asked, normally URL.
URL string URL string
// Timeout is how long a request waits for its client's first answer,
// and how long a request to GeoJS may take before it is abandoned
// (SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS).
Timeout time.Duration
// Wait is true when a setting needs each request's answer before the
// request goes on. Otherwise no request waits for one.
Wait bool
// Answered, unless nil, is given each answer GeoJS gives, once it is // Answered, unless nil, is given each answer GeoJS gives, once it is
// kept. // kept.
Answered func(Answer) Answered func(Answer)
// Now tells the time, normally time.Now in UTC. // Now tells the time, normally time.Now in UTC.
Now func() time.Time Now func() time.Time
// Asked is called for each request to GeoJS. // ProcessLog receives GeoJS's failures.
Asked func() ProcessLog *slog.Logger
// Failed is called for each failure of GeoJS, with what went wrong and // Metrics count the requests to GeoJS, those that failed, and the
// how long GeoJS is left alone after it. The error never names the // clients that go without an answer.
// addresses asked about. Metrics *metrics.Metrics
Failed func(err error, askingAgainIn time.Duration) // Alerts receive a source_failure alert each time GeoJS fails.
// WentWithoutAnswer is called each time a caller that waits for an Alerts *alerts.Queue
// answer goes on without one.
WentWithoutAnswer func()
} }
// GeoJS looks up clients' AS numbers and countries through GeoJS. At most // GeoJS looks up clients' AS numbers and countries through GeoJS. At most
// one request to GeoJS is under way at a time, and it asks about every // one request to GeoJS is under way at a time, and it asks about every
// client waiting, up to maxPerRequest. It is safe for concurrent use. // client waiting, up to maxPerRequest. It is safe for concurrent use.
type GeoJS struct { type GeoJS struct {
url string url string
answered func(Answer) timeout time.Duration
now func() time.Time wait bool
asked func() answered func(Answer)
failed func(err error, askingAgainIn time.Duration) now func() time.Time
wentWithoutAnswer func() processLog *slog.Logger
metrics *metrics.Metrics
alerts *alerts.Queue
// httpClient follows no redirect, so that visitors' addresses go to // httpClient follows no redirect, so that visitors' addresses go to
// GeoJS alone: a redirect is a failure. // GeoJS alone: a redirect is a failure.
httpClient *http.Client httpClient *http.Client
@@ -107,10 +114,12 @@ type GeoJS struct {
retryAt time.Time retryAt time.Time
} }
// Answer is what GeoJS said about a client: its AS number, such as AS64496, // Answer is what GeoJS or the lookup database said about a client: its AS
// and the AS's name, both "" when GeoJS knows no AS number for it; its // number, such as AS64496, and the AS's name, both "" when the source knows
// country, "" when GeoJS cannot place it; when GeoJS said so; and when the // no AS number for it; its country, "" when the source cannot place it;
// answer was last used. The zero Answer is that of a client with no answer. // when the source said so; and, for GeoJS's answers, which lookups.json
// holds, when the answer was last used. The zero Answer is that of a
// client with no answer.
// //
//nolint:tagliatelle // the state files use snake_case, as the request log does //nolint:tagliatelle // the state files use snake_case, as the request log does
type Answer struct { type Answer struct {
@@ -128,7 +137,7 @@ type wait struct {
// replaced each time GeoJS fails before then. // replaced each time GeoJS fails before then.
asked chan struct{} asked chan struct{}
// late is true once the client has gone without an answer, for a // late is true once the client has gone without an answer, for a
// whole wait or because GeoJS failed: its callers no longer wait. // whole timeout or because GeoJS failed: its requests no longer wait.
late bool late bool
} }
@@ -140,12 +149,14 @@ func New(params Params) *GeoJS {
} }
return &GeoJS{ return &GeoJS{
url: params.URL, url: params.URL,
answered: params.Answered, timeout: params.Timeout,
now: params.Now, wait: params.Wait,
asked: params.Asked, answered: params.Answered,
failed: params.Failed, now: params.Now,
wentWithoutAnswer: params.WentWithoutAnswer, processLog: params.ProcessLog,
metrics: params.Metrics,
alerts: params.Alerts,
httpClient: &http.Client{ httpClient: &http.Client{
CheckRedirect: func(*http.Request, []*http.Request) error { CheckRedirect: func(*http.Request, []*http.Request) error {
return http.ErrUseLastResponse return http.ErrUseLastResponse
@@ -159,22 +170,21 @@ func New(params Params) *GeoJS {
// LookUp returns the answer GeoJS gave about client, with its country as // LookUp returns the answer GeoJS gave about client, with its country as
// a two-letter code in capitals, or the zero Answer when there is none // a two-letter code in capitals, or the zero Answer when there is none
// yet. An answer is kept for 7 days. Without one, the client is asked // yet. An answer is kept for 7 days. Without one, the client is asked
// about in the background, and LookUp waits up to wait for the answer, // about in the background, and, while Wait is set, the request waits up
// unless the client has gone without one before. The wait ends early when // to Timeout for the answer, unless the client has gone without one
// ctx ends. Neither ends the request to GeoJS. // before. ctx is the context of the client's request, and ends the wait
// when it ends.
// //
// GeoJS is asked about the client's first address, which is the client's // GeoJS is asked about the client's first address, which is the client's
// own address for IPv4, and an address in the same place for an IPv6 // own address for IPv4, and an address in the same place for an IPv6
// netblock. // netblock.
func (g *GeoJS) LookUp( func (g *GeoJS) LookUp(ctx context.Context, client netip.Prefix) Answer {
ctx context.Context, client netip.Prefix, wait time.Duration, answer, asked := g.answerOrWait(ctx, client, g.wait)
) Answer {
answer, asked := g.answerOrWait(ctx, client, true)
if asked == nil { if asked == nil {
return answer return answer
} }
timer := time.NewTimer(wait) timer := time.NewTimer(g.timeout)
defer timer.Stop() defer timer.Stop()
select { select {
@@ -188,7 +198,7 @@ func (g *GeoJS) LookUp(
answer, found := g.kept(client) answer, found := g.kept(client)
if !found { if !found {
g.wentWithoutAnswer() g.metrics.RequestsWithoutGeoJSAnswer.Inc()
} }
w, waiting := g.waiting[client] w, waiting := g.waiting[client]
@@ -199,8 +209,8 @@ func (g *GeoJS) LookUp(
return answer return answer
} }
// LookUpWithoutWaiting is LookUp for a caller that does not need the answer: // LookUpWithoutWaiting is LookUp for a request that does not need the answer,
// it returns the zero Answer at once when none is kept. // whatever Wait says: it returns the zero Answer at once when none is kept.
func (g *GeoJS) LookUpWithoutWaiting( func (g *GeoJS) LookUpWithoutWaiting(
ctx context.Context, ctx context.Context,
client netip.Prefix, client netip.Prefix,
@@ -218,7 +228,8 @@ func (g *GeoJS) Kept(client netip.Prefix) (Answer, bool) {
return g.kept(client) return g.kept(client)
} }
// Snapshot returns every answer kept, sorted by client. // Snapshot returns every answer kept, sorted by client, as lookups.json
// lists them.
func (g *GeoJS) Snapshot() []Answer { func (g *GeoJS) Snapshot() []Answer {
g.mu.Lock() g.mu.Lock()
@@ -236,9 +247,9 @@ func (g *GeoJS) Snapshot() []Answer {
return answers return answers
} }
// Load keeps answers, such as those of an earlier Snapshot, in place of the // Load keeps answers read from lookups.json, in place of the answers it
// answers it keeps, in the order they were last used, so that the one used // keeps, in the order they were last used, so that the one used longest
// longest ago is dropped first. Answers GeoJS gave keepFor ago or more are // ago is dropped first. Answers GeoJS gave keepFor ago or more are
// dropped. // dropped.
func (g *GeoJS) Load(answers []Answer) { func (g *GeoJS) Load(answers []Answer) {
answers = slices.Clone(answers) answers = slices.Clone(answers)
@@ -284,11 +295,11 @@ func (g *GeoJS) answerOrWait(
g.ask(ctx) g.ask(ctx)
if !mustWait { if !mustWait {
return Answer{}, nil // the answer is not needed before the caller goes on return Answer{}, nil // the answer is not needed before the request goes on
} }
if w == nil { if w == nil {
g.wentWithoutAnswer() g.metrics.RequestsWithoutGeoJSAnswer.Inc()
return Answer{}, nil // too many clients wait already return Answer{}, nil // too many clients wait already
} }
@@ -299,7 +310,7 @@ func (g *GeoJS) answerOrWait(
} }
if w.late { if w.late {
g.wentWithoutAnswer() g.metrics.RequestsWithoutGeoJSAnswer.Inc()
return Answer{}, nil return Answer{}, nil
} }
@@ -324,8 +335,8 @@ func (g *GeoJS) kept(client netip.Prefix) (Answer, bool) {
// ask starts asking GeoJS about the waiting clients, unless a request to // ask starts asking GeoJS about the waiting clients, unless a request to
// it is under way or it is left alone after a failure. The requests to // it is under way or it is left alone after a failure. The requests to
// GeoJS are for every client waiting, so they go on when the caller whose // GeoJS are for every client waiting, so they go on when the client's
// ctx is given stops waiting. // request whose ctx is given ends.
func (g *GeoJS) ask(ctx context.Context) { func (g *GeoJS) ask(ctx context.Context) {
if g.asking || g.now().Before(g.retryAt) { if g.asking || g.now().Before(g.retryAt) {
return return
@@ -430,6 +441,8 @@ func (g *GeoJS) keep(
} }
if err != nil { if err != nil {
g.metrics.GeoJSFailures.Inc()
g.retryDelay = min( g.retryDelay = min(
max(retryDelayFactor*g.retryDelay, firstRetryDelay), max(retryDelayFactor*g.retryDelay, firstRetryDelay),
maxRetryDelay, maxRetryDelay,
@@ -444,7 +457,16 @@ func (g *GeoJS) keep(
w.late = true w.late = true
} }
g.failed(err, g.retryDelay) g.processLog.Warn("asking GeoJS failed",
"error", err.Error(), "asking_again_in", g.retryDelay.String())
g.alerts.Raise(alerts.Alert{
Event: alerts.EventSourceFailure,
Reason: "asking GeoJS failed",
Detail: map[string]any{
"source": "geojs", "error": err.Error(),
"asking_again_in": g.retryDelay.String(),
},
})
return kept, false return kept, false
} }
@@ -457,8 +479,7 @@ func (g *GeoJS) keep(
// request asks GeoJS about clients in one request, and returns the answer // request asks GeoJS about clients in one request, and returns the answer
// for each address GeoJS's answer names: its AS number and the AS's name, // for each address GeoJS's answer names: its AS number and the AS's name,
// both "" for the AS number 64512, which GeoJS gives when it knows none, // both "" for the AS number 64512, which GeoJS gives when it knows none,
// and its country, in capitals. The request is abandoned after // and its country, in capitals.
// requestTimeout.
func (g *GeoJS) request( func (g *GeoJS) request(
ctx context.Context, clients []netip.Prefix, ctx context.Context, clients []netip.Prefix,
) (map[netip.Addr]Answer, error) { ) (map[netip.Addr]Answer, error) {
@@ -468,7 +489,7 @@ func (g *GeoJS) request(
addrs = append(addrs, client.Addr().String()) addrs = append(addrs, client.Addr().String())
} }
ctx, cancel := context.WithTimeout(ctx, requestTimeout) ctx, cancel := context.WithTimeout(ctx, g.timeout)
defer cancel() defer cancel()
req, err := http.NewRequestWithContext( req, err := http.NewRequestWithContext(
@@ -483,7 +504,7 @@ func (g *GeoJS) request(
req.URL.RawQuery = "ip=" + strings.Join(addrs, ",") req.URL.RawQuery = "ip=" + strings.Join(addrs, ",")
g.asked() g.metrics.GeoJSRequests.Inc()
res, err := g.httpClient.Do(req) res, err := g.httpClient.Do(req)
if err != nil { if err != nil {
File diff suppressed because it is too large. Load diff
@@ -1,4 +1,4 @@
package geojs_test package lookup_test
import ( import (
"net/netip" "net/netip"
@@ -7,7 +7,7 @@ import (
"testing/synctest" "testing/synctest"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
) )
func TestSnapshotHoldsEachAnswerAndWhenItWasLastUsed(t *testing.T) { func TestSnapshotHoldsEachAnswerAndWhenItWasLastUsed(t *testing.T) {
@@ -25,7 +25,7 @@ func TestSnapshotHoldsEachAnswerAndWhenItWasLastUsed(t *testing.T) {
clock.advance(time.Hour) clock.advance(time.Hour)
wantCountry(t, g, placed, germany) wantCountry(t, g, placed, germany)
want := []geojs.Answer{ want := []lookup.Answer{
{Client: notPlaced, Answered: asked, Used: asked}, {Client: notPlaced, Answered: asked, Used: asked},
{ {
Client: placed, ASN: asn, ASName: asName, Country: germany, Client: placed, ASN: asn, ASName: asName, Country: germany,
@@ -41,24 +41,24 @@ func TestSnapshotHoldsEachAnswerAndWhenItWasLastUsed(t *testing.T) {
func TestLoadedAnswersAreKeptFor7DaysFromWhenGeoJSGaveThem(t *testing.T) { func TestLoadedAnswersAreKeptFor7DaysFromWhenGeoJSGaveThem(t *testing.T) {
t.Parallel() t.Parallel()
service, clock, g := start() geojs, clock, g := start()
now := clock.Now() now := clock.Now()
kept := geojs.Answer{ kept := lookup.Answer{
Client: netip.MustParsePrefix("203.0.113.9/32"), Client: netip.MustParsePrefix("203.0.113.9/32"),
Country: "FR", Country: "FR",
Answered: now.Add(-week + time.Second), Answered: now.Add(-week + time.Second),
Used: now.Add(-time.Hour), Used: now.Add(-time.Hour),
} }
stale := geojs.Answer{ stale := lookup.Answer{
Client: netip.MustParsePrefix("203.0.113.10/32"), Client: netip.MustParsePrefix("203.0.113.10/32"),
Country: "FR", Country: "FR",
Answered: now.Add(-week), Answered: now.Add(-week),
Used: now.Add(-time.Hour), Used: now.Add(-time.Hour),
} }
g.Load([]geojs.Answer{kept, stale}) g.Load([]lookup.Answer{kept, stale})
if got := g.Snapshot(); !slices.Equal(got, []geojs.Answer{kept}) { if got := g.Snapshot(); !slices.Equal(got, []lookup.Answer{kept}) {
t.Errorf( t.Errorf(
"kept %+v, want only the answer GeoJS gave less than 7 days ago", "kept %+v, want only the answer GeoJS gave less than 7 days ago",
got, got,
@@ -66,7 +66,7 @@ func TestLoadedAnswersAreKeptFor7DaysFromWhenGeoJSGaveThem(t *testing.T) {
} }
wantCountry(t, g, kept.Client, "FR") wantCountry(t, g, kept.Client, "FR")
wantRequests(t, service, 0) wantRequests(t, geojs, 0)
} }
func TestLoadDropsTheAnswerUsedLongestAgoFirst(t *testing.T) { func TestLoadDropsTheAnswerUsedLongestAgoFirst(t *testing.T) {
@@ -80,11 +80,11 @@ func TestLoadDropsTheAnswerUsedLongestAgoFirst(t *testing.T) {
// lookups.json lists the answers by client. Here each was last used a // lookups.json lists the answers by client. Here each was last used a
// second before the one listed before it, so the last listed is the // second before the one listed before it, so the last listed is the
// one used longest ago, and the one dropped. // one used longest ago, and the one dropped.
answers := make([]geojs.Answer, maxAnswers+1) answers := make([]lookup.Answer, maxAnswers+1)
addr := netip.MustParseAddr("10.0.0.0") addr := netip.MustParseAddr("10.0.0.0")
for i := range answers { for i := range answers {
answers[i] = geojs.Answer{ answers[i] = lookup.Answer{
Client: netip.PrefixFrom(addr, addr.BitLen()), Client: netip.PrefixFrom(addr, addr.BitLen()),
Country: germany, Country: germany,
Answered: now, Answered: now,
+2 -1
View File
@@ -274,7 +274,8 @@ func (m *Metrics) AddRemoteLog(remote *remotelog.Sender) {
// AddLookupFile adds the metrics of the lookup database, read as the // AddLookupFile adds the metrics of the lookup database, read as the
// metrics are asked for: when the file in use was read, which lastRead // metrics are asked for: when the file in use was read, which lastRead
// returns, and the replacements of it that could not be read, which // returns, and the replacements of it that could not be read, which
// readFailures returns. // readFailures returns. The lookup package's File, which has both, cannot
// be named here: that package counts GeoJS's requests in these metrics.
func (m *Metrics) AddLookupFile( func (m *Metrics) AddLookupFile(
lastRead func() time.Time, lastRead func() time.Time,
readFailures func() int, readFailures func() int,
+1 -1
View File
@@ -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 = "host1/blog" appName = "fsn1app1/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
+3 -3
View File
@@ -140,7 +140,7 @@ func TestProcessLinesAreMarkedProcessAndGiveTheInstance(t *testing.T) {
var out bytes.Buffer var out bytes.Buffer
requestlog.NewProcessLogger(&out, "host1/blog", slog.LevelInfo). requestlog.NewProcessLogger(&out, "fsn1app1/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"] != "host1/blog" || fields["instance"] != "fsn1app1/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,
"host1/blog", "fsn1app1/blog",
level, level,
) )
for _, at := range levels { for _, at := range levels {
+8 -7
View File
@@ -21,9 +21,8 @@ var errBreakerOpen = errors.New(
// breaker is the circuit breaker for asks to waf. It opens when // breaker is the circuit breaker for asks to waf. It opens when
// breakerFailures asks fail within breakerWindow. An ask fails when it gets no // breakerFailures asks fail within breakerWindow. An ask fails when it gets no
// answer in time, or an answer rproxy cannot pass on. While it is open, at // answer in time. While it is open, at most one request each breakerAskInterval
// most one request each breakerAskInterval asks waf. Any usable answer closes // asks waf. The first answer closes it, whatever it decides.
// it, whatever it decides, and forgets the failures before it.
type breaker struct { type breaker struct {
mu sync.Mutex mu sync.Mutex
// failures holds the times of the latest failed asks, oldest first, at most // failures holds the times of the latest failed asks, oldest first, at most
@@ -53,14 +52,16 @@ func (b *breaker) mayAsk(now time.Time) bool {
return true return true
} }
// noteAnswer notes that an ask got an answer rproxy can use. It closes the // noteAnswer notes that an ask got an answer in time. It closes the breaker,
// breaker and forgets the failures before it. // and forgets the failures before it.
func (b *breaker) noteAnswer() { func (b *breaker) noteAnswer() {
b.mu.Lock() b.mu.Lock()
defer b.mu.Unlock() defer b.mu.Unlock()
b.open = false if b.open {
b.failures = nil b.open = false
b.failures = nil
}
} }
// noteFailure notes that an ask that ended at now got no answer in time, and // noteFailure notes that an ask that ended at now got no answer in time, and
+5 -5
View File
@@ -63,17 +63,17 @@ func TestFiveFailedAsksOverMoreThanFiveSecondsLeaveTheBreakerClosed(
} }
} }
func TestAnAnswerBetweenFailedAsksKeepsTheBreakerClosed(t *testing.T) { func TestAnAnswerBeforeTheBreakerOpensDoesNotForgetFailures(t *testing.T) {
t.Parallel() t.Parallel()
now := time.Now() now := time.Now()
b := &rproxy.Breaker{} b := &rproxy.Breaker{}
fail(b, now, 4, 100*time.Millisecond) fail(b, now, 4, time.Millisecond)
b.NoteAnswer() b.NoteAnswer()
fail(b, now.Add(500*time.Millisecond), 4, 100*time.Millisecond) b.NoteFailure(now.Add(time.Second))
if !b.MayAsk(now.Add(900 * time.Millisecond)) { if b.MayAsk(now.Add(time.Second)) {
t.Error("a request may not ask, want it to") t.Error("a request may ask, want it not to")
} }
} }
+1 -1
View File
@@ -12,7 +12,7 @@ func (b *Breaker) MayAsk(now time.Time) bool {
return b.b.mayAsk(now) return b.b.mayAsk(now)
} }
// NoteAnswer notes that an ask got an answer rproxy can use. // NoteAnswer notes that an ask got an answer in time.
func (b *Breaker) NoteAnswer() { func (b *Breaker) NoteAnswer() {
b.b.noteAnswer() b.b.noteAnswer()
} }
+5 -106
View File
@@ -1424,14 +1424,7 @@ func TestFiveFailedAsksKeepTheNextRequestFromAskingWAF(t *testing.T) {
failure(w, r) failure(w, r)
}, },
) )
nextID := make(chan string, 1) app := startApp(t, greet)
app := startApp(t, func(w http.ResponseWriter, r *http.Request) {
if answering.Load() {
nextID <- r.Header.Get(requestIDHeader)
}
greet(w, r)
})
addr, out := startRProxy( addr, out := startRProxy(
t, t,
standIn.URL, standIn.URL,
@@ -1441,118 +1434,24 @@ func TestFiveFailedAsksKeepTheNextRequestFromAskingWAF(t *testing.T) {
}, },
) )
// An ask can time out before it reaches the stand-in, so these
// may leave fewer than five questions, or leave some late.
for range 5 { for range 5 {
wantGreeting(t, get(t, addr, "/")) wantGreeting(t, get(t, addr, "/"))
} standIn.question(t)
// rproxy writes this line before it answers a request it kept
// from asking waf, so no wait is needed.
if out.has("the circuit breaker is open") {
t.Error("the circuit breaker opened before five asks failed")
} }
answering.Store(true) answering.Store(true)
wantGreeting(t, get(t, addr, "/")) wantGreeting(t, get(t, addr, "/"))
out.waitFor(t, "the circuit breaker is open") out.waitFor(t, "the circuit breaker is open")
// Had the next request asked waf, its question would have reached
// the stand-in before the request reached the app.
var id string
select { select {
case id = <-nextID: case <-standIn.questions:
default: t.Error("waf was asked, want it not to be")
t.Fatal("the app did not get the next request") case <-time.After(10 * pollInterval):
}
for len(standIn.questions) > 0 {
asked := <-standIn.questions
if asked.header.Get(requestIDHeader) == id {
t.Error("waf was asked, want it not to be")
}
} }
}) })
} }
} }
func TestVisitorsThatGoAwayWhileWAFIsAskedLeaveTheBreakerClosed(
t *testing.T,
) {
t.Parallel()
var answering atomic.Bool
standIn := startWAF(t, func(w http.ResponseWriter, r *http.Request) {
if answering.Load() {
allow(w, r)
return
}
<-r.Context().Done()
})
app := startApp(t, greet)
addr, out := startRProxy(t, standIn.URL, app.URL, map[string]string{
wafBackendTimeout: "60000",
})
// Five of these would open the breaker if they counted as failures.
for range 5 {
conn := dial(t, addr)
send(t, conn, "GET / HTTP/1.1\r\nHost: site.example\r\n\r\n")
id := standIn.question(t).header.Get(requestIDHeader)
_ = conn.Close()
// rproxy writes the request's log line once it is done with the ask.
out.waitFor(t, id)
}
answering.Store(true)
wantGreeting(t, get(t, addr, "/"))
standIn.question(t)
}
func TestAnswersThatCannotBePassedOnOpenTheBreaker(t *testing.T) {
t.Parallel()
var answering atomic.Bool
tooLarge := overOneMiB(dispositionDeny)
standIn := startWAF(t, func(w http.ResponseWriter, r *http.Request) {
if answering.Load() {
allow(w, r)
return
}
tooLarge(w, r)
})
app := startApp(t, greet)
addr, out := startRProxy(t, standIn.URL, app.URL, map[string]string{
wafBackendTimeout: "60000",
})
for range 5 {
if got := get(t, addr, "/"); got.status != http.StatusBadGateway {
t.Errorf("answered %d, want 502", got.status)
}
standIn.question(t)
}
answering.Store(true)
wantGreeting(t, get(t, addr, "/"))
out.waitFor(t, "the circuit breaker is open")
select {
case <-standIn.questions:
t.Error("waf was asked, want it not to be")
case <-time.After(10 * pollInterval):
}
}
func TestAPathUnderOwnPrefixNeverReachesTheApp(t *testing.T) { func TestAPathUnderOwnPrefixNeverReachesTheApp(t *testing.T) {
t.Parallel() t.Parallel()
+2 -2
View File
@@ -90,7 +90,7 @@ func (rq *request) handleNoUsableAnswer(ctx context.Context, err error) {
// askUnlessBreakerOpen asks waf, unless the circuit breaker is open and it is // askUnlessBreakerOpen asks waf, unless the circuit breaker is open and it is
// not yet time for a request to ask. It then tells the breaker whether waf // not yet time for a request to ask. It then tells the breaker whether waf
// answered in time. An answer rproxy cannot pass on counts as a failure. A // answered in time. An answer rproxy cannot pass on still came in time. A
// visitor that goes away tells the breaker nothing. ctx is the request's own // visitor that goes away tells the breaker nothing. ctx is the request's own
// context. // context.
func (rq *request) askUnlessBreakerOpen( func (rq *request) askUnlessBreakerOpen(
@@ -104,7 +104,7 @@ func (rq *request) askUnlessBreakerOpen(
answer, err := rq.ask(ctx) answer, err := rq.ask(ctx)
switch { switch {
case err == nil: case err == nil, errors.Is(err, errCannotPassOn):
b.noteAnswer() b.noteAnswer()
case ctx.Err() == nil: case ctx.Err() == nil:
b.noteFailure(time.Now()) b.noteFailure(time.Now())
+4 -4
View File
@@ -46,7 +46,7 @@ import (
"sneak.berlin/go/smallwebwaf/internal/alerts" "sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/anomaly" "sneak.berlin/go/smallwebwaf/internal/anomaly"
"sneak.berlin/go/smallwebwaf/internal/bans" "sneak.berlin/go/smallwebwaf/internal/bans"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/metrics" "sneak.berlin/go/smallwebwaf/internal/metrics"
"sneak.berlin/go/smallwebwaf/internal/ratelimit" "sneak.berlin/go/smallwebwaf/internal/ratelimit"
"sneak.berlin/go/smallwebwaf/internal/reputation" "sneak.berlin/go/smallwebwaf/internal/reputation"
@@ -135,7 +135,7 @@ type Params struct {
// sww runs. // sww runs.
Ledger *bans.Ledger Ledger *bans.Ledger
Limiter *ratelimit.Limiter Limiter *ratelimit.Limiter
GeoJS *geojs.GeoJS GeoJS *lookup.GeoJS
Lists *reputation.Lists Lists *reputation.Lists
DNSBL *reputation.DNSBL DNSBL *reputation.DNSBL
AbuseIPDB *reputation.AbuseIPDB AbuseIPDB *reputation.AbuseIPDB
@@ -195,8 +195,8 @@ type clientsFile struct {
// lookupsFile is lookups.json, with each answer on a line of its own. // lookupsFile is lookups.json, with each answer on a line of its own.
type lookupsFile struct { type lookupsFile struct {
Version int `json:"version"` Version int `json:"version"`
Lookups []geojs.Answer `json:"lookups"` Lookups []lookup.Answer `json:"lookups"`
} }
// abuseIPDBChecksSpentFile is abuseipdb-checks-spent.json, indented for an // abuseIPDBChecksSpentFile is abuseipdb-checks-spent.json, indented for an
+9 -7
View File
@@ -26,7 +26,7 @@ import (
"sneak.berlin/go/smallwebwaf/internal/alerts" "sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/anomaly" "sneak.berlin/go/smallwebwaf/internal/anomaly"
"sneak.berlin/go/smallwebwaf/internal/bans" "sneak.berlin/go/smallwebwaf/internal/bans"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/metrics" "sneak.berlin/go/smallwebwaf/internal/metrics"
"sneak.berlin/go/smallwebwaf/internal/ratelimit" "sneak.berlin/go/smallwebwaf/internal/ratelimit"
"sneak.berlin/go/smallwebwaf/internal/reputation" "sneak.berlin/go/smallwebwaf/internal/reputation"
@@ -159,7 +159,7 @@ const filledAlertsJSON = `{
"waiting": { "waiting": {
"webhook": [ "webhook": [
{ {
"instance": "host1/blog", "instance": "fsn1app1/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": "host1/blog", "instance": "fsn1app1/blog",
"time": "2026-10-06T00:00:00Z", "time": "2026-10-06T00:00:00Z",
"event": "file_error", "event": "file_error",
"client": "", "client": "",
@@ -1700,7 +1700,7 @@ func TestEditOfEachFileTakenIn(t *testing.T) {
t, t,
lookupsJSON, lookupsJSON,
params.GeoJS.Snapshot(), params.GeoJS.Snapshot(),
[]geojs.Answer{ []lookup.Answer{
{Client: client, Country: "FR", Answered: midnight()}, {Client: client, Country: "FR", Answered: midnight()},
}, },
) )
@@ -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: "host1/blog", Instance: "fsn1app1/blog",
Now: midnight, Now: midnight,
}) })
@@ -2415,7 +2415,9 @@ func newParams(dir string) state.Params {
MaxBans: 5000, MaxBans: 5000,
}), }),
Limiter: ratelimit.New(ratelimit.Limits{}, 20000), Limiter: ratelimit.New(ratelimit.Limits{}, 20000),
GeoJS: geojs.New(geojs.Params{Now: midnight}), GeoJS: lookup.New(lookup.Params{
Now: midnight, ProcessLog: discard, Metrics: m,
}),
Lists: reputation.New(reputation.Params{ Lists: reputation.New(reputation.Params{
BlocklistURLs: []string{ BlocklistURLs: []string{
blocklistURL, blocklistURL,
@@ -2492,7 +2494,7 @@ func fill(params state.Params) {
}) })
params.Limiter.AddLookup(client, now.Add(-time.Hour), asn, asName, "DE") params.Limiter.AddLookup(client, now.Add(-time.Hour), asn, asName, "DE")
params.GeoJS.Load([]geojs.Answer{ params.GeoJS.Load([]lookup.Answer{
{ {
Client: client, ASN: asn, ASName: asName, Country: "DE", Client: client, ASN: asn, ASName: asName, Country: "DE",
Answered: now.Add(-time.Hour), Used: now, Answered: now.Add(-time.Hour), Used: now,
+1 -2
View File
@@ -25,7 +25,6 @@ import (
"sneak.berlin/go/smallwebwaf/internal/alerts" "sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/config" "sneak.berlin/go/smallwebwaf/internal/config"
"sneak.berlin/go/smallwebwaf/internal/coreruleset" "sneak.berlin/go/smallwebwaf/internal/coreruleset"
"sneak.berlin/go/smallwebwaf/internal/geojs"
"sneak.berlin/go/smallwebwaf/internal/lookup" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/remotelog" "sneak.berlin/go/smallwebwaf/internal/remotelog"
"sneak.berlin/go/smallwebwaf/internal/reputation" "sneak.berlin/go/smallwebwaf/internal/reputation"
@@ -271,7 +270,7 @@ func newServer(
Config: cfg, Config: cfg,
RequestLog: stdout, RequestLog: stdout,
ProcessLog: processLog, ProcessLog: processLog,
GeoJSURL: geojs.URL, GeoJSURL: lookup.URL,
AbuseIPDBURL: reputation.AbuseIPDBURL, AbuseIPDBURL: reputation.AbuseIPDBURL,
LookupFile: lookupFile, LookupFile: lookupFile,
CoreRuleSet: crs, CoreRuleSet: crs,
+14 -14
View File
@@ -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 = "host1/blog" instance = "fsn1app1/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="host1/blog"`) { !strings.Contains(line, `instance="fsn1app1/blog"`) {
t.Errorf("series %q, without instance=\"host1/blog\"", line) t.Errorf("series %q, without instance=\"fsn1app1/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="host1/blog"} 1`, `sww_lookup_database_read_failures_total{instance="fsn1app1/blog"} 1`,
) )
lastRead = seriesValue( lastRead = seriesValue(
t, t,
metrics, metrics,
`sww_lookup_database_last_read_timestamp_seconds{instance="host1/blog"}`, `sww_lookup_database_last_read_timestamp_seconds{instance="fsn1app1/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="host1/blog",` + failures := `sww_reputation_failures_total{instance="fsn1app1/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="host1/blog"} 0`, `sww_remote_log_lines_sent_total{instance="fsn1app1/blog"} 0`,
`sww_remote_log_lines_waiting{instance="host1/blog"} 1`, `sww_remote_log_lines_waiting{instance="fsn1app1/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="host1/blog"} ` `{instance="fsn1app1/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="host1/blog"}` const ofWebhook = `{destination="webhook",instance="fsn1app1/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, "*host1/blog: ban*\n") || !strings.HasPrefix(message.Text, "*fsn1app1/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") != "host1/blog: ban" || if ntfyPost.header.Get("Title") != "fsn1app1/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=\"host1/blog\"} 1\n", "instance=\"fsn1app1/blog\"} 1\n",
"\nsww_alerts_sent_total{destination=\"ntfy\"," + "\nsww_alerts_sent_total{destination=\"ntfy\"," +
"instance=\"host1/blog\"} 1\n", "instance=\"fsn1app1/blog\"} 1\n",
} }
metrics := metricsWith(t, url+"_sww/metrics", token, sent...) metrics := metricsWith(t, url+"_sww/metrics", token, sent...)
+1 -1
View File
@@ -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 = "host1/blog" alertInstance = "fsn1app1/blog"
) )
func TestBanForABrokenLimitRaisesABanAlertWithItsNotes(t *testing.T) { func TestBanForABrokenLimitRaisesABanAlertWithItsNotes(t *testing.T) {
+4 -9
View File
@@ -20,7 +20,7 @@ import (
"github.com/prometheus/client_golang/prometheus/testutil" "github.com/prometheus/client_golang/prometheus/testutil"
"sneak.berlin/go/smallwebwaf/internal/bans" "sneak.berlin/go/smallwebwaf/internal/bans"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest" "sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest"
"sneak.berlin/go/smallwebwaf/internal/ratelimit" "sneak.berlin/go/smallwebwaf/internal/ratelimit"
"sneak.berlin/go/smallwebwaf/internal/reputation" "sneak.berlin/go/smallwebwaf/internal/reputation"
@@ -591,7 +591,7 @@ func TestAClientGeoJSPlacedInNoCountryCountsAsUnknownWithoutWaiting(
s := startWAF(t, geojsURL, map[string]string{ s := startWAF(t, geojsURL, map[string]string{
unknownCountryLimitPercent: "0", rateLimitPerMinute: "1", unknownCountryLimitPercent: "0", rateLimitPerMinute: "1",
}) })
s.server.GeoJS.Load([]geojs.Answer{{ s.server.GeoJS.Load([]lookup.Answer{{
Client: netip.MustParsePrefix(client + "/32"), ASN: "AS64512", Client: netip.MustParsePrefix(client + "/32"), ASN: "AS64512",
Answered: s.clock.Now(), Used: s.clock.Now(), Answered: s.clock.Now(), Used: s.clock.Now(),
}}) }})
@@ -770,8 +770,6 @@ func TestARefusedRequestDoesNotWaitForASlowGeoJS(t *testing.T) {
// TestRequestWaitsAsLongAsTheASNAndCountryLookupTimeoutSays says, // TestRequestWaitsAsLongAsTheASNAndCountryLookupTimeoutSays says,
// so that a request that does not wait takes no time at all. // so that a request that does not wait takes no time at all.
synctest.Test(t, func(t *testing.T) { synctest.Test(t, func(t *testing.T) {
defer waitForGeoJSRequestsToBeAbandoned()
server, out := newWAFInBubble(t, tc.env) server, out := newWAFInBubble(t, tc.env)
tc.prepare(t, server, time.Now()) tc.prepare(t, server, time.Now())
@@ -840,8 +838,6 @@ func TestAQuestionWaitsForASlowGeoJSOnlyAsLongAsTheDefaultSays(
t.Parallel() t.Parallel()
synctest.Test(t, func(t *testing.T) { synctest.Test(t, func(t *testing.T) {
defer waitForGeoJSRequestsToBeAbandoned()
server, out := newWAFInBubble(t, tc.env) server, out := newWAFInBubble(t, tc.env)
tc.prepare(t, server, time.Now()) tc.prepare(t, server, time.Now())
@@ -954,11 +950,10 @@ func TestWAFAnswersWithinTheTimeLimitWhileEveryOutsideSourceHangs(
t.Errorf("%d checks with AbuseIPDB, want 1", checked) t.Errorf("%d checks with AbuseIPDB, want 1", checked)
} }
// The query is answered, and the check with AbuseIPDB and the request // The query is answered, and the check with AbuseIPDB abandoned,
// to GeoJS abandoned, before the bubble ends. // before the bubble ends.
releaseResolver() releaseResolver()
time.Sleep(defaultDNSBLAbuseIPDBWait) time.Sleep(defaultDNSBLAbuseIPDBWait)
waitForGeoJSRequestsToBeAbandoned()
}) })
} }
-4
View File
@@ -339,8 +339,6 @@ func TestClientWithoutAnAnswerInTimeHasTheUnknownCountryLimitPercent(
// TestRequestWaitsAsLongAsTheASNAndCountryLookupTimeoutSays says, with // TestRequestWaitsAsLongAsTheASNAndCountryLookupTimeoutSays says, with
// a GeoJS that never answers. // a GeoJS that never answers.
synctest.Test(t, func(t *testing.T) { synctest.Test(t, func(t *testing.T) {
defer waitForGeoJSRequestsToBeAbandoned()
server, out, _ := newWAF(t, silentGeoJSURL, time.Now, server, out, _ := newWAF(t, silentGeoJSURL, time.Now,
map[string]string{unknownCountryLimitPercent: "0"}) map[string]string{unknownCountryLimitPercent: "0"})
@@ -392,8 +390,6 @@ func TestRequestWaitsForItsLookupWhileABiasedThresholdIsSet(t *testing.T) {
// with a GeoJS that never answers. The headers, which need the // with a GeoJS that never answers. The headers, which need the
// answer too, are off. // answer too, are off.
synctest.Test(t, func(t *testing.T) { synctest.Test(t, func(t *testing.T) {
defer waitForGeoJSRequestsToBeAbandoned()
server, out, _ := newWAF(t, silentGeoJSURL, time.Now, server, out, _ := newWAF(t, silentGeoJSURL, time.Now,
map[string]string{ map[string]string{
asnAndCountryLookupTimeout: strconv.FormatInt( asnAndCountryLookupTimeout: strconv.FormatInt(
+6 -26
View File
@@ -7,9 +7,8 @@ import (
"strings" "strings"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/config" "sneak.berlin/go/smallwebwaf/internal/config"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
) )
// The headers in which an answer of allow gives rproxy the client's AS number // The headers in which an answer of allow gives rproxy the client's AS number
@@ -27,9 +26,9 @@ const (
// SWW_WAF_LOOKUP_SOURCE is off or the client is on a private, loopback or // SWW_WAF_LOOKUP_SOURCE is off or the client is on a private, loopback or
// link-local address, which no lookup can place. The lookup database // link-local address, which no lookup can place. The lookup database
// answers at once. With GeoJS, while a setting needs the answer, such as a // answers at once. With GeoJS, while a setting needs the answer, such as a
// country list or a biased threshold, a new client's request waits for it up // country list or a biased threshold, a new client's request waits for it,
// to SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS, unless refusedWhateverTheAnswer // unless refusedWhateverTheAnswer reports true. ctx is the request's own
// reports true. ctx is the request's own context. // context.
func (rq *request) lookUp(ctx context.Context, now time.Time) { func (rq *request) lookUp(ctx context.Context, now time.Time) {
if rq.h.config.LookupSource == "off" || !canBePlaced(rq.client) { if rq.h.config.LookupSource == "off" || !canBePlaced(rq.client) {
return return
@@ -43,11 +42,8 @@ func (rq *request) lookUp(ctx context.Context, now time.Time) {
case rq.refusedWhateverTheAnswer(now): case rq.refusedWhateverTheAnswer(now):
rq.lookupAnswer = rq.h.geojs.LookUpWithoutWaiting(ctx, client) rq.lookupAnswer = rq.h.geojs.LookUpWithoutWaiting(ctx, client)
rq.skippedLookupWait = rq.lookupAnswer.Answered.IsZero() rq.skippedLookupWait = rq.lookupAnswer.Answered.IsZero()
case !rq.h.waitForGeoJS:
rq.lookupAnswer = rq.h.geojs.LookUpWithoutWaiting(ctx, client)
default: default:
rq.lookupAnswer = rq.h.geojs.LookUp(ctx, client, rq.lookupAnswer = rq.h.geojs.LookUp(ctx, client)
rq.h.config.ASNAndCountryLookupTimeout)
} }
rq.lookedUp = true rq.lookedUp = true
@@ -87,29 +83,13 @@ func countryTag(country string) string {
// addLookup adds answer, an answer about a client from the lookup // addLookup adds answer, an answer about a client from the lookup
// database or GeoJS, to the client's history, and to the notes of the bans // database or GeoJS, to the client's history, and to the notes of the bans
// on its netblock that have no AS number, AS name or country yet. // on its netblock that have no AS number, AS name or country yet.
func (h *handler) addLookup(answer geojs.Answer) { func (h *handler) addLookup(answer lookup.Answer) {
h.limiter.AddLookup(answer.Client, answer.Answered, h.limiter.AddLookup(answer.Client, answer.Answered,
answer.ASN, answer.ASName, answer.Country) answer.ASN, answer.ASName, answer.Country)
h.ledger.AddLookup(h.netblock(answer.Client.Addr()), h.ledger.AddLookup(h.netblock(answer.Client.Addr()),
answer.ASN, answer.ASName, answer.Country) answer.ASN, answer.ASName, answer.Country)
} }
// geojsFailed logs a failure of GeoJS, raises a source_failure alert for it
// and counts it. askingAgainIn is how long GeoJS is left alone after it.
func (h *handler) geojsFailed(err error, askingAgainIn time.Duration) {
h.processLog.Warn("asking GeoJS failed",
"error", err.Error(), "asking_again_in", askingAgainIn.String())
h.alerts.Raise(alerts.Alert{
Event: alerts.EventSourceFailure,
Reason: "asking GeoJS failed",
Detail: map[string]any{
"source": "geojs", "error": err.Error(),
"asking_again_in": askingAgainIn.String(),
},
})
h.metrics.GeoJSFailures.Inc()
}
// setLookupHeaders sets the headers that give the client's AS number and // setLookupHeaders sets the headers that give the client's AS number and
// country, leaving out one that is unknown. // country, leaving out one that is unknown.
func setLookupHeaders(header http.Header, asn, country string) { func setLookupHeaders(header http.Header, asn, country string) {
+4 -17
View File
@@ -12,7 +12,7 @@ import (
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/alerts" "sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest" "sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest"
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
@@ -138,7 +138,7 @@ func TestRequestThatWaitedForItsLookupIsCountedWhenItGoesOn(t *testing.T) {
// of lookups.json would keep it, while the first request still waits // of lookups.json would keep it, while the first request still waits
// for GeoJS. The second request goes on at once, and is counted. // for GeoJS. The second request goes on at once, and is counted.
clk.advance(2500 * time.Millisecond) clk.advance(2500 * time.Millisecond)
server.GeoJS.Load([]geojs.Answer{{ server.GeoJS.Load([]lookup.Answer{{
Client: netip.MustParsePrefix( Client: netip.MustParsePrefix(
fromDE + "/32", fromDE + "/32",
), ASN: asnDE, ASName: asNameDE, ), ASN: asnDE, ASName: asNameDE,
@@ -199,7 +199,7 @@ func TestASNumberAndNameInTheLogLineTheHistoryTheBanNotesAndTheAlert(
// The answer is kept before the requests, so GeoJS is not asked, and // The answer is kept before the requests, so GeoJS is not asked, and
// gives no answer of its own. // gives no answer of its own.
netblock := netip.MustParsePrefix(fromDE + "/32") netblock := netip.MustParsePrefix(fromDE + "/32")
server.GeoJS.Load([]geojs.Answer{{ server.GeoJS.Load([]lookup.Answer{{
Client: netblock, ASN: asnDE, ASName: asNameDE, Country: "DE", Client: netblock, ASN: asnDE, ASName: asNameDE, Country: "DE",
Answered: clk.Now(), Used: clk.Now(), Answered: clk.Now(), Used: clk.Now(),
}}) }})
@@ -249,7 +249,7 @@ func TestLookupSourceOffLooksNoClientUp(t *testing.T) {
) )
// Even an answer kept from before is not used. // Even an answer kept from before is not used.
server.GeoJS.Load([]geojs.Answer{{ server.GeoJS.Load([]lookup.Answer{{
Client: netip.MustParsePrefix( Client: netip.MustParsePrefix(
fromDE + "/32", fromDE + "/32",
), ASN: asnDE, ASName: asNameDE, ), ASN: asnDE, ASName: asNameDE,
@@ -450,8 +450,6 @@ func TestRequestWaitsAsLongAsTheASNAndCountryLookupTimeoutSays(
// network, which would keep that clock from moving on: the request is // network, which would keep that clock from moving on: the request is
// handed to waf's handler, and GeoJS is one that never answers. // handed to waf's handler, and GeoJS is one that never answers.
synctest.Test(t, func(t *testing.T) { synctest.Test(t, func(t *testing.T) {
defer waitForGeoJSRequestsToBeAbandoned()
// Not the default. The exclusive list needs the answer, and the app // Not the default. The exclusive list needs the answer, and the app
// is never reached. // is never reached.
const timeout = 3 * time.Second const timeout = 3 * time.Second
@@ -497,17 +495,6 @@ func TestMain(m *testing.M) {
m.Run() m.Run()
} }
// geojsRequestTimeout is how long a request to GeoJS may take before it is
// abandoned.
const geojsRequestTimeout = 10 * time.Second
// waitForGeoJSRequestsToBeAbandoned sleeps until every request to the GeoJS at
// silentGeoJSURL made so far has been abandoned. A synctest bubble that asks
// it defers this: the bubble cannot end while a request waits on it.
func waitForGeoJSRequestsToBeAbandoned() {
time.Sleep(geojsRequestTimeout)
}
// silentGeoJS is the GeoJS at silentGeoJSURL. // silentGeoJS is the GeoJS at silentGeoJSURL.
type silentGeoJS struct{} type silentGeoJS struct{}
+14 -50
View File
@@ -1,7 +1,6 @@
package waf_test package waf_test
import ( import (
"fmt"
"io" "io"
"net/http" "net/http"
"net/http/httptest" "net/http/httptest"
@@ -11,9 +10,8 @@ import (
"testing" "testing"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/alerts"
"sneak.berlin/go/smallwebwaf/internal/bans" "sneak.berlin/go/smallwebwaf/internal/bans"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
"sneak.berlin/go/smallwebwaf/internal/waf" "sneak.berlin/go/smallwebwaf/internal/waf"
) )
@@ -250,7 +248,7 @@ func TestMetricsByCountryKeepTheBusiestAndCountTheRestAsOther(t *testing.T) {
// The answers are kept before the requests, so that none waits for // The answers are kept before the requests, so that none waits for
// GeoJS. // GeoJS.
server.GeoJS.Load([]geojs.Answer{ server.GeoJS.Load([]lookup.Answer{
keptAnswer(fromKP, "KP"), keptAnswer(fromDE, "DE"), keptAnswer(fromKP, "KP"), keptAnswer(fromDE, "DE"),
keptAnswer(fromFR, "FR"), keptAnswer(fromFR, "FR"),
}) })
@@ -331,13 +329,13 @@ func TestMetricsByASNumberKeepTheBusiestAndCountTheRestAsOther(
// The answers are kept before the requests, so that GeoJS gives none // The answers are kept before the requests, so that GeoJS gives none
// of its own. Each client is in an AS of its own. // of its own. Each client is in an AS of its own.
answer := func(addr, asn string) geojs.Answer { answer := func(addr, asn string) lookup.Answer {
return geojs.Answer{ return lookup.Answer{
Client: netip.MustParsePrefix(addr + "/32"), ASN: asn, Client: netip.MustParsePrefix(addr + "/32"), ASN: asn,
Answered: clk.Now(), Used: clk.Now(), Answered: clk.Now(), Used: clk.Now(),
} }
} }
server.GeoJS.Load([]geojs.Answer{ server.GeoJS.Load([]lookup.Answer{
answer(fromDE, "AS64501"), answer(fromKP, "AS64502"), answer(fromDE, "AS64501"), answer(fromKP, "AS64502"),
}) })
@@ -359,23 +357,21 @@ func TestMetricsByASNumberKeepTheBusiestAndCountTheRestAsOther(
`sww_asn_requests_total{asn="AS64502",instance="app"}`) `sww_asn_requests_total{asn="AS64502",instance="app"}`)
} }
func TestGeoJSFailureIsCountedLoggedAndAlerted(t *testing.T) { func TestMetricsCountGeoJSRequestsAndFailures(t *testing.T) {
t.Parallel() t.Parallel()
failingGeoJS := httptest.NewServer(http.HandlerFunc( geojs := httptest.NewServer(http.HandlerFunc(
func(w http.ResponseWriter, _ *http.Request) { func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusServiceUnavailable) w.WriteHeader(http.StatusServiceUnavailable)
})) }))
t.Cleanup(failingGeoJS.Close) t.Cleanup(geojs.Close)
app := startApp(t, func(http.ResponseWriter, *http.Request) {}) app := startApp(t, func(http.ResponseWriter, *http.Request) {})
addr, out, server, queue := startProxyWithAlerts(t, app.URL, addr, _, server := startProxyWithClock(t, app.URL, geojs.URL, time.Now,
failingGeoJS.URL, time.Now,
map[string]string{ map[string]string{
trustedProxies: trustLocalhost, trustedProxies: trustLocalhost,
metricsToken: token, metricsToken: token,
tagDeny: denyKP, tagDeny: denyKP,
alertWebhookURL: "https://alerts.example/waf",
}) })
// GeoJS fails, so the client has no country= tag, and SWW_WAF_TAG_DENY does // GeoJS fails, so the client has no country= tag, and SWW_WAF_TAG_DENY does
@@ -405,46 +401,14 @@ func TestGeoJSFailureIsCountedLoggedAndAlerted(t *testing.T) {
`sww_requests_without_geojs_answer_total{instance="app"}`, `sww_requests_without_geojs_answer_total{instance="app"}`,
1, 1,
) )
// The process log's line names the failure but not the address asked
// about.
logged := ""
for line := range strings.Lines(out.text()) {
if strings.Contains(line, "asking GeoJS failed") {
logged = line
}
}
if logged == "" || strings.Contains(logged, fromDE) {
t.Errorf(
"logged %q, want the failure without the address asked about",
logged,
)
}
// fmt prints a map sorted by its keys.
const want = "map[asking_again_in:1s " +
"error:GeoJS answered 503 Service Unavailable source:geojs]"
waiting := queue.Snapshot().Waiting[alerts.DestinationWebhook]
if len(waiting) != 1 || waiting[0].Event != alerts.EventSourceFailure ||
waiting[0].Reason != "asking GeoJS failed" ||
fmt.Sprint(waiting[0].Detail) != want {
t.Errorf(
"alerts waiting %+v, want one source_failure alert with %v",
waiting,
want,
)
}
} }
// keptAnswer returns GeoJS's answer that the client at addr is in // keptAnswer returns GeoJS's answer that the client at addr is in
// country, given now. // country, given now.
func keptAnswer(addr, country string) geojs.Answer { func keptAnswer(addr, country string) lookup.Answer {
now := time.Now() now := time.Now()
return geojs.Answer{ return lookup.Answer{
Client: netip.MustParsePrefix(addr + "/32"), Country: country, Client: netip.MustParsePrefix(addr + "/32"), Country: country,
Answered: now, Used: now, Answered: now, Used: now,
} }
+31 -28
View File
@@ -17,7 +17,6 @@ import (
"sneak.berlin/go/smallwebwaf/internal/bans" "sneak.berlin/go/smallwebwaf/internal/bans"
"sneak.berlin/go/smallwebwaf/internal/config" "sneak.berlin/go/smallwebwaf/internal/config"
"sneak.berlin/go/smallwebwaf/internal/coreruleset" "sneak.berlin/go/smallwebwaf/internal/coreruleset"
"sneak.berlin/go/smallwebwaf/internal/geojs"
"sneak.berlin/go/smallwebwaf/internal/lookup" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/metrics" "sneak.berlin/go/smallwebwaf/internal/metrics"
"sneak.berlin/go/smallwebwaf/internal/ratelimit" "sneak.berlin/go/smallwebwaf/internal/ratelimit"
@@ -56,7 +55,7 @@ type Params struct {
// ProcessLog receives the process's own messages. // ProcessLog receives the process's own messages.
ProcessLog *slog.Logger ProcessLog *slog.Logger
// GeoJSURL is where clients' AS numbers and countries are looked up // GeoJSURL is where clients' AS numbers and countries are looked up
// while SWW_WAF_LOOKUP_SOURCE is geojs, normally geojs.URL. // while SWW_WAF_LOOKUP_SOURCE is geojs, normally lookup.URL.
GeoJSURL string GeoJSURL string
// AbuseIPDBURL is where clients are checked with AbuseIPDB while // AbuseIPDBURL is where clients are checked with AbuseIPDB while
// SWW_WAF_ABUSEIPDB_KEY is set, normally reputation.AbuseIPDBURL. // SWW_WAF_ABUSEIPDB_KEY is set, normally reputation.AbuseIPDBURL.
@@ -94,7 +93,7 @@ type Server struct {
Ledger *bans.Ledger Ledger *bans.Ledger
Limiter *ratelimit.Limiter Limiter *ratelimit.Limiter
GeoJS *geojs.GeoJS GeoJS *lookup.GeoJS
Anomalies *anomaly.Counters Anomalies *anomaly.Counters
LookupFile *lookup.File LookupFile *lookup.File
Lists *reputation.Lists Lists *reputation.Lists
@@ -165,19 +164,20 @@ func newHandler(params Params) *handler {
}) })
} }
// The country list, the headers, the tag settings that name an asn= or h.geojs = lookup.New(lookup.Params{
// country= tag and the biased thresholds act on the answer before the URL: params.GeoJSURL,
// request goes on. Timeout: params.Config.ASNAndCountryLookupTimeout,
h.waitForGeoJS = len(params.Config.ExclusivelyAllowedCountries) > 0 || // The country list, the headers, the tag settings that name an asn=
params.Config.AddLookupHeaders || params.Config.TagsNeedLookup() || // or country= tag and the biased thresholds act on the answer before
biasedThresholdsSet(params.Config) // the request goes on.
h.geojs = geojs.New(geojs.Params{ Wait: len(params.Config.ExclusivelyAllowedCountries) > 0 ||
URL: params.GeoJSURL, params.Config.AddLookupHeaders || params.Config.TagsNeedLookup() ||
Answered: h.addLookup, biasedThresholdsSet(params.Config),
Now: params.Now, Answered: h.addLookup,
Asked: m.GeoJSRequests.Inc, Now: params.Now,
Failed: h.geojsFailed, ProcessLog: params.ProcessLog,
WentWithoutAnswer: m.RequestsWithoutGeoJSAnswer.Inc, Metrics: m,
Alerts: params.Alerts,
}) })
m.AddBansAndClients(h.ledger, h.limiter, params.Now) m.AddBansAndClients(h.ledger, h.limiter, params.Now)
m.AddRules(params.Rules) m.AddRules(params.Rules)
@@ -228,9 +228,12 @@ 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. An exclusions file that // or nil while SWW_WAF_CORE_RULE_SET_MODE is off. It
// coreruleset.New refuses is an error in every mode. While the mode is off, a // reads at most QuestionBodyMaxBytes less one byte: a question's body of
// set file is loaded with the Core Rule Set only to check it. // QuestionBodyMaxBytes may be cut short, and the Core Rule Set does not read a
// 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 == "" {
@@ -238,11 +241,14 @@ 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: cfg.CoreRuleSetBodyInspectionSize, BodyInspectionSize: min(
ExclusionsFile: cfg.CoreRuleSetExclusionsFile, cfg.CoreRuleSetBodyInspectionSize,
Apps: cfg.Apps, QuestionBodyMaxBytes-1,
),
ExclusionsFile: cfg.CoreRuleSetExclusionsFile,
Apps: cfg.Apps,
}) })
if err != nil { if err != nil {
return nil, fmt.Errorf( return nil, fmt.Errorf(
@@ -268,7 +274,7 @@ type handler struct {
metrics *metrics.Metrics metrics *metrics.Metrics
limiter *ratelimit.Limiter limiter *ratelimit.Limiter
ledger *bans.Ledger ledger *bans.Ledger
geojs *geojs.GeoJS geojs *lookup.GeoJS
anomalies *anomaly.Counters anomalies *anomaly.Counters
lookupFile *lookup.File lookupFile *lookup.File
lists *reputation.Lists lists *reputation.Lists
@@ -278,9 +284,6 @@ type handler struct {
rules *rules.Files rules *rules.Files
coreRuleSet *coreruleset.CoreRuleSet coreRuleSet *coreruleset.CoreRuleSet
alerts *alerts.Queue alerts *alerts.Queue
// waitForGeoJS is true when a setting needs each request's answer from
// GeoJS before the request goes on.
waitForGeoJS bool
// awaitingReport holds the decision on each answered question by its id // awaitingReport holds the decision on each answered question by its id
// until its report comes, and nil for a question still being handled. // until its report comes, and nil for a question still being handled.
awaitingReport *lru.Cache[string, *decision] awaitingReport *lru.Cache[string, *decision]
+2 -2
View File
@@ -5,7 +5,7 @@ import (
"sync/atomic" "sync/atomic"
"testing" "testing"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/ratelimit" "sneak.berlin/go/smallwebwaf/internal/ratelimit"
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
@@ -162,7 +162,7 @@ func TestRateLimitExemptPathsAreNeitherCountedNorRefused(t *testing.T) {
// The answers are kept before the requests, so that none waits for // The answers are kept before the requests, so that none waits for
// GeoJS. // GeoJS.
server.GeoJS.Load([]geojs.Answer{ server.GeoJS.Load([]lookup.Answer{
keptAnswer(client, "DE"), keptAnswer(fromKP, "KP"), keptAnswer(client, "DE"), keptAnswer(fromKP, "KP"),
}) })
+4 -4
View File
@@ -11,7 +11,7 @@ import (
"sneak.berlin/go/smallwebwaf/internal/anomaly" "sneak.berlin/go/smallwebwaf/internal/anomaly"
"sneak.berlin/go/smallwebwaf/internal/bans" "sneak.berlin/go/smallwebwaf/internal/bans"
"sneak.berlin/go/smallwebwaf/internal/config" "sneak.berlin/go/smallwebwaf/internal/config"
"sneak.berlin/go/smallwebwaf/internal/geojs" "sneak.berlin/go/smallwebwaf/internal/lookup"
"sneak.berlin/go/smallwebwaf/internal/ratelimit" "sneak.berlin/go/smallwebwaf/internal/ratelimit"
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
"sneak.berlin/go/smallwebwaf/internal/rules" "sneak.berlin/go/smallwebwaf/internal/rules"
@@ -42,7 +42,7 @@ type decision struct {
// looked up, whether or not an answer was there, and lookupAnswer is // looked up, whether or not an answer was there, and lookupAnswer is
// what the lookup gave then, the zero Answer while GeoJS had given none. // what the lookup gave then, the zero Answer while GeoJS had given none.
lookedUp bool lookedUp bool
lookupAnswer geojs.Answer lookupAnswer lookup.Answer
// skippedLookupWait is true for a request that did not wait for GeoJS and // skippedLookupWait is true for a request that did not wait for GeoJS and
// found no answer kept. SWW_WAF_UNKNOWN_COUNTRY_LIMIT_PERCENT does not apply to it, // found no answer kept. SWW_WAF_UNKNOWN_COUNTRY_LIMIT_PERCENT does not apply to it,
// so that not waiting never lowers its client's limits. // so that not waiting never lowers its client's limits.
@@ -382,9 +382,9 @@ func anomalyThresholdsSet(cfg *config.WAF) bool {
// answer about it as the request ends, and whether there is one: the // answer about it as the request ends, and whether there is one: the
// lookup database's, which was there at once, or the one GeoJS has given // lookup database's, which was there at once, or the one GeoJS has given
// by then, which a request does not wait for unless a setting needs it. // by then, which a request does not wait for unless a setting needs it.
func (rq *request) answerAtTheEnd() (geojs.Answer, bool) { func (rq *request) answerAtTheEnd() (lookup.Answer, bool) {
if !rq.lookedUp { if !rq.lookedUp {
return geojs.Answer{}, false return lookup.Answer{}, false
} }
if rq.h.config.LookupSource == "file" { if rq.h.config.LookupSource == "file" {
+1 -1
View File
@@ -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 = "host1/blog" instance = "fsn1app1/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"
+4 -4
View File
@@ -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: "8K", coreRuleSetMode: block, coreRuleSetBodyInspectionSize: "64K",
}) })
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 8 KiB of a longer JSON body cannot be parsed, which is no // The first 64 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", 8<<10) cut := `{"text":"` + strings.Repeat("x", waf.QuestionBodyMaxBytes)
got = ask("application/json", cut) got = ask("application/json", cut[:waf.QuestionBodyMaxBytes])
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow) wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
} }
+6 -12
View File
@@ -2,9 +2,8 @@
# 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. DOCKER_HOST names the Docker host and # tests and the linter run first. The host and the registry name are
# PUBLISH_IMAGE the image in the registry. Both must be set; neither has # environment variables with defaults, for running it against another.
# 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
@@ -14,16 +13,11 @@ 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)"
main() { : "${DOCKER_HOST:=ssh://root@fsn1app1}"
if [ -z "${DOCKER_HOST:-}" ]; then : "${PUBLISH_IMAGE:=git.eeqj.de/sneak/smallwebwaf}"
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 export DOCKER_HOST
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
main() {
cd "$ROOT" cd "$ROOT"
# Own line: a failing command substitution inside an argument does # Own line: a failing command substitution inside an argument does