Compare commits

..
Author SHA1 Message Date
sneak a3e86333f7 Docs: rproxy runs behind any TLS-terminating reverse proxy (closes #388)
check / check (push) Successful in 6m50s
README, SPEC and docs no longer present traefik as the required front
proxy, and call it the TLS-terminating proxy. The README section of that
name lists what the proxy must do: forward plain HTTP to port 8080, keep
Host, set X-Forwarded-For and X-Forwarded-Proto, close an unused
connection in under 120 seconds, and connect from an address in
SWW_RPROXY_TRUSTED_PROXIES. traefik, Caddy and nginx appear as examples,
with the Caddy and nginx settings their defaults lack.

Model: opus-5-5
2026-11-14 17:17:10 +00:00
36 changed files with 219 additions and 1203 deletions

No files matched your search

+14 -43
View File
@@ -2,20 +2,7 @@
`smallwebwaf` is an MIT-licensed web application firewall, written in Go by `smallwebwaf` is an MIT-licensed web application firewall, written in Go by
[@sneak](https://sneak.berlin), for self-hosted web apps. It refuses the [@sneak](https://sneak.berlin), for self-hosted web apps. It refuses the
requests of misbehaving scrapers, scanners and other abusers before they reach requests of scrapers, scanners and other abusers before they reach an app.
an app.
With the default settings, a client is banned when it does any of these:
- makes more than 120 requests in a minute, 1500 in an hour or 6000 in a day;
- moves more than `50G` of request and response bodies in an hour, or `100G` in
a day;
- asks for a secret or backup file, such as `/.env` or `/.git/config`;
- sends a user agent that names a security scanner, such as `sqlmap` or `nikto`;
- has more than 30 requests in a minute refused as probes or attacks.
A scraper that does none of these is left alone. A scraper that waits 15 seconds
between requests stays under the rate limits.
## What it does ## What it does
@@ -26,7 +13,7 @@ shipped in one image, with two commands that do this together:
- `sww rproxy` is a small reverse proxy in front of one app. It sits behind a - `sww rproxy` is a small reverse proxy in front of one app. It sits behind a
TLS-terminating proxy, such as traefik, nginx or Caddy. It asks `waf` about TLS-terminating proxy, such as traefik, nginx or Caddy. It asks `waf` about
each request, passes the allowed ones to the app, and passes the app's answers each request, passes the allowed ones to the app, and passes the app's answers
back. It writes nothing to disk. back. It keeps nothing between requests and writes nothing to disk.
- `sww waf` decides. It runs the checks and keeps the bans, the counters and - `sww waf` decides. It runs the checks and keeps the bans, the counters and
each client's history. One `waf` serves many sites: a client banned through each client's history. One `waf` serves many sites: a client banned through
one site is refused on all of them, and its requests on all of them count one site is refused on all of them, and its requests on all of them count
@@ -35,26 +22,7 @@ shipped in one image, with two commands that do this together:
The site keeps answering while `waf` is down, slow or restarting: without an The site keeps answering while `waf` is down, slow or restarting: without an
answer in time, `rproxy` passes the request to the app. answer in time, `rproxy` passes the request to the app.
`rproxy` also protects the app on its own, whether or not `waf` answers. With It protects against:
the default settings, `rproxy`:
- answers `400` to a malformed request, such as a broken header line or a
missing `Host`;
- answers `405` to a method it does not pass on, such as `TRACE`;
- answers `431` to a request line and headers over 32 KiB together;
- gives the visitor 60 seconds to send the request line and headers, and then 60
seconds more for the whole request to reach the app;
- answers `413` to a request body over 100 MiB;
- gives the app's answer 30 minutes to reach the visitor, counted from the end
of the request;
- answers `502` in place of an app's answer whose body is over 1 GiB, or cuts it
off if it has started;
- closes a kept-open connection after 120 seconds idle.
`rproxy` does not limit the number of headers. `waf` limits the number of
headers and cookies, and the length of the request line and of each header line.
Together, `rproxy` and `waf` protect against:
- Scrapers that fetch every page of a site, all day. Each client gets a limit on - Scrapers that fetch every page of a site, all day. Each client gets a limit on
requests and on body bytes per minute, per hour and per day. The defaults requests and on body bytes per minute, per hour and per day. The defaults
@@ -76,6 +44,8 @@ Together, `rproxy` and `waf` protect against:
limit, so that they are banned sooner; limit, so that they are banned sooner;
- refuse or limit clients on a blocklist, a DNS blocklist, or with a high - refuse or limit clients on a blocklist, a DNS blocklist, or with a high
AbuseIPDB score. AbuseIPDB score.
- Slow and oversized requests. Every request and every answer has a time limit
and a size limit.
For the operator, it: For the operator, it:
@@ -298,13 +268,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 +299,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` | `500` | 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_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 +318,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 +500,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.
@@ -818,9 +788,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;
+31 -73
View File
@@ -704,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.
@@ -2398,19 +2397,21 @@ 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
`rproxy` stops waiting for `waf` after `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`, by `rproxy` stops waiting for `waf` after `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`, by
default 2 seconds, and `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` then default 2 seconds, and `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` then
decides. The longest a question waits on an outside source is decides. The longest a question waits on an outside source is
`SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS`, by default 500 milliseconds, well `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS`, by default 800 milliseconds, well
within that time. 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 500 milliseconds. A `SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS`, by default 800 milliseconds. A
client without an answer by then counts as unknown. No question waits on these, client without an answer by then counts as unknown. No question waits on these,
which run in the background: which run in the background:
@@ -2451,11 +2452,8 @@ It refuses a request with `431` for any of:
- a header line longer than 8 KiB. Each value of a header sent twice is a line - a header line longer than 8 KiB. Each value of a header sent twice is a line
of its own. `Host` counts as a line. of its own. `Host` counts as a line.
- more than one `Cookie` line. A browser sends all its cookies on one line, as - more than 50 cookies. Each part of its `Cookie` headers between semicolons
RFC 6265 requires. Go's server joins the `Cookie` lines of an HTTP/2 request counts as one, unless it is empty or only spaces and tabs.
into one before `rproxy` sees them.
- more than 50 cookies. Each part of its `Cookie` line between semicolons counts
as one, unless it is empty or only spaces and tabs.
- more than 100 header fields. A header sent twice counts twice. `Host` and - more than 100 header fields. A header sent twice counts twice. `Host` and
`Transfer-Encoding` do not count. `X-Request-ID` and `X-Forwarded-Proto` do. `Transfer-Encoding` do not count. `X-Request-ID` and `X-Forwarded-Proto` do.
@@ -2476,27 +2474,11 @@ 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
"`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, even with every core busy. Its share of the default 2
seconds is 1.3 seconds: the rest is the default 500 milliseconds of waiting for
GeoJS and 200 milliseconds for the other checks. So `waf` answers it in time.
Enough such requests at once can still overload `waf` past
`SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`. `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`.
### The report ### The report
@@ -2601,11 +2583,11 @@ request and ban notes name the site by its host.
## `rproxy` ## `rproxy`
`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 keeps nothing between requests and
thing it keeps between requests is its circuit breaker for asks to `waf`. writes nothing to disk. When `waf` cannot be connected to, does not answer at
`SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` decides what is done with a all, or does not answer within `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`,
request when `waf` gives no answer in time, and while the circuit breaker is `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` decides. Its default, `allow`,
open. Its default, `allow`, keeps the site answering. 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
@@ -2623,8 +2605,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`.
@@ -2698,24 +2679,23 @@ log line has status `0`.
### Without an answer from `waf` ### Without an answer from `waf`
`SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` decides what is done with the `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` decides what is done with the
request when `waf`: request only when `waf`:
- cannot be connected to; - cannot be connected to;
- does not answer at all; - does not answer at all;
- does not answer within `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`, which covers - does not answer within `SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS`, which covers
connecting, sending the question and reading the whole answer. connecting, sending the question and reading the whole answer.
An answer whose body breaks off counts as no answer at all. The setting also An answer whose body breaks off counts as no answer at all.
decides, without asking `waf`, while the circuit breaker is open.
`allow`, the default, passes the request to the app. `deny` answers `503`. `allow`, the default, passes the request to the app. `deny` answers `503`.
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.
@@ -2730,28 +2710,6 @@ A visitor that goes away while `waf` is being asked is no failure of `waf`.
`SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` does not apply. Its log line has `SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` does not apply. Its log line has
status `0` and no `disposition`. status `0` and no `disposition`.
### The circuit breaker
`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
`waf`"), or an answer `rproxy` cannot pass on. Any other answer in time
succeeds, whatever it decides. A visitor that goes away while `waf` is being
asked counts as neither.
The breaker works like this:
- It opens when 5 asks fail within 5 seconds. Fewer failures never open it.
- While it is open, a request gets
`SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION` at once, without asking `waf`.
It gets the same process warning and `waf_backend_no_answer` as a request
whose ask failed.
- While it is open, one request a second still asks `waf`.
- Each ask that succeeds clears the failures counted so far, and closes the
breaker if it is open.
The breaker lives in memory, and a restart of `rproxy` closes it. It has no
settings.
### Passing a request to the app ### Passing a request to the app
`rproxy` sends the app at `SWW_RPROXY_UPSTREAM_URL` the visitor's request: the `rproxy` sends the app at `SWW_RPROXY_UPSTREAM_URL` the visitor's request: the
@@ -3025,8 +2983,8 @@ host directory, keeps them across deploys. A host directory mounted there needs
no change of owner, and files an earlier owner left in it can be read and no change of owner, and files an earlier owner left in it can be read and
replaced. The volume holds a few tens of MiB at most with the defaults, and replaced. The volume holds a few tens of MiB at most with the defaults, and
needs no backup beyond the host's own. The image declares no volume, since every needs no backup beyond the host's own. The image declares no volume, since every
app image built on it would inherit it. `rproxy` writes nothing to disk, and app image built on it would inherit it. `rproxy` keeps nothing, and needs no
needs no volume. volume.
`waf` keeps its cache files in `SWW_WAF_CACHE_DIR`, `/var/cache/sww` by default, `waf` keeps its cache files in `SWW_WAF_CACHE_DIR`, `/var/cache/sww` by default,
which the `run` script makes. The cache directory needs no volume and can be which the `run` script makes. The cache directory needs no volume and can be
+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;
+4 -5
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
@@ -128,8 +128,8 @@ Every one of these lines has:
- `rule_files`: `rule_id` and `rule_action`, of the rule that refused it; - `rule_files`: `rule_id` and `rule_action`, of the rule that refused it;
- `header_limits`: for a request line, `request_line_bytes` and - `header_limits`: for a request line, `request_line_bytes` and
`request_line_bytes_limit`; for headers, `longest_header_line_bytes`, `request_line_bytes_limit`; for headers, `longest_header_line_bytes`,
`header_line_bytes_limit`, `fields`, `fields_limit`, `cookie_lines`, `header_line_bytes_limit`, `fields`, `fields_limit`, `cookies` and
`cookie_lines_limit`, `cookies` and `cookies_limit`; `cookies_limit`;
- `core_rule_set`: `score`, and `threshold`, - `core_rule_set`: `score`, and `threshold`,
`SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD`; `SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD`;
- `refusal_limit`: `window`, `count` and `limit`, of the refusal limit; - `refusal_limit`: `window`, `count` and `limit`, of the refusal limit;
@@ -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`.
+13 -14
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`.
@@ -158,7 +158,7 @@ cut off; the client is banned.
- an anomaly threshold per AS number. - an anomaly threshold per AS number.
- `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 `500`): 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, and how long a request request waits for its client's first answer from GeoJS, and how long a request
to GeoJS may take. A time in milliseconds; never `off`. to GeoJS may take. A time in milliseconds; never `off`.
- `SWW_WAF_ADD_LOOKUP_HEADERS` (default `true`): `true` has `rproxy` pass the - `SWW_WAF_ADD_LOOKUP_HEADERS` (default `true`): `true` has `rproxy` pass the
@@ -251,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
@@ -422,12 +423,9 @@ A few limits are fixed rather than settings:
- at most 20,000 anomaly counters are kept; - at most 20,000 anomaly counters are kept;
- each alert destination's queue holds at most 1,000 alerts; - each alert destination's queue holds at most 1,000 alerts;
- `waf` holds at most 10,000 answered requests awaiting their reports; - `waf` holds at most 10,000 answered requests awaiting their reports;
- `waf` refuses a request with any of these (see "Answering in time" under - `waf` refuses a request with a request line or header line over 8 KiB, more
"`waf`" in [`SPEC.md`](../SPEC.md)): than 50 cookies or more than 100 header fields (see "Answering in time" under
- a request line or header line over 8 KiB; "`waf`" in [`SPEC.md`](../SPEC.md));
- more than one `Cookie` line;
- more than 50 cookies;
- more than 100 header fields;
- `rproxy` takes a request line and headers of at most 32 KiB, and closes a - `rproxy` takes a request line and headers of at most 32 KiB, and closes a
kept-open connection idle for 120 seconds; kept-open connection idle for 120 seconds;
- `rproxy` reads at most 1 MiB of the body of `waf`'s answer, and answers `502` - `rproxy` reads at most 1 MiB of the body of `waf`'s answer, and answers `502`
@@ -455,9 +453,10 @@ 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`. `allow` passes it
answers `503`. It does not apply to an answer `waf` gives, such as an error. 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",
}, },
+7 -7
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(
@@ -548,7 +548,7 @@ func WAFFromEnvironment(v *viper.Viper) (*WAF, error) {
LookupDBPath: env.value("SWW_WAF_LOOKUP_DB_PATH", ""), LookupDBPath: env.value("SWW_WAF_LOOKUP_DB_PATH", ""),
ASNAndCountryLookupTimeout: env.milliseconds( ASNAndCountryLookupTimeout: env.milliseconds(
"SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS", "SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS",
"500", "800",
), ),
ExclusivelyAllowedCountries: env.countries( ExclusivelyAllowedCountries: env.countries(
"SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES", ""), "SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES", ""),
@@ -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
+20 -22
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"
) )
@@ -286,7 +286,7 @@ func TestDefaults(t *testing.T) {
RuleFilesEnabled: true, RuleFilesEnabled: true,
}) })
wantLookupSettings(t, cfg, config.WAF{ wantLookupSettings(t, cfg, config.WAF{
LookupSource: defaultLookupSource, ASNAndCountryLookupTimeout: 500 * time.Millisecond, LookupSource: defaultLookupSource, ASNAndCountryLookupTimeout: 800 * time.Millisecond,
AddLookupHeaders: true, AddLookupHeaders: true,
}) })
wantByteLimitSettings(t, cfg, config.WAF{ wantByteLimitSettings(t, cfg, config.WAF{
@@ -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 {
@@ -1407,7 +1405,7 @@ func TestLookupSettingsAsSet(t *testing.T) {
// With no client looked up, the headers are off unless set. // With no client looked up, the headers are off unless set.
cfg = wafFromEnvironment(t, environment{lookupSource: off}) cfg = wafFromEnvironment(t, environment{lookupSource: off})
wantLookupSettings(t, cfg, config.WAF{ wantLookupSettings(t, cfg, config.WAF{
LookupSource: off, ASNAndCountryLookupTimeout: 500 * time.Millisecond, LookupSource: off, ASNAndCountryLookupTimeout: 800 * time.Millisecond,
}) })
} }
@@ -2933,7 +2931,7 @@ func TestLogsEachSettingWithItsValue(t *testing.T) {
bytesCounted: "both", bytesCounted: "both",
lookupSource: defaultLookupSource, lookupSource: defaultLookupSource,
lookupDBPath: "", lookupDBPath: "",
asnAndCountryLookupTimeout: "500", asnAndCountryLookupTimeout: "800",
addLookupHeaders: enabled, addLookupHeaders: enabled,
allowedCountries: "", allowedCountries: "",
tagLists: "", tagLists: "",
+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{},
-438
View File
@@ -1,438 +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.3 seconds 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, 500 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.3 seconds. 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 16 times it is about 1.25 seconds. With that host fully
// busy, no try of the slowest request took more than 6.7 times referenceTime.
const inspectionTimeLimitMultiple = 16
// 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. waf refuses a second Cookie line, so
// it has one, and User-Agent and Referer lines, which keep the Core Rule Set
// busier than other header lines. The JSON body of the most elements under a
// key keeps it busier than the other bodies.
func worstCaseRequests() []visitorRequest {
return append(
append(worstCaseHeaders(), worstCaseBodies()...),
visitorRequest{
name: "the longest request line, Cookie, User-Agent and " +
"Referer lines and body",
target: longestTarget()[:fullLine-len("POST HTTP/1.1")],
header: http.Header{
cookieHeader: {cookieLine(1)[:fullLine-len("Cookie: ")]},
"User-Agent": {headerValue("User-Agent", fullLine)},
"Referer": {headerValue("Referer", fullLine)},
},
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 -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 {
-82
View File
@@ -1,82 +0,0 @@
package rproxy
import (
"errors"
"sync"
"time"
)
// What opens the circuit breaker, and how often a request asks waf while it is
// open.
const (
breakerFailures = 5
breakerWindow = 5 * time.Second
breakerAskInterval = time.Second
)
// errBreakerOpen is why a request did not ask waf.
var errBreakerOpen = errors.New(
"waf is not asked while the circuit breaker is open",
)
// breaker is the circuit breaker for asks to waf. It opens when
// 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
// most one request each breakerAskInterval asks waf. Any usable answer closes
// it, whatever it decides, and forgets the failures before it.
type breaker struct {
mu sync.Mutex
// failures holds the times of the latest failed asks, oldest first, at most
// breakerFailures of them.
failures []time.Time
open bool
// lastAsk is when a request last asked waf while the breaker was open.
lastAsk time.Time
}
// mayAsk reports whether a request may ask waf at now. While the breaker is
// open, it says yes once each breakerAskInterval.
func (b *breaker) mayAsk(now time.Time) bool {
b.mu.Lock()
defer b.mu.Unlock()
if !b.open {
return true
}
if now.Sub(b.lastAsk) < breakerAskInterval {
return false
}
b.lastAsk = now
return true
}
// noteAnswer notes that an ask got an answer rproxy can use. It closes the
// breaker and forgets the failures before it.
func (b *breaker) noteAnswer() {
b.mu.Lock()
defer b.mu.Unlock()
b.open = false
b.failures = nil
}
// noteFailure notes that an ask that ended at now got no answer in time, and
// opens the breaker if breakerFailures asks have failed within breakerWindow.
func (b *breaker) noteFailure(now time.Time) {
b.mu.Lock()
defer b.mu.Unlock()
b.failures = append(b.failures, now)
if len(b.failures) > breakerFailures {
b.failures = b.failures[1:]
}
if !b.open && len(b.failures) == breakerFailures &&
now.Sub(b.failures[0]) <= breakerWindow {
b.open = true
b.lastAsk = now
}
}
-142
View File
@@ -1,142 +0,0 @@
package rproxy_test
import (
"testing"
"time"
"sneak.berlin/go/smallwebwaf/internal/rproxy"
)
// The breaker tests give the breaker each time themselves, counted from
// time.Now(), and never wait.
// fail notes count failed asks on b, one each step from at.
func fail(b *rproxy.Breaker, at time.Time, count int, step time.Duration) {
for i := range count {
b.NoteFailure(at.Add(time.Duration(i) * step))
}
}
// openBreaker returns a breaker opened at now by five failed asks, one a
// second.
func openBreaker(now time.Time) *rproxy.Breaker {
b := &rproxy.Breaker{}
fail(b, now.Add(-4*time.Second), 5, time.Second)
return b
}
func TestFourFailedAsksWithinFiveSecondsLeaveTheBreakerClosed(t *testing.T) {
t.Parallel()
now := time.Now()
b := &rproxy.Breaker{}
fail(b, now, 4, time.Second)
if !b.MayAsk(now.Add(3 * time.Second)) {
t.Error("a request may not ask, want it to")
}
}
func TestFiveFailedAsksWithinFiveSecondsOpenTheBreaker(t *testing.T) {
t.Parallel()
now := time.Now()
b := openBreaker(now)
if b.MayAsk(now) {
t.Error("a request may ask, want it not to")
}
}
func TestFiveFailedAsksOverMoreThanFiveSecondsLeaveTheBreakerClosed(
t *testing.T,
) {
t.Parallel()
now := time.Now()
b := &rproxy.Breaker{}
fail(b, now, 5, 1300*time.Millisecond)
if !b.MayAsk(now.Add(6 * time.Second)) {
t.Error("a request may not ask, want it to")
}
}
func TestAnAnswerBetweenFailedAsksKeepsTheBreakerClosed(t *testing.T) {
t.Parallel()
now := time.Now()
b := &rproxy.Breaker{}
fail(b, now, 4, 100*time.Millisecond)
b.NoteAnswer()
fail(b, now.Add(500*time.Millisecond), 4, 100*time.Millisecond)
if !b.MayAsk(now.Add(900 * time.Millisecond)) {
t.Error("a request may not ask, want it to")
}
}
func TestAnOpenBreakerLetsOneRequestAskEachSecond(t *testing.T) {
t.Parallel()
now := time.Now()
b := openBreaker(now)
for _, tc := range []struct {
after time.Duration
want bool
}{
{999 * time.Millisecond, false},
{time.Second, true},
{time.Second, false},
{1500 * time.Millisecond, false},
{2 * time.Second, true},
} {
got := b.MayAsk(now.Add(tc.after))
if got != tc.want {
t.Errorf("may ask %v after it opened: %v, want %v",
tc.after, got, tc.want)
}
}
}
func TestAFailedAskKeepsTheBreakerOpen(t *testing.T) {
t.Parallel()
opened := time.Now()
b := openBreaker(opened)
now := opened.Add(time.Second)
b.MayAsk(now)
b.NoteFailure(now)
if b.MayAsk(now.Add(999 * time.Millisecond)) {
t.Error("a request may ask, want it not to")
}
if !b.MayAsk(now.Add(time.Second)) {
t.Error("a request may not ask a second later, want it to")
}
}
func TestOneAnswerClosesTheBreaker(t *testing.T) {
t.Parallel()
opened := time.Now()
b := openBreaker(opened)
now := opened.Add(time.Second)
b.MayAsk(now)
b.NoteAnswer()
if !b.MayAsk(now) {
t.Error("a request may not ask, want it to")
}
// The failures before the answer no longer count, so one more does not open
// the breaker again.
b.NoteFailure(now)
if !b.MayAsk(now) {
t.Error("a request may not ask after one failure, want it to")
}
}
-23
View File
@@ -1,23 +0,0 @@
package rproxy
import "time"
// Breaker is the circuit breaker, for tests that give it the time.
type Breaker struct {
b breaker
}
// MayAsk reports whether a request may ask waf at now.
func (b *Breaker) MayAsk(now time.Time) bool {
return b.b.mayAsk(now)
}
// NoteAnswer notes that an ask got an answer rproxy can use.
func (b *Breaker) NoteAnswer() {
b.b.noteAnswer()
}
// NoteFailure notes that an ask that ended at now got no answer in time.
func (b *Breaker) NoteFailure(now time.Time) {
b.b.noteFailure(now)
}
+5 -8
View File
@@ -4,11 +4,10 @@
// waf goes to the visitor as waf gave it. // waf goes to the visitor as waf gave it.
// SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION decides only when waf cannot // SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION decides only when waf cannot
// be connected to, does not answer at all, or does not answer within // be connected to, does not answer at all, or does not answer within
// SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS, or while the circuit breaker for asks to // SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS. rproxy itself refuses a request with a
// waf is open. rproxy itself refuses a request with a method it does not pass // method it does not pass on, or one it cannot put to waf as the visitor
// on, or one it cannot put to waf as the visitor sent it. It keeps nothing // sent it. It keeps nothing between requests and writes nothing to disk. "rproxy" in
// between requests but the circuit breaker, and writes nothing to disk. // SPEC.md says what it does.
// "rproxy" in SPEC.md says what it does.
package rproxy package rproxy
import ( import (
@@ -133,8 +132,6 @@ type handler struct {
wafTransport http.RoundTripper wafTransport http.RoundTripper
// reportURL is where the reports go. // reportURL is where the reports go.
reportURL string reportURL string
// breaker is the circuit breaker for asks to waf.
breaker breaker
// reports waits for the reports being sent. reportsMu guards starting one // reports waits for the reports being sent. reportsMu guards starting one
// against reportsStopped, which is set once nothing is to wait for another. // against reportsStopped, which is set once nothing is to wait for another.
reports sync.WaitGroup reports sync.WaitGroup
@@ -199,7 +196,7 @@ func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
return return
} }
answer, err := rq.askUnlessBreakerOpen(r.Context()) answer, err := rq.ask(r.Context())
if err != nil { if err != nil {
rq.handleNoUsableAnswer(r.Context(), err) rq.handleNoUsableAnswer(r.Context(), err)
-158
View File
@@ -15,7 +15,6 @@ import (
"strconv" "strconv"
"strings" "strings"
"sync" "sync"
"sync/atomic"
"testing" "testing"
"time" "time"
@@ -1396,163 +1395,6 @@ func TestSendsNoReportWithoutAnAnswer(t *testing.T) {
standIn.wantNoReport(t) standIn.wantNoReport(t)
} }
func TestFiveFailedAsksKeepTheNextRequestFromAskingWAF(t *testing.T) {
t.Parallel()
for name, failure := range map[string]http.HandlerFunc{
"no answer at all": func(http.ResponseWriter, *http.Request) {
panic(http.ErrAbortHandler)
},
"a slow answer": func(_ http.ResponseWriter, r *http.Request) {
<-r.Context().Done()
},
} {
t.Run(name, func(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
}
failure(w, r)
},
)
nextID := make(chan string, 1)
app := startApp(t, func(w http.ResponseWriter, r *http.Request) {
if answering.Load() {
nextID <- r.Header.Get(requestIDHeader)
}
greet(w, r)
})
addr, out := startRProxy(
t,
standIn.URL,
app.URL,
map[string]string{
wafBackendTimeout: "200",
},
)
// 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 {
wantGreeting(t, get(t, addr, "/"))
}
// 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)
wantGreeting(t, get(t, addr, "/"))
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 {
case id = <-nextID:
default:
t.Fatal("the app did not get the next request")
}
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()
+1 -28
View File
@@ -10,7 +10,6 @@ import (
"maps" "maps"
"net/http" "net/http"
"strings" "strings"
"time"
"sneak.berlin/go/smallwebwaf/internal/waf" "sneak.berlin/go/smallwebwaf/internal/waf"
) )
@@ -68,8 +67,7 @@ func (rq *request) handleNoUsableAnswer(ctx context.Context, err error) {
rq.answer(http.StatusBadGateway) rq.answer(http.StatusBadGateway)
default: default:
// waf cannot be connected to, does not answer at all, or does not answer // waf cannot be connected to, does not answer at all, or does not answer
// within SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS; or the circuit breaker // within SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS. A request that keeps waf
// kept the request from asking. A request that keeps waf
// busy past SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS, like any request while // busy past SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS, like any request while
// waf is overloaded, gets SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION // waf is overloaded, gets SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION
// here. deny closes this, at the cost of answering 503 whenever waf is // here. deny closes this, at the cost of answering 503 whenever waf is
@@ -88,31 +86,6 @@ func (rq *request) handleNoUsableAnswer(ctx context.Context, err error) {
} }
} }
// 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
// answered in time. An answer rproxy cannot pass on counts as a failure. A
// visitor that goes away tells the breaker nothing. ctx is the request's own
// context.
func (rq *request) askUnlessBreakerOpen(
ctx context.Context,
) (*wafAnswer, error) {
b := &rq.h.breaker
if !b.mayAsk(time.Now()) {
return nil, errBreakerOpen
}
answer, err := rq.ask(ctx)
switch {
case err == nil:
b.noteAnswer()
case ctx.Err() == nil:
b.noteFailure(time.Now())
}
return answer, err
}
// ask sends waf the question, and returns its answer, which must have come // ask sends waf the question, and returns its answer, which must have come
// whole within SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS. It ends when ctx does, as // whole within SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS. It ends when ctx does, as
// when the visitor goes away. // when the visitor goes away.
+3 -3
View File
@@ -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": "",
@@ -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,
}) })
+1 -11
View File
@@ -260,17 +260,7 @@ func TestTheSiteAnswersWhileWAFIsStoppedAndStartedAgain(t *testing.T) {
stop() stop()
}() }()
// The visitor's asks have opened rproxy's circuit breaker, which lets one wantStatus(t, site+"/", placed, http.StatusForbidden)
// request a second ask until one is answered.
deadline := time.Now().Add(waitLimit)
for statusFrom(t, site+"/", placed) != http.StatusForbidden {
if time.Now().After(deadline) {
t.Fatalf("request from %s: never answered %d", placed,
http.StatusForbidden)
}
time.Sleep(pollInterval)
}
close(visitorStop) close(visitorStop)
<-visitorDone <-visitorDone
+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 -8
View File
@@ -33,7 +33,7 @@ const (
// SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS, the time waf has to answer. // SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS, the time waf has to answer.
answerTimeLimit = 2 * time.Second answerTimeLimit = 2 * time.Second
// defaultLookupWait is the default of SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS. // defaultLookupWait is the default of SWW_WAF_ASN_AND_COUNTRY_LOOKUP_TIMEOUT_MS.
defaultLookupWait = 500 * time.Millisecond defaultLookupWait = 800 * time.Millisecond
// defaultDNSBLAbuseIPDBWait is the default of SWW_WAF_DNSBL_ABUSEIPDB_TIMEOUT_MS. // defaultDNSBLAbuseIPDBWait is the default of SWW_WAF_DNSBL_ABUSEIPDB_TIMEOUT_MS.
defaultDNSBLAbuseIPDBWait = 2 * time.Second defaultDNSBLAbuseIPDBWait = 2 * time.Second
// The header limits SPEC.md gives. // The header limits SPEC.md gives.
@@ -111,8 +111,7 @@ func TestHeaderLimitRefusalNamesItsHeuristicCountsAndLimits(t *testing.T) {
s.out.requestLine(t), s.out.requestLine(t),
"header_limits", "header_limits",
`{"longest_header_line_bytes": 40, "header_line_bytes_limit": 8192, `{"longest_header_line_bytes": 40, "header_line_bytes_limit": 8192,
"fields": 101, "fields_limit": 100, "cookie_lines": 0, "fields": 101, "fields_limit": 100, "cookies": 0, "cookies_limit": 50}`,
"cookie_lines_limit": 1, "cookies": 0, "cookies_limit": 50}`,
) )
} }
@@ -199,9 +198,6 @@ func TestAHeaderLineOverTheLimitIsRefusedWith431(t *testing.T) {
{"a header line over the limit", func(req *http.Request) { {"a header line over the limit", func(req *http.Request) {
req.Header.Set("X-Long", strings.Repeat("a", lineLimit+1-len("X-Long: "))) req.Header.Set("X-Long", strings.Repeat("a", lineLimit+1-len("X-Long: ")))
}, true}, }, true},
{"a Cookie line at the limit", func(req *http.Request) {
req.Header.Set(cookieHeader, "a="+strings.Repeat("a", lineLimit-len("Cookie: a=")))
}, false},
{"one cookie over the limit", func(req *http.Request) { {"one cookie over the limit", func(req *http.Request) {
req.Header.Set(cookieHeader, "a="+strings.Repeat("a", lineLimit)) req.Header.Set(cookieHeader, "a="+strings.Repeat("a", lineLimit))
}, true}, }, true},
@@ -271,8 +267,8 @@ func TestEachHeaderLimitRefusesARequestOverIt(t *testing.T) {
{"parts of no-break spaces count", func(req *http.Request) { {"parts of no-break spaces count", func(req *http.Request) {
req.Header.Set(cookieHeader, strings.Repeat(" ;", cookieLimit+1)) req.Header.Set(cookieHeader, strings.Repeat(" ;", cookieLimit+1))
}, true}, }, true},
{"two Cookie lines", func(req *http.Request) { {"cookies over the limit across two headers", func(req *http.Request) {
req.Header[cookieHeader] = []string{"a=1", "b=1"} req.Header[cookieHeader] = []string{cookies(cookieLimit), "last=1"}
}, true}, }, true},
{"cookies without a value count", func(req *http.Request) { {"cookies without a value count", func(req *http.Request) {
req.Header.Set(cookieHeader, strings.Repeat("a;", cookieLimit+1)) req.Header.Set(cookieHeader, strings.Repeat("a;", cookieLimit+1))
+9 -16
View File
@@ -10,15 +10,11 @@ import (
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// The header limits: the most Cookie lines, cookies and header fields a request // The header limits: the most cookies and header fields a request may have,
// may have, and the longest its request line and each header line may be, in // and the longest its request line and each header line may be, in bytes, not
// bytes, not counting the line ending. Real clients rarely reach them. // counting the line ending. Real clients rarely reach them. maxLineBytes is
// maxLineBytes is what nginx allows by default. A browser sends all its cookies // what nginx allows by default.
// on one Cookie line, as RFC 6265 requires, and Go's server joins the Cookie
// lines of an HTTP/2 request into one. A second line would only give a visitor
// another 8 KiB for the Core Rule Set to read.
const ( const (
maxCookieLines = 1
maxCookies = 50 maxCookies = 50
maxHeaderFields = 100 maxHeaderFields = 100
maxLineBytes = 8 << 10 maxLineBytes = 8 << 10
@@ -26,11 +22,10 @@ const (
// headerLimits refuses a request with a request line longer than maxLineBytes, // headerLimits refuses a request with a request line longer than maxLineBytes,
// with 414. It refuses a request with a header line longer than maxLineBytes, // with 414. It refuses a request with a header line longer than maxLineBytes,
// more than maxHeaderFields header fields, more than maxCookieLines Cookie // more than maxHeaderFields header fields or more than maxCookies cookies, with
// lines or more than maxCookies cookies, with 431. Its figures are the request // 431. Its figures are the request line's length and its limit for 414. For
// line's length and its limit for 414. For 431 they are the longest header // 431 they are the longest header line, the header fields and the cookies,
// line, the header fields, the Cookie lines and the cookies, each with its // each with its limit.
// limit.
type headerLimits struct{} type headerLimits struct{}
func (headerLimits) name() string { return "header_limits" } func (headerLimits) name() string { return "header_limits" }
@@ -53,10 +48,9 @@ func (headerLimits) check(
longest := rq.longestHeaderLineBytes() longest := rq.longestHeaderLineBytes()
fields, cookies := rq.headerCounts() fields, cookies := rq.headerCounts()
cookieLines := len(rq.in.Header.Values("Cookie"))
if longest <= maxLineBytes && fields <= maxHeaderFields && if longest <= maxLineBytes && fields <= maxHeaderFields &&
cookieLines <= maxCookieLines && cookies <= maxCookies { cookies <= maxCookies {
return nil return nil
} }
@@ -66,7 +60,6 @@ func (headerLimits) check(
"longest_header_line_bytes": longest, "longest_header_line_bytes": longest,
"header_line_bytes_limit": maxLineBytes, "header_line_bytes_limit": maxLineBytes,
"fields": fields, "fields_limit": maxHeaderFields, "fields": fields, "fields_limit": maxHeaderFields,
"cookie_lines": cookieLines, "cookie_lines_limit": maxCookieLines,
"cookies": cookies, "cookies_limit": maxCookies, "cookies": cookies, "cookies_limit": maxCookies,
}, },
} }
+14 -8
View File
@@ -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(
+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)
} }
+4 -1
View File
@@ -2,6 +2,9 @@
# script/cibuild: run the CI build. It bootstraps first: a CI runner # script/cibuild: run the CI build. It bootstraps first: a CI runner
# checks out and runs this and nothing else, and script/fmt-check runs # checks out and runs this and nothing else, and script/fmt-check runs
# the formatter on the host, which a pristine checkout cannot do. # the formatter on the host, which a pristine checkout cannot do.
# --no-cache for the same reason as script/docker: the gate phases the
# final stage depends on are RUN steps, and a cached one is a check that
# did not run.
set -eu set -eu
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
@@ -17,7 +20,7 @@ main() {
# the version a build stage derives from the .git in the context. # the version a build stage derives from the .git in the context.
version="$(git describe --tags --always --dirty 2>/dev/null || true)" version="$(git describe --tags --always --dirty 2>/dev/null || true)"
[ -n "$version" ] || version="unknown" [ -n "$version" ] || version="unknown"
docker build \ docker build --no-cache \
--build-arg VERSION="$version" \ --build-arg VERSION="$version" \
-t "$("$SCRIPT_DIR/projectname")" . -t "$("$SCRIPT_DIR/projectname")" .
} }
+3 -1
View File
@@ -1,6 +1,8 @@
#!/bin/sh #!/bin/sh
# script/docker: build the Docker image tagged with the project name. # script/docker: build the Docker image tagged with the project name.
# Identical in all repos; the tag comes from script/projectname. # Identical in all repos; the tag comes from script/projectname.
# --no-cache because the gate phases the final stage depends on are RUN
# steps, and a cached one is a check that did not run.
set -eu set -eu
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
@@ -14,7 +16,7 @@ main() {
# the version a build stage derives from the .git in the context. # the version a build stage derives from the .git in the context.
version="$(git describe --tags --always --dirty 2>/dev/null || true)" version="$(git describe --tags --always --dirty 2>/dev/null || true)"
[ -n "$version" ] || version="unknown" [ -n "$version" ] || version="unknown"
docker build \ docker build --no-cache \
--build-arg VERSION="$version" \ --build-arg VERSION="$version" \
-t "$("$SCRIPT_DIR/projectname")" . -t "$("$SCRIPT_DIR/projectname")" .
} }
+2 -2
View File
@@ -170,8 +170,8 @@ main() {
trap cleanup EXIT trap cleanup EXIT
trap 'exit 1' HUP INT TERM trap 'exit 1' HUP INT TERM
docker build -t "$IMAGE" . docker build --no-cache -t "$IMAGE" .
docker build --build-arg SWW_IMAGE="$IMAGE" \ docker build --no-cache --build-arg SWW_IMAGE="$IMAGE" \
-t "$APP_IMAGE" deploy/example-app -t "$APP_IMAGE" deploy/example-app
docker network create "$NETWORK" >/dev/null docker network create "$NETWORK" >/dev/null
+3 -2
View File
@@ -5,7 +5,8 @@
# make its answer untrustworthy. # make its answer untrustworthy.
# #
# The phase is not the last stage in the file, so it is built only when # The phase is not the last stage in the file, so it is built only when
# --target names it. The tag makes each build replace the previous image # --target names it. --no-cache because a cached lint layer is a lint
# that did not run. The tag makes each build replace the previous image
# instead of leaving a dangling one behind. # instead of leaving a dangling one behind.
set -eu set -eu
@@ -14,7 +15,7 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
docker build \ docker build --no-cache \
--target lint \ --target lint \
-t "$("$SCRIPT_DIR/projectname")-lint" . -t "$("$SCRIPT_DIR/projectname")-lint" .
} }
+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
+3 -2
View File
@@ -2,7 +2,8 @@
# script/test: run the test suite. Testing is a phase of the Dockerfile # script/test: run the test suite. Testing is a phase of the Dockerfile
# and this builds that phase alone, on the same terms as script/lint: # and this builds that phase alone, on the same terms as script/lint:
# --target because a phase that is not the last stage is built only when # --target because a phase that is not the last stage is built only when
# named, and a tag so each build replaces the previous image. # named, --no-cache because a cached test layer is a test that did not
# run, and a tag so each build replaces the previous image.
set -eu set -eu
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
@@ -10,7 +11,7 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
docker build \ docker build --no-cache \
--target test \ --target test \
-t "$("$SCRIPT_DIR/projectname")-test" . -t "$("$SCRIPT_DIR/projectname")-test" .
} }
+3 -1
View File
@@ -3,13 +3,15 @@
# the test phase of the Dockerfile checks. This builds the Dockerfile's # the test phase of the Dockerfile checks. This builds the Dockerfile's
# tidy-files stage, which holds the two files alone, and --output writes # tidy-files stage, which holds the two files alone, and --output writes
# them into the working tree. The build makes no image, so it has no tag. # them into the working tree. The build makes no image, so it has no tag.
# --no-cache because `go mod tidy` asks the module proxy, whose answers a
# cached layer would repeat.
set -eu set -eu
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
main() { main() {
cd "$ROOT" cd "$ROOT"
docker build \ docker build --no-cache \
--target tidy-files \ --target tidy-files \
--output "type=local,dest=$ROOT" . --output "type=local,dest=$ROOT" .
} }