Compare commits

..
Author SHA1 Message Date
sneak 3669abe761 config: each waf setting's code in one place (closes #449)
check / check (push) Waiting to run
internal/config/waf.go is reordered by setting, in the order of the
settings sections of SPEC and docs/settings.md. The struct WAF and
WAFFromEnvironment stay first. Each setting's reader, parser, errors
and check sit together. A helper several settings share sits before
the first of them.

Moves only. The one error block and the one block of constants are
split into a block beside each user, so gofmt re-aligns the = of some
of those lines.

Model: opus-5-5
2026-11-20 00:17:29 +00:00
44 changed files with 299 additions and 383 deletions

No files matched your search

+30 -31
View File
@@ -828,8 +828,8 @@ The supported apps are:
- `vaultwarden`; - `vaultwarden`;
- `wordpress`. - `wordpress`.
Each app's fixes are in one file named for the app, such as Each app's fixes are in one file, such as `internal/coreruleset/gitea.conf`, and
`internal/coreruleset/apps/gitea.conf`. gitea's fixes are: one entry of `apps` in `internal/coreruleset/coreruleset.go`. gitea's fixes are:
1. Ten parameters are not checked against the Core Rule Set's lists of system 1. Ten parameters are not checked against the Core Rule Set's lists of system
files (930120), shell paths (932160) and command names (932260), on any path: files (930120), shell paths (932160) and command names (932260), on any path:
@@ -862,8 +862,8 @@ Each app's fixes are in one file named for the app, such as
3. On gitea's paths, some fields skip the rules that refused ordinary gitea 3. On gitea's paths, some fields skip the rules that refused ordinary gitea
requests there. They are the fields where gitea sends a search, a file's name requests there. They are the fields where gitea sends a search, a file's name
or text, a commit message, a branch name or a repository's name. or text, a commit message, a branch name or a repository's name.
`internal/coreruleset/apps/gitea.conf` lists each rule and the request it `internal/coreruleset/gitea.conf` lists each rule and the request it refused.
refused. The fields are: The fields are:
- `q` on gitea's searches of code, of issues and pull requests, and of - `q` on gitea's searches of code, of issues and pull requests, and of
commits. A code search holds code, such as `<script>`, commits. A code search holds code, such as `<script>`,
`SELECT * FROM users WHERE` or `../`. The searches of issues and pull `SELECT * FROM users WHERE` or `../`. The searches of issues and pull
@@ -1048,7 +1048,7 @@ Each app's fixes are in one file named for the app, such as
- The `Content-Range` header of an artifact upload from - The `Content-Range` header of an artifact upload from
`actions/upload-artifact@v3` (920450). `actions/upload-artifact@v3` (920450).
- The passwords in a body, for each rule that random passwords set off. The - The passwords in a body, for each rule that random passwords set off. The
numbers are in `internal/coreruleset/apps/gitea.conf`. numbers are in `internal/coreruleset/gitea.conf`.
- `password` on these paths: - `password` on these paths:
- `/user/login`, `/user/sign_up`, `/user/activate`; - `/user/login`, `/user/sign_up`, `/user/activate`;
- `/user/link_account_signin` and `/user/link_account_signup`; - `/user/link_account_signin` and `/user/link_account_signup`;
@@ -1080,8 +1080,8 @@ Each app's fixes are in one file named for the app, such as
such as `owner/python3-app` would have that push refused. such as `owner/python3-app` would have that push refused.
WordPress's fixes: on WordPress's paths, some fields skip the rules that refused WordPress's fixes: on WordPress's paths, some fields skip the rules that refused
ordinary WordPress requests there. `internal/coreruleset/apps/wordpress.conf` ordinary WordPress requests there. `internal/coreruleset/wordpress.conf` lists
lists each rule and the request it refused. The REST API has four addresses: each rule and the request it refused. The REST API has four addresses:
- `/wp-json/...` - `/wp-json/...`
- `/index.php/wp-json/...` - `/index.php/wp-json/...`
@@ -1173,9 +1173,9 @@ Elsewhere WordPress's fixes do not apply. The paths are those of WordPress at
the site root. the site root.
Drupal's fixes: on Drupal's paths, some fields skip the rules that refused Drupal's fixes: on Drupal's paths, some fields skip the rules that refused
ordinary Drupal requests there. `internal/coreruleset/apps/drupal.conf` lists ordinary Drupal requests there. `internal/coreruleset/drupal.conf` lists each
each rule and the request it refused. These query fields skip the lists of rule and the request it refused. These query fields skip the lists of system
system files and command names (930120, 932120, 932250, 932260): files and command names (930120, 932120, 932250, 932260):
- On every page under `/admin`: `title`, `name`, `user`, `filename`, `filemime`, - On every page under `/admin`: `title`, `name`, `user`, `filename`, `filemime`,
`info`, `subject`, `author_name`, `search`, `q` and `destination`. `info`, `subject`, `author_name`, `search`, `q` and `destination`.
@@ -1265,10 +1265,10 @@ first path segment of two or three lowercase letters, optionally followed by a
hyphen and more letters, so `/api` counts too. hyphen and more letters, so `/api` counts too.
MediaWiki's fixes: on MediaWiki's paths, some fields skip the rules that refused MediaWiki's fixes: on MediaWiki's paths, some fields skip the rules that refused
ordinary MediaWiki requests there. `internal/coreruleset/apps/mediawiki.conf` ordinary MediaWiki requests there. `internal/coreruleset/mediawiki.conf` lists
lists each rule and the request it refused. These fields skip the lists of each rule and the request it refused. These fields skip the lists of system
system files and command names (930120, 932120, 932250, 932260), in the query or files and command names (930120, 932120, 932250, 932260), in the query or the
the body: body:
- On MediaWiki's pages, which are `/index.php` and the paths under `/index.php/` - On MediaWiki's pages, which are `/index.php` and the paths under `/index.php/`
and `/wiki/`: and `/wiki/`:
@@ -1374,9 +1374,9 @@ Elsewhere these fields keep every rule. The paths are those of MediaWiki at the
site root or under `/w/`. site root or under `/w/`.
Mastodon's fixes: on Mastodon's paths, some fields skip the rules that refused Mastodon's fixes: on Mastodon's paths, some fields skip the rules that refused
ordinary Mastodon requests there. `internal/coreruleset/apps/mastodon.conf` ordinary Mastodon requests there. `internal/coreruleset/mastodon.conf` lists
lists each rule and the request it refused. These fields skip the lists of each rule and the request it refused. These fields skip the lists of system
system files and command names (930120, 932120, 932250, 932260), in the query: files and command names (930120, 932120, 932250, 932260), in the query:
- On the API's search, accounts and admin accounts, under `/api/v1/` and - On the API's search, accounts and admin accounts, under `/api/v1/` and
`/api/v2/`, the searches and names `q`, `acct`, `username`, `display_name`, `/api/v2/`, the searches and names `q`, `acct`, `username`, `display_name`,
@@ -1537,7 +1537,7 @@ every rule.
Vaultwarden's fixes: on Vaultwarden's paths, some fields skip the rules that Vaultwarden's fixes: on Vaultwarden's paths, some fields skip the rules that
refused ordinary Vaultwarden requests there. refused ordinary Vaultwarden requests there.
`internal/coreruleset/apps/vaultwarden.conf` lists each rule and the request it `internal/coreruleset/vaultwarden.conf` lists each rule and the request it
refused. The apps encrypt vault items, folders, collections and sends before refused. The apps encrypt vault items, folders, collections and sends before
sending them, so those fields skip no rules. The fields below hold plain text. sending them, so those fields skip no rules. The fields below hold plain text.
@@ -1588,8 +1588,8 @@ has a parameter of the same name.
`token` in the body of `/admin`, the admin token typed on the admin page, skips `token` in the body of `/admin`, the admin token typed on the admin page, skips
each rule that random passwords set off. The numbers are in each rule that random passwords set off. The numbers are in
`internal/coreruleset/apps/vaultwarden.conf`. It applies only when the query has `internal/coreruleset/vaultwarden.conf`. It applies only when the query has no
no `token` parameter. `' OR '1'='1`, `../../etc/passwd`, `; cat /etc/passwd` and `token` parameter. `' OR '1'='1`, `../../etc/passwd`, `; cat /etc/passwd` and
`<img src=x onerror=x()>` sent as the token reach Vaultwarden; `<img src=x onerror=x()>` sent as the token reach Vaultwarden;
`<script>alert(1)</script>` and `javascript:alert(1)` are still refused. `<script>alert(1)</script>` and `javascript:alert(1)` are still refused.
@@ -1611,7 +1611,7 @@ Elsewhere these fields keep every rule.
Nextcloud's fixes: on Nextcloud's paths, some fields skip the rules that refused Nextcloud's fixes: on Nextcloud's paths, some fields skip the rules that refused
ordinary Nextcloud requests there, and its WebDAV methods are allowed. ordinary Nextcloud requests there, and its WebDAV methods are allowed.
`internal/coreruleset/apps/nextcloud.conf` lists each rule and the request it `internal/coreruleset/nextcloud.conf` lists each rule and the request it
refused. refused.
The sync client and the Files app use WebDAV on these paths: The sync client and the Files app use WebDAV on these paths:
@@ -1621,8 +1621,7 @@ The sync client and the Files app use WebDAV on these paths:
- `/remote.php/webdav/`; - `/remote.php/webdav/`;
- `/public.php/webdav/`. - `/public.php/webdav/`.
These methods are allowed there, besides `PUT`, `PATCH` and `DELETE`, which These methods are allowed there, besides those of the first change:
every app gets:
- `PROPFIND` and `PROPPATCH`; - `PROPFIND` and `PROPPATCH`;
- `MKCOL`; - `MKCOL`;
@@ -1766,7 +1765,7 @@ gets gitea's fixes too. Forgejo's own fixes hold only what Forgejo sends and
gitea does not. gitea does not.
On Forgejo's paths, some fields skip the rules that refused ordinary Forgejo On Forgejo's paths, some fields skip the rules that refused ordinary Forgejo
requests there. `internal/coreruleset/apps/forgejo.conf` lists each rule and the requests there. `internal/coreruleset/forgejo.conf` lists each rule and the
request it refused. request it refused.
`q` skips rules on some of Forgejo's searches. The searches are: `q` skips rules on some of Forgejo's searches. The searches are:
@@ -1812,10 +1811,10 @@ The Core Rule Set reads the request without the `flash` cookie, in which Forgejo
puts what gitea puts in `gitea_flash` (gitea's second fix). puts what gitea puts in `gitea_flash` (gitea's second fix).
Ghost's fixes: on Ghost's paths, some fields skip the rules that refused Ghost's fixes: on Ghost's paths, some fields skip the rules that refused
ordinary Ghost requests there. `internal/coreruleset/apps/ghost.conf` lists each ordinary Ghost requests there. `internal/coreruleset/ghost.conf` lists each rule
rule and the request it refused. Ghost's admin and integrations call the Admin and the request it refused. Ghost's admin and integrations call the Admin API
API under `/ghost/api/admin/`. Themes and Ghost's scripts call the Content API under `/ghost/api/admin/`. Themes and Ghost's scripts call the Content API under
under `/ghost/api/content/`, and members call `/members/api/`. The admin calls `/ghost/api/content/`, and members call `/members/api/`. The admin calls
ActivityPub, a service of its own, under `/.ghost/activitypub/`. ActivityPub, a service of its own, under `/.ghost/activitypub/`.
Eight rules refused words that name commands and files, such as `python3`, Eight rules refused words that name commands and files, such as `python3`,
@@ -1953,9 +1952,9 @@ That name holds `.profile`, a file on the list of system files, so the name
skips 930120 when a profile is saved. skips 930120 when a profile is saved.
The passwords skip each rule that random passwords set off. The numbers are in The passwords skip each rule that random passwords set off. The numbers are in
`internal/coreruleset/apps/ghost.conf`. They are `password` when signing in, and `internal/coreruleset/ghost.conf`. They are `password` when signing in, and the
the passwords sent when creating the first staff user, accepting an invitation, passwords sent when creating the first staff user, accepting an invitation, and
and resetting or changing a password. `' OR '1'='1`, `../../etc/passwd`, resetting or changing a password. `' OR '1'='1`, `../../etc/passwd`,
`; cat /etc/passwd` and `<img src=x onerror=x()>` sent as a password reach `; cat /etc/passwd` and `<img src=x onerror=x()>` sent as a password reach
Ghost; `<script>alert(1)</script>` and `javascript:alert(1)` are still refused. Ghost; `<script>alert(1)</script>` and `javascript:alert(1)` are still refused.
+65 -43
View File
@@ -12,10 +12,11 @@
package coreruleset package coreruleset
import ( import (
"embed" _ "embed"
"errors" "errors"
"fmt" "fmt"
"io" "io"
"maps"
"net" "net"
"net/http" "net/http"
"net/netip" "net/netip"
@@ -34,7 +35,7 @@ import (
// directives are the Core Rule Set as sww runs it, with the // directives are the Core Rule Set as sww runs it, with the
// paranoia level for %d, bodyDirectives for the first %s while // paranoia level for %d, bodyDirectives for the first %s while
// SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE is set, the exclusions file for // SWW_WAF_CORE_RULE_SET_BODY_INSPECTION_SIZE is set, the exclusions file for
// the second, and the fixes of every app in appFixes for the third. // the second, and the directives of every app in apps for the third.
// Each rule sww adds has an id from 900000 to 900999, the ids the // Each rule sww adds has an id from 900000 to 900999, the ids the
// Core Rule Set keeps for the rules that set it up, which // Core Rule Set keeps for the rules that set it up, which
// SWW_WAF_CORE_RULE_SET_DISABLED_RULES and the exclusions file refuse, so that no // SWW_WAF_CORE_RULE_SET_DISABLED_RULES and the exclusions file refuse, so that no
@@ -53,12 +54,13 @@ Include @crs-setup.conf.example
SecAction "id:900000,phase:1,pass,nolog,\ SecAction "id:900000,phase:1,pass,nolog,\
setvar:tx.blocking_paranoia_level=%d" setvar:tx.blocking_paranoia_level=%d"
# PUT, PATCH and DELETE are allowed besides GET, HEAD, POST and OPTIONS. # The first change: PUT, PATCH and DELETE are allowed besides GET, HEAD,
# POST and OPTIONS.
SecAction "id:900200,phase:1,pass,nolog,\ SecAction "id:900200,phase:1,pass,nolog,\
setvar:'tx.allowed_methods=GET HEAD POST OPTIONS PUT PATCH DELETE'" setvar:'tx.allowed_methods=GET HEAD POST OPTIONS PUT PATCH DELETE'"
# Expect and Content-Encoding are taken off the Core Rule Set's list of the # The second: Expect and Content-Encoding are taken off the Core Rule Set's
# headers it refuses. Content-Encoding goes back on it for a # list of the headers it refuses. Content-Encoding goes back on it for a
# body the Core Rule Set reads (900260 in bodyDirectives). # body the Core Rule Set reads (900260 in bodyDirectives).
SecAction "id:900250,phase:1,pass,nolog,\ SecAction "id:900250,phase:1,pass,nolog,\
setvar:'tx.restricted_headers_basic=/proxy/ /lock-token/ /content-range/ \ setvar:'tx.restricted_headers_basic=/proxy/ /lock-token/ /content-range/ \
@@ -84,17 +86,18 @@ SecRule ARGUMENTS_LIMIT_REACHED "@eq 1" "id:900300,phase:2,pass,\
# The apps' fixes come before the rules for the same reason. # The apps' fixes come before the rules for the same reason.
%s %s
# Only the rules for requests are loaded, and no response is inspected. # The fifth: only the rules for requests are loaded, and no response is
# inspected.
Include @owasp_crs/REQUEST-*.conf Include @owasp_crs/REQUEST-*.conf
# redirect_uri is not checked for a URL naming an IP address or # The third: redirect_uri is not checked for a URL naming an IP address or
# localhost. Coraza matches a parameter name here without regard to case. # localhost. Coraza matches a parameter name here without regard to case.
# ARGS holds the fields of a form data or multipart body Coraza reads as # ARGS holds the fields of a form data or multipart body Coraza reads as
# well as the query parameters, so a field of this name is left out too. # well as the query parameters, so a field of this name is left out too.
SecRuleUpdateTargetById 931100 "!ARGS:redirect_uri" SecRuleUpdateTargetById 931100 "!ARGS:redirect_uri"
SecRuleUpdateTargetById 934110 "!ARGS:redirect_uri" SecRuleUpdateTargetById 934110 "!ARGS:redirect_uri"
# Referer is not checked for a Unix command without arguments # The fourth: Referer is not checked for a Unix command without arguments
# or for Java starting a process. # or for Java starting a process.
SecRuleUpdateTargetById 932340 "!REQUEST_HEADERS:Referer" SecRuleUpdateTargetById 932340 "!REQUEST_HEADERS:Referer"
SecRuleUpdateTargetById 944110 "!REQUEST_HEADERS:Referer" SecRuleUpdateTargetById 944110 "!REQUEST_HEADERS:Referer"
@@ -119,9 +122,9 @@ SecRule REQUEST_HEADERS:Content-Type \
"@rx ^(?:application|text)/(?:[a-z0-9.-]+[+])?json" \ "@rx ^(?:application|text)/(?:[a-z0-9.-]+[+])?json" \
"id:900420,phase:1,pass,nolog,t:none,t:lowercase,ctl:requestBodyProcessor=JSON" "id:900420,phase:1,pass,nolog,t:none,t:lowercase,ctl:requestBodyProcessor=JSON"
# Content-Encoding goes back on the list of the headers the Core Rule Set # The rest of the second change: Content-Encoding is refused again on a
# refuses (900250 in directives) for a body of a kind it reads, since a # body of a kind the Core Rule Set reads, since a compressed body cannot be
# compressed body cannot be inspected. # inspected.
SecRule REQBODY_PROCESSOR "@rx ^(?:URLENCODED|MULTIPART|JSON|XML)$" \ SecRule REQBODY_PROCESSOR "@rx ^(?:URLENCODED|MULTIPART|JSON|XML)$" \
"id:900260,phase:1,pass,nolog,\ "id:900260,phase:1,pass,nolog,\
setvar:'tx.restricted_headers_basic=%%{tx.restricted_headers_basic} \ setvar:'tx.restricted_headers_basic=%%{tx.restricted_headers_basic} \
@@ -142,19 +145,15 @@ SecRule MULTIPART_STRICT_ERROR "!@eq 0" "id:900450,phase:2,pass,\
severity:'CRITICAL',setvar:'tx.inbound_anomaly_score_pl1=+5'" severity:'CRITICAL',setvar:'tx.inbound_anomaly_score_pl1=+5'"
` `
// appFixes holds the fixes of each app whose ordinary requests the Core // app is an app whose ordinary requests the Core Rule Set would refuse,
// Rule Set would refuse, in a file named for the app by the name // with the fixes that let them pass.
// SWW_WAF_APPS gives it, such as apps/gitea.conf. The fixes are Coraza
// exclusions, loaded before the Core Rule Set's rules. Their first rule
// skips to the marker they end with, unless Inspect sets the transaction
// variable named for the app, such as app_gitea. The skip reaches only
// phase 1, so a rule of a later phase must check that variable itself.
//
//go:embed apps/*.conf
var appFixes embed.FS
// app is what an app's file in appFixes cannot say about it.
type app struct { type app struct {
// directives are Coraza exclusions, loaded before the Core Rule Set's
// rules. Their first rule skips to the marker they end with, unless
// Inspect sets the transaction variable named for the app, such as
// app_gitea. The skip reaches only phase 1, so a rule of a later phase
// must check that variable itself.
directives string
// cookies are the cookies the Core Rule Set reads a request without. // cookies are the cookies the Core Rule Set reads a request without.
cookies []string cookies []string
// forkOf names the app this one is a fork of, "" for none. A hostname // forkOf names the app this one is a fork of, "" for none. A hostname
@@ -162,34 +161,60 @@ type app struct {
forkOf string forkOf string
} }
// apps are the apps that need more than their file in appFixes, by the //go:embed gitea.conf
// name SWW_WAF_APPS gives each. flash is Forgejo's name for gitea_flash. var giteaDirectives string
//go:embed wordpress.conf
var wordpressDirectives string
//go:embed drupal.conf
var drupalDirectives string
//go:embed mediawiki.conf
var mediawikiDirectives string
//go:embed mastodon.conf
var mastodonDirectives string
//go:embed vaultwarden.conf
var vaultwardenDirectives string
//go:embed nextcloud.conf
var nextcloudDirectives string
//go:embed forgejo.conf
var forgejoDirectives string
//go:embed ghost.conf
var ghostDirectives string
// apps are the apps whose fixes sww has, by the name SWW_WAF_APPS gives each.
// flash is Forgejo's name for gitea_flash.
// //
//nolint:gochecknoglobals // a constant cannot be a map //nolint:gochecknoglobals // a constant cannot be a map
var apps = map[string]app{ var apps = map[string]app{
"drupal": {directives: drupalDirectives},
"forgejo": { "forgejo": {
cookies: []string{"flash"}, directives: forgejoDirectives,
forkOf: "gitea", cookies: []string{"flash"},
forkOf: "gitea",
}, },
"ghost": {directives: ghostDirectives},
"gitea": { "gitea": {
cookies: []string{"gitea_flash", "redirect_to"}, directives: giteaDirectives,
cookies: []string{"gitea_flash", "redirect_to"},
}, },
"mastodon": {directives: mastodonDirectives},
"mediawiki": {directives: mediawikiDirectives},
"nextcloud": {directives: nextcloudDirectives},
"vaultwarden": {directives: vaultwardenDirectives},
"wordpress": {directives: wordpressDirectives},
} }
// AppNames returns the names of the apps whose fixes sww has, in // AppNames returns the names of the apps whose fixes sww has, in
// alphabetical order. // alphabetical order.
func AppNames() []string { func AppNames() []string {
// An embedded directory always reads. return slices.Sorted(maps.Keys(apps))
files, _ := appFixes.ReadDir("apps")
names := make([]string, len(files))
for i, file := range files {
names[i] = strings.TrimSuffix(file.Name(), ".conf")
}
slices.Sort(names)
return names
} }
// Params are what New needs. // Params are what New needs.
@@ -348,11 +373,8 @@ func New(params Params) (*CoreRuleSet, error) {
} }
var fixes strings.Builder var fixes strings.Builder
for _, name := range AppNames() { for _, name := range AppNames() {
// An embedded file always reads. fixes.WriteString(apps[name].directives + "\n")
file, _ := appFixes.ReadFile("apps/" + name + ".conf")
fixes.WriteString(string(file) + "\n")
} }
text := fmt.Sprintf(directives, params.ParanoiaLevel, body, exclusions, text := fmt.Sprintf(directives, params.ParanoiaLevel, body, exclusions,
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
+3 -3
View File
@@ -17,7 +17,7 @@ const (
) )
// giteaSearches are searches of the pages gitea and Forgejo share whose q // giteaSearches are searches of the pages gitea and Forgejo share whose q
// skips the lists of system files and command names, in gitea's fixes. // skips the lists of system files and command names, in the eighth change.
// gitea serves its admin pages under /-/admin/ and Forgejo under /admin/. // gitea serves its admin pages under /-/admin/ and Forgejo under /admin/.
// //
//nolint:gochecknoglobals // a constant cannot be a list //nolint:gochecknoglobals // a constant cannot be a list
@@ -222,8 +222,8 @@ func TestGiteaSearchExclusionsAreNarrow(t *testing.T) {
} }
// Under /admin/, where Forgejo serves its admin pages, only the hard // Under /admin/, where Forgejo serves its admin pages, only the hard
// values are left out: Drupal's fixes let them through in q on every path // values are left out: the tenth change lets them through in q on every
// there. // path there, for Drupal.
for _, target := range []string{ for _, target := range []string{
"/admin/packages/delete?q=", "/admin/packages/delete?q=",
"/admin/packages?other=", "/admin/packages?other=",
File renamed without changes.
File renamed without changes.
@@ -37,10 +37,9 @@
SecRule &TX:app_nextcloud "@eq 0" \ SecRule &TX:app_nextcloud "@eq 0" \
"id:900090,phase:1,pass,nolog,skipAfter:END_NEXTCLOUD" "id:900090,phase:1,pass,nolog,skipAfter:END_NEXTCLOUD"
# The sync client and the Files app use these WebDAV methods besides PUT, # The sync client and the Files app use these WebDAV methods besides those
# PATCH and DELETE, which sww allows for every app, on /remote.php/dav/ and # the first change allows, on /remote.php/dav/ and /public.php/dav/ and on the
# /public.php/dav/ and on the older /remote.php/webdav/ and /public.php/webdav/. # older /remote.php/webdav/ and /public.php/webdav/. 911100 refused each:
# 911100 refused each:
# PROPFIND, PROPPATCH: listing a folder, marking a file a favourite # PROPFIND, PROPPATCH: listing a folder, marking a file a favourite
# MKCOL: making a folder, and starting a chunked upload # MKCOL: making a folder, and starting a chunked upload
# COPY, MOVE: copying, moving and renaming, and ending a chunked upload # COPY, MOVE: copying, moving and renaming, and ending a chunked upload
File renamed without changes.
+1 -9
View File
@@ -1,14 +1,6 @@
package rproxy package rproxy
import ( import "time"
"net/http"
"time"
)
// HTTPServer is Go's server s holds, for tests that read its settings.
func (s *Server) HTTPServer() *http.Server {
return s.httpServer
}
// StopBreakerClock has the circuit breaker of s read at as the time, so that how // StopBreakerClock has the circuit breaker of s read at as the time, so that how
// long requests take cannot matter to it. It is called before s serves. // long requests take cannot matter to it. It is called before s serves.
+5 -5
View File
@@ -56,7 +56,7 @@ func TestServerHasTheFixedLimits(t *testing.T) {
InstanceName: "test", InstanceName: "test",
Level: slog.LevelInfo, Level: slog.LevelInfo,
}), }),
}).HTTPServer() })
if server.Addr != ":8080" || server.MaxHeaderBytes != 28<<10 || if server.Addr != ":8080" || server.MaxHeaderBytes != 28<<10 ||
server.IdleTimeout != 2*time.Minute || server.ReadHeaderTimeout != time.Minute { server.IdleTimeout != 2*time.Minute || server.ReadHeaderTimeout != time.Minute {
@@ -709,7 +709,7 @@ func TestABodyLeftUnreadIsReadOnlyUntilTheRequestTimeLimit(t *testing.T) {
before := time.Now() before := time.Now()
server.ServeHTTP(w, req) server.Handler.ServeHTTP(w, req)
if w.Code != http.StatusNoContent { if w.Code != http.StatusNoContent {
t.Errorf("status %d, want the app's 204", w.Code) t.Errorf("status %d, want the app's 204", w.Code)
@@ -762,7 +762,7 @@ func TestABodyLeftUnreadIsReadNoMoreOnceTheTimeToSendTheAnswerRunsOut(
before := time.Now() before := time.Now()
server.ServeHTTP(w, req) server.Handler.ServeHTTP(w, req)
if w.Code != http.StatusOK { if w.Code != http.StatusOK {
t.Errorf("status %d, want the app's 200", w.Code) t.Errorf("status %d, want the app's 200", w.Code)
@@ -815,7 +815,7 @@ func TestAnAnswerRProxyGivesItselfHasTheResponseTimeToBeSent(t *testing.T) {
before := time.Now() before := time.Now()
server.ServeHTTP(w, req) server.Handler.ServeHTTP(w, req)
if w.Code != tc.status { if w.Code != tc.status {
t.Errorf("status %d, want %d", w.Code, tc.status) t.Errorf("status %d, want %d", w.Code, tc.status)
@@ -856,7 +856,7 @@ func TestAnAnswerRProxyGivesItselfHasTenSecondsToBeSentAtLeast(
before := time.Now() before := time.Now()
server.ServeHTTP(w, req) server.Handler.ServeHTTP(w, req)
if w.writeDeadline.Before(before.Add(least)) { if w.writeDeadline.Before(before.Add(least)) {
t.Errorf( t.Errorf(
+1 -1
View File
@@ -583,7 +583,7 @@ func TestAQuestionNamesNoZone(t *testing.T) {
req.RemoteAddr = tc.remoteAddr req.RemoteAddr = tc.remoteAddr
req.Header.Set(forwardedForHeader, tc.forwardedFor) req.Header.Set(forwardedForHeader, tc.forwardedFor)
server.ServeHTTP(httptest.NewRecorder(), req) server.Handler.ServeHTTP(httptest.NewRecorder(), req)
asked := standIn.question(t) asked := standIn.question(t)
if asked.header.Get(wafprotocol.ClientHeader) != tc.client || if asked.header.Get(wafprotocol.ClientHeader) != tc.client ||
+24 -39
View File
@@ -16,11 +16,11 @@ import (
"io" "io"
"log" "log"
"log/slog" "log/slog"
"net"
"net/http" "net/http"
"net/url" "net/url"
"slices" "slices"
"strings" "strings"
"sync"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/config" "sneak.berlin/go/smallwebwaf/internal/config"
@@ -64,8 +64,9 @@ type Params struct {
// Server is the server `sww rproxy` runs. // Server is the server `sww rproxy` runs.
type Server struct { type Server struct {
httpServer *http.Server *http.Server
h *handler
h *handler
} }
// New returns the server `sww rproxy` runs. Go's server itself refuses // New returns the server `sww rproxy` runs. Go's server itself refuses
@@ -94,47 +95,28 @@ func New(params Params) *Server {
breakerClock: time.Now, breakerClock: time.Now,
} }
s := &Server{h: h} return &Server{
s.httpServer = &http.Server{ Server: &http.Server{
Addr: params.Config.ListenAddr, Addr: params.Config.ListenAddr,
Handler: s, Handler: h,
ErrorLog: errorLog, ErrorLog: errorLog,
ReadHeaderTimeout: params.Config.MaxRequestTime, ReadHeaderTimeout: params.Config.MaxRequestTime,
IdleTimeout: idleTimeout, IdleTimeout: idleTimeout,
MaxHeaderBytes: requestHeaderMaxBytes - goServerExtraHeaderBytes, MaxHeaderBytes: requestHeaderMaxBytes - goServerExtraHeaderBytes,
},
h: h,
} }
return s
}
// Serve serves requests on listener until Shutdown or Close, as Go's
// http.Server.Serve does.
func (s *Server) Serve(listener net.Listener) error {
return s.httpServer.Serve(listener)
}
// Shutdown stops serving once the requests in progress have finished, or
// when ctx is done, as Go's http.Server.Shutdown does.
func (s *Server) Shutdown(ctx context.Context) error {
return s.httpServer.Shutdown(ctx)
}
// Close stops serving at once and closes every connection, as Go's
// http.Server.Close does.
func (s *Server) Close() error {
return s.httpServer.Close()
}
// ServeHTTP handles one request from a visitor, as handler.ServeHTTP says.
func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
s.h.ServeHTTP(w, r)
} }
// WaitForReports returns once the reports being sent have gone or failed, // WaitForReports returns once the reports being sent have gone or failed,
// which SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS bounds. Any report after this call // which SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS bounds. Any report after this call
// is dropped: that of a WebSocket that closes while rproxy stops, for one. // is dropped: that of a WebSocket that closes while rproxy stops, for one.
func (s *Server) WaitForReports() { func (s *Server) WaitForReports() {
s.h.reports.stopAndWait() s.h.reportsMu.Lock()
s.h.reportsStopped = true
s.h.reportsMu.Unlock()
s.h.reports.Wait()
} }
// handler is the proxy. It holds what every request shares; what belongs to // handler is the proxy. It holds what every request shares; what belongs to
@@ -154,8 +136,11 @@ type handler struct {
// the time. // the time.
breaker breaker breaker breaker
breakerClock func() time.Time breakerClock func() time.Time
// reports are the goroutines sending reports to waf. // reports waits for the reports being sent. reportsMu guards starting one
reports reportGoroutines // against reportsStopped, which is set once nothing is to wait for another.
reports sync.WaitGroup
reportsMu sync.Mutex
reportsStopped bool
} }
// newTransport returns what carries requests to the app. It never goes through // newTransport returns what carries requests to the app. It never goes through
+1 -1
View File
@@ -710,7 +710,7 @@ func TestAnAnswerWithoutAContentTypeGetsNone(t *testing.T) {
) )
w := httptest.NewRecorder() w := httptest.NewRecorder()
server.ServeHTTP(w, req) server.Handler.ServeHTTP(w, req)
// Go's server guesses a type when the first part of the body goes before the // Go's server guesses a type when the first part of the body goes before the
// headers are flushed, which is a matter of timing here. So this looks for what // headers are flushed, which is a matter of timing here. So this looks for what
+8 -33
View File
@@ -8,7 +8,6 @@ import (
"maps" "maps"
"net/http" "net/http"
"strings" "strings"
"sync"
"sneak.berlin/go/smallwebwaf/internal/rules" "sneak.berlin/go/smallwebwaf/internal/rules"
"sneak.berlin/go/smallwebwaf/internal/wafprotocol" "sneak.berlin/go/smallwebwaf/internal/wafprotocol"
@@ -211,7 +210,14 @@ func (h *handler) sendReport(
ctx context.Context, ctx context.Context,
report *wafprotocol.Report, report *wafprotocol.Report,
) { ) {
h.reports.startUnlessStopped(func() { h.reportsMu.Lock()
defer h.reportsMu.Unlock()
if h.reportsStopped {
return
}
h.reports.Go(func() {
err := h.postReport(context.WithoutCancel(ctx), report) err := h.postReport(context.WithoutCancel(ctx), report)
if err != nil { if err != nil {
h.processLog.Warn("a report is dropped", "error", err.Error()) h.processLog.Warn("a report is dropped", "error", err.Error())
@@ -219,37 +225,6 @@ func (h *handler) sendReport(
}) })
} }
// reportGoroutines are the goroutines sending reports to waf. None starts once
// stopAndWait has been called.
type reportGoroutines struct {
mu sync.Mutex
stopped bool
running sync.WaitGroup
}
// startUnlessStopped runs send on a goroutine of its own, or drops it once
// stopAndWait has been called.
func (g *reportGoroutines) startUnlessStopped(send func()) {
g.mu.Lock()
defer g.mu.Unlock()
if g.stopped {
return
}
g.running.Go(send)
}
// stopAndWait stops any more goroutines from starting, and returns once those
// running have ended.
func (g *reportGoroutines) stopAndWait() {
g.mu.Lock()
g.stopped = true
g.mu.Unlock()
g.running.Wait()
}
// postReport posts report to waf, and waits for its answer for up to // postReport posts report to waf, and waits for its answer for up to
// SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS. // SWW_RPROXY_WAF_BACKEND_TIMEOUT_MS.
func (h *handler) postReport( func (h *handler) postReport(
+1 -9
View File
@@ -95,20 +95,12 @@ func background(loop func(context.Context)) fx.Hook {
) )
} }
// daemonServer is the server a daemon runs, waf.Server or rproxy.Server: the
// methods of Go's http.Server that serve starts and stops it with.
type daemonServer interface {
Serve(listener net.Listener) error
Shutdown(ctx context.Context) error
Close() error
}
// serve serves requests on listener from the start. At the stop it gives the // serve serves requests on listener from the start. At the stop it gives the
// requests in progress shutdownTimeout to finish, then closes their // requests in progress shutdownTimeout to finish, then closes their
// connections. When serving fails, it logs why and sends the error to // connections. When serving fails, it logs why and sends the error to
// failed. // failed.
func serve( func serve(
lc fx.Lifecycle, server daemonServer, listener net.Listener, lc fx.Lifecycle, server *http.Server, listener net.Listener,
processLog *slog.Logger, failed servingFailed, processLog *slog.Logger, failed servingFailed,
) { ) {
served := make(chan error, 1) served := make(chan error, 1)
+3 -7
View File
@@ -4,6 +4,7 @@ import (
"context" "context"
"log/slog" "log/slog"
"net" "net"
"net/http"
"os" "os"
"go.uber.org/fx" "go.uber.org/fx"
@@ -43,13 +44,8 @@ func RunRProxy(ctx context.Context, params Params) int {
app := fx.New( app := fx.New(
fx.Supply(cfg, processLog, requestLog{params.Stdout}, failed), fx.Supply(cfg, processLog, requestLog{params.Stdout}, failed),
fx.Provide( fx.Provide(
// run waits for rproxy.Server's reports, and serve takes it as a newRProxyServer,
// daemonServer. func(server *rproxy.Server) *http.Server { return server.Server },
fx.Annotate(
newRProxyServer,
fx.As(fx.Self()),
fx.As(new(daemonServer)),
),
newRProxyListener, newRProxyListener,
), ),
fx.Invoke(serve), fx.Invoke(serve),
+3 -2
View File
@@ -6,6 +6,7 @@ import (
"io" "io"
"log/slog" "log/slog"
"net" "net"
"net/http"
"time" "time"
"go.uber.org/fx" "go.uber.org/fx"
@@ -96,8 +97,8 @@ func RunWAF(ctx context.Context, params Params) int {
newAlertQueue, newRuleFiles, newCoreRuleSet, newLookupFile, newAlertQueue, newRuleFiles, newCoreRuleSet, newLookupFile,
newLimiter, newLedger, newAnomalyCounters, newLimiter, newLedger, newAnomalyCounters,
newLists, newDNSBL, newAbuseIPDB, newRouteWatch, newLists, newDNSBL, newAbuseIPDB, newRouteWatch,
newMetrics, newGeoJS, newMetrics, newGeoJS, newWAFServer,
fx.Annotate(newWAFServer, fx.As(new(daemonServer))), func(server *waf.Server) *http.Server { return server.Server },
newWAFListener, newStateFiles, newWAFListener, newStateFiles,
), ),
// fx stops hooks in the reverse of the order they were added in. The // fx stops hooks in the reverse of the order they were added in. The
+5 -9
View File
@@ -1,8 +1,7 @@
package waf package waf
// The heuristic abuseipdb. It reads SWW_WAF_ABUSEIPDB_KEY, // The heuristic abuseipdb. It reads SWW_WAF_ABUSEIPDB_KEY,
// SWW_WAF_ABUSEIPDB_MIN_SCORE, SWW_WAF_DNSBL_ABUSEIPDB_ACTION and // SWW_WAF_ABUSEIPDB_MIN_SCORE and SWW_WAF_DNSBL_ABUSEIPDB_ACTION.
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
@@ -17,11 +16,10 @@ import (
// abuseIPDB adds the tag abuseipdb and notes AbuseIPDB, as noteHit does, with // abuseIPDB adds the tag abuseipdb and notes AbuseIPDB, as noteHit does, with
// the score, when its score of the client is a hit, and refuses the request // the score, when its score of the client is a hit, and refuses the request
// with SWW_WAF_BAN_RESPONSE when SWW_WAF_DNSBL_ABUSEIPDB_ACTION is deny, as // when SWW_WAF_DNSBL_ABUSEIPDB_ACTION is deny, as dnsbl does for a zone. While
// dnsbl does for a zone. While SWW_WAF_ABUSEIPDB_KEY is unset it does nothing. // SWW_WAF_ABUSEIPDB_KEY is unset it does nothing. A client without a score is
// A client without a score is checked in the background, by the request's // checked in the background, by the request's address, if its history counts
// address, if its history counts an offence, and the request does not wait for // an offence, and the request does not wait for the answer. The score is then
// the answer. The score is then
// used for each address of the client. Its figures are the score and // used for each address of the client. Its figures are the score and
// SWW_WAF_ABUSEIPDB_MIN_SCORE. // SWW_WAF_ABUSEIPDB_MIN_SCORE.
type abuseIPDB struct { type abuseIPDB struct {
@@ -32,7 +30,6 @@ type abuseIPDB struct {
keySet bool // SWW_WAF_ABUSEIPDB_KEY is set keySet bool // SWW_WAF_ABUSEIPDB_KEY is set
minScore int64 // SWW_WAF_ABUSEIPDB_MIN_SCORE minScore int64 // SWW_WAF_ABUSEIPDB_MIN_SCORE
action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION
banResponse int // SWW_WAF_BAN_RESPONSE
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
hitNoter reputationHitNoter hitNoter reputationHitNoter
} }
@@ -74,7 +71,6 @@ func (a abuseIPDB) check(
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: a.banResponse,
figures: map[string]any{ figures: map[string]any{
figureScore: score, "min_score": a.minScore, figureScore: score, "min_score": a.minScore,
}, },
+1 -1
View File
@@ -717,7 +717,7 @@ func askDirectly(
recorder := httptest.NewRecorder() recorder := httptest.NewRecorder()
began := time.Now() began := time.Now()
server.ServeHTTP(recorder, req) server.Handler.ServeHTTP(recorder, req)
return recorder.Code, time.Since(began) return recorder.Code, time.Since(began)
} }
+13 -11
View File
@@ -1,8 +1,7 @@
package waf package waf
// The heuristic active_ban, and banMaker, which makes the bans of several // The heuristic active_ban, and banMaker, which makes the bans of several
// heuristics. active_ban reads SWW_WAF_MODE and SWW_WAF_BAN_RESPONSE; the bans // heuristics. active_ban reads SWW_WAF_MODE; the bans are the ban ledger's.
// are the ban ledger's.
import ( import (
"context" "context"
@@ -17,11 +16,16 @@ import (
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// activeBan refuses a client a ban covers, with SWW_WAF_BAN_RESPONSE: a ban on // banResponse is a refusal answered with SWW_WAF_BAN_RESPONSE, and logged
// a netblock the client is in, in force at now. It notes for the log line when // with action.
// that ban ends. A request that makes the ban permanent, or in observe mode func (rq *request) banResponse(action requestlog.Action) *refusal {
// would have, raises the alert for it. Its figures are the ban's netblock and return &refusal{status: rq.h.config.BanResponse, action: action}
// when it ends. }
// activeBan refuses a client a ban covers: a ban on a netblock the client is
// in, in force at now. It notes for the log line when that ban ends. A request
// that makes the ban permanent, or in observe mode would have, raises the alert
// for it. Its figures are the ban's netblock and when it ends.
type activeBan struct { type activeBan struct {
banMaker banMaker banMaker banMaker
} }
@@ -59,7 +63,6 @@ func (a activeBan) check(
return &verdict{ return &verdict{
action: banAction(ban.Permanent()), action: banAction(ban.Permanent()),
status: a.banMaker.banResponse,
figures: map[string]any{ figures: map[string]any{
figureNetblock: ban.Netblock.String(), "ban_expires": expires, figureNetblock: ban.Netblock.String(), "ban_expires": expires,
}, },
@@ -115,9 +118,8 @@ type banMaker struct {
alerts *alerts.Queue alerts *alerts.Queue
// observe is true in observe mode (SWW_WAF_MODE). // observe is true in observe mode (SWW_WAF_MODE).
observe bool observe bool
// banResponse is SWW_WAF_BAN_RESPONSE: the status of a request refused // banResponse is SWW_WAF_BAN_RESPONSE, the status the notes of a ban for a
// under a ban or for a clear sign of attack, which the notes of a ban for // clear sign of attack give.
// a clear sign of attack give.
banResponse int banResponse int
// banScopeV4Prefix is SWW_WAF_BAN_SCOPE_V4_PREFIX and ipv6GroupPrefix // banScopeV4Prefix is SWW_WAF_BAN_SCOPE_V4_PREFIX and ipv6GroupPrefix
// SWW_WAF_IPV6_GROUP_PREFIX, which set the netblock a ban covers. // SWW_WAF_IPV6_GROUP_PREFIX, which set the netblock a ban covers.
-2
View File
@@ -4,7 +4,6 @@ package waf
import ( import (
"context" "context"
"net/http"
"sync/atomic" "sync/atomic"
"time" "time"
@@ -162,7 +161,6 @@ func (rq *request) applyFindings(
func (rq *request) timedOut(running string) *verdict { func (rq *request) timedOut(running string) *verdict {
v := &verdict{ v := &verdict{
action: requestlog.ActionChecksTimedOut, action: requestlog.ActionChecksTimedOut,
status: http.StatusServiceUnavailable,
figures: map[string]any{ figures: map[string]any{
"time_limit_ms": rq.h.besideLookupLimit.Milliseconds(), "time_limit_ms": rq.h.besideLookupLimit.Milliseconds(),
}, },
+1 -1
View File
@@ -592,7 +592,7 @@ func serveFromDE(
req.Header.Set(wafprotocol.ClientHeader, fromDE) req.Header.Set(wafprotocol.ClientHeader, fromDE)
req.Header.Set(requestIDHeader, "the-id") req.Header.Set(requestIDHeader, "the-id")
server.ServeHTTP(httptest.NewRecorder(), req) server.Handler.ServeHTTP(httptest.NewRecorder(), req)
} }
// wantPercent checks a limit percentage that a log line or a ban's notes // wantPercent checks a limit percentage that a log line or a ban's notes
+8 -11
View File
@@ -1,7 +1,7 @@
package waf package waf
// The heuristic blocklists. It reads SWW_WAF_BLOCKLIST_ACTION and // The heuristic blocklists. It reads SWW_WAF_BLOCKLIST_ACTION, and the blocklists
// SWW_WAF_BAN_RESPONSE, and the blocklists through the reputation lists. // through the reputation lists.
import ( import (
"context" "context"
@@ -13,15 +13,13 @@ import (
) )
// blocklists notes the blocklists that list the client, as noteListed does, // blocklists notes the blocklists that list the client, as noteListed does,
// and refuses the request with SWW_WAF_BAN_RESPONSE when // and refuses the request when SWW_WAF_BLOCKLIST_ACTION is deny. Being limit, it
// SWW_WAF_BLOCKLIST_ACTION is deny. Being limit, it lowers the client's limits // lowers the client's limits instead (see limitPercentages), and being log, it
// instead (see limitPercentages), and being log, it does nothing more. Its // does nothing more. Its figure is the blocklists that list the client.
// figure is the blocklists that list the client.
type blocklists struct { type blocklists struct {
lists *reputation.Lists lists *reputation.Lists
action config.ReputationAction // SWW_WAF_BLOCKLIST_ACTION action config.ReputationAction // SWW_WAF_BLOCKLIST_ACTION
banResponse int // SWW_WAF_BAN_RESPONSE hitNoter reputationHitNoter
hitNoter reputationHitNoter
} }
func (blocklists) name() string { return "blocklists" } func (blocklists) name() string { return "blocklists" }
@@ -41,7 +39,6 @@ func (b blocklists) check(
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: b.banResponse,
figures: map[string]any{"lists": listedBy}, figures: map[string]any{"lists": listedBy},
} }
} }
-2
View File
@@ -5,7 +5,6 @@ package waf
import ( import (
"context" "context"
"net/http"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/alerts" "sneak.berlin/go/smallwebwaf/internal/alerts"
@@ -78,7 +77,6 @@ func (c coreRuleSet) check(
return &verdict{ return &verdict{
action: requestlog.ActionBlockedByCoreRuleSet, action: requestlog.ActionBlockedByCoreRuleSet,
status: http.StatusForbidden,
figures: map[string]any{ figures: map[string]any{
figureScore: result.Score, figureScore: result.Score,
"threshold": threshold, "threshold": threshold,
+4 -8
View File
@@ -1,7 +1,6 @@
package waf package waf
// The heuristic countries. It reads SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES and // The heuristic countries. It reads SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES.
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
@@ -14,12 +13,10 @@ import (
// countries refuses a request when SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES is set and // countries refuses a request when SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES is set and
// does not hold the client's country as it was looked up. A client without a // does not hold the client's country as it was looked up. A client without a
// country, or whose country cannot be found, is refused. It refuses with // country, or whose country cannot be found, is refused. Its figures are the
// SWW_WAF_BAN_RESPONSE. Its figures are the country and the setting that // country and the setting that refused it.
// refused it.
type countries struct { type countries struct {
allowed []string // SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES allowed []string // SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES
banResponse int // SWW_WAF_BAN_RESPONSE
} }
func (countries) name() string { return "countries" } func (countries) name() string { return "countries" }
@@ -38,7 +35,6 @@ func (c countries) check(
return &verdict{ return &verdict{
action: requestlog.ActionCountryDenied, action: requestlog.ActionCountryDenied,
status: c.banResponse,
figures: map[string]any{ figures: map[string]any{
"country": country, "country": country,
"setting": config.ExclusivelyAllowedCountriesSetting, "setting": config.ExclusivelyAllowedCountriesSetting,
+4 -6
View File
@@ -1,6 +1,6 @@
package waf package waf
// The heuristic deny_nets. It reads SWW_WAF_DENY_NETS and SWW_WAF_BAN_RESPONSE. // The heuristic deny_nets. It reads SWW_WAF_DENY_NETS.
import ( import (
"context" "context"
@@ -10,11 +10,10 @@ import (
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// denyNets refuses a client in SWW_WAF_DENY_NETS, with SWW_WAF_BAN_RESPONSE. // denyNets refuses a client in SWW_WAF_DENY_NETS. Its figure is the netblock of
// Its figure is the netblock of the setting the client is in. // the setting the client is in.
type denyNets struct { type denyNets struct {
netblocks []netip.Prefix // SWW_WAF_DENY_NETS netblocks []netip.Prefix // SWW_WAF_DENY_NETS
banResponse int // SWW_WAF_BAN_RESPONSE
} }
func (denyNets) name() string { return "deny_nets" } func (denyNets) name() string { return "deny_nets" }
@@ -28,7 +27,6 @@ func (d denyNets) check(
if netblock.Contains(rq.client) { if netblock.Contains(rq.client) {
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: d.banResponse,
figures: map[string]any{figureNetblock: netblock.String()}, figures: map[string]any{figureNetblock: netblock.String()},
} }
} }
+10 -14
View File
@@ -1,8 +1,7 @@
package waf package waf
// The heuristic dnsbl. It reads SWW_WAF_DNSBL_ABUSEIPDB_ACTION and // The heuristic dnsbl. It reads SWW_WAF_DNSBL_ABUSEIPDB_ACTION, and the DNSBL zones'
// SWW_WAF_BAN_RESPONSE, and the DNSBL zones' verdicts through the DNSBL // verdicts through the DNSBL checker.
// checker.
import ( import (
"context" "context"
@@ -16,17 +15,15 @@ import (
// dnsbl notes the DNSBL zones whose verdict lists the client, as noteListed // dnsbl notes the DNSBL zones whose verdict lists the client, as noteListed
// does, adds the tag dnsbl=<zone> for each, the zone's key masked, and refuses // does, adds the tag dnsbl=<zone> for each, the zone's key masked, and refuses
// the request with SWW_WAF_BAN_RESPONSE when SWW_WAF_DNSBL_ABUSEIPDB_ACTION is // the request when SWW_WAF_DNSBL_ABUSEIPDB_ACTION is deny. Being
// deny. Being limit, it lowers the client's limits instead (see // limit, it lowers the client's limits instead (see limitPercentages), and
// limitPercentages), and being log, it does nothing more. A zone without a // being log, it does nothing more. A zone without a verdict on the client is
// verdict on the client is asked about it in the background, and the request // asked about it in the background, and the request does not wait for the
// does not wait for the answer. Its figure is the zones that list the client, // answer. Its figure is the zones that list the client, their keys masked.
// their keys masked.
type dnsbl struct { type dnsbl struct {
dnsbl *reputation.DNSBL dnsbl *reputation.DNSBL
action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION
banResponse int // SWW_WAF_BAN_RESPONSE hitNoter reputationHitNoter
hitNoter reputationHitNoter
} }
func (dnsbl) name() string { return "dnsbl" } func (dnsbl) name() string { return "dnsbl" }
@@ -50,7 +47,6 @@ func (d dnsbl) check(
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: d.banResponse,
figures: map[string]any{"zones": listedBy}, figures: map[string]any{"zones": listedBy},
} }
} }
-7
View File
@@ -1,11 +1,4 @@
package waf package waf
import "net/http"
// BesideLookupTimeLimit is besideLookupTimeLimit. // BesideLookupTimeLimit is besideLookupTimeLimit.
const BesideLookupTimeLimit = besideLookupTimeLimit const BesideLookupTimeLimit = besideLookupTimeLimit
// HTTPServer is Go's server s holds, for tests that read its settings.
func (s *Server) HTTPServer() *http.Server {
return s.httpServer
}
-3
View File
@@ -4,7 +4,6 @@ package waf
import ( import (
"context" "context"
"net/http"
"strings" "strings"
"time" "time"
@@ -40,7 +39,6 @@ func (headerLimits) check(
if requestLine > maxLineBytes { if requestLine > maxLineBytes {
return &verdict{ return &verdict{
action: requestlog.ActionRequestLineTooLong, action: requestlog.ActionRequestLineTooLong,
status: http.StatusRequestURITooLong,
figures: map[string]any{ figures: map[string]any{
"request_line_bytes": requestLine, "request_line_bytes": requestLine,
"request_line_bytes_limit": maxLineBytes, "request_line_bytes_limit": maxLineBytes,
@@ -58,7 +56,6 @@ func (headerLimits) check(
return &verdict{ return &verdict{
action: requestlog.ActionRequestHeaderTooLarge, action: requestlog.ActionRequestHeaderTooLarge,
status: http.StatusRequestHeaderFieldsTooLarge,
figures: map[string]any{ figures: map[string]any{
"longest_header_line_bytes": longest, "longest_header_line_bytes": longest,
"header_line_bytes_limit": maxLineBytes, "header_line_bytes_limit": maxLineBytes,
+2 -5
View File
@@ -42,13 +42,10 @@ type refusesWithoutLookup interface {
} }
// verdict is a heuristic refusing a request, or banning its client: the action // verdict is a heuristic refusing a request, or banning its client: the action
// the log line names, the status the visitor is answered with, and the figures // the log line names, and the figures the heuristic acted on, by name, such as
// the heuristic acted on, by name, such as the count and the limit. A status of // the count and the limit.
// 0 closes the visitor's connection without an answer. A verdict of afterAnswer
// or onReport refuses nothing, and has neither action nor status.
type verdict struct { type verdict struct {
action requestlog.Action action requestlog.Action
status int
figures map[string]any figures map[string]any
} }
+12 -20
View File
@@ -109,8 +109,7 @@ type CoreRuleSetInspector interface {
// Server is the server waf runs. // Server is the server waf runs.
type Server struct { type Server struct {
httpServer *http.Server *http.Server
h *handler
} }
// newHandler returns the handler with what every request shares, the parts // newHandler returns the handler with what every request shares, the parts
@@ -190,25 +189,20 @@ func newHandler(params Params) *handler {
routeWatch: params.RouteWatch, routeWatch: params.RouteWatch,
ipv6GroupPrefix: cfg.IPv6GroupPrefix, ipv6GroupPrefix: cfg.IPv6GroupPrefix,
}, },
denyNets{netblocks: cfg.DenyNets, banResponse: cfg.BanResponse}, denyNets{netblocks: cfg.DenyNets},
activeBan{banMaker: sharedBanMaker}, activeBan{banMaker: sharedBanMaker},
} }
h.afterLookup = []heuristic{ h.afterLookup = []heuristic{
countries{ countries{allowed: cfg.ExclusivelyAllowedCountries},
allowed: cfg.ExclusivelyAllowedCountries,
banResponse: cfg.BanResponse,
},
blocklists{ blocklists{
lists: params.Lists, lists: params.Lists,
action: cfg.BlocklistAction, action: cfg.BlocklistAction,
banResponse: cfg.BanResponse, hitNoter: hitNoter,
hitNoter: hitNoter,
}, },
dnsbl{ dnsbl{
dnsbl: params.DNSBL, dnsbl: params.DNSBL,
action: cfg.DNSBLAbuseIPDBAction, action: cfg.DNSBLAbuseIPDBAction,
banResponse: cfg.BanResponse, hitNoter: hitNoter,
hitNoter: hitNoter,
}, },
abuseIPDB{ abuseIPDB{
abuseIPDB: params.AbuseIPDB, abuseIPDB: params.AbuseIPDB,
@@ -216,11 +210,10 @@ func newHandler(params Params) *handler {
keySet: cfg.AbuseIPDBKey != "", keySet: cfg.AbuseIPDBKey != "",
minScore: cfg.AbuseIPDBMinScore, minScore: cfg.AbuseIPDBMinScore,
action: cfg.DNSBLAbuseIPDBAction, action: cfg.DNSBLAbuseIPDBAction,
banResponse: cfg.BanResponse,
ipv6GroupPrefix: cfg.IPv6GroupPrefix, ipv6GroupPrefix: cfg.IPv6GroupPrefix,
hitNoter: hitNoter, hitNoter: hitNoter,
}, },
tagDeny{tags: cfg.TagDeny, banResponse: cfg.BanResponse}, tagDeny{tags: cfg.TagDeny},
rateLimits{ rateLimits{
limiter: params.Limiter, limiter: params.Limiter,
exemptNets: cfg.RateLimitExemptNets, exemptNets: cfg.RateLimitExemptNets,
@@ -242,13 +235,12 @@ func newHandler(params Params) *handler {
}, },
} }
h.besideLookup = []heuristic{h.trapPaths, h.ruleFiles, h.coreRuleSet} h.besideLookup = []heuristic{h.trapPaths, h.ruleFiles, h.coreRuleSet}
h.afterBesideLookup = []heuristic{ h.afterBesideLookup = []heuristic{tagDeny{tags: cfg.TagDeny}}
tagDeny{tags: cfg.TagDeny, banResponse: cfg.BanResponse},
}
h.afterAnswer = []heuristic{ h.afterAnswer = []heuristic{
refusalLimit{ refusalLimit{
limiter: params.Limiter, limiter: params.Limiter,
perMinute: cfg.RefusalsLimitPerMinute, perMinute: cfg.RefusalsLimitPerMinute,
banResponse: cfg.BanResponse,
ipv6GroupPrefix: cfg.IPv6GroupPrefix, ipv6GroupPrefix: cfg.IPv6GroupPrefix,
banMaker: sharedBanMaker, banMaker: sharedBanMaker,
}, },
+3 -6
View File
@@ -344,8 +344,8 @@ func startProxyWithAlerts(
return startRProxy(t, server.Addr, appURL, env), out, server, alertQueue return startRProxy(t, server.Addr, appURL, env), out, server, alertQueue
} }
// serve serves server on a port of its own until the test ends, and sets // serve serves server on a port of its own until the test ends, and sets its
// server.Addr to where it listens. // Addr to where it listens.
func serve(t *testing.T, server *wafAndParts) { func serve(t *testing.T, server *wafAndParts) {
t.Helper() t.Helper()
@@ -423,13 +423,10 @@ func startRProxy(
} }
// wafAndParts is waf's server with the Params it was built from, so that a // wafAndParts is waf's server with the Params it was built from, so that a
// test can read the parts the server uses. Addr is where it listens once serve // test can read the parts the server uses.
// has it serving.
type wafAndParts struct { type wafAndParts struct {
*waf.Server *waf.Server
waf.Params waf.Params
Addr string
} }
// banAbuseIPDBBlacklist does on w what a fetch of AbuseIPDB's blacklist with // banAbuseIPDBBlacklist does on w what a fetch of AbuseIPDB's blacklist with
+4 -6
View File
@@ -17,9 +17,9 @@ import (
// countedByRateLimits exempts it, by the client's limit percentages, which it // countedByRateLimits exempts it, by the client's limit percentages, which it
// notes for the log line with the client's counts. A request that takes the // notes for the log line with the client's counts. A request that takes the
// client over a rate limit, as its limit percentage lowers it, breaks it: it is // client over a rate limit, as its limit percentage lowers it, breaks it: it is
// refused with SWW_WAF_BAN_RESPONSE, and bans the client. A request exempt // refused, and bans the client. A request exempt from the rate limits is exempt
// from the rate limits is exempt from the byte limits too. Its figures are the // from the byte limits too. Its figures are the window, the count and the
// window, the count and the limit. // limit.
type rateLimits struct { type rateLimits struct {
limiter *ratelimit.Limiter limiter *ratelimit.Limiter
exemptNets []netip.Prefix // SWW_WAF_RATE_LIMIT_EXEMPT_NETS exemptNets []netip.Prefix // SWW_WAF_RATE_LIMIT_EXEMPT_NETS
@@ -63,9 +63,7 @@ func (r rateLimits) check(
r.banMaker.banForLimit(rq, now, hit, r.banResponse) r.banMaker.banForLimit(rq, now, hit, r.banResponse)
return &verdict{ return &verdict{
action: requestlog.ActionClientIsRateLimited, action: requestlog.ActionClientIsRateLimited, figures: limitFigures(hit),
status: r.banResponse,
figures: limitFigures(hit),
} }
} }
+27 -4
View File
@@ -1,12 +1,15 @@
package waf package waf
// The heuristic refusal_limit. It reads SWW_WAF_REFUSALS_LIMIT_PER_MINUTE. // The heuristic refusal_limit. It reads SWW_WAF_REFUSALS_LIMIT_PER_MINUTE and
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
"net/http"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/ratelimit" "sneak.berlin/go/smallwebwaf/internal/ratelimit"
"sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// refusalLimit counts the request once it has been answered, if waf // refusalLimit counts the request once it has been answered, if waf
@@ -15,11 +18,11 @@ import (
// SWW_WAF_REFUSALS_LIMIT_PER_MINUTE such refusals of the client within a minute break // SWW_WAF_REFUSALS_LIMIT_PER_MINUTE such refusals of the client within a minute break
// a limit, which bans the client. A client in SWW_WAF_ALLOW_NETS, which the // a limit, which bans the client. A client in SWW_WAF_ALLOW_NETS, which the
// heuristics skip, is not counted, and nothing is while the limit is off. // heuristics skip, is not counted, and nothing is while the limit is off.
// The ban's notes give the status the client was sent, or in observe mode // Its figures are the window, the count and the limit.
// would have been. Its figures are the window, the count and the limit.
type refusalLimit struct { type refusalLimit struct {
limiter *ratelimit.Limiter limiter *ratelimit.Limiter
perMinute int64 // SWW_WAF_REFUSALS_LIMIT_PER_MINUTE perMinute int64 // SWW_WAF_REFUSALS_LIMIT_PER_MINUTE
banResponse int // SWW_WAF_BAN_RESPONSE
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
banMaker banMaker banMaker banMaker
} }
@@ -48,7 +51,27 @@ func (r refusalLimit) check(
return nil return nil
} }
r.banMaker.banForLimit(rq, now, hit, rq.refusalStatus) // What the client was sent, or in observe mode would have been.
status := rq.out.status
switch rq.wouldAction {
case requestlog.ActionBlockedByBlockRule,
requestlog.ActionBlockedByCoreRuleSet:
status = http.StatusForbidden
case requestlog.ActionTemporarilyBanned,
requestlog.ActionPermanentlyBanned:
status = r.banResponse
case requestlog.ActionForward,
requestlog.ActionRequestLineTooLong,
requestlog.ActionRequestHeaderTooLarge,
requestlog.ActionClientIsRateLimited,
requestlog.ActionClientDenied,
requestlog.ActionCountryDenied,
requestlog.ActionChecksTimedOut,
requestlog.ActionOwnEndpoint:
}
r.banMaker.banForLimit(rq, now, hit, status)
return &verdict{figures: limitFigures(hit)} return &verdict{figures: limitFigures(hit)}
} }
+25 -12
View File
@@ -69,10 +69,6 @@ type decision struct {
// its client's history counts. trapPaths and ruleFiles set attack, // its client's history counts. trapPaths and ruleFiles set attack,
// ruleFiles blockedByBlockRule, and coreRuleSet blockedByCoreRuleSet. // ruleFiles blockedByBlockRule, and coreRuleSet blockedByCoreRuleSet.
attack, blockedByBlockRule, blockedByCoreRuleSet bool attack, blockedByBlockRule, blockedByCoreRuleSet bool
// refusalStatus is the status of the verdict that refused the request, or
// in observe mode would have: what the visitor was answered with, or would
// have been. check sets it.
refusalStatus int
// wouldAction is, in observe mode, the action enforce mode would have // wouldAction is, in observe mode, the action enforce mode would have
// refused the request with, one of requestlog's Action constants, and "" // refused the request with, one of requestlog's Action constants, and ""
// otherwise. check sets it. // otherwise. check sets it.
@@ -207,8 +203,9 @@ func requestHeaders(r *http.Request, names []string) map[string]string {
// check is the one place where a request can be refused. It returns nil to let // check is the one place where a request can be refused. It returns nil to let
// the request through. The heuristics of checkClient decide: a request they // the request through. The heuristics of checkClient decide: a request they
// refuse is answered with the status and logged with the action of the verdict // refuse is answered with SWW_WAF_BAN_RESPONSE, 403 for a block rule or the Core
// that refused it. In observe mode nothing is refused, and the log line names // Rule Set, 503 for heuristics that ran out of time, or 414 or 431 for the
// header limits. In observe mode nothing is refused, and the log line names
// what enforce mode would have done. ctx is the request's own context. // what enforce mode would have done. ctx is the request's own context.
func (rq *request) check(ctx context.Context) *refusal { func (rq *request) check(ctx context.Context) *refusal {
v := rq.checkClient(ctx) v := rq.checkClient(ctx)
@@ -216,16 +213,32 @@ func (rq *request) check(ctx context.Context) *refusal {
return nil return nil
} }
rq.refusalStatus = v.status action := v.action
if rq.h.config.Observe { switch {
rq.wouldAction = v.action case rq.h.config.Observe:
rq.line.WouldAction = v.action rq.wouldAction = action
rq.line.WouldAction = action
return nil return nil
case action == requestlog.ActionBlockedByBlockRule ||
action == requestlog.ActionBlockedByCoreRuleSet:
return &refusal{status: http.StatusForbidden, action: action}
case action == requestlog.ActionChecksTimedOut:
return &refusal{
status: http.StatusServiceUnavailable,
action: action,
}
case action == requestlog.ActionRequestLineTooLong:
return &refusal{status: http.StatusRequestURITooLong, action: action}
case action == requestlog.ActionRequestHeaderTooLarge:
return &refusal{
status: http.StatusRequestHeaderFieldsTooLarge,
action: action,
}
default:
return rq.banResponse(action)
} }
return &refusal{status: v.status, action: v.action}
} }
// checkClient runs the heuristics on the request, and returns the first // checkClient runs the heuristics on the request, and returns the first
+3 -8
View File
@@ -1,12 +1,10 @@
package waf package waf
// The heuristic rule_files. It reads the rules of the rule files, which // The heuristic rule_files. It reads the rules of the rule files, which
// SWW_WAF_RULE_FILES_DIR and SWW_WAF_RULE_FILES_ENABLED name, and // SWW_WAF_RULE_FILES_DIR and SWW_WAF_RULE_FILES_ENABLED name.
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
"net/http"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/bans" "sneak.berlin/go/smallwebwaf/internal/bans"
@@ -19,9 +17,8 @@ import (
// ruleFiles takes the rules of the rule files the request matched, which // ruleFiles takes the rules of the rule files the request matched, which
// findBesideLookup found, notes their ids in the log line, adds the tag // findBesideLookup found, notes their ids in the log line, adds the tag
// exploitsignature when it matches any, and refuses the request // exploitsignature when it matches any, and refuses the request
// when the last rule it matches refuses it: with 403 and // when the last rule it matches refuses it: with ActionBlockedByBlockRule for a
// ActionBlockedByBlockRule for a block rule, and for a ban rule with // block rule, and for a ban rule with the action for the ban it makes. A ban
// SWW_WAF_BAN_RESPONSE and the action for the ban it makes. A ban
// rule bans the client's netblock for a clear sign of attack, or in observe // rule bans the client's netblock for a clear sign of attack, or in observe
// mode raises the alert for the ban // mode raises the alert for the ban
// it would have made. Either rule's match is noted as an offence, for the // it would have made. Either rule's match is noted as an offence, for the
@@ -62,7 +59,6 @@ func (r ruleFiles) check(
return &verdict{ return &verdict{
action: requestlog.ActionBlockedByBlockRule, action: requestlog.ActionBlockedByBlockRule,
status: http.StatusForbidden,
figures: figures, figures: figures,
} }
case rules.ActionBan: case rules.ActionBan:
@@ -74,7 +70,6 @@ func (r ruleFiles) check(
now, now,
bans.Notes{RuleID: last.ID, Target: last.Target}, bans.Notes{RuleID: last.ID, Target: last.Target},
), ),
status: r.banMaker.banResponse,
figures: figures, figures: figures,
} }
case rules.ActionLog: case rules.ActionLog:
+4 -6
View File
@@ -1,6 +1,6 @@
package waf package waf
// The heuristic tag_deny. It reads SWW_WAF_TAG_DENY and SWW_WAF_BAN_RESPONSE. // The heuristic tag_deny. It reads SWW_WAF_TAG_DENY.
import ( import (
"context" "context"
@@ -10,11 +10,10 @@ import (
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// tagDeny refuses a request that carries a tag in SWW_WAF_TAG_DENY, with // tagDeny refuses a request that carries a tag in SWW_WAF_TAG_DENY. Its figure is
// SWW_WAF_BAN_RESPONSE. Its figure is the first such tag, in sorted order. // the first such tag, in sorted order.
type tagDeny struct { type tagDeny struct {
tags []string // SWW_WAF_TAG_DENY tags []string // SWW_WAF_TAG_DENY
banResponse int // SWW_WAF_BAN_RESPONSE
} }
func (tagDeny) name() string { return "tag_deny" } func (tagDeny) name() string { return "tag_deny" }
@@ -28,7 +27,6 @@ func (t tagDeny) check(
if slices.Contains(t.tags, tag) { if slices.Contains(t.tags, tag) {
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: t.banResponse,
figures: map[string]any{"tag": tag}, figures: map[string]any{"tag": tag},
} }
} }
+5 -7
View File
@@ -1,7 +1,6 @@
package waf package waf
// The heuristic trap_paths. It reads SWW_WAF_TRAP_PATHS and // The heuristic trap_paths. It reads SWW_WAF_TRAP_PATHS.
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
@@ -13,10 +12,10 @@ import (
) )
// trapPaths refuses a request for a path in SWW_WAF_TRAP_PATHS, as trapPath // trapPaths refuses a request for a path in SWW_WAF_TRAP_PATHS, as trapPath
// finds it, with SWW_WAF_BAN_RESPONSE. Such a request is a clear sign of // finds it. Such a request is a clear sign of attack, as a ban rule's match is:
// attack, as a ban rule's match is: it bans the client's netblock, or in // it bans the client's netblock, or in observe mode raises the alert for the
// observe mode raises the alert for the ban it would have made. The ban's // ban it would have made. The ban's notes give the path as sent, and so does
// notes give the path as sent, and so does its figure. // its figure.
type trapPaths struct { type trapPaths struct {
paths []string // SWW_WAF_TRAP_PATHS paths []string // SWW_WAF_TRAP_PATHS
banMaker banMaker banMaker banMaker
@@ -42,7 +41,6 @@ func (t trapPaths) check(
now, now,
bans.Notes{TrapPath: path}, bans.Notes{TrapPath: path},
), ),
status: t.banMaker.banResponse,
figures: map[string]any{"path": path}, figures: map[string]any{"path": path},
} }
} }
+12 -37
View File
@@ -4,7 +4,6 @@ import (
"context" "context"
"errors" "errors"
"log/slog" "log/slog"
"net"
"net/http" "net/http"
"strings" "strings"
"time" "time"
@@ -31,43 +30,19 @@ const (
// is far above rproxy's, and a question refused for its size would have rproxy // is far above rproxy's, and a question refused for its size would have rproxy
// let the request through. // let the request through.
func New(params Params) *Server { func New(params Params) *Server {
s := &Server{h: newHandler(params)} return &Server{
s.httpServer = &http.Server{ Server: &http.Server{
Addr: params.Config.ListenAddr, Addr: params.Config.ListenAddr,
Handler: s, Handler: newHandler(params),
ErrorLog: slog.NewLogLogger( ErrorLog: slog.NewLogLogger(
params.ProcessLog.Handler(), params.ProcessLog.Handler(),
slog.LevelWarn, slog.LevelWarn,
), ),
ReadTimeout: wafTimeout, ReadTimeout: wafTimeout,
WriteTimeout: wafTimeout, WriteTimeout: wafTimeout,
IdleTimeout: wafIdleTimeout, IdleTimeout: wafIdleTimeout,
},
} }
return s
}
// Serve serves requests on listener until Shutdown or Close, as Go's
// http.Server.Serve does.
func (s *Server) Serve(listener net.Listener) error {
return s.httpServer.Serve(listener)
}
// Shutdown stops serving once the requests in progress have finished, or
// when ctx is done, as Go's http.Server.Shutdown does.
func (s *Server) Shutdown(ctx context.Context) error {
return s.httpServer.Shutdown(ctx)
}
// Close stops serving at once and closes every connection, as Go's
// http.Server.Close does.
func (s *Server) Close() error {
return s.httpServer.Close()
}
// ServeHTTP handles one request to waf, as handler.ServeHTTP says.
func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
s.h.ServeHTTP(w, r)
} }
// ServeHTTP handles one request to waf: a request carrying // ServeHTTP handles one request to waf: a request carrying
+8 -10
View File
@@ -703,9 +703,7 @@ func TestQuestionWhoseBodyStopsArrivingGetsNoAnswer(t *testing.T) {
t, t,
"", "",
map[string]string{metricsToken: token}, map[string]string{metricsToken: token},
func(server *wafAndParts) { func(server *wafAndParts) { server.ReadTimeout = readTimeout },
server.HTTPServer().ReadTimeout = readTimeout
},
) )
conn := dial(t, s.addr) conn := dial(t, s.addr)
@@ -1836,16 +1834,16 @@ func TestLogLevelHoldsBackNoRequestLine(t *testing.T) {
func TestServerHasTheTimeLimitsSPECGives(t *testing.T) { func TestServerHasTheTimeLimitsSPECGives(t *testing.T) {
t.Parallel() t.Parallel()
server := startWAF(t, "", nil).server.HTTPServer() s := startWAF(t, "", nil)
if server.ReadTimeout != time.Minute || if s.server.ReadTimeout != time.Minute ||
server.WriteTimeout != time.Minute || s.server.WriteTimeout != time.Minute ||
server.IdleTimeout != 2*time.Minute { s.server.IdleTimeout != 2*time.Minute {
t.Errorf( t.Errorf(
"the read, write and idle limits are %v, %v and %v, want 1m, 1m and 2m", "the read, write and idle limits are %v, %v and %v, want 1m, 1m and 2m",
server.ReadTimeout, s.server.ReadTimeout,
server.WriteTimeout, s.server.WriteTimeout,
server.IdleTimeout, s.server.IdleTimeout,
) )
} }
} }