Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
249d6a1142 | ||
|
|
0a0850f797 | ||
|
|
56a57125f1 |
No files matched your search
@@ -902,6 +902,8 @@ stops the running process (see [`docs/state-files.md`](docs/state-files.md)).
|
|||||||
- `internal/rproxy`: the reverse proxy in front of one app.
|
- `internal/rproxy`: the reverse proxy in front of one app.
|
||||||
- `internal/waf`: `waf`'s server, which runs the checks and answers its own
|
- `internal/waf`: `waf`'s server, which runs the checks and answers its own
|
||||||
endpoints.
|
endpoints.
|
||||||
|
- `internal/wafprotocol`: the question, the answer and the report that `rproxy`
|
||||||
|
and `waf` send each other.
|
||||||
- `internal/ratelimit`, `internal/bans`, `internal/rules`,
|
- `internal/ratelimit`, `internal/bans`, `internal/rules`,
|
||||||
`internal/coreruleset`, `internal/geojs`, `internal/lookup`,
|
`internal/coreruleset`, `internal/geojs`, `internal/lookup`,
|
||||||
`internal/reputation`, `internal/routewatch`, `internal/anomaly` and
|
`internal/reputation`, `internal/routewatch`, `internal/anomaly` and
|
||||||
|
|||||||
@@ -73,13 +73,16 @@ never as a time.
|
|||||||
`go.uber.org/fx`. fx builds the parts of `waf` and `rproxy`, and starts
|
`go.uber.org/fx`. fx builds the parts of `waf` and `rproxy`, and starts
|
||||||
and stops their background work.
|
and stops their background work.
|
||||||
- `internal/config`: reads the settings, the one place they are read.
|
- `internal/config`: reads the settings, the one place they are read.
|
||||||
- `internal/waf`: `waf`'s server. It runs the checks in `check`, and holds
|
- `internal/waf`: `waf`'s server. It runs the checks in `check`, and answers
|
||||||
`waf`'s question, answer and report. It answers `waf`'s own endpoints in
|
`waf`'s own endpoints in `answerOwnEndpoint`. It counts bytes, refusals
|
||||||
`answerOwnEndpoint`. It counts bytes, refusals and anomalies, and writes
|
and anomalies, and writes the log lines.
|
||||||
the log lines.
|
|
||||||
- `internal/rproxy`: the reverse proxy in front of one app that asks `waf`
|
- `internal/rproxy`: the reverse proxy in front of one app that asks `waf`
|
||||||
about each request. It passes a request to the app with the standard
|
about each request. It passes a request to the app with the standard
|
||||||
library's `httputil.ReverseProxy`, within the time and size limits.
|
library's `httputil.ReverseProxy`, within the time and size limits.
|
||||||
|
- `internal/wafprotocol`: the question, the answer and the report that
|
||||||
|
`rproxy` and `waf` send each other (see "`waf`"). It writes and reads each
|
||||||
|
one, and declares every header, path and limit both sides use.
|
||||||
|
`internal/rproxy` imports it, not `internal/waf`.
|
||||||
- `internal/ratelimit`: the table of clients. It counts requests, bytes and
|
- `internal/ratelimit`: the table of clients. It counts requests, bytes and
|
||||||
refusals, and keeps each client's history.
|
refusals, and keeps each client's history.
|
||||||
- `internal/bans`: the bans. It holds each netblock's bans with their notes,
|
- `internal/bans`: the bans. It holds each netblock's bans with their notes,
|
||||||
|
|||||||
@@ -7,16 +7,6 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The headers rproxy sets on the requests it passes to the app. Go writes every
|
|
||||||
// header name in this form, as it sends it and as it receives it, so
|
|
||||||
// X-Client-ASN arrives as X-Client-Asn, and Del removes a visitor's own whatever
|
|
||||||
// their case; header names are not case-sensitive.
|
|
||||||
const (
|
|
||||||
requestIDHeader = "X-Request-ID"
|
|
||||||
asnHeader = "X-Client-Asn"
|
|
||||||
countryHeader = "X-Client-Country"
|
|
||||||
)
|
|
||||||
|
|
||||||
// peerAddress is the address of the request's TCP peer, normally traefik, without
|
// peerAddress is the address of the request's TCP peer, normally traefik, without
|
||||||
// any IPv6 zone, which waf refuses.
|
// any IPv6 zone, which waf refuses.
|
||||||
func peerAddress(r *http.Request) netip.Addr {
|
func peerAddress(r *http.Request) netip.Addr {
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/config/configtest"
|
"sneak.berlin/go/smallwebwaf/internal/config/configtest"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/processlog"
|
"sneak.berlin/go/smallwebwaf/internal/processlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/rproxy"
|
"sneak.berlin/go/smallwebwaf/internal/rproxy"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// post is the start of a POST whose headers end with what follows it.
|
// post is the start of a POST whose headers end with what follows it.
|
||||||
@@ -492,7 +492,7 @@ func TestASettingOfOffSetsNoLimit(t *testing.T) {
|
|||||||
strings.NewReader("a body"))),
|
strings.NewReader("a body"))),
|
||||||
)
|
)
|
||||||
|
|
||||||
if got := get(t, addr, waf.HealthPath); got.status != http.StatusOK {
|
if got := get(t, addr, wafprotocol.HealthPath); got.status != http.StatusOK {
|
||||||
t.Errorf("answered %+v, want rproxy's own 200", got)
|
t.Errorf("answered %+v, want rproxy's own 200", got)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
@@ -1480,7 +1480,7 @@ func TestAVisitorThatStopsALittleShortGetsAnAnswerRProxyGivesAtOnce(
|
|||||||
{"a deny", post, http.StatusForbidden},
|
{"a deny", post, http.StatusForbidden},
|
||||||
{
|
{
|
||||||
"the health check",
|
"the health check",
|
||||||
"GET " + waf.HealthPath + " HTTP/1.1\r\nHost: site.example\r\n",
|
"GET " + wafprotocol.HealthPath + " HTTP/1.1\r\nHost: site.example\r\n",
|
||||||
http.StatusOK,
|
http.StatusOK,
|
||||||
},
|
},
|
||||||
} {
|
} {
|
||||||
|
|||||||
@@ -12,11 +12,11 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// questionBodyMaxBytes is the most of a body a question carries.
|
// questionBodyMaxBytes is the most of a body a question carries.
|
||||||
const questionBodyMaxBytes = waf.QuestionBodyMaxBytes
|
const questionBodyMaxBytes = wafprotocol.QuestionBodyMaxBytes
|
||||||
|
|
||||||
// chunked is the encoding of a body whose length the visitor did not announce.
|
// chunked is the encoding of a body whose length the visitor did not announce.
|
||||||
const chunked = "chunked"
|
const chunked = "chunked"
|
||||||
@@ -42,9 +42,9 @@ func TestQuestionIsTheVisitorsRequestWithRProxysHeaders(t *testing.T) {
|
|||||||
req.Header.Set(forwardedForHeader, "198.51.100.1")
|
req.Header.Set(forwardedForHeader, "198.51.100.1")
|
||||||
req.Header.Set(forwardedProtoHeader, "gopher")
|
req.Header.Set(forwardedProtoHeader, "gopher")
|
||||||
req.Header.Set(requestIDHeader, "the-visitor's")
|
req.Header.Set(requestIDHeader, "the-visitor's")
|
||||||
req.Header.Set(waf.ClientHeader, "198.51.100.2")
|
req.Header.Set(wafprotocol.ClientHeader, "198.51.100.2")
|
||||||
req.Header.Set(waf.PeerHeader, "198.51.100.3")
|
req.Header.Set(wafprotocol.PeerHeader, "198.51.100.3")
|
||||||
req.Header.Set(waf.ContentLengthHeader, "12345")
|
req.Header.Set(wafprotocol.ContentLengthHeader, "12345")
|
||||||
// Go's client then sends no User-Agent, so that one in the question would be
|
// Go's client then sends no User-Agent, so that one in the question would be
|
||||||
// Go's own.
|
// Go's own.
|
||||||
req.Header["User-Agent"] = nil
|
req.Header["User-Agent"] = nil
|
||||||
@@ -73,8 +73,8 @@ func TestQuestionIsTheVisitorsRequestWithRProxysHeaders(t *testing.T) {
|
|||||||
want.Set(forwardedForHeader, "198.51.100.1")
|
want.Set(forwardedForHeader, "198.51.100.1")
|
||||||
want.Set(forwardedProtoHeader, "http")
|
want.Set(forwardedProtoHeader, "http")
|
||||||
want.Set(requestIDHeader, asked.header.Get(requestIDHeader))
|
want.Set(requestIDHeader, asked.header.Get(requestIDHeader))
|
||||||
want.Set(waf.ClientHeader, localhost)
|
want.Set(wafprotocol.ClientHeader, localhost)
|
||||||
want.Set(waf.PeerHeader, localhost)
|
want.Set(wafprotocol.PeerHeader, localhost)
|
||||||
|
|
||||||
if !maps.EqualFunc(asked.header, want, slices.Equal) {
|
if !maps.EqualFunc(asked.header, want, slices.Equal) {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
@@ -124,8 +124,8 @@ func TestQuestionNamesTheVisitorATrustedProxySpeaksFor(t *testing.T) {
|
|||||||
wantGreeting(t, visit(t, req))
|
wantGreeting(t, visit(t, req))
|
||||||
|
|
||||||
asked := standIn.question(t)
|
asked := standIn.question(t)
|
||||||
if asked.header.Get(waf.ClientHeader) != tc.client ||
|
if asked.header.Get(wafprotocol.ClientHeader) != tc.client ||
|
||||||
asked.header.Get(waf.PeerHeader) != localhost ||
|
asked.header.Get(wafprotocol.PeerHeader) != localhost ||
|
||||||
asked.header.Get(forwardedForHeader) != visitor ||
|
asked.header.Get(forwardedForHeader) != visitor ||
|
||||||
asked.header.Get(forwardedProtoHeader) != tc.proto {
|
asked.header.Get(forwardedProtoHeader) != tc.proto {
|
||||||
t.Errorf("the question's headers are %v", asked.header)
|
t.Errorf("the question's headers are %v", asked.header)
|
||||||
@@ -191,7 +191,7 @@ func TestQuestionNamesTheClientAsTheForwardedAddressesSay(t *testing.T) {
|
|||||||
req.Header[forwardedForHeader] = tc.header
|
req.Header[forwardedForHeader] = tc.header
|
||||||
wantGreeting(t, visit(t, req))
|
wantGreeting(t, visit(t, req))
|
||||||
|
|
||||||
if got := standIn.question(t).header.Get(waf.ClientHeader); got !=
|
if got := standIn.question(t).header.Get(wafprotocol.ClientHeader); got !=
|
||||||
tc.client {
|
tc.client {
|
||||||
t.Errorf("the question names %s, want %s", got, tc.client)
|
t.Errorf("the question names %s, want %s", got, tc.client)
|
||||||
}
|
}
|
||||||
@@ -282,7 +282,7 @@ func wantQuestionBody(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
values := asked.header.Values(waf.ContentLengthHeader)
|
values := asked.header.Values(wafprotocol.ContentLengthHeader)
|
||||||
|
|
||||||
if announced {
|
if announced {
|
||||||
if !slices.Equal(values, []string{strconv.Itoa(size)}) ||
|
if !slices.Equal(values, []string{strconv.Itoa(size)}) ||
|
||||||
@@ -586,8 +586,8 @@ func TestAQuestionNamesNoZone(t *testing.T) {
|
|||||||
server.Handler.ServeHTTP(httptest.NewRecorder(), req)
|
server.Handler.ServeHTTP(httptest.NewRecorder(), req)
|
||||||
|
|
||||||
asked := standIn.question(t)
|
asked := standIn.question(t)
|
||||||
if asked.header.Get(waf.ClientHeader) != tc.client ||
|
if asked.header.Get(wafprotocol.ClientHeader) != tc.client ||
|
||||||
asked.header.Get(waf.PeerHeader) != tc.peer {
|
asked.header.Get(wafprotocol.PeerHeader) != tc.peer {
|
||||||
t.Errorf("the question's headers are %v", asked.header)
|
t.Errorf("the question's headers are %v", asked.header)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+11
-13
@@ -18,17 +18,13 @@ import (
|
|||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/rules"
|
"sneak.berlin/go/smallwebwaf/internal/rules"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// flushAfterEachWrite has ReverseProxy pass on each part of the app's answer as
|
// flushAfterEachWrite has ReverseProxy pass on each part of the app's answer as
|
||||||
// soon as it arrives.
|
// soon as it arrives.
|
||||||
const flushAfterEachWrite time.Duration = -1
|
const flushAfterEachWrite time.Duration = -1
|
||||||
|
|
||||||
// reportStatusMax is the highest status waf takes in a report. An app can
|
|
||||||
// send a higher one, up to 999, and the visitor gets that as it is.
|
|
||||||
const reportStatusMax = 599
|
|
||||||
|
|
||||||
// plainText is the Content-Type of the answers rproxy gives itself.
|
// plainText is the Content-Type of the answers rproxy gives itself.
|
||||||
const plainText = "text/plain; charset=utf-8"
|
const plainText = "text/plain; charset=utf-8"
|
||||||
|
|
||||||
@@ -154,7 +150,7 @@ func (rq *request) readFirstPartOfBody() bool {
|
|||||||
|
|
||||||
_ = rq.rc.SetReadDeadline(rq.requestDeadline())
|
_ = rq.rc.SetReadDeadline(rq.requestDeadline())
|
||||||
held, err := io.ReadAll(
|
held, err := io.ReadAll(
|
||||||
io.LimitReader(rq.body, waf.QuestionBodyMaxBytes),
|
io.LimitReader(rq.body, wafprotocol.QuestionBodyMaxBytes),
|
||||||
)
|
)
|
||||||
// From here on, the request timer ends a read of the rest of the body, so that
|
// From here on, the request timer ends a read of the rest of the body, so that
|
||||||
// the answer can name the side rproxy was waiting on.
|
// the answer can name the side rproxy was waiting on.
|
||||||
@@ -228,16 +224,17 @@ func (rq *request) rewrite(pr *httputil.ProxyRequest) {
|
|||||||
setPathAsSent(pr.Out.URL, pr.In)
|
setPathAsSent(pr.Out.URL, pr.In)
|
||||||
|
|
||||||
setForwardedHeaders(pr.In, pr.Out, rq.peer, rq.peerTrusted)
|
setForwardedHeaders(pr.In, pr.Out, rq.peer, rq.peerTrusted)
|
||||||
pr.Out.Header.Set(requestIDHeader, rq.id)
|
pr.Out.Header.Set(wafprotocol.RequestIDHeader, rq.id)
|
||||||
pr.Out.Header.Del(asnHeader)
|
// Del removes a visitor's own, whatever their case.
|
||||||
pr.Out.Header.Del(countryHeader)
|
pr.Out.Header.Del(wafprotocol.ASNHeader)
|
||||||
|
pr.Out.Header.Del(wafprotocol.CountryHeader)
|
||||||
|
|
||||||
if rq.asn != "" {
|
if rq.asn != "" {
|
||||||
pr.Out.Header.Set(asnHeader, rq.asn)
|
pr.Out.Header.Set(wafprotocol.ASNHeader, rq.asn)
|
||||||
}
|
}
|
||||||
|
|
||||||
if rq.country != "" {
|
if rq.country != "" {
|
||||||
pr.Out.Header.Set(countryHeader, rq.country)
|
pr.Out.Header.Set(wafprotocol.CountryHeader, rq.country)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -470,9 +467,10 @@ func (rq *request) finish(ctx context.Context) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
report := &waf.Report{
|
// An app can send a status up to 999, and the visitor gets it as it is.
|
||||||
|
report := &wafprotocol.Report{
|
||||||
RequestID: rq.id,
|
RequestID: rq.id,
|
||||||
Status: min(rq.out.status, reportStatusMax),
|
Status: min(rq.out.status, wafprotocol.ReportStatusMax),
|
||||||
RequestBytes: requestBytes,
|
RequestBytes: requestBytes,
|
||||||
ResponseBytes: responseBytes,
|
ResponseBytes: responseBytes,
|
||||||
DurationTotalMS: requestlog.Milliseconds(end.Sub(rq.start)),
|
DurationTotalMS: requestlog.Milliseconds(end.Sub(rq.start)),
|
||||||
|
|||||||
+10
-12
@@ -24,7 +24,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// How rproxy keeps connections to the app and to waf open between
|
// How rproxy keeps connections to the app and to waf open between
|
||||||
@@ -47,10 +47,6 @@ const (
|
|||||||
idleTimeout = 120 * time.Second
|
idleTimeout = 120 * time.Second
|
||||||
)
|
)
|
||||||
|
|
||||||
// ownEndpointPrefix starts the path of every request for sww itself, which
|
|
||||||
// never reaches the app.
|
|
||||||
const ownEndpointPrefix = "/_sww/"
|
|
||||||
|
|
||||||
// allowedMethods lists the methods rproxy passes on, as an Allow header gives
|
// allowedMethods lists the methods rproxy passes on, as an Allow header gives
|
||||||
// them. It answers any other method 405 itself.
|
// them. It answers any other method 405 itself.
|
||||||
// The WebDAV ones are for Nextcloud.
|
// The WebDAV ones are for Nextcloud.
|
||||||
@@ -92,7 +88,9 @@ func New(params Params) *Server {
|
|||||||
transport: newTransport(),
|
transport: newTransport(),
|
||||||
wafTransport: newWAFTransport(),
|
wafTransport: newWAFTransport(),
|
||||||
reportURL: (&url.URL{
|
reportURL: (&url.URL{
|
||||||
Scheme: backend.Scheme, Host: backend.Host, Path: waf.ReportPath,
|
Scheme: backend.Scheme,
|
||||||
|
Host: backend.Host,
|
||||||
|
Path: wafprotocol.ReportPath,
|
||||||
}).String(),
|
}).String(),
|
||||||
breakerClock: time.Now,
|
breakerClock: time.Now,
|
||||||
}
|
}
|
||||||
@@ -179,7 +177,7 @@ func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
defer rq.readRestOfBody()
|
defer rq.readRestOfBody()
|
||||||
defer rq.finish(r.Context())
|
defer rq.finish(r.Context())
|
||||||
|
|
||||||
if r.Method == http.MethodGet && r.URL.Path == waf.HealthPath {
|
if r.Method == http.MethodGet && r.URL.Path == wafprotocol.HealthPath {
|
||||||
rq.answerHealth()
|
rq.answerHealth()
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -212,9 +210,9 @@ func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
rq.noteAnswer(answer)
|
rq.noteAnswer(answer)
|
||||||
|
|
||||||
switch rq.disposition {
|
switch rq.disposition {
|
||||||
case waf.DispositionAllow:
|
case wafprotocol.DispositionAllow:
|
||||||
rq.passToApp(r.Context())
|
rq.passToApp(r.Context())
|
||||||
case waf.DispositionClose:
|
case wafprotocol.DispositionClose:
|
||||||
// This panic has Go's server close the connection without an answer,
|
// This panic has Go's server close the connection without an answer,
|
||||||
// and log nothing; the deferred finish still runs.
|
// and log nothing; the deferred finish still runs.
|
||||||
panic(http.ErrAbortHandler)
|
panic(http.ErrAbortHandler)
|
||||||
@@ -224,8 +222,8 @@ func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// passToApp passes the request on to the app, unless a limit or its path keeps
|
// passToApp passes the request on to the app, unless a limit or its path keeps
|
||||||
// it from the app. waf answers a path under ownEndpointPrefix itself, so
|
// it from the app. waf answers a path under wafprotocol.OwnEndpointPrefix
|
||||||
// such a request gets here only when
|
// itself, so such a request gets here only when
|
||||||
// SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION allowed it.
|
// SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION allowed it.
|
||||||
// ctx is the request's own context.
|
// ctx is the request's own context.
|
||||||
func (rq *request) passToApp(ctx context.Context) {
|
func (rq *request) passToApp(ctx context.Context) {
|
||||||
@@ -234,7 +232,7 @@ func (rq *request) passToApp(ctx context.Context) {
|
|||||||
switch {
|
switch {
|
||||||
case rq.refused.Load() != 0 || (maxBytes > 0 && rq.in.ContentLength > maxBytes):
|
case rq.refused.Load() != 0 || (maxBytes > 0 && rq.in.ContentLength > maxBytes):
|
||||||
rq.answer(http.StatusRequestEntityTooLarge)
|
rq.answer(http.StatusRequestEntityTooLarge)
|
||||||
case strings.HasPrefix(rq.in.URL.Path, ownEndpointPrefix):
|
case strings.HasPrefix(rq.in.URL.Path, wafprotocol.OwnEndpointPrefix):
|
||||||
rq.answer(http.StatusNotFound)
|
rq.answer(http.StatusNotFound)
|
||||||
default:
|
default:
|
||||||
rq.forward(ctx)
|
rq.forward(ctx)
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/config/configtest"
|
"sneak.berlin/go/smallwebwaf/internal/config/configtest"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/processlog"
|
"sneak.berlin/go/smallwebwaf/internal/processlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/rproxy"
|
"sneak.berlin/go/smallwebwaf/internal/rproxy"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -56,7 +56,7 @@ const (
|
|||||||
|
|
||||||
// The headers the tests set and look at.
|
// The headers the tests set and look at.
|
||||||
const (
|
const (
|
||||||
dispositionHeader = waf.DispositionHeader
|
dispositionHeader = wafprotocol.DispositionHeader
|
||||||
forwardedForHeader = "X-Forwarded-For"
|
forwardedForHeader = "X-Forwarded-For"
|
||||||
forwardedProtoHeader = "X-Forwarded-Proto"
|
forwardedProtoHeader = "X-Forwarded-Proto"
|
||||||
requestIDHeader = "X-Request-ID"
|
requestIDHeader = "X-Request-ID"
|
||||||
@@ -72,9 +72,9 @@ const (
|
|||||||
|
|
||||||
// What the stand-in for waf answers.
|
// What the stand-in for waf answers.
|
||||||
const (
|
const (
|
||||||
dispositionAllow = waf.DispositionAllow
|
dispositionAllow = wafprotocol.DispositionAllow
|
||||||
dispositionDeny = waf.DispositionDeny
|
dispositionDeny = wafprotocol.DispositionDeny
|
||||||
dispositionClose = waf.DispositionClose
|
dispositionClose = wafprotocol.DispositionClose
|
||||||
// deniedBody is the body of a deny.
|
// deniedBody is the body of a deny.
|
||||||
deniedBody = "refused by waf"
|
deniedBody = "refused by waf"
|
||||||
)
|
)
|
||||||
@@ -175,7 +175,7 @@ type WAF struct {
|
|||||||
*httptest.Server
|
*httptest.Server
|
||||||
|
|
||||||
questions chan question
|
questions chan question
|
||||||
reports chan waf.Report
|
reports chan wafprotocol.Report
|
||||||
}
|
}
|
||||||
|
|
||||||
// startWAF starts a stand-in for waf.
|
// startWAF starts a stand-in for waf.
|
||||||
@@ -184,11 +184,11 @@ func startWAF(t *testing.T, answer http.HandlerFunc) *WAF {
|
|||||||
|
|
||||||
s := &WAF{
|
s := &WAF{
|
||||||
questions: make(chan question, 10),
|
questions: make(chan question, 10),
|
||||||
reports: make(chan waf.Report, 10),
|
reports: make(chan wafprotocol.Report, 10),
|
||||||
}
|
}
|
||||||
s.Server = httptest.NewServer(http.HandlerFunc(
|
s.Server = httptest.NewServer(http.HandlerFunc(
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
func(w http.ResponseWriter, r *http.Request) {
|
||||||
if r.Header.Get(waf.ClientHeader) == "" {
|
if r.Header.Get(wafprotocol.ClientHeader) == "" {
|
||||||
s.takeReport(t, w, r)
|
s.takeReport(t, w, r)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -217,11 +217,11 @@ func (s *WAF) takeReport(
|
|||||||
) {
|
) {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
var report waf.Report
|
var report wafprotocol.Report
|
||||||
|
|
||||||
err := json.NewDecoder(r.Body).Decode(&report)
|
err := json.NewDecoder(r.Body).Decode(&report)
|
||||||
if err != nil || r.Method != http.MethodPost ||
|
if err != nil || r.Method != http.MethodPost ||
|
||||||
r.URL.Path != waf.ReportPath {
|
r.URL.Path != wafprotocol.ReportPath {
|
||||||
t.Errorf("%s %s is no report: %v", r.Method, r.URL.Path, err)
|
t.Errorf("%s %s is no report: %v", r.Method, r.URL.Path, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -242,7 +242,7 @@ func (s *WAF) wantNoReport(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// report waits for a report.
|
// report waits for a report.
|
||||||
func (s *WAF) report(t *testing.T) waf.Report {
|
func (s *WAF) report(t *testing.T) wafprotocol.Report {
|
||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
select {
|
select {
|
||||||
@@ -251,7 +251,7 @@ func (s *WAF) report(t *testing.T) waf.Report {
|
|||||||
case <-time.After(waitLimit):
|
case <-time.After(waitLimit):
|
||||||
t.Fatal("no report")
|
t.Fatal("no report")
|
||||||
|
|
||||||
return waf.Report{}
|
return wafprotocol.Report{}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -279,7 +279,7 @@ func startWAFAnsweringReports(
|
|||||||
|
|
||||||
backend := httptest.NewServer(http.HandlerFunc(
|
backend := httptest.NewServer(http.HandlerFunc(
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
func(w http.ResponseWriter, r *http.Request) {
|
||||||
if r.Header.Get(waf.ClientHeader) != "" {
|
if r.Header.Get(wafprotocol.ClientHeader) != "" {
|
||||||
answer(w, r)
|
answer(w, r)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -829,7 +829,7 @@ func TestAnAnswerRProxyHoldsWholeIsSentBeforeItsLogLine(t *testing.T) {
|
|||||||
}{
|
}{
|
||||||
{"a deny", "GET /" + host, deniedBody, http.StatusForbidden},
|
{"a deny", "GET /" + host, deniedBody, http.StatusForbidden},
|
||||||
{"rproxy's own answer", "GET x:admin" + host, "Bad Request\n", http.StatusBadRequest},
|
{"rproxy's own answer", "GET x:admin" + host, "Bad Request\n", http.StatusBadRequest},
|
||||||
{"the health check", "GET " + waf.HealthPath + host, "ok\n", http.StatusOK},
|
{"the health check", "GET " + wafprotocol.HealthPath + host, "ok\n", http.StatusOK},
|
||||||
} {
|
} {
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
@@ -1602,19 +1602,19 @@ func TestHealthCheckIsAnsweredWhileWAFIsDown(t *testing.T) {
|
|||||||
app := startApp(t, greet)
|
app := startApp(t, greet)
|
||||||
addr, out := startRProxy(t, nowhere, app.URL, nil)
|
addr, out := startRProxy(t, nowhere, app.URL, nil)
|
||||||
|
|
||||||
got := get(t, addr, waf.HealthPath)
|
got := get(t, addr, wafprotocol.HealthPath)
|
||||||
if got.status != http.StatusOK || got.body != "ok\n" {
|
if got.status != http.StatusOK || got.body != "ok\n" {
|
||||||
t.Errorf("answered %+v, want ok", got)
|
t.Errorf("answered %+v, want ok", got)
|
||||||
}
|
}
|
||||||
|
|
||||||
line := out.requestLine(t)
|
line := out.requestLine(t)
|
||||||
if line["path"] != waf.HealthPath || line["disposition"] != nil {
|
if line["path"] != wafprotocol.HealthPath || line["disposition"] != nil {
|
||||||
t.Errorf("line %v, want one with no disposition", line)
|
t.Errorf("line %v, want one with no disposition", line)
|
||||||
}
|
}
|
||||||
|
|
||||||
// With waf up too, it is not asked.
|
// With waf up too, it is not asked.
|
||||||
addr, _ = startRProxy(t, standIn.URL, app.URL, nil)
|
addr, _ = startRProxy(t, standIn.URL, app.URL, nil)
|
||||||
get(t, addr, waf.HealthPath)
|
get(t, addr, wafprotocol.HealthPath)
|
||||||
|
|
||||||
if len(standIn.questions) != 0 {
|
if len(standIn.questions) != 0 {
|
||||||
t.Error("waf was asked about the health check")
|
t.Error("waf was asked about the health check")
|
||||||
@@ -1775,7 +1775,7 @@ func TestWaitForReportsWaitsForAReportBeingSent(t *testing.T) {
|
|||||||
release := make(chan struct{})
|
release := make(chan struct{})
|
||||||
backend := httptest.NewServer(http.HandlerFunc(
|
backend := httptest.NewServer(http.HandlerFunc(
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
func(w http.ResponseWriter, r *http.Request) {
|
||||||
if r.Header.Get(waf.ClientHeader) != "" {
|
if r.Header.Get(wafprotocol.ClientHeader) != "" {
|
||||||
allow(w, r)
|
allow(w, r)
|
||||||
|
|
||||||
return
|
return
|
||||||
|
|||||||
+34
-82
@@ -1,9 +1,7 @@
|
|||||||
package rproxy
|
package rproxy
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
@@ -11,7 +9,8 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/rules"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// answerBodyMaxBytes is the most of the body of waf's answer that is read.
|
// answerBodyMaxBytes is the most of the body of waf's answer that is read.
|
||||||
@@ -40,15 +39,12 @@ type wafAnswer struct {
|
|||||||
// notes nothing, and no report is due for it: waf holds no decision to report
|
// notes nothing, and no report is due for it: waf holds no decision to report
|
||||||
// on.
|
// on.
|
||||||
func (rq *request) noteAnswer(answer *wafAnswer) {
|
func (rq *request) noteAnswer(answer *wafAnswer) {
|
||||||
disposition := answer.header.Get(waf.DispositionHeader)
|
read, valid := wafprotocol.ReadAnswer(answer.header)
|
||||||
|
if valid {
|
||||||
switch disposition {
|
rq.disposition = read.Disposition
|
||||||
case waf.DispositionAllow, waf.DispositionDeny,
|
|
||||||
waf.DispositionClose:
|
|
||||||
rq.disposition = disposition
|
|
||||||
rq.answered = true
|
rq.answered = true
|
||||||
rq.asn = answer.header.Get(asnHeader)
|
rq.asn = read.ASN
|
||||||
rq.country = answer.header.Get(countryHeader)
|
rq.country = read.Country
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -79,7 +75,7 @@ func (rq *request) handleNoUsableAnswer(ctx context.Context, err error) {
|
|||||||
rq.disposition = rq.h.config.WAFBackendNoAnswerDisposition
|
rq.disposition = rq.h.config.WAFBackendNoAnswerDisposition
|
||||||
rq.wafNoAnswer = true
|
rq.wafNoAnswer = true
|
||||||
|
|
||||||
if rq.disposition == waf.DispositionAllow {
|
if rq.disposition == wafprotocol.DispositionAllow {
|
||||||
rq.passToApp(ctx)
|
rq.passToApp(ctx)
|
||||||
} else {
|
} else {
|
||||||
rq.answer(http.StatusServiceUnavailable)
|
rq.answer(http.StatusServiceUnavailable)
|
||||||
@@ -119,7 +115,21 @@ func (rq *request) ask(ctx context.Context) (*wafAnswer, error) {
|
|||||||
ctx, cancel := context.WithTimeout(ctx, rq.h.config.WAFBackendTimeout)
|
ctx, cancel := context.WithTimeout(ctx, rq.h.config.WAFBackendTimeout)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
question, err := rq.newQuestion(ctx)
|
var held []byte
|
||||||
|
if rq.body != nil {
|
||||||
|
held = rq.body.held
|
||||||
|
}
|
||||||
|
|
||||||
|
question, err := wafprotocol.NewQuestion(ctx, wafprotocol.QuestionParams{
|
||||||
|
Visitor: rq.in,
|
||||||
|
PathAsSent: rules.Path(rq.in),
|
||||||
|
Body: held,
|
||||||
|
WAFBackend: rq.h.config.WAFBackend,
|
||||||
|
Client: rq.client,
|
||||||
|
Peer: rq.peer,
|
||||||
|
RequestID: rq.id,
|
||||||
|
Scheme: scheme(rq.in, rq.peerTrusted),
|
||||||
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -176,69 +186,13 @@ func canBeAsked(r *http.Request) bool {
|
|||||||
len(r.Header.Values("User-Agent")) <= 1
|
len(r.Header.Values("User-Agent")) <= 1
|
||||||
}
|
}
|
||||||
|
|
||||||
// newQuestion returns the question about the request, as "The question" in
|
|
||||||
// SPEC.md gives it: the visitor's request as the visitor sent it, with the part
|
|
||||||
// of the body it holds and rproxy's headers.
|
|
||||||
func (rq *request) newQuestion(ctx context.Context) (*http.Request, error) {
|
|
||||||
in := rq.in
|
|
||||||
|
|
||||||
var held []byte
|
|
||||||
if rq.body != nil {
|
|
||||||
held = rq.body.held
|
|
||||||
}
|
|
||||||
|
|
||||||
question, err := http.NewRequestWithContext( //nolint:gosec // a setting's URL
|
|
||||||
ctx,
|
|
||||||
in.Method,
|
|
||||||
rq.h.config.WAFBackend.String(),
|
|
||||||
bytes.NewReader(held),
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("make the question: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
backend := question.URL
|
|
||||||
target := *in.URL
|
|
||||||
target.Scheme = backend.Scheme
|
|
||||||
target.Host = backend.Host
|
|
||||||
setPathAsSent(&target, in)
|
|
||||||
question.URL = &target
|
|
||||||
question.Host = in.Host
|
|
||||||
|
|
||||||
// The length NewRequestWithContext set is that of what is held. This line makes
|
|
||||||
// a body whose length the visitor did not announce go chunked, as "The question"
|
|
||||||
// in SPEC.md requires.
|
|
||||||
question.TransferEncoding = in.TransferEncoding
|
|
||||||
|
|
||||||
question.Header = in.Header.Clone()
|
|
||||||
question.Header.Set(waf.ClientHeader, rq.client.String())
|
|
||||||
question.Header.Set(waf.PeerHeader, rq.peer.String())
|
|
||||||
question.Header.Del(waf.ContentLengthHeader)
|
|
||||||
|
|
||||||
announced := in.Header.Get("Content-Length")
|
|
||||||
if announced != "" {
|
|
||||||
question.Header.Set(waf.ContentLengthHeader, announced)
|
|
||||||
}
|
|
||||||
|
|
||||||
question.Header.Set(requestIDHeader, rq.id)
|
|
||||||
question.Header.Set("X-Forwarded-Proto", scheme(in, rq.peerTrusted))
|
|
||||||
|
|
||||||
// Go's client adds a User-Agent of its own to a request without the key.
|
|
||||||
_, sent := question.Header["User-Agent"]
|
|
||||||
if !sent {
|
|
||||||
question.Header["User-Agent"] = nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return question, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// answerWith gives the visitor waf's answer, less its disposition.
|
// answerWith gives the visitor waf's answer, less its disposition.
|
||||||
func (rq *request) answerWith(answer *wafAnswer) {
|
func (rq *request) answerWith(answer *wafAnswer) {
|
||||||
rq.prepareOwnAnswer(rq.requestDeadline())
|
rq.prepareOwnAnswer(rq.requestDeadline())
|
||||||
|
|
||||||
header := rq.out.Header()
|
header := rq.out.Header()
|
||||||
maps.Copy(header, answer.header)
|
maps.Copy(header, answer.header)
|
||||||
header.Del(waf.DispositionHeader)
|
header.Del(wafprotocol.DispositionHeader)
|
||||||
|
|
||||||
// Go's server adds a Content-Type it guesses from the body to a response whose
|
// Go's server adds a Content-Type it guesses from the body to a response whose
|
||||||
// headers have no Content-Type key. The key with no value sends none.
|
// headers have no Content-Type key. The key with no value sends none.
|
||||||
@@ -252,7 +206,10 @@ func (rq *request) answerWith(answer *wafAnswer) {
|
|||||||
// sendReport sends waf report on a goroutine of its own, so that the
|
// sendReport sends waf report on a goroutine of its own, so that the
|
||||||
// visitor does not wait for it. The report goes on after ctx, the request's own
|
// visitor does not wait for it. The report goes on after ctx, the request's own
|
||||||
// context, has ended.
|
// context, has ended.
|
||||||
func (h *handler) sendReport(ctx context.Context, report *waf.Report) {
|
func (h *handler) sendReport(
|
||||||
|
ctx context.Context,
|
||||||
|
report *wafprotocol.Report,
|
||||||
|
) {
|
||||||
h.reportsMu.Lock()
|
h.reportsMu.Lock()
|
||||||
defer h.reportsMu.Unlock()
|
defer h.reportsMu.Unlock()
|
||||||
|
|
||||||
@@ -270,23 +227,18 @@ func (h *handler) sendReport(ctx context.Context, report *waf.Report) {
|
|||||||
|
|
||||||
// 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(ctx context.Context, report *waf.Report) error {
|
func (h *handler) postReport(
|
||||||
body, err := json.Marshal(report)
|
ctx context.Context,
|
||||||
if err != nil {
|
report *wafprotocol.Report,
|
||||||
return fmt.Errorf("encode the report: %w", err)
|
) error {
|
||||||
}
|
|
||||||
|
|
||||||
ctx, cancel := context.WithTimeout(ctx, h.config.WAFBackendTimeout)
|
ctx, cancel := context.WithTimeout(ctx, h.config.WAFBackendTimeout)
|
||||||
defer cancel()
|
defer cancel()
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext( //nolint:gosec // a setting's URL
|
req, err := wafprotocol.NewReportRequest(ctx, h.reportURL, report)
|
||||||
ctx, http.MethodPost, h.reportURL, bytes.NewReader(body))
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("make the request: %w", err)
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
req.Header.Set("Content-Type", "application/json")
|
|
||||||
|
|
||||||
res, err := h.wafTransport.RoundTrip(req)
|
res, err := h.wafTransport.RoundTrip(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("send the report: %w", err)
|
return fmt.Errorf("send the report: %w", err)
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ import (
|
|||||||
"github.com/spf13/viper"
|
"github.com/spf13/viper"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// healthCheckTimeout bounds the whole health check.
|
// healthCheckTimeout bounds the whole health check.
|
||||||
@@ -116,7 +116,7 @@ func askHealthEndpoint(ctx context.Context, listenAddr string) error {
|
|||||||
health := "http://" + net.JoinHostPort(
|
health := "http://" + net.JoinHostPort(
|
||||||
"127.0.0.1",
|
"127.0.0.1",
|
||||||
port,
|
port,
|
||||||
) + waf.HealthPath
|
) + wafprotocol.HealthPath
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(
|
req, err := http.NewRequestWithContext(
|
||||||
ctx,
|
ctx,
|
||||||
|
|||||||
+17
-17
@@ -21,7 +21,7 @@ import (
|
|||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config/configtest"
|
"sneak.berlin/go/smallwebwaf/internal/config/configtest"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/sww"
|
"sneak.berlin/go/smallwebwaf/internal/sww"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -164,7 +164,7 @@ func TestABanThroughOneSiteRefusesTheClientOnTheOther(t *testing.T) {
|
|||||||
|
|
||||||
// One request's three lines carry one id, rproxy's with waf's answer.
|
// One request's three lines carry one id, rproxy's with waf's answer.
|
||||||
line := firstOut.line(t, "path", bannedProbe)
|
line := firstOut.line(t, "path", bannedProbe)
|
||||||
if line["disposition"] != waf.DispositionDeny ||
|
if line["disposition"] != wafprotocol.DispositionDeny ||
|
||||||
line["client_ip"] != placed {
|
line["client_ip"] != placed {
|
||||||
t.Errorf("rproxy's line is %v", line)
|
t.Errorf("rproxy's line is %v", line)
|
||||||
}
|
}
|
||||||
@@ -249,7 +249,7 @@ func TestTheSiteAnswersWhileWAFIsStoppedAndStartedAgain(t *testing.T) {
|
|||||||
wantStatus(t, site+"/after-stop", placed, http.StatusOK)
|
wantStatus(t, site+"/after-stop", placed, http.StatusOK)
|
||||||
|
|
||||||
line := out.line(t, "path", "/after-stop")
|
line := out.line(t, "path", "/after-stop")
|
||||||
if line["disposition"] != waf.DispositionAllow ||
|
if line["disposition"] != wafprotocol.DispositionAllow ||
|
||||||
line["waf_backend_no_answer"] != true {
|
line["waf_backend_no_answer"] != true {
|
||||||
t.Errorf("rproxy's line is %v", line)
|
t.Errorf("rproxy's line is %v", line)
|
||||||
}
|
}
|
||||||
@@ -437,7 +437,7 @@ func TestAChunkedBodyStaysABodyAtWAF(t *testing.T) {
|
|||||||
const smuggledID = "smuggled-request"
|
const smuggledID = "smuggled-request"
|
||||||
|
|
||||||
smuggled := "GET " + bannedProbe + " HTTP/1.1\r\nHost: site.example\r\n" +
|
smuggled := "GET " + bannedProbe + " HTTP/1.1\r\nHost: site.example\r\n" +
|
||||||
waf.ClientHeader + ": " + otherClient + "\r\n" +
|
wafprotocol.ClientHeader + ": " + otherClient + "\r\n" +
|
||||||
"X-Request-ID: " + smuggledID + "\r\n\r\n"
|
"X-Request-ID: " + smuggledID + "\r\n\r\n"
|
||||||
|
|
||||||
status := sendRaw(
|
status := sendRaw(
|
||||||
@@ -605,10 +605,11 @@ func TestRProxyAsksAWAFThatSpeaksHTTP2OverHTTP1(t *testing.T) {
|
|||||||
protocols := make(chan string, 10)
|
protocols := make(chan string, 10)
|
||||||
backend := httptest.NewUnstartedServer(http.HandlerFunc(
|
backend := httptest.NewUnstartedServer(http.HandlerFunc(
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
func(w http.ResponseWriter, r *http.Request) {
|
||||||
if r.Header.Get(waf.ClientHeader) != "" {
|
if r.Header.Get(wafprotocol.ClientHeader) != "" {
|
||||||
protocols <- r.Proto
|
protocols <- r.Proto
|
||||||
|
|
||||||
w.Header().Set(waf.DispositionHeader, waf.DispositionDeny)
|
w.Header().
|
||||||
|
Set(wafprotocol.DispositionHeader, wafprotocol.DispositionDeny)
|
||||||
w.WriteHeader(http.StatusForbidden)
|
w.WriteHeader(http.StatusForbidden)
|
||||||
}
|
}
|
||||||
}))
|
}))
|
||||||
@@ -690,8 +691,9 @@ func TestRProxyStoppingWaitsForAReportBeingSent(t *testing.T) {
|
|||||||
release := make(chan struct{})
|
release := make(chan struct{})
|
||||||
backend := httptest.NewServer(http.HandlerFunc(
|
backend := httptest.NewServer(http.HandlerFunc(
|
||||||
func(w http.ResponseWriter, r *http.Request) {
|
func(w http.ResponseWriter, r *http.Request) {
|
||||||
if r.Header.Get(waf.ClientHeader) != "" {
|
if r.Header.Get(wafprotocol.ClientHeader) != "" {
|
||||||
w.Header().Set(waf.DispositionHeader, waf.DispositionAllow)
|
w.Header().
|
||||||
|
Set(wafprotocol.DispositionHeader, wafprotocol.DispositionAllow)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -779,10 +781,7 @@ func sendAndKeepOpen(t *testing.T, addr, request string) net.Conn {
|
|||||||
func TestRProxyStoppingCutsOffARequestAfterFiveSeconds(t *testing.T) {
|
func TestRProxyStoppingCutsOffARequestAfterFiveSeconds(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
const (
|
const cutOffAfter = 5 * time.Second
|
||||||
cutOffAfter = 5 * time.Second
|
|
||||||
upstreamSetting = "SWW_RPROXY_UPSTREAM_URL"
|
|
||||||
)
|
|
||||||
|
|
||||||
asked := make(chan struct{})
|
asked := make(chan struct{})
|
||||||
release := make(chan struct{})
|
release := make(chan struct{})
|
||||||
@@ -796,7 +795,8 @@ func TestRProxyStoppingCutsOffARequestAfterFiveSeconds(t *testing.T) {
|
|||||||
|
|
||||||
backend := httptest.NewServer(http.HandlerFunc(
|
backend := httptest.NewServer(http.HandlerFunc(
|
||||||
func(w http.ResponseWriter, _ *http.Request) {
|
func(w http.ResponseWriter, _ *http.Request) {
|
||||||
w.Header().Set(waf.DispositionHeader, waf.DispositionAllow)
|
w.Header().
|
||||||
|
Set(wafprotocol.DispositionHeader, wafprotocol.DispositionAllow)
|
||||||
}))
|
}))
|
||||||
t.Cleanup(backend.Close)
|
t.Cleanup(backend.Close)
|
||||||
|
|
||||||
@@ -804,9 +804,9 @@ func TestRProxyStoppingCutsOffARequestAfterFiveSeconds(t *testing.T) {
|
|||||||
defer stop()
|
defer stop()
|
||||||
|
|
||||||
env := map[string]string{
|
env := map[string]string{
|
||||||
rproxyListenAddr: localhost + ":0",
|
rproxyListenAddr: localhost + ":0",
|
||||||
upstreamSetting: app.URL,
|
rproxyUpstreamURL: app.URL,
|
||||||
wafBackend: backend.URL,
|
wafBackend: backend.URL,
|
||||||
}
|
}
|
||||||
out := &output{}
|
out := &output{}
|
||||||
exited := make(chan int, 1)
|
exited := make(chan int, 1)
|
||||||
@@ -932,7 +932,7 @@ func TestMainRunsRProxy(t *testing.T) {
|
|||||||
addr, stop := startRProxyProcess(t, wafBackend+"=http://127.0.0.1:9")
|
addr, stop := startRProxyProcess(t, wafBackend+"=http://127.0.0.1:9")
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(t.Context(), http.MethodGet,
|
req, err := http.NewRequestWithContext(t.Context(), http.MethodGet,
|
||||||
"http://"+addr+waf.HealthPath, http.NoBody)
|
"http://"+addr+wafprotocol.HealthPath, http.NoBody)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("new request: %v", err)
|
t.Fatalf("new request: %v", err)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/config/configtest"
|
"sneak.berlin/go/smallwebwaf/internal/config/configtest"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest"
|
"sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/sww"
|
"sneak.berlin/go/smallwebwaf/internal/sww"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -1813,7 +1813,7 @@ func statusFrom(t *testing.T, url, from string) int {
|
|||||||
}
|
}
|
||||||
|
|
||||||
req.Header.Set("X-Forwarded-For", from)
|
req.Header.Set("X-Forwarded-For", from)
|
||||||
req.Header.Set(waf.ClientHeader, from)
|
req.Header.Set(wafprotocol.ClientHeader, from)
|
||||||
req.Header.Set("X-Request-ID", rand.Text())
|
req.Header.Set("X-Request-ID", rand.Text())
|
||||||
|
|
||||||
transport := &http.Transport{}
|
transport := &http.Transport{}
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ import (
|
|||||||
_ "time/tzdata"
|
_ "time/tzdata"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/sww"
|
"sneak.berlin/go/smallwebwaf/internal/sww"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// commandForMain, while set in the environment, has this test binary run Main
|
// commandForMain, while set in the environment, has this test binary run Main
|
||||||
@@ -106,7 +106,7 @@ func TestMainRunsWAF(t *testing.T) {
|
|||||||
|
|
||||||
starting := out.lineBeforeExit(t, "starting", exited)
|
starting := out.lineBeforeExit(t, "starting", exited)
|
||||||
addr, _ := starting["address"].(string)
|
addr, _ := starting["address"].(string)
|
||||||
ask(t, addr, "/", http.StatusOK, waf.DispositionAllow)
|
ask(t, addr, "/", http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
|
|
||||||
// The files are written as sww stops.
|
// The files are written as sww stops.
|
||||||
err = cmd.Process.Signal(syscall.SIGTERM)
|
err = cmd.Process.Signal(syscall.SIGTERM)
|
||||||
@@ -217,7 +217,7 @@ func ask(t *testing.T, addr, path string, status int, disposition string) {
|
|||||||
t.Fatalf("new request: %v", err)
|
t.Fatalf("new request: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
req.Header.Set(waf.ClientHeader, placed)
|
req.Header.Set(wafprotocol.ClientHeader, placed)
|
||||||
req.Header.Set("X-Request-ID", rand.Text())
|
req.Header.Set("X-Request-ID", rand.Text())
|
||||||
|
|
||||||
transport := &http.Transport{}
|
transport := &http.Transport{}
|
||||||
@@ -232,11 +232,11 @@ func ask(t *testing.T, addr, path string, status int, disposition string) {
|
|||||||
_ = res.Body.Close()
|
_ = res.Body.Close()
|
||||||
|
|
||||||
if res.StatusCode != status ||
|
if res.StatusCode != status ||
|
||||||
res.Header.Get(waf.DispositionHeader) != disposition {
|
res.Header.Get(wafprotocol.DispositionHeader) != disposition {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"answered %d with disposition %q, want %d with %q",
|
"answered %d with disposition %q, want %d with %q",
|
||||||
res.StatusCode,
|
res.StatusCode,
|
||||||
res.Header.Get(waf.DispositionHeader),
|
res.Header.Get(wafprotocol.DispositionHeader),
|
||||||
status,
|
status,
|
||||||
disposition,
|
disposition,
|
||||||
)
|
)
|
||||||
@@ -287,12 +287,18 @@ func TestWAFKeepsItsBansAcrossARestartAndNeedsNoApp(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
runWAF(t, env, func(addr string) {
|
runWAF(t, env, func(addr string) {
|
||||||
ask(t, addr, "/", http.StatusOK, waf.DispositionAllow)
|
ask(t, addr, "/", http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
// The default rule file bans a probe for this.
|
// The default rule file bans a probe for this.
|
||||||
ask(t, addr, "/.env", http.StatusForbidden, waf.DispositionDeny)
|
ask(
|
||||||
|
t,
|
||||||
|
addr,
|
||||||
|
"/.env",
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
runWAF(t, env, func(addr string) {
|
runWAF(t, env, func(addr string) {
|
||||||
ask(t, addr, "/", http.StatusForbidden, waf.DispositionDeny)
|
ask(t, addr, "/", http.StatusForbidden, wafprotocol.DispositionDeny)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -22,31 +22,42 @@ import (
|
|||||||
// an offence, and the request does not wait for the answer. The score is then
|
// an offence, and the request does not wait for 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 {
|
||||||
|
abuseIPDB *reputation.AbuseIPDB
|
||||||
|
// limiter is the table of clients the rate limits count, whose histories
|
||||||
|
// say which clients are offenders.
|
||||||
|
limiter *ratelimit.Limiter
|
||||||
|
keySet bool // SWW_WAF_ABUSEIPDB_KEY is set
|
||||||
|
minScore int64 // SWW_WAF_ABUSEIPDB_MIN_SCORE
|
||||||
|
action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION
|
||||||
|
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
|
||||||
|
hitNoter reputationHitNoter
|
||||||
|
}
|
||||||
|
|
||||||
func (abuseIPDB) name() string { return "abuseipdb" }
|
func (abuseIPDB) name() string { return "abuseipdb" }
|
||||||
|
|
||||||
func (abuseIPDB) check(
|
func (a abuseIPDB) check(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
_ time.Time,
|
_ time.Time,
|
||||||
) *verdict {
|
) *verdict {
|
||||||
if rq.h.config.AbuseIPDBKey == "" {
|
if !a.keySet {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
client := clientGroup(rq.h.config, rq.client)
|
client := clientGroup(a.ipv6GroupPrefix, rq.client)
|
||||||
held, _ := rq.h.limiter.Client(client)
|
held, _ := a.limiter.Client(client)
|
||||||
offender := held.History.Offences != ratelimit.Offences{}
|
offender := held.History.Offences != ratelimit.Offences{}
|
||||||
|
|
||||||
score, hit := rq.h.abuseIPDB.Hit(ctx, client, rq.client, offender)
|
score, hit := a.abuseIPDB.Hit(ctx, client, rq.client, offender)
|
||||||
if !hit {
|
if !hit {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.abuseIPDBHit = true
|
rq.abuseIPDBHit = true
|
||||||
rq.addTag(config.AbuseIPDBTag)
|
rq.addTag(config.AbuseIPDBTag)
|
||||||
rq.noteHit(
|
a.hitNoter.noteHit(
|
||||||
|
rq,
|
||||||
bans.ReputationHit{
|
bans.ReputationHit{
|
||||||
Source: reputation.AbuseIPDBSource,
|
Source: reputation.AbuseIPDBSource,
|
||||||
Score: &score,
|
Score: &score,
|
||||||
@@ -54,14 +65,14 @@ func (abuseIPDB) check(
|
|||||||
"scored by AbuseIPDB at or over SWW_WAF_ABUSEIPDB_MIN_SCORE",
|
"scored by AbuseIPDB at or over SWW_WAF_ABUSEIPDB_MIN_SCORE",
|
||||||
)
|
)
|
||||||
|
|
||||||
if rq.h.config.DNSBLAbuseIPDBAction != config.ReputationActionDeny {
|
if a.action != config.ReputationActionDeny {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
return &verdict{
|
return &verdict{
|
||||||
action: requestlog.ActionClientDenied,
|
action: requestlog.ActionClientDenied,
|
||||||
figures: map[string]any{
|
figures: map[string]any{
|
||||||
figureScore: score, "min_score": rq.h.config.AbuseIPDBMinScore,
|
figureScore: score, "min_score": a.minScore,
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -26,7 +26,9 @@ func BanAbuseIPDBBlacklist(
|
|||||||
scores := make(map[netip.Prefix]int64, len(listed))
|
scores := make(map[netip.Prefix]int64, len(listed))
|
||||||
|
|
||||||
for _, client := range listed {
|
for _, client := range listed {
|
||||||
netblock := banNetblock(cfg, client.Addr)
|
netblock := banNetblock(
|
||||||
|
cfg.BanScopeV4Prefix, cfg.IPv6GroupPrefix, client.Addr,
|
||||||
|
)
|
||||||
scores[netblock] = max(scores[netblock], client.Score)
|
scores[netblock] = max(scores[netblock], client.Score)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -224,7 +224,11 @@ func (h *handler) parseBanNetblock(value string) (netip.Prefix, error) {
|
|||||||
return netip.Prefix{}, fmt.Errorf("netblock %q %w", value, errZone)
|
return netip.Prefix{}, fmt.Errorf("netblock %q %w", value, errZone)
|
||||||
}
|
}
|
||||||
|
|
||||||
return banNetblock(h.config, addr), nil
|
return banNetblock(
|
||||||
|
h.config.BanScopeV4Prefix,
|
||||||
|
h.config.IPv6GroupPrefix,
|
||||||
|
addr,
|
||||||
|
), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// expiry returns when a ban made at now for duration ends: duration
|
// expiry returns when a ban made at now for duration ends: duration
|
||||||
@@ -295,7 +299,9 @@ func (rq *request) showClient() {
|
|||||||
Bans: state.BanEntries(rq.h.ledger.Covering(addr)),
|
Bans: state.BanEntries(rq.h.ledger.Covering(addr)),
|
||||||
}
|
}
|
||||||
|
|
||||||
client, seen := rq.h.limiter.Client(clientGroup(rq.h.config, addr))
|
client, seen := rq.h.limiter.Client(
|
||||||
|
clientGroup(rq.h.config.IPv6GroupPrefix, addr),
|
||||||
|
)
|
||||||
if seen {
|
if seen {
|
||||||
answer.Client = &client
|
answer.Client = &client
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -26,6 +26,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/reputation"
|
"sneak.berlin/go/smallwebwaf/internal/reputation"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/waf"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -84,7 +85,7 @@ func TestSixteenThousandCookiesAreRefusedBeforeTheCoreRuleSetReadsThem(
|
|||||||
|
|
||||||
got := do(t, req)
|
got := do(t, req)
|
||||||
|
|
||||||
wantDisposition(t, got, tooLarge, waf.DispositionDeny)
|
wantDisposition(t, got, tooLarge, wafprotocol.DispositionDeny)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
wantLine(t, line, tooLarge, requestlog.ActionRequestHeaderTooLarge)
|
wantLine(t, line, tooLarge, requestlog.ActionRequestHeaderTooLarge)
|
||||||
@@ -164,9 +165,14 @@ func TestARequestLineOverTheLimitIsRefusedWith414BeforeAnyOtherCheck(
|
|||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
|
|
||||||
if tc.status == http.StatusOK {
|
if tc.status == http.StatusOK {
|
||||||
wantDisposition(t, got, tc.status, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
tc.status,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
} else {
|
} else {
|
||||||
wantDisposition(t, got, tc.status, waf.DispositionDeny)
|
wantDisposition(t, got, tc.status, wafprotocol.DispositionDeny)
|
||||||
}
|
}
|
||||||
|
|
||||||
wantLine(t, line, tc.status, tc.action)
|
wantLine(t, line, tc.status, tc.action)
|
||||||
@@ -219,9 +225,14 @@ func TestAHeaderLineOverTheLimitIsRefusedWith431(t *testing.T) {
|
|||||||
got := do(t, req)
|
got := do(t, req)
|
||||||
|
|
||||||
if tc.refused {
|
if tc.refused {
|
||||||
wantDisposition(t, got, tooLarge, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
tooLarge,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
} else {
|
} else {
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -244,10 +255,7 @@ func TestRequestLineRefusalNamesItsHeuristicLengthAndLimit(t *testing.T) {
|
|||||||
func TestEachHeaderLimitRefusesARequestOverIt(t *testing.T) {
|
func TestEachHeaderLimitRefusesARequestOverIt(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
repeated := make([]string, headerFieldLimit)
|
repeated := slices.Repeat([]string{"1"}, headerFieldLimit)
|
||||||
for i := range repeated {
|
|
||||||
repeated[i] = "1"
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range []struct {
|
for _, tc := range []struct {
|
||||||
name string
|
name string
|
||||||
@@ -294,7 +302,12 @@ func TestEachHeaderLimitRefusesARequestOverIt(t *testing.T) {
|
|||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
|
|
||||||
if tc.refused {
|
if tc.refused {
|
||||||
wantDisposition(t, got, tooLarge, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
tooLarge,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
wantLine(
|
wantLine(
|
||||||
t,
|
t,
|
||||||
line,
|
line,
|
||||||
@@ -305,7 +318,12 @@ func TestEachHeaderLimitRefusesARequestOverIt(t *testing.T) {
|
|||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
wantLine(t, line, http.StatusOK, requestlog.ActionForward)
|
wantLine(t, line, http.StatusOK, requestlog.ActionForward)
|
||||||
|
|
||||||
if line.DurationCoreRuleSetMS == nil {
|
if line.DurationCoreRuleSetMS == nil {
|
||||||
@@ -332,7 +350,12 @@ func TestHeaderLimitsHoldWhateverTheCoreRuleSetSettingsSay(t *testing.T) {
|
|||||||
req := s.question(siteA, client, "/")
|
req := s.question(siteA, client, "/")
|
||||||
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
||||||
|
|
||||||
wantDisposition(t, do(t, req), tooLarge, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, req),
|
||||||
|
tooLarge,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -348,7 +371,12 @@ func TestClientInTheAllowNetsSkipsTheHeaderLimits(t *testing.T) {
|
|||||||
req := s.question(siteA, client, "/")
|
req := s.question(siteA, client, "/")
|
||||||
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
||||||
|
|
||||||
wantDisposition(t, do(t, req), http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, req),
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestObserveModeAllowsARequestOverTheHeaderLimitsUnread(t *testing.T) {
|
func TestObserveModeAllowsARequestOverTheHeaderLimitsUnread(t *testing.T) {
|
||||||
@@ -364,7 +392,7 @@ func TestObserveModeAllowsARequestOverTheHeaderLimitsUnread(t *testing.T) {
|
|||||||
|
|
||||||
got := do(t, req)
|
got := do(t, req)
|
||||||
|
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
if line.WouldAction != requestlog.ActionRequestHeaderTooLarge ||
|
if line.WouldAction != requestlog.ActionRequestHeaderTooLarge ||
|
||||||
@@ -386,14 +414,14 @@ func TestTheRateLimitsDoNotCountRequestsOverTheHeaderLimits(t *testing.T) {
|
|||||||
for range 2 {
|
for range 2 {
|
||||||
req := s.question(siteA, client, "/")
|
req := s.question(siteA, client, "/")
|
||||||
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
||||||
wantDisposition(t, do(t, req), tooLarge, waf.DispositionDeny)
|
wantDisposition(t, do(t, req), tooLarge, wafprotocol.DispositionDeny)
|
||||||
}
|
}
|
||||||
|
|
||||||
wantDisposition(
|
wantDisposition(
|
||||||
t,
|
t,
|
||||||
s.ask(client, "/"),
|
s.ask(client, "/"),
|
||||||
http.StatusOK,
|
http.StatusOK,
|
||||||
waf.DispositionAllow,
|
wafprotocol.DispositionAllow,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -466,7 +494,12 @@ func TestTheHeaderLimitsComeBeforeEveryCheckThatRefuses(t *testing.T) {
|
|||||||
req := s.question(siteA, client, tc.path)
|
req := s.question(siteA, client, tc.path)
|
||||||
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
||||||
|
|
||||||
wantDisposition(t, do(t, req), tooLarge, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, req),
|
||||||
|
tooLarge,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
wantLine(
|
wantLine(
|
||||||
t,
|
t,
|
||||||
s.out.requestLine(t),
|
s.out.requestLine(t),
|
||||||
@@ -503,11 +536,16 @@ func TestARequestOverTheHeaderLimitsRunsNoOtherCheck(t *testing.T) {
|
|||||||
|
|
||||||
over := s.question(siteA, client, "/")
|
over := s.question(siteA, client, "/")
|
||||||
over.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
over.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
||||||
wantDisposition(t, do(t, over), tooLarge, waf.DispositionDeny)
|
wantDisposition(t, do(t, over), tooLarge, wafprotocol.DispositionDeny)
|
||||||
|
|
||||||
within := s.question(siteA, client, "/")
|
within := s.question(siteA, client, "/")
|
||||||
within.Header.Set(cookieHeader, cookies(cookieLimit))
|
within.Header.Set(cookieHeader, cookies(cookieLimit))
|
||||||
wantDisposition(t, do(t, within), http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, within),
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
|
|
||||||
lines := s.out.requestLines(t, 2)
|
lines := s.out.requestLines(t, 2)
|
||||||
|
|
||||||
@@ -564,7 +602,7 @@ func TestNotWaitingForGeoJSNeverLowersAClientsLimit(t *testing.T) {
|
|||||||
t,
|
t,
|
||||||
s.ask(fromDE, "/"),
|
s.ask(fromDE, "/"),
|
||||||
http.StatusForbidden,
|
http.StatusForbidden,
|
||||||
waf.DispositionDeny,
|
wafprotocol.DispositionDeny,
|
||||||
)
|
)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
@@ -601,7 +639,7 @@ func TestAClientGeoJSPlacedInNoCountryCountsAsUnknownWithoutWaiting(
|
|||||||
t,
|
t,
|
||||||
s.ask(client, "/"),
|
s.ask(client, "/"),
|
||||||
http.StatusForbidden,
|
http.StatusForbidden,
|
||||||
waf.DispositionDeny,
|
wafprotocol.DispositionDeny,
|
||||||
)
|
)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
@@ -630,7 +668,7 @@ func TestObserveModeAsksGeoJSNothingForARequestOverTheHeaderLimits(
|
|||||||
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
req.Header.Set(cookieHeader, cookies(cookieLimit+1))
|
||||||
|
|
||||||
got := do(t, req)
|
got := do(t, req)
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
|
|
||||||
if len(asked()) != 0 || got.header.Get("X-Client-Asn") != "" {
|
if len(asked()) != 0 || got.header.Get("X-Client-Asn") != "" {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
@@ -672,7 +710,7 @@ func askDirectly(
|
|||||||
http.NoBody,
|
http.NoBody,
|
||||||
)
|
)
|
||||||
req.RemoteAddr = net.JoinHostPort(rproxyPeer, "1234")
|
req.RemoteAddr = net.JoinHostPort(rproxyPeer, "1234")
|
||||||
req.Header.Set(waf.ClientHeader, client)
|
req.Header.Set(wafprotocol.ClientHeader, client)
|
||||||
req.Header.Set(requestIDHeader, "the-id")
|
req.Header.Set(requestIDHeader, "the-id")
|
||||||
change(req)
|
change(req)
|
||||||
|
|
||||||
|
|||||||
+105
-61
@@ -1,7 +1,7 @@
|
|||||||
package waf
|
package waf
|
||||||
|
|
||||||
// The heuristic active_ban, and the code that makes bans, which several
|
// The heuristic active_ban, and banMaker, which makes the bans of several
|
||||||
// heuristics share. active_ban reads SWW_WAF_MODE; the bans are the ban ledger's.
|
// heuristics. active_ban reads SWW_WAF_MODE; the bans are the ban ledger's.
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
@@ -11,6 +11,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/bans"
|
"sneak.berlin/go/smallwebwaf/internal/bans"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/metrics"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
)
|
)
|
||||||
@@ -25,18 +26,22 @@ func (rq *request) banResponse(action string) *refusal {
|
|||||||
// in, in force at now. It notes for the log line when that ban ends. A request
|
// 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
|
// 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.
|
// for it. Its figures are the ban's netblock and when it ends.
|
||||||
type activeBan struct{}
|
type activeBan struct {
|
||||||
|
banMaker banMaker
|
||||||
|
}
|
||||||
|
|
||||||
func (activeBan) name() string { return "active_ban" }
|
func (activeBan) name() string { return "active_ban" }
|
||||||
|
|
||||||
func (activeBan) check(
|
func (a activeBan) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
) *verdict {
|
) *verdict {
|
||||||
check := rq.h.ledger.Check
|
ledger := a.banMaker.ledger
|
||||||
if rq.h.config.Observe {
|
|
||||||
check = rq.h.ledger.Find // the ban refuses nothing, and stays as it is
|
check := ledger.Check
|
||||||
|
if a.banMaker.observe {
|
||||||
|
check = ledger.Find // the ban refuses nothing, and stays as it is
|
||||||
}
|
}
|
||||||
|
|
||||||
ban, banned, madePermanent := check(rq.client, now)
|
ban, banned, madePermanent := check(rq.client, now)
|
||||||
@@ -46,7 +51,7 @@ func (activeBan) check(
|
|||||||
|
|
||||||
if madePermanent {
|
if madePermanent {
|
||||||
ban.Expires = time.Time{} // the ban made permanent, which Find leaves as it is
|
ban.Expires = time.Time{} // the ban made permanent, which Find leaves as it is
|
||||||
rq.alertBan(ban)
|
a.banMaker.alertBan(rq, ban)
|
||||||
}
|
}
|
||||||
|
|
||||||
if !banned {
|
if !banned {
|
||||||
@@ -81,11 +86,12 @@ func limitFigures(hit ratelimit.Hit) map[string]any {
|
|||||||
|
|
||||||
// countedBytes returns the request's bytes, once it has ended, as the
|
// countedBytes returns the request's bytes, once it has ended, as the
|
||||||
// byte limits and the anomaly thresholds count them: the response's body
|
// byte limits and the anomaly thresholds count them: the response's body
|
||||||
// bytes, the request's, or both, as SWW_WAF_BYTES_COUNTED says.
|
// bytes, the request's, or both, as bytesCounted, SWW_WAF_BYTES_COUNTED,
|
||||||
func (rq *request) countedBytes() int64 {
|
// says.
|
||||||
|
func (rq *request) countedBytes(bytesCounted config.BytesCounted) int64 {
|
||||||
response, request := rq.out.bytes, rq.requestBytes
|
response, request := rq.out.bytes, rq.requestBytes
|
||||||
|
|
||||||
switch rq.h.config.BytesCounted {
|
switch bytesCounted {
|
||||||
case config.BytesCountedResponse:
|
case config.BytesCountedResponse:
|
||||||
return response
|
return response
|
||||||
case config.BytesCountedRequest:
|
case config.BytesCountedRequest:
|
||||||
@@ -96,7 +102,29 @@ func (rq *request) countedBytes() int64 {
|
|||||||
return response + request
|
return response + request
|
||||||
}
|
}
|
||||||
|
|
||||||
// banForLimit bans the client's netblock at now for a broken limit, the
|
// banMaker makes the bans of the heuristics that ban a client, in the ban
|
||||||
|
// ledger, and raises the alert for each. In observe mode it makes no ban, and
|
||||||
|
// raises the alert for the ban it would have made.
|
||||||
|
type banMaker struct {
|
||||||
|
ledger *bans.Ledger
|
||||||
|
// limiter is the table of clients the rate limits count. A ban for a limit
|
||||||
|
// sets the client's counters back to zero, and a ban's notes give how many
|
||||||
|
// requests its netblock has sent.
|
||||||
|
limiter *ratelimit.Limiter
|
||||||
|
metrics *metrics.Metrics
|
||||||
|
alerts *alerts.Queue
|
||||||
|
// observe is true in observe mode (SWW_WAF_MODE).
|
||||||
|
observe bool
|
||||||
|
// banResponse is SWW_WAF_BAN_RESPONSE, the status the notes of a ban for a
|
||||||
|
// clear sign of attack give.
|
||||||
|
banResponse int
|
||||||
|
// banScopeV4Prefix is SWW_WAF_BAN_SCOPE_V4_PREFIX and ipv6GroupPrefix
|
||||||
|
// SWW_WAF_IPV6_GROUP_PREFIX, which set the netblock a ban covers.
|
||||||
|
banScopeV4Prefix int
|
||||||
|
ipv6GroupPrefix int
|
||||||
|
}
|
||||||
|
|
||||||
|
// banForLimit bans the netblock of rq's client at now for a broken limit, the
|
||||||
// one hit names, notes the offence for the log line and counts the hit in
|
// one hit names, notes the offence for the log line and counts the hit in
|
||||||
// the metrics. status is what the client was sent, or is sent:
|
// the metrics. status is what the client was sent, or is sent:
|
||||||
// SWW_WAF_BAN_RESPONSE for a request over a rate limit, what the report says for
|
// SWW_WAF_BAN_RESPONSE for a request over a rate limit, what the report says for
|
||||||
@@ -105,7 +133,8 @@ func (rq *request) countedBytes() int64 {
|
|||||||
// rate limit or a byte limit; the refusal limit is not lowered. The ban sets
|
// rate limit or a byte limit; the refusal limit is not lowered. The ban sets
|
||||||
// the client's counters back to zero. In observe mode, banClient says what
|
// the client's counters back to zero. In observe mode, banClient says what
|
||||||
// happens instead.
|
// happens instead.
|
||||||
func (rq *request) banForLimit(
|
func (b banMaker) banForLimit(
|
||||||
|
rq *request,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
hit ratelimit.Hit,
|
hit ratelimit.Hit,
|
||||||
status int,
|
status int,
|
||||||
@@ -120,7 +149,8 @@ func (rq *request) banForLimit(
|
|||||||
}
|
}
|
||||||
|
|
||||||
rq.line.Offence = requestlog.OffenceLimit
|
rq.line.Offence = requestlog.OffenceLimit
|
||||||
rq.h.metrics.LimitHit(hit)
|
|
||||||
|
b.metrics.LimitHit(hit)
|
||||||
|
|
||||||
notes := bans.Notes{
|
notes := bans.Notes{
|
||||||
Kind: hit.Kind,
|
Kind: hit.Kind,
|
||||||
@@ -136,81 +166,94 @@ func (rq *request) banForLimit(
|
|||||||
notes.LimitPercent, notes.LimitPercentSetting = rq.bytesLimitPercent.logged()
|
notes.LimitPercent, notes.LimitPercentSetting = rq.bytesLimitPercent.logged()
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.banClient(
|
b.banClient(
|
||||||
|
rq,
|
||||||
now,
|
now,
|
||||||
status,
|
status,
|
||||||
bans.Grounds{Cause: bans.CauseLimit, Notes: notes},
|
bans.Grounds{Cause: bans.CauseLimit, Notes: notes},
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// banForAttack bans the client's netblock at now for a clear sign of
|
// banForAttack bans the netblock of rq's client at now for a clear sign of
|
||||||
// attack, which notes name: the ban rule that matched, or the trap path
|
// attack, which notes name: the ban rule that matched, or the trap path
|
||||||
// asked for. It returns the action for that ban. In observe mode, banClient
|
// asked for. It returns the action for that ban. In observe mode, banClient
|
||||||
// says what happens instead.
|
// says what happens instead.
|
||||||
func (rq *request) banForAttack(now time.Time, notes bans.Notes) string {
|
func (b banMaker) banForAttack(
|
||||||
return rq.banClient(
|
rq *request, now time.Time, notes bans.Notes,
|
||||||
|
) string {
|
||||||
|
return b.banClient(
|
||||||
|
rq,
|
||||||
now,
|
now,
|
||||||
rq.h.config.BanResponse,
|
b.banResponse,
|
||||||
bans.Grounds{Cause: bans.CauseAttack, Notes: notes},
|
bans.Grounds{Cause: bans.CauseAttack, Notes: notes},
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// banClient bans the client's netblock at now on grounds, and returns the
|
// banClient bans the netblock of rq's client at now on grounds, and returns
|
||||||
// action for that ban. It adds to the notes what the request tells of the
|
// the action for that ban. It adds to the notes what the request tells of the
|
||||||
// client, with status, what the client was sent. A ban for a broken limit
|
// client, with status, what the client was sent. A ban for a broken limit
|
||||||
// sets the client's counters back to zero.
|
// sets the client's counters back to zero.
|
||||||
//
|
//
|
||||||
// In observe mode it makes no ban and sets nothing back. It raises the
|
// In observe mode it makes no ban and sets nothing back. It raises the
|
||||||
// alert for the ban it would have made, if that alert would be sent.
|
// alert for the ban it would have made, if that alert would be sent.
|
||||||
func (rq *request) banClient(
|
func (b banMaker) banClient(
|
||||||
|
rq *request,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
status int,
|
status int,
|
||||||
grounds bans.Grounds,
|
grounds bans.Grounds,
|
||||||
) string {
|
) string {
|
||||||
netblock := banNetblock(rq.h.config, rq.client)
|
netblock := banNetblock(b.banScopeV4Prefix, b.ipv6GroupPrefix, rq.client)
|
||||||
|
|
||||||
if rq.h.config.Observe {
|
if b.observe {
|
||||||
if !rq.wouldAlertBan(netblock, now, grounds.Cause) {
|
if !b.wouldAlertBan(netblock, now, grounds.Cause) {
|
||||||
return banAction(
|
return banAction(
|
||||||
rq.h.ledger.WouldBePermanent(netblock, now, grounds.Cause),
|
b.ledger.WouldBePermanent(netblock, now, grounds.Cause),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
grounds.Notes = rq.withClientNotes(
|
grounds.Notes = b.withClientNotes(
|
||||||
|
rq,
|
||||||
grounds.Notes,
|
grounds.Notes,
|
||||||
now,
|
now,
|
||||||
status,
|
status,
|
||||||
netblock,
|
netblock,
|
||||||
)
|
)
|
||||||
|
|
||||||
ban, wouldBan := rq.h.ledger.WouldBan(netblock, now, grounds)
|
ban, wouldBan := b.ledger.WouldBan(netblock, now, grounds)
|
||||||
if wouldBan {
|
if wouldBan {
|
||||||
rq.alertBan(ban)
|
b.alertBan(rq, ban)
|
||||||
}
|
}
|
||||||
|
|
||||||
return banAction(ban.Permanent())
|
return banAction(ban.Permanent())
|
||||||
}
|
}
|
||||||
|
|
||||||
grounds.Notes = rq.withClientNotes(grounds.Notes, now, status, netblock)
|
grounds.Notes = b.withClientNotes(
|
||||||
|
rq,
|
||||||
|
grounds.Notes,
|
||||||
|
now,
|
||||||
|
status,
|
||||||
|
netblock,
|
||||||
|
)
|
||||||
|
|
||||||
ban, made := rq.h.ledger.Ban(netblock, now, grounds)
|
ban, made := b.ledger.Ban(netblock, now, grounds)
|
||||||
if grounds.Cause == bans.CauseLimit {
|
if grounds.Cause == bans.CauseLimit {
|
||||||
rq.h.limiter.Reset(clientGroup(rq.h.config, rq.client))
|
b.limiter.Reset(clientGroup(b.ipv6GroupPrefix, rq.client))
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.line.BanExpires = banExpires(ban)
|
rq.line.BanExpires = banExpires(ban)
|
||||||
|
|
||||||
if made {
|
if made {
|
||||||
rq.alertBan(ban)
|
b.alertBan(rq, ban)
|
||||||
}
|
}
|
||||||
|
|
||||||
return banAction(ban.Permanent())
|
return banAction(ban.Permanent())
|
||||||
}
|
}
|
||||||
|
|
||||||
// withClientNotes is notes with what the request tells of the client
|
// withClientNotes is notes with what rq tells of its client added: its AS,
|
||||||
// added: its AS, country and reputation, the request at now with status,
|
// country and reputation, the request at now with status, and how many
|
||||||
// and how many requests netblock, the client's, has sent.
|
// requests netblock, the client's, has sent.
|
||||||
func (rq *request) withClientNotes(
|
func (b banMaker) withClientNotes(
|
||||||
|
rq *request,
|
||||||
notes bans.Notes,
|
notes bans.Notes,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
status int,
|
status int,
|
||||||
@@ -221,7 +264,7 @@ func (rq *request) withClientNotes(
|
|||||||
notes.Country = rq.line.Country
|
notes.Country = rq.line.Country
|
||||||
notes.Reputation = rq.reputation
|
notes.Reputation = rq.reputation
|
||||||
notes.Request = rq.noted(now, status)
|
notes.Request = rq.noted(now, status)
|
||||||
notes.Requests = rq.netblockRequests(netblock)
|
notes.Requests = b.netblockRequests(netblock)
|
||||||
|
|
||||||
return notes
|
return notes
|
||||||
}
|
}
|
||||||
@@ -231,23 +274,22 @@ func (rq *request) withClientNotes(
|
|||||||
// have made is worked out only then, at most once per
|
// have made is worked out only then, at most once per
|
||||||
// SWW_WAF_ALERT_COOLDOWN and never with no webhook set: its notes count the
|
// SWW_WAF_ALERT_COOLDOWN and never with no webhook set: its notes count the
|
||||||
// netblock's requests, which can mean going through every client.
|
// netblock's requests, which can mean going through every client.
|
||||||
func (rq *request) wouldAlertBan(
|
func (b banMaker) wouldAlertBan(
|
||||||
netblock netip.Prefix, now time.Time, cause string,
|
netblock netip.Prefix, now time.Time, cause string,
|
||||||
) bool {
|
) bool {
|
||||||
event := alerts.EventBan
|
event := alerts.EventBan
|
||||||
if rq.h.ledger.WouldBePermanent(netblock, now, cause) {
|
if b.ledger.WouldBePermanent(netblock, now, cause) {
|
||||||
event = alerts.EventPermanentBan
|
event = alerts.EventPermanentBan
|
||||||
}
|
}
|
||||||
|
|
||||||
return rq.h.alerts.WouldSend(event, netblock)
|
return b.alerts.WouldSend(event, netblock)
|
||||||
}
|
}
|
||||||
|
|
||||||
// alertBan raises the alert for ban, which the request made, or made
|
// alertBan raises the alert for ban, which rq made, or made permanent:
|
||||||
// permanent: permanent_ban for a permanent ban, ban for another. Its
|
// permanent_ban for a permanent ban, ban for another. Its detail gives the
|
||||||
// detail gives the ban's cause, when it ends, and its notes, and in
|
// ban's cause, when it ends, and its notes, and in observe mode, where ban is
|
||||||
// observe mode, where ban is the ban that would have been made, or made
|
// the ban that would have been made, or made permanent, mode, observe.
|
||||||
// permanent, mode, observe.
|
func (b banMaker) alertBan(rq *request, ban bans.Ban) {
|
||||||
func (rq *request) alertBan(ban bans.Ban) {
|
|
||||||
event := alerts.EventBan
|
event := alerts.EventBan
|
||||||
if ban.Permanent() {
|
if ban.Permanent() {
|
||||||
event = alerts.EventPermanentBan
|
event = alerts.EventPermanentBan
|
||||||
@@ -256,11 +298,11 @@ func (rq *request) alertBan(ban bans.Ban) {
|
|||||||
detail := map[string]any{
|
detail := map[string]any{
|
||||||
"cause": ban.Cause, "ban_expires": banExpires(ban), "notes": ban.Notes,
|
"cause": ban.Cause, "ban_expires": banExpires(ban), "notes": ban.Notes,
|
||||||
}
|
}
|
||||||
if rq.h.config.Observe {
|
if b.observe {
|
||||||
detail["mode"] = "observe"
|
detail["mode"] = "observe"
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.h.alerts.Raise(alerts.Alert{
|
b.alerts.Raise(alerts.Alert{
|
||||||
Event: event,
|
Event: event,
|
||||||
Host: rq.site,
|
Host: rq.site,
|
||||||
Client: rq.client,
|
Client: rq.client,
|
||||||
@@ -273,6 +315,13 @@ func (rq *request) alertBan(ban bans.Ban) {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// netblockRequests is how many requests netblock has sent since it was
|
||||||
|
// first seen, the request being banned for included: the histories count it
|
||||||
|
// only once it has ended.
|
||||||
|
func (b banMaker) netblockRequests(netblock netip.Prefix) int64 {
|
||||||
|
return b.limiter.Requests(netblock) + 1
|
||||||
|
}
|
||||||
|
|
||||||
// noted is the request, at now, with status, what the client was sent, or
|
// noted is the request, at now, with status, what the client was sent, or
|
||||||
// in observe mode would have been, as the notes of the ban it makes keep
|
// in observe mode would have been, as the notes of the ban it makes keep
|
||||||
// it.
|
// it.
|
||||||
@@ -287,23 +336,18 @@ func (rq *request) noted(now time.Time, status int) bans.Request {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// netblockRequests is how many requests netblock has sent since it was
|
|
||||||
// first seen, this one included: the histories count it only once it has
|
|
||||||
// ended.
|
|
||||||
func (rq *request) netblockRequests(netblock netip.Prefix) int64 {
|
|
||||||
return rq.h.limiter.Requests(netblock) + 1
|
|
||||||
}
|
|
||||||
|
|
||||||
// banNetblock is the netblock a ban on client covers: its IPv4 address,
|
// banNetblock is the netblock a ban on client covers: its IPv4 address,
|
||||||
// widened to SWW_WAF_BAN_SCOPE_V4_PREFIX, or the IPv6 group clientGroup
|
// widened to banScopeV4Prefix, SWW_WAF_BAN_SCOPE_V4_PREFIX, or the IPv6 group
|
||||||
// counts it in.
|
// clientGroup counts it in, of length ipv6GroupPrefix.
|
||||||
func banNetblock(cfg *config.WAF, client netip.Addr) netip.Prefix {
|
func banNetblock(
|
||||||
|
banScopeV4Prefix, ipv6GroupPrefix int, client netip.Addr,
|
||||||
|
) netip.Prefix {
|
||||||
addr := client.Unmap()
|
addr := client.Unmap()
|
||||||
if addr.Is4() {
|
if addr.Is4() {
|
||||||
return netip.PrefixFrom(addr, cfg.BanScopeV4Prefix).Masked()
|
return netip.PrefixFrom(addr, banScopeV4Prefix).Masked()
|
||||||
}
|
}
|
||||||
|
|
||||||
return clientGroup(cfg, addr)
|
return clientGroup(ipv6GroupPrefix, addr)
|
||||||
}
|
}
|
||||||
|
|
||||||
// banExpires is when ban ends, as the log line gives it: a time, or
|
// banExpires is when ban ends, as the log line gives it: a time, or
|
||||||
|
|||||||
@@ -54,7 +54,7 @@ func (rq *request) runBesideLookup(
|
|||||||
) *verdict {
|
) *verdict {
|
||||||
var running atomic.Pointer[string]
|
var running atomic.Pointer[string]
|
||||||
|
|
||||||
running.Store(new(trapPaths{}.name()))
|
running.Store(new(rq.h.trapPaths.name()))
|
||||||
|
|
||||||
found := make(chan *besideLookupFindings, 1)
|
found := make(chan *besideLookupFindings, 1)
|
||||||
|
|
||||||
@@ -92,7 +92,7 @@ func (rq *request) runBesideLookup(
|
|||||||
return v
|
return v
|
||||||
}
|
}
|
||||||
|
|
||||||
return rq.runHeuristics(ctx, afterBesideLookup(), rq.h.now())
|
return rq.runHeuristics(ctx, rq.h.afterBesideLookup, rq.h.now())
|
||||||
}
|
}
|
||||||
|
|
||||||
// findBesideLookup does the work of the heuristics of besideLookup on the
|
// findBesideLookup does the work of the heuristics of besideLookup on the
|
||||||
@@ -105,39 +105,39 @@ func (rq *request) findBesideLookup(
|
|||||||
) *besideLookupFindings {
|
) *besideLookupFindings {
|
||||||
findings := &besideLookupFindings{}
|
findings := &besideLookupFindings{}
|
||||||
|
|
||||||
findings.trapPath = rq.trapPath()
|
findings.trapPath = rq.h.trapPaths.trapPath(rq)
|
||||||
if findings.trapPath != "" {
|
if findings.trapPath != "" {
|
||||||
findings.refuses = true
|
findings.refuses = true
|
||||||
|
|
||||||
return findings
|
return findings
|
||||||
}
|
}
|
||||||
|
|
||||||
running.Store(new(ruleFiles{}.name()))
|
running.Store(new(rq.h.ruleFiles.name()))
|
||||||
|
|
||||||
findings.rules = rq.h.rules.Match(rq.in)
|
findings.rules = rq.h.ruleFiles.rules.Match(rq.in)
|
||||||
if refusedByRule(findings.rules) {
|
if refusedByRule(findings.rules) {
|
||||||
findings.refuses = true
|
findings.refuses = true
|
||||||
|
|
||||||
return findings
|
return findings
|
||||||
}
|
}
|
||||||
|
|
||||||
running.Store(new(coreRuleSet{}.name()))
|
coreRuleSet := rq.h.coreRuleSet
|
||||||
|
running.Store(new(coreRuleSet.name()))
|
||||||
|
|
||||||
cfg := rq.h.config
|
if coreRuleSet.mode == config.CoreRuleSetModeOff ||
|
||||||
if cfg.CoreRuleSetMode == config.CoreRuleSetModeOff ||
|
pathExempt(rq.in, coreRuleSet.exemptPaths) {
|
||||||
pathExempt(rq.in, cfg.CoreRuleSetExemptPaths) {
|
|
||||||
return findings
|
return findings
|
||||||
}
|
}
|
||||||
|
|
||||||
start := time.Now()
|
start := time.Now()
|
||||||
// A question's body has been read into memory, so that reading it here
|
// A question's body has been read into memory, so that reading it here
|
||||||
// cannot fail.
|
// cannot fail.
|
||||||
findings.inspection, findings.read, _ = rq.h.coreRuleSet.Inspect(
|
findings.inspection, findings.read, _ = coreRuleSet.inspector.Inspect(
|
||||||
rq.in, rq.client, rq.in.Body,
|
rq.in, rq.client, rq.in.Body,
|
||||||
)
|
)
|
||||||
findings.inspectionTime = time.Since(start)
|
findings.inspectionTime = time.Since(start)
|
||||||
findings.inspected = true
|
findings.inspected = true
|
||||||
findings.refuses = rq.refusedByCoreRuleSet(findings.inspection)
|
findings.refuses = coreRuleSet.refusedByCoreRuleSet(findings.inspection)
|
||||||
|
|
||||||
return findings
|
return findings
|
||||||
}
|
}
|
||||||
@@ -151,7 +151,7 @@ func (rq *request) applyFindings(
|
|||||||
) *verdict {
|
) *verdict {
|
||||||
rq.findings = findings
|
rq.findings = findings
|
||||||
|
|
||||||
return rq.runHeuristics(ctx, besideLookup(), rq.h.now())
|
return rq.runHeuristics(ctx, rq.h.besideLookup, rq.h.now())
|
||||||
}
|
}
|
||||||
|
|
||||||
// timedOut refuses the request for the heuristics of besideLookup not having
|
// timedOut refuses the request for the heuristics of besideLookup not having
|
||||||
|
|||||||
+36
-15
@@ -2,6 +2,7 @@ package waf
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/reputation"
|
||||||
)
|
)
|
||||||
|
|
||||||
// whole is the percentage of each limit a client gets when no biased
|
// whole is the percentage of each limit a client gets when no biased
|
||||||
@@ -29,6 +30,25 @@ func biasedThresholdsSet(cfg *config.WAF) bool {
|
|||||||
cfg.ASNLimitPercentURL != ""
|
cfg.ASNLimitPercentURL != ""
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// biasedThresholds are the settings and the lists by which limitPercentages
|
||||||
|
// lowers a client's limits.
|
||||||
|
type biasedThresholds struct {
|
||||||
|
// lists hold the file SWW_WAF_ASN_LIMIT_PERCENT_URL names.
|
||||||
|
lists *reputation.Lists
|
||||||
|
tagLimitPercent map[string]int64 // SWW_WAF_TAG_LIMIT_PERCENT
|
||||||
|
asnBytesLimitPercent map[string]int64 // SWW_WAF_ASN_BYTES_LIMIT_PERCENT
|
||||||
|
countryBytesLimitPercent map[string]int64 // SWW_WAF_COUNTRY_BYTES_LIMIT_PERCENT
|
||||||
|
unknownCountryLimitPercent int64 // SWW_WAF_UNKNOWN_COUNTRY_LIMIT_PERCENT
|
||||||
|
// blocklistAction and blocklistLimitPercent are SWW_WAF_BLOCKLIST_ACTION
|
||||||
|
// and its percentage.
|
||||||
|
blocklistAction config.ReputationAction
|
||||||
|
blocklistLimitPercent int64
|
||||||
|
// dnsblAbuseIPDBAction and dnsblAbuseIPDBLimitPercent are
|
||||||
|
// SWW_WAF_DNSBL_ABUSEIPDB_ACTION and its percentage.
|
||||||
|
dnsblAbuseIPDBAction config.ReputationAction
|
||||||
|
dnsblAbuseIPDBLimitPercent int64
|
||||||
|
}
|
||||||
|
|
||||||
// limitPercentages returns the client's limit percentages, for the rate
|
// limitPercentages returns the client's limit percentages, for the rate
|
||||||
// limits and for the byte limits, by its tags, its AS number and country
|
// limits and for the byte limits, by its tags, its AS number and country
|
||||||
// as looked up, each "" when unknown, and the blocklists, DNSBL zones and
|
// as looked up, each "" when unknown, and the blocklists, DNSBL zones and
|
||||||
@@ -45,37 +65,38 @@ func biasedThresholdsSet(cfg *config.WAF) bool {
|
|||||||
// the byte limits, SWW_WAF_ASN_BYTES_LIMIT_PERCENT and
|
// the byte limits, SWW_WAF_ASN_BYTES_LIMIT_PERCENT and
|
||||||
// SWW_WAF_COUNTRY_BYTES_LIMIT_PERCENT take the place of the first three for
|
// SWW_WAF_COUNTRY_BYTES_LIMIT_PERCENT take the place of the first three for
|
||||||
// an AS number or a country they list.
|
// an AS number or a country they list.
|
||||||
func (rq *request) limitPercentages() (percentage, percentage) {
|
func (b biasedThresholds) limitPercentages(
|
||||||
cfg := rq.h.config
|
rq *request,
|
||||||
|
) (percentage, percentage) {
|
||||||
asn, country := rq.line.ASN, rq.line.Country
|
asn, country := rq.line.ASN, rq.line.Country
|
||||||
|
|
||||||
unknown := percentage{percent: whole}
|
unknown := percentage{percent: whole}
|
||||||
if country == "" && !rq.skippedLookupWait {
|
if country == "" && !rq.skippedLookupWait {
|
||||||
unknown = percentage{
|
unknown = percentage{
|
||||||
cfg.UnknownCountryLimitPercent,
|
b.unknownCountryLimitPercent,
|
||||||
config.UnknownCountryLimitPercentSetting,
|
config.UnknownCountryLimitPercentSetting,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fetched := percentage{percent: whole}
|
fetched := percentage{percent: whole}
|
||||||
if percent, listed := rq.h.lists.ASNLimitPercent(asn); listed {
|
if percent, listed := b.lists.ASNLimitPercent(asn); listed {
|
||||||
fetched = percentage{percent, config.ASNLimitPercentURLSetting}
|
fetched = percentage{percent, config.ASNLimitPercentURLSetting}
|
||||||
}
|
}
|
||||||
|
|
||||||
blocklisted := percentage{percent: whole}
|
blocklisted := percentage{percent: whole}
|
||||||
if rq.blocklisted &&
|
if rq.blocklisted &&
|
||||||
cfg.BlocklistAction == config.ReputationActionLimit {
|
b.blocklistAction == config.ReputationActionLimit {
|
||||||
blocklisted = percentage{
|
blocklisted = percentage{
|
||||||
cfg.BlocklistLimitPercent,
|
b.blocklistLimitPercent,
|
||||||
config.BlocklistActionSetting,
|
config.BlocklistActionSetting,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
dnsblAbuseIPDBListed := percentage{percent: whole}
|
dnsblAbuseIPDBListed := percentage{percent: whole}
|
||||||
if (rq.dnsblListed || rq.abuseIPDBHit) &&
|
if (rq.dnsblListed || rq.abuseIPDBHit) &&
|
||||||
cfg.DNSBLAbuseIPDBAction == config.ReputationActionLimit {
|
b.dnsblAbuseIPDBAction == config.ReputationActionLimit {
|
||||||
dnsblAbuseIPDBListed = percentage{
|
dnsblAbuseIPDBListed = percentage{
|
||||||
cfg.DNSBLAbuseIPDBLimitPercent,
|
b.dnsblAbuseIPDBLimitPercent,
|
||||||
config.DNSBLAbuseIPDBActionSetting,
|
config.DNSBLAbuseIPDBActionSetting,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -83,11 +104,11 @@ func (rq *request) limitPercentages() (percentage, percentage) {
|
|||||||
const tagSetting = config.TagLimitPercentSetting
|
const tagSetting = config.TagLimitPercentSetting
|
||||||
|
|
||||||
asnRequests := lowest(
|
asnRequests := lowest(
|
||||||
given(cfg.TagLimitPercent, asnTag(asn), tagSetting),
|
given(b.tagLimitPercent, asnTag(asn), tagSetting),
|
||||||
fetched,
|
fetched,
|
||||||
)
|
)
|
||||||
countryRequests := given(
|
countryRequests := given(
|
||||||
cfg.TagLimitPercent,
|
b.tagLimitPercent,
|
||||||
countryTag(country),
|
countryTag(country),
|
||||||
tagSetting,
|
tagSetting,
|
||||||
)
|
)
|
||||||
@@ -98,23 +119,23 @@ func (rq *request) limitPercentages() (percentage, percentage) {
|
|||||||
if tag != asnTag(asn) && tag != countryTag(country) {
|
if tag != asnTag(asn) && tag != countryTag(country) {
|
||||||
otherTags = lowest(
|
otherTags = lowest(
|
||||||
otherTags,
|
otherTags,
|
||||||
given(cfg.TagLimitPercent, tag, tagSetting),
|
given(b.tagLimitPercent, tag, tagSetting),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
asnBytes, countryBytes := asnRequests, countryRequests
|
asnBytes, countryBytes := asnRequests, countryRequests
|
||||||
if _, listed := cfg.ASNBytesLimitPercent[asn]; listed {
|
if _, listed := b.asnBytesLimitPercent[asn]; listed {
|
||||||
asnBytes = given(
|
asnBytes = given(
|
||||||
cfg.ASNBytesLimitPercent,
|
b.asnBytesLimitPercent,
|
||||||
asn,
|
asn,
|
||||||
config.ASNBytesLimitPercentSetting,
|
config.ASNBytesLimitPercentSetting,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if _, listed := cfg.CountryBytesLimitPercent[country]; listed {
|
if _, listed := b.countryBytesLimitPercent[country]; listed {
|
||||||
countryBytes = given(
|
countryBytes = given(
|
||||||
cfg.CountryBytesLimitPercent,
|
b.countryBytesLimitPercent,
|
||||||
country,
|
country,
|
||||||
config.CountryBytesLimitPercentSetting,
|
config.CountryBytesLimitPercentSetting,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -19,6 +19,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest"
|
"sneak.berlin/go/smallwebwaf/internal/lookup/lookuptest"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/waf"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The biased thresholds.
|
// The biased thresholds.
|
||||||
@@ -589,7 +590,7 @@ func serveFromDE(
|
|||||||
t.Helper()
|
t.Helper()
|
||||||
|
|
||||||
req := httptest.NewRequestWithContext(t.Context(), method, "/", body)
|
req := httptest.NewRequestWithContext(t.Context(), method, "/", body)
|
||||||
req.Header.Set(waf.ClientHeader, fromDE)
|
req.Header.Set(wafprotocol.ClientHeader, fromDE)
|
||||||
req.Header.Set(requestIDHeader, "the-id")
|
req.Header.Set(requestIDHeader, "the-id")
|
||||||
|
|
||||||
server.Handler.ServeHTTP(httptest.NewRecorder(), req)
|
server.Handler.ServeHTTP(httptest.NewRecorder(), req)
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/reputation"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -15,20 +16,24 @@ import (
|
|||||||
// and refuses the request when SWW_WAF_BLOCKLIST_ACTION is deny. Being limit, it
|
// and refuses the request when SWW_WAF_BLOCKLIST_ACTION is deny. Being limit, it
|
||||||
// lowers the client's limits instead (see limitPercentages), and being log, it
|
// lowers the client's limits instead (see limitPercentages), and being log, it
|
||||||
// does nothing more. Its figure is the blocklists that list the client.
|
// does nothing more. Its figure is the blocklists that list the client.
|
||||||
type blocklists struct{}
|
type blocklists struct {
|
||||||
|
lists *reputation.Lists
|
||||||
|
action config.ReputationAction // SWW_WAF_BLOCKLIST_ACTION
|
||||||
|
hitNoter reputationHitNoter
|
||||||
|
}
|
||||||
|
|
||||||
func (blocklists) name() string { return "blocklists" }
|
func (blocklists) name() string { return "blocklists" }
|
||||||
|
|
||||||
func (blocklists) check(
|
func (b blocklists) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
_ time.Time,
|
_ time.Time,
|
||||||
) *verdict {
|
) *verdict {
|
||||||
listedBy := rq.h.lists.ListedBy(rq.client)
|
listedBy := b.lists.ListedBy(rq.client)
|
||||||
rq.blocklisted = len(listedBy) > 0
|
rq.blocklisted = len(listedBy) > 0
|
||||||
rq.noteListed(listedBy, "listed by a blocklist")
|
b.hitNoter.noteListed(rq, listedBy, "listed by a blocklist")
|
||||||
|
|
||||||
if !rq.refusedByBlocklists(listedBy) {
|
if !b.refusedByBlocklists(listedBy) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -41,7 +46,6 @@ func (blocklists) check(
|
|||||||
// refusedByBlocklists reports whether the heuristic blocklists refuses a
|
// refusedByBlocklists reports whether the heuristic blocklists refuses a
|
||||||
// client, given listedBy, the blocklists that list it: it does when one lists
|
// client, given listedBy, the blocklists that list it: it does when one lists
|
||||||
// it and SWW_WAF_BLOCKLIST_ACTION is deny.
|
// it and SWW_WAF_BLOCKLIST_ACTION is deny.
|
||||||
func (rq *request) refusedByBlocklists(listedBy []string) bool {
|
func (b blocklists) refusedByBlocklists(listedBy []string) bool {
|
||||||
return len(listedBy) > 0 && rq.h.config.BlocklistAction ==
|
return len(listedBy) > 0 && b.action == config.ReputationActionDeny
|
||||||
config.ReputationActionDeny
|
|
||||||
}
|
}
|
||||||
@@ -6,6 +6,9 @@ package waf
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
)
|
)
|
||||||
|
|
||||||
// byteLimits counts the request's bytes, as countedBytes gives them, for the
|
// byteLimits counts the request's bytes, as countedBytes gives them, for the
|
||||||
@@ -16,11 +19,16 @@ import (
|
|||||||
// the client over a byte limit, as its limit percentage for the byte limits
|
// the client over a byte limit, as its limit percentage for the byte limits
|
||||||
// lowers it, break it, which bans the client; the response was passed on whole.
|
// lowers it, break it, which bans the client; the response was passed on whole.
|
||||||
// Its figures are the window, the count and the limit.
|
// Its figures are the window, the count and the limit.
|
||||||
type byteLimits struct{}
|
type byteLimits struct {
|
||||||
|
limiter *ratelimit.Limiter
|
||||||
|
bytesCounted config.BytesCounted // SWW_WAF_BYTES_COUNTED
|
||||||
|
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
|
||||||
|
banMaker banMaker
|
||||||
|
}
|
||||||
|
|
||||||
func (byteLimits) name() string { return "byte_limits" }
|
func (byteLimits) name() string { return "byte_limits" }
|
||||||
|
|
||||||
func (byteLimits) check(
|
func (b byteLimits) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
@@ -29,10 +37,10 @@ func (byteLimits) check(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
counts, hit, over := rq.h.limiter.CountBytes(
|
counts, hit, over := b.limiter.CountBytes(
|
||||||
clientGroup(rq.h.config, rq.client),
|
clientGroup(b.ipv6GroupPrefix, rq.client),
|
||||||
now,
|
now,
|
||||||
rq.countedBytes(),
|
rq.countedBytes(b.bytesCounted),
|
||||||
rq.bytesLimitPercent.percent,
|
rq.bytesLimitPercent.percent,
|
||||||
)
|
)
|
||||||
rq.line.Counts.MinuteBytes = counts.MinuteBytes
|
rq.line.Counts.MinuteBytes = counts.MinuteBytes
|
||||||
@@ -43,7 +51,7 @@ func (byteLimits) check(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.banForLimit(now, hit, rq.out.status)
|
b.banMaker.banForLimit(rq, now, hit, rq.out.status)
|
||||||
|
|
||||||
return &verdict{figures: limitFigures(hit)}
|
return &verdict{figures: limitFigures(hit)}
|
||||||
}
|
}
|
||||||
@@ -6,7 +6,7 @@ import (
|
|||||||
"net/netip"
|
"net/netip"
|
||||||
"slices"
|
"slices"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// peerAddress is the address of the request's TCP peer.
|
// peerAddress is the address of the request's TCP peer.
|
||||||
@@ -19,14 +19,11 @@ func peerAddress(r *http.Request) netip.Addr {
|
|||||||
return addrPort.Addr().Unmap()
|
return addrPort.Addr().Unmap()
|
||||||
}
|
}
|
||||||
|
|
||||||
// requestIDHeader carries the request's id, from rproxy.
|
|
||||||
const requestIDHeader = "X-Request-ID"
|
|
||||||
|
|
||||||
// requestID is the request's id: the one a question gives, or for any other
|
// requestID is the request's id: the one a question gives, or for any other
|
||||||
// request a new random one.
|
// request a new random one.
|
||||||
func requestID(r *http.Request, isQuestion bool) string {
|
func requestID(r *http.Request, isQuestion bool) string {
|
||||||
if isQuestion {
|
if isQuestion {
|
||||||
return r.Header.Get(requestIDHeader)
|
return r.Header.Get(wafprotocol.RequestIDHeader)
|
||||||
}
|
}
|
||||||
|
|
||||||
return rand.Text()
|
return rand.Text()
|
||||||
@@ -45,12 +42,13 @@ func scheme(r *http.Request, isQuestion bool) string {
|
|||||||
|
|
||||||
// clientGroup is the client a request is counted toward: its IPv4
|
// clientGroup is the client a request is counted toward: its IPv4
|
||||||
// address, or its IPv6 group, the netblock its IPv6 address is in of the
|
// address, or its IPv6 group, the netblock its IPv6 address is in of the
|
||||||
// length SWW_WAF_IPV6_GROUP_PREFIX sets, a /64 by default, since one abuser
|
// length ipv6GroupPrefix, SWW_WAF_IPV6_GROUP_PREFIX, a /64 by default, since
|
||||||
// usually holds a whole /64. An IPv4 address in IPv6 form counts as IPv4.
|
// one abuser usually holds a whole /64. An IPv4 address in IPv6 form counts as
|
||||||
func clientGroup(cfg *config.WAF, addr netip.Addr) netip.Prefix {
|
// IPv4.
|
||||||
|
func clientGroup(ipv6GroupPrefix int, addr netip.Addr) netip.Prefix {
|
||||||
addr = addr.Unmap()
|
addr = addr.Unmap()
|
||||||
if addr.Is6() {
|
if addr.Is6() {
|
||||||
return netip.PrefixFrom(addr, cfg.IPv6GroupPrefix).Masked()
|
return netip.PrefixFrom(addr, ipv6GroupPrefix).Masked()
|
||||||
}
|
}
|
||||||
|
|
||||||
return netip.PrefixFrom(addr, addr.BitLen())
|
return netip.PrefixFrom(addr, addr.BitLen())
|
||||||
|
|||||||
+30
-18
@@ -10,6 +10,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/coreruleset"
|
"sneak.berlin/go/smallwebwaf/internal/coreruleset"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/metrics"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -22,11 +23,22 @@ import (
|
|||||||
// exploitsignature, raises the core_rule_set_match alert, and in block mode
|
// exploitsignature, raises the core_rule_set_match alert, and in block mode
|
||||||
// refuses the request with 403, which is an offence its client's history
|
// refuses the request with 403, which is an offence its client's history
|
||||||
// counts. Its figures are the score and the threshold.
|
// counts. Its figures are the score and the threshold.
|
||||||
type coreRuleSet struct{}
|
type coreRuleSet struct {
|
||||||
|
// inspector is the Core Rule Set, nil while SWW_WAF_CORE_RULE_SET_MODE is
|
||||||
|
// off.
|
||||||
|
inspector CoreRuleSetInspector
|
||||||
|
metrics *metrics.Metrics
|
||||||
|
alerts *alerts.Queue
|
||||||
|
mode config.CoreRuleSetMode // SWW_WAF_CORE_RULE_SET_MODE
|
||||||
|
exemptPaths []string // SWW_WAF_CORE_RULE_SET_EXEMPT_PATHS
|
||||||
|
scoreThreshold int // SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD
|
||||||
|
observe bool // SWW_WAF_MODE is observe
|
||||||
|
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
|
||||||
|
}
|
||||||
|
|
||||||
func (coreRuleSet) name() string { return "core_rule_set" }
|
func (coreRuleSet) name() string { return "core_rule_set" }
|
||||||
|
|
||||||
func (coreRuleSet) check(
|
func (c coreRuleSet) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
_ time.Time,
|
_ time.Time,
|
||||||
@@ -36,7 +48,6 @@ func (coreRuleSet) check(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg := rq.h.config
|
|
||||||
result := findings.inspection
|
result := findings.inspection
|
||||||
rq.requestBytes = int64(len(findings.read))
|
rq.requestBytes = int64(len(findings.read))
|
||||||
|
|
||||||
@@ -47,18 +58,18 @@ func (coreRuleSet) check(
|
|||||||
rq.line.CoreRuleSetScore = &result.Score
|
rq.line.CoreRuleSetScore = &result.Score
|
||||||
|
|
||||||
for _, id := range result.RuleIDs {
|
for _, id := range result.RuleIDs {
|
||||||
rq.h.metrics.CoreRuleSetMatched(string(cfg.CoreRuleSetMode), id)
|
c.metrics.CoreRuleSetMatched(string(c.mode), id)
|
||||||
}
|
}
|
||||||
|
|
||||||
threshold := cfg.CoreRuleSetScoreThreshold
|
threshold := c.scoreThreshold
|
||||||
if threshold == 0 || result.Score < threshold {
|
if threshold == 0 || result.Score < threshold {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.addTag(config.ExploitSignatureTag)
|
rq.addTag(config.ExploitSignatureTag)
|
||||||
rq.alertCoreRuleSetMatch(result)
|
c.alertCoreRuleSetMatch(rq, result)
|
||||||
|
|
||||||
if !rq.refusedByCoreRuleSet(result) {
|
if !c.refusedByCoreRuleSet(result) {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -76,20 +87,21 @@ func (coreRuleSet) check(
|
|||||||
// refusedByCoreRuleSet reports whether coreRuleSet refuses a request the Core
|
// refusedByCoreRuleSet reports whether coreRuleSet refuses a request the Core
|
||||||
// Rule Set found result of: whether the score is at or over
|
// Rule Set found result of: whether the score is at or over
|
||||||
// SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD in block mode.
|
// SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD in block mode.
|
||||||
func (rq *request) refusedByCoreRuleSet(result coreruleset.Result) bool {
|
func (c coreRuleSet) refusedByCoreRuleSet(result coreruleset.Result) bool {
|
||||||
cfg := rq.h.config
|
threshold := c.scoreThreshold
|
||||||
threshold := cfg.CoreRuleSetScoreThreshold
|
|
||||||
|
|
||||||
return cfg.CoreRuleSetMode == config.CoreRuleSetModeBlock &&
|
return c.mode == config.CoreRuleSetModeBlock &&
|
||||||
threshold != 0 && result.Score >= threshold
|
threshold != 0 && result.Score >= threshold
|
||||||
}
|
}
|
||||||
|
|
||||||
// alertCoreRuleSetMatch raises the core_rule_set_match alert for the request,
|
// alertCoreRuleSetMatch raises the core_rule_set_match alert for rq, which the
|
||||||
// which the Core Rule Set scored at result, at or over
|
// Core Rule Set scored at result, at or over
|
||||||
// SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD. Its detail gives the rule ids, the
|
// SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD. Its detail gives the rule ids, the
|
||||||
// score, the method and the path with the query, and, for a request that is
|
// score, the method and the path with the query, and, for a request that is
|
||||||
// not refused for it, the mode: detect, or observe in observe mode.
|
// not refused for it, the mode: detect, or observe in observe mode.
|
||||||
func (rq *request) alertCoreRuleSetMatch(result coreruleset.Result) {
|
func (c coreRuleSet) alertCoreRuleSetMatch(
|
||||||
|
rq *request, result coreruleset.Result,
|
||||||
|
) {
|
||||||
detail := map[string]any{
|
detail := map[string]any{
|
||||||
"rule_ids": result.RuleIDs,
|
"rule_ids": result.RuleIDs,
|
||||||
"score": result.Score,
|
"score": result.Score,
|
||||||
@@ -98,17 +110,17 @@ func (rq *request) alertCoreRuleSetMatch(result coreruleset.Result) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
switch {
|
switch {
|
||||||
case rq.h.config.CoreRuleSetMode == config.CoreRuleSetModeDetect:
|
case c.mode == config.CoreRuleSetModeDetect:
|
||||||
detail["mode"] = string(config.CoreRuleSetModeDetect)
|
detail["mode"] = string(config.CoreRuleSetModeDetect)
|
||||||
case rq.h.config.Observe:
|
case c.observe:
|
||||||
detail["mode"] = "observe"
|
detail["mode"] = "observe"
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.h.alerts.Raise(alerts.Alert{
|
c.alerts.Raise(alerts.Alert{
|
||||||
Event: alerts.EventCoreRuleSetMatch,
|
Event: alerts.EventCoreRuleSetMatch,
|
||||||
Host: rq.site,
|
Host: rq.site,
|
||||||
Client: rq.client,
|
Client: rq.client,
|
||||||
Netblock: clientGroup(rq.h.config, rq.client),
|
Netblock: clientGroup(c.ipv6GroupPrefix, rq.client),
|
||||||
ASN: rq.line.ASN,
|
ASN: rq.line.ASN,
|
||||||
ASName: rq.line.ASName,
|
ASName: rq.line.ASName,
|
||||||
Country: rq.line.Country,
|
Country: rq.line.Country,
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The Core Rule Set's settings the tests set, besides SWW_WAF_CORE_RULE_SET_MODE, and
|
// The Core Rule Set's settings the tests set, besides SWW_WAF_CORE_RULE_SET_MODE, and
|
||||||
@@ -395,9 +395,9 @@ func TestGiteasFixesApplyOnlyToAHostnameThatServesGitea(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
wantDisposition(t, do(t, s.question(siteA, client, fileName)),
|
wantDisposition(t, do(t, s.question(siteA, client, fileName)),
|
||||||
http.StatusOK, waf.DispositionAllow)
|
http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
wantDisposition(t, do(t, s.question(siteB, client, fileName)),
|
wantDisposition(t, do(t, s.question(siteB, client, fileName)),
|
||||||
http.StatusForbidden, waf.DispositionDeny)
|
http.StatusForbidden, wafprotocol.DispositionDeny)
|
||||||
|
|
||||||
lines := s.out.requestLines(t, 2)
|
lines := s.out.requestLines(t, 2)
|
||||||
wantLine(t, lines[0], http.StatusOK, requestlog.ActionForward)
|
wantLine(t, lines[0], http.StatusOK, requestlog.ActionForward)
|
||||||
|
|||||||
@@ -15,16 +15,18 @@ import (
|
|||||||
// 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. Its figures are the
|
// country, or whose country cannot be found, is refused. Its figures are the
|
||||||
// country and the setting that refused it.
|
// country and the setting that refused it.
|
||||||
type countries struct{}
|
type countries struct {
|
||||||
|
allowed []string // SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES
|
||||||
|
}
|
||||||
|
|
||||||
func (countries) name() string { return "countries" }
|
func (countries) name() string { return "countries" }
|
||||||
|
|
||||||
func (countries) check(
|
func (c countries) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
_ time.Time,
|
_ time.Time,
|
||||||
) *verdict {
|
) *verdict {
|
||||||
allowed := rq.h.config.ExclusivelyAllowedCountries
|
allowed := c.allowed
|
||||||
country := rq.line.Country
|
country := rq.line.Country
|
||||||
|
|
||||||
if len(allowed) == 0 || slices.Contains(allowed, country) {
|
if len(allowed) == 0 || slices.Contains(allowed, country) {
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ package waf
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"net/netip"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
@@ -11,12 +12,18 @@ import (
|
|||||||
|
|
||||||
// denyNets refuses a client in SWW_WAF_DENY_NETS. Its figure is the netblock of
|
// denyNets refuses a client in SWW_WAF_DENY_NETS. 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
|
||||||
|
}
|
||||||
|
|
||||||
func (denyNets) name() string { return "deny_nets" }
|
func (denyNets) name() string { return "deny_nets" }
|
||||||
|
|
||||||
func (denyNets) check(_ context.Context, rq *request, _ time.Time) *verdict {
|
func (d denyNets) check(
|
||||||
for _, netblock := range rq.h.config.DenyNets {
|
_ context.Context,
|
||||||
|
rq *request,
|
||||||
|
_ time.Time,
|
||||||
|
) *verdict {
|
||||||
|
for _, netblock := range d.netblocks {
|
||||||
if netblock.Contains(rq.client) {
|
if netblock.Contains(rq.client) {
|
||||||
return &verdict{
|
return &verdict{
|
||||||
action: requestlog.ActionClientDenied,
|
action: requestlog.ActionClientDenied,
|
||||||
|
|||||||
@@ -0,0 +1,47 @@
|
|||||||
|
package waf
|
||||||
|
|
||||||
|
import (
|
||||||
|
"net/netip"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestDenyNetsRefusesOnlyAClientInsideItsNetblocks(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
heuristic := denyNets{
|
||||||
|
netblocks: []netip.Prefix{netip.MustParsePrefix("198.51.100.0/24")},
|
||||||
|
}
|
||||||
|
|
||||||
|
// The request has no handler: the heuristic reads only what it holds.
|
||||||
|
inside := &request{
|
||||||
|
decision: decision{client: netip.MustParseAddr("198.51.100.7")},
|
||||||
|
}
|
||||||
|
|
||||||
|
v := heuristic.check(t.Context(), inside, time.Time{})
|
||||||
|
if v == nil {
|
||||||
|
t.Fatal("a client inside the netblock was let through")
|
||||||
|
}
|
||||||
|
|
||||||
|
if v.action != requestlog.ActionClientDenied {
|
||||||
|
t.Errorf(
|
||||||
|
"action = %q, want %q",
|
||||||
|
v.action,
|
||||||
|
requestlog.ActionClientDenied,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := v.figures[figureNetblock]; got != "198.51.100.0/24" {
|
||||||
|
t.Errorf("netblock figure = %v, want 198.51.100.0/24", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
outside := &request{
|
||||||
|
decision: decision{client: netip.MustParseAddr("203.0.113.7")},
|
||||||
|
}
|
||||||
|
|
||||||
|
if v := heuristic.check(t.Context(), outside, time.Time{}); v != nil {
|
||||||
|
t.Errorf("a client outside the netblock was refused: %+v", v)
|
||||||
|
}
|
||||||
|
}
|
||||||
+14
-6
@@ -9,6 +9,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/reputation"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -19,21 +20,28 @@ import (
|
|||||||
// being log, it does nothing more. A zone without a verdict on the client is
|
// being log, it does nothing more. A zone without a verdict on the client is
|
||||||
// asked about it in the background, and the request does not wait for the
|
// asked about it in the background, and the request does not wait for the
|
||||||
// answer. Its figure is the zones that list the client, their keys masked.
|
// answer. Its figure is the zones that list the client, their keys masked.
|
||||||
type dnsbl struct{}
|
type dnsbl struct {
|
||||||
|
dnsbl *reputation.DNSBL
|
||||||
|
action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION
|
||||||
|
hitNoter reputationHitNoter
|
||||||
|
}
|
||||||
|
|
||||||
func (dnsbl) name() string { return "dnsbl" }
|
func (dnsbl) name() string { return "dnsbl" }
|
||||||
|
|
||||||
func (dnsbl) check(ctx context.Context, rq *request, _ time.Time) *verdict {
|
func (d dnsbl) check(
|
||||||
listedBy := rq.h.dnsbl.ListedBy(ctx, rq.client)
|
ctx context.Context,
|
||||||
|
rq *request,
|
||||||
|
_ time.Time,
|
||||||
|
) *verdict {
|
||||||
|
listedBy := d.dnsbl.ListedBy(ctx, rq.client)
|
||||||
rq.dnsblListed = len(listedBy) > 0
|
rq.dnsblListed = len(listedBy) > 0
|
||||||
rq.noteListed(listedBy, "listed by a DNSBL zone")
|
d.hitNoter.noteListed(rq, listedBy, "listed by a DNSBL zone")
|
||||||
|
|
||||||
for _, zone := range listedBy {
|
for _, zone := range listedBy {
|
||||||
rq.addTag(config.DNSBLTagPrefix + strings.ToLower(zone))
|
rq.addTag(config.DNSBLTagPrefix + strings.ToLower(zone))
|
||||||
}
|
}
|
||||||
|
|
||||||
if !rq.dnsblListed ||
|
if !rq.dnsblListed || d.action != config.ReputationActionDeny {
|
||||||
rq.h.config.DNSBLAbuseIPDBAction != config.ReputationActionDeny {
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ import (
|
|||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestHealthEndpointCountsTowardNoLimit(t *testing.T) {
|
func TestHealthEndpointCountsTowardNoLimit(t *testing.T) {
|
||||||
@@ -25,8 +25,13 @@ func TestHealthEndpointCountsTowardNoLimit(t *testing.T) {
|
|||||||
)
|
)
|
||||||
|
|
||||||
for range healthChecks {
|
for range healthChecks {
|
||||||
got := s.ownEndpointRequest("", http.MethodGet, waf.HealthPath, "",
|
got := s.ownEndpointRequest(
|
||||||
http.StatusOK)
|
"",
|
||||||
|
http.MethodGet,
|
||||||
|
wafprotocol.HealthPath,
|
||||||
|
"",
|
||||||
|
http.StatusOK,
|
||||||
|
)
|
||||||
|
|
||||||
if string(got.body) != "ok\n" ||
|
if string(got.body) != "ok\n" ||
|
||||||
got.header.Get("Content-Type") != contentType {
|
got.header.Get("Content-Type") != contentType {
|
||||||
|
|||||||
@@ -5,9 +5,10 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
// To add a heuristic, write one file with a type that implements heuristic,
|
// To add a heuristic, write one file with a struct that implements heuristic
|
||||||
// and add one line for it to one of the lists below. Its settings go in
|
// and holds the settings and parts it reads. Add one line for it to one of the
|
||||||
// config.WAF, and the comment at the top of its file names them.
|
// lists that newHandler builds, which hands it those settings and parts. Its
|
||||||
|
// settings go in config.WAF, and the comment at the top of its file names them.
|
||||||
|
|
||||||
// heuristic is one of the checks that decide what waf does with a
|
// heuristic is one of the checks that decide what waf does with a
|
||||||
// request.
|
// request.
|
||||||
@@ -36,74 +37,6 @@ const (
|
|||||||
figureNetblock = "netblock"
|
figureNetblock = "netblock"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The lists of heuristics, each in the order its heuristics run. A client in
|
|
||||||
// SWW_WAF_ALLOW_NETS skips them all.
|
|
||||||
|
|
||||||
// beforeLookup are the heuristics that run before the client's AS number and
|
|
||||||
// country are looked up, so that a client they refuse is not looked up.
|
|
||||||
// header_limits comes first: it only measures and counts, and a request it
|
|
||||||
// refuses causes no other work.
|
|
||||||
func beforeLookup() []heuristic {
|
|
||||||
return []heuristic{
|
|
||||||
headerLimits{},
|
|
||||||
tagLists{},
|
|
||||||
routeWatchTags{},
|
|
||||||
denyNets{},
|
|
||||||
activeBan{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// afterLookup are the heuristics that run once the lookup has been made.
|
|
||||||
func afterLookup() []heuristic {
|
|
||||||
return []heuristic{
|
|
||||||
countries{},
|
|
||||||
blocklists{},
|
|
||||||
dnsbl{},
|
|
||||||
abuseIPDB{},
|
|
||||||
tagDeny{},
|
|
||||||
rateLimits{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// besideLookup are the heuristics that only read the request. Their work runs
|
|
||||||
// beside the lookup and afterLookup, in findBesideLookup, which changes nothing
|
|
||||||
// of the request. Their check then applies what that work found, and runs only
|
|
||||||
// once waf takes it.
|
|
||||||
func besideLookup() []heuristic {
|
|
||||||
return []heuristic{
|
|
||||||
trapPaths{},
|
|
||||||
ruleFiles{},
|
|
||||||
coreRuleSet{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// afterBesideLookup are the heuristics that run once afterLookup and
|
|
||||||
// besideLookup have both let the request through. tag_deny runs a second time,
|
|
||||||
// on the tag rule_files and core_rule_set can add.
|
|
||||||
func afterBesideLookup() []heuristic {
|
|
||||||
return []heuristic{
|
|
||||||
tagDeny{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// afterAnswer are the heuristics that run on a request once waf has
|
|
||||||
// answered it, before its decision line is written. They ban the client, and do
|
|
||||||
// not change what the request got: their verdict's action is not used.
|
|
||||||
func afterAnswer() []heuristic {
|
|
||||||
return []heuristic{
|
|
||||||
refusalLimit{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// onReport are the heuristics that run on an allowed request when rproxy's
|
|
||||||
// report of it comes, before its report line is written. Like afterAnswer, they
|
|
||||||
// only ban.
|
|
||||||
func onReport() []heuristic {
|
|
||||||
return []heuristic{
|
|
||||||
byteLimits{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// runHeuristics runs list, one of those checkClient runs, on the request at now,
|
// runHeuristics runs list, one of those checkClient runs, on the request at now,
|
||||||
// and returns the first verdict, or nil when none gives one. The log line's
|
// and returns the first verdict, or nil when none gives one. The log line's
|
||||||
// heuristic and heuristic_figures name the heuristic that gave it, and give its
|
// heuristic and heuristic_figures name the heuristic that gave it, and give its
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/waf"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestHistoryKeepsEachRequestOfTheClient(t *testing.T) {
|
func TestHistoryKeepsEachRequestOfTheClient(t *testing.T) {
|
||||||
@@ -118,7 +119,7 @@ func TestOwnEndpointsAreNotInTheHistory(t *testing.T) {
|
|||||||
s.ownEndpointRequest(
|
s.ownEndpointRequest(
|
||||||
"",
|
"",
|
||||||
http.MethodGet,
|
http.MethodGet,
|
||||||
waf.HealthPath,
|
wafprotocol.HealthPath,
|
||||||
"",
|
"",
|
||||||
http.StatusOK,
|
http.StatusOK,
|
||||||
)
|
)
|
||||||
|
|||||||
+5
-25
@@ -3,7 +3,6 @@ package waf
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
@@ -16,15 +15,6 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The headers in which an answer of allow gives rproxy the client's AS number
|
|
||||||
// and country, for the app, while SWW_WAF_ADD_LOOKUP_HEADERS is true. Go writes
|
|
||||||
// every header name in this form, as it sends it and as it receives it, so
|
|
||||||
// X-Client-ASN arrives as X-Client-Asn; header names are not case-sensitive.
|
|
||||||
const (
|
|
||||||
asnHeader = "X-Client-Asn"
|
|
||||||
countryHeader = "X-Client-Country"
|
|
||||||
)
|
|
||||||
|
|
||||||
// lookupResult is what the lookup gave for a request: whether its client was
|
// lookupResult is what the lookup gave for a request: whether its client was
|
||||||
// looked up, the answer, and whether the request skipped the wait for GeoJS.
|
// looked up, the answer, and whether the request skipped the wait for GeoJS.
|
||||||
type lookupResult struct {
|
type lookupResult struct {
|
||||||
@@ -56,7 +46,7 @@ func (rq *request) startLookUp(
|
|||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
client := clientGroup(rq.h.config, rq.client)
|
client := clientGroup(rq.h.config.IPv6GroupPrefix, rq.client)
|
||||||
|
|
||||||
if rq.h.config.LookupSource == config.LookupSourceFile {
|
if rq.h.config.LookupSource == config.LookupSourceFile {
|
||||||
result <- lookupResult{
|
result <- lookupResult{
|
||||||
@@ -143,8 +133,10 @@ func AddLookup(
|
|||||||
) {
|
) {
|
||||||
limiter.AddLookup(answer.Client, answer.Answered,
|
limiter.AddLookup(answer.Client, answer.Answered,
|
||||||
answer.ASN, answer.ASName, answer.Country)
|
answer.ASN, answer.ASName, answer.Country)
|
||||||
ledger.AddLookup(banNetblock(cfg, answer.Client.Addr()),
|
netblock := banNetblock(
|
||||||
answer.ASN, answer.ASName, answer.Country)
|
cfg.BanScopeV4Prefix, cfg.IPv6GroupPrefix, answer.Client.Addr(),
|
||||||
|
)
|
||||||
|
ledger.AddLookup(netblock, answer.ASN, answer.ASName, answer.Country)
|
||||||
}
|
}
|
||||||
|
|
||||||
// GeoJSFailed logs a failure of GeoJS to processLog, raises a
|
// GeoJSFailed logs a failure of GeoJS to processLog, raises a
|
||||||
@@ -167,18 +159,6 @@ func GeoJSFailed(
|
|||||||
m.GeoJSFailures.Inc()
|
m.GeoJSFailures.Inc()
|
||||||
}
|
}
|
||||||
|
|
||||||
// setLookupHeaders sets the headers that give the client's AS number and
|
|
||||||
// country, leaving out one that is unknown.
|
|
||||||
func setLookupHeaders(header http.Header, asn, country string) {
|
|
||||||
if asn != "" {
|
|
||||||
header.Set(asnHeader, asn)
|
|
||||||
}
|
|
||||||
|
|
||||||
if country != "" {
|
|
||||||
header.Set(countryHeader, country)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// canBePlaced reports whether a lookup can place addr: private, loopback
|
// canBePlaced reports whether a lookup can place addr: private, loopback
|
||||||
// and link-local addresses have no AS number or country.
|
// and link-local addresses have no AS number or country.
|
||||||
func canBePlaced(addr netip.Addr) bool {
|
func canBePlaced(addr netip.Addr) bool {
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/geojs"
|
"sneak.berlin/go/smallwebwaf/internal/geojs"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/waf"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -66,7 +67,7 @@ func TestMetricsNeedTheTokenAndOtherPathsAreNotFound(t *testing.T) {
|
|||||||
{http.MethodPost, waf.MetricsPath, bearer, http.StatusNotFound},
|
{http.MethodPost, waf.MetricsPath, bearer, http.StatusNotFound},
|
||||||
{http.MethodGet, waf.MetricsPath + "/", bearer, http.StatusNotFound},
|
{http.MethodGet, waf.MetricsPath + "/", bearer, http.StatusNotFound},
|
||||||
{http.MethodGet, "/_sww/bans", bearer, http.StatusNotFound},
|
{http.MethodGet, "/_sww/bans", bearer, http.StatusNotFound},
|
||||||
{http.MethodPost, waf.HealthPath, "", http.StatusNotFound},
|
{http.MethodPost, wafprotocol.HealthPath, "", http.StatusNotFound},
|
||||||
} {
|
} {
|
||||||
got := s.ownEndpointRequest(
|
got := s.ownEndpointRequest(
|
||||||
tc.authorization,
|
tc.authorization,
|
||||||
|
|||||||
+168
-39
@@ -28,14 +28,6 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/rules"
|
"sneak.berlin/go/smallwebwaf/internal/rules"
|
||||||
)
|
)
|
||||||
|
|
||||||
// ownEndpointPrefix starts the path of each of waf's own endpoints. The app
|
|
||||||
// never sees a path under it.
|
|
||||||
const ownEndpointPrefix = "/_sww/"
|
|
||||||
|
|
||||||
// HealthPath is the health endpoint of waf and of rproxy, which the
|
|
||||||
// container's health check asks.
|
|
||||||
const HealthPath = "/_sww/healthz"
|
|
||||||
|
|
||||||
// MetricsPath is where the metrics are, for a request that carries
|
// MetricsPath is where the metrics are, for a request that carries
|
||||||
// SWW_WAF_METRICS_TOKEN.
|
// SWW_WAF_METRICS_TOKEN.
|
||||||
const MetricsPath = "/_sww/metrics"
|
const MetricsPath = "/_sww/metrics"
|
||||||
@@ -133,15 +125,19 @@ type Server struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// newHandler returns the handler with what every request shares, the parts
|
// newHandler returns the handler with what every request shares, the parts
|
||||||
// in params among it.
|
// in params among it. It builds the heuristics, each with the settings and
|
||||||
|
// parts it reads, and the lists they run in.
|
||||||
|
//
|
||||||
|
//nolint:funlen // a few lines for each heuristic, a list that grows with them
|
||||||
func newHandler(params Params) *handler {
|
func newHandler(params Params) *handler {
|
||||||
awaitingReport, err := lru.New[string, *decision](maxAwaitingReport)
|
awaitingReport, err := lru.New[string, *decision](maxAwaitingReport)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
panic(err) // New fails only for a size below one
|
panic(err) // New fails only for a size below one
|
||||||
}
|
}
|
||||||
|
|
||||||
return &handler{
|
cfg := params.Config
|
||||||
config: params.Config,
|
h := &handler{
|
||||||
|
config: cfg,
|
||||||
requestLog: params.RequestLog,
|
requestLog: params.RequestLog,
|
||||||
processLog: params.ProcessLog,
|
processLog: params.ProcessLog,
|
||||||
now: params.Now,
|
now: params.Now,
|
||||||
@@ -152,47 +148,142 @@ func newHandler(params Params) *handler {
|
|||||||
geojs: params.GeoJS,
|
geojs: params.GeoJS,
|
||||||
anomalies: params.Anomalies,
|
anomalies: params.Anomalies,
|
||||||
lookupFile: params.LookupFile,
|
lookupFile: params.LookupFile,
|
||||||
lists: params.Lists,
|
|
||||||
dnsbl: params.DNSBL,
|
|
||||||
abuseIPDB: params.AbuseIPDB,
|
|
||||||
routeWatch: params.RouteWatch,
|
|
||||||
rules: params.Rules,
|
|
||||||
coreRuleSet: params.CoreRuleSet,
|
|
||||||
alerts: params.Alerts,
|
|
||||||
// The country list, the headers, the tag settings that name an asn=
|
// The country list, the headers, the tag settings that name an asn=
|
||||||
// or country= tag and the biased thresholds act on the answer before
|
// or country= tag and the biased thresholds act on the answer before
|
||||||
// the request goes on.
|
// the request goes on.
|
||||||
waitForGeoJS: len(params.Config.ExclusivelyAllowedCountries) > 0 ||
|
waitForGeoJS: len(cfg.ExclusivelyAllowedCountries) > 0 ||
|
||||||
params.Config.AddLookupHeaders ||
|
cfg.AddLookupHeaders ||
|
||||||
params.Config.TagsNeedLookup() ||
|
cfg.TagsNeedLookup() ||
|
||||||
biasedThresholdsSet(params.Config),
|
biasedThresholdsSet(cfg),
|
||||||
besideLookupLimit: cmp.Or(
|
besideLookupLimit: cmp.Or(
|
||||||
params.BesideLookupTimeLimit,
|
params.BesideLookupTimeLimit,
|
||||||
besideLookupTimeLimit,
|
besideLookupTimeLimit,
|
||||||
),
|
),
|
||||||
}
|
}
|
||||||
|
|
||||||
|
sharedBanMaker := banMaker{
|
||||||
|
ledger: params.Ledger,
|
||||||
|
limiter: params.Limiter,
|
||||||
|
metrics: params.Metrics,
|
||||||
|
alerts: params.Alerts,
|
||||||
|
observe: cfg.Observe,
|
||||||
|
banResponse: cfg.BanResponse,
|
||||||
|
banScopeV4Prefix: cfg.BanScopeV4Prefix,
|
||||||
|
ipv6GroupPrefix: cfg.IPv6GroupPrefix,
|
||||||
|
}
|
||||||
|
hitNoter := reputationHitNoter{
|
||||||
|
metrics: params.Metrics,
|
||||||
|
alerts: params.Alerts,
|
||||||
|
ipv6GroupPrefix: cfg.IPv6GroupPrefix,
|
||||||
|
}
|
||||||
|
|
||||||
|
h.blocklists = blocklists{
|
||||||
|
lists: params.Lists,
|
||||||
|
action: cfg.BlocklistAction,
|
||||||
|
hitNoter: hitNoter,
|
||||||
|
}
|
||||||
|
h.rateLimits = rateLimits{
|
||||||
|
limiter: params.Limiter,
|
||||||
|
exemptNets: cfg.RateLimitExemptNets,
|
||||||
|
exemptPaths: cfg.RateLimitExemptPaths,
|
||||||
|
banResponse: cfg.BanResponse,
|
||||||
|
ipv6GroupPrefix: cfg.IPv6GroupPrefix,
|
||||||
|
biasedThresholds: biasedThresholds{
|
||||||
|
lists: params.Lists,
|
||||||
|
tagLimitPercent: cfg.TagLimitPercent,
|
||||||
|
asnBytesLimitPercent: cfg.ASNBytesLimitPercent,
|
||||||
|
countryBytesLimitPercent: cfg.CountryBytesLimitPercent,
|
||||||
|
unknownCountryLimitPercent: cfg.UnknownCountryLimitPercent,
|
||||||
|
blocklistAction: cfg.BlocklistAction,
|
||||||
|
blocklistLimitPercent: cfg.BlocklistLimitPercent,
|
||||||
|
dnsblAbuseIPDBAction: cfg.DNSBLAbuseIPDBAction,
|
||||||
|
dnsblAbuseIPDBLimitPercent: cfg.DNSBLAbuseIPDBLimitPercent,
|
||||||
|
},
|
||||||
|
banMaker: sharedBanMaker,
|
||||||
|
}
|
||||||
|
h.trapPaths = trapPaths{paths: cfg.TrapPaths, banMaker: sharedBanMaker}
|
||||||
|
h.ruleFiles = ruleFiles{
|
||||||
|
rules: params.Rules,
|
||||||
|
metrics: params.Metrics,
|
||||||
|
banMaker: sharedBanMaker,
|
||||||
|
}
|
||||||
|
h.coreRuleSet = coreRuleSet{
|
||||||
|
inspector: params.CoreRuleSet,
|
||||||
|
metrics: params.Metrics,
|
||||||
|
alerts: params.Alerts,
|
||||||
|
mode: cfg.CoreRuleSetMode,
|
||||||
|
exemptPaths: cfg.CoreRuleSetExemptPaths,
|
||||||
|
scoreThreshold: cfg.CoreRuleSetScoreThreshold,
|
||||||
|
observe: cfg.Observe,
|
||||||
|
ipv6GroupPrefix: cfg.IPv6GroupPrefix,
|
||||||
|
}
|
||||||
|
|
||||||
|
h.beforeLookup = []heuristic{
|
||||||
|
headerLimits{},
|
||||||
|
tagLists{lists: params.Lists},
|
||||||
|
routeWatchTags{
|
||||||
|
routeWatch: params.RouteWatch,
|
||||||
|
ipv6GroupPrefix: cfg.IPv6GroupPrefix,
|
||||||
|
},
|
||||||
|
denyNets{netblocks: cfg.DenyNets},
|
||||||
|
activeBan{banMaker: sharedBanMaker},
|
||||||
|
}
|
||||||
|
h.afterLookup = []heuristic{
|
||||||
|
countries{allowed: cfg.ExclusivelyAllowedCountries},
|
||||||
|
h.blocklists,
|
||||||
|
dnsbl{
|
||||||
|
dnsbl: params.DNSBL,
|
||||||
|
action: cfg.DNSBLAbuseIPDBAction,
|
||||||
|
hitNoter: hitNoter,
|
||||||
|
},
|
||||||
|
abuseIPDB{
|
||||||
|
abuseIPDB: params.AbuseIPDB,
|
||||||
|
limiter: params.Limiter,
|
||||||
|
keySet: cfg.AbuseIPDBKey != "",
|
||||||
|
minScore: cfg.AbuseIPDBMinScore,
|
||||||
|
action: cfg.DNSBLAbuseIPDBAction,
|
||||||
|
ipv6GroupPrefix: cfg.IPv6GroupPrefix,
|
||||||
|
hitNoter: hitNoter,
|
||||||
|
},
|
||||||
|
tagDeny{tags: cfg.TagDeny},
|
||||||
|
h.rateLimits,
|
||||||
|
}
|
||||||
|
h.besideLookup = []heuristic{h.trapPaths, h.ruleFiles, h.coreRuleSet}
|
||||||
|
h.afterBesideLookup = []heuristic{tagDeny{tags: cfg.TagDeny}}
|
||||||
|
h.afterAnswer = []heuristic{
|
||||||
|
refusalLimit{
|
||||||
|
limiter: params.Limiter,
|
||||||
|
perMinute: cfg.RefusalsLimitPerMinute,
|
||||||
|
banResponse: cfg.BanResponse,
|
||||||
|
ipv6GroupPrefix: cfg.IPv6GroupPrefix,
|
||||||
|
banMaker: sharedBanMaker,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
h.onReport = []heuristic{
|
||||||
|
byteLimits{
|
||||||
|
limiter: params.Limiter,
|
||||||
|
bytesCounted: cfg.BytesCounted,
|
||||||
|
ipv6GroupPrefix: cfg.IPv6GroupPrefix,
|
||||||
|
banMaker: sharedBanMaker,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
return h
|
||||||
}
|
}
|
||||||
|
|
||||||
// handler is waf's handler. It holds what every request shares; what
|
// handler is waf's handler. It holds what every request shares; what
|
||||||
// belongs to one request is in a request.
|
// belongs to one request is in a request.
|
||||||
type handler struct {
|
type handler struct {
|
||||||
config *config.WAF
|
config *config.WAF
|
||||||
requestLog io.Writer
|
requestLog io.Writer
|
||||||
processLog *slog.Logger
|
processLog *slog.Logger
|
||||||
now func() time.Time
|
now func() time.Time
|
||||||
metrics *metrics.Metrics
|
metrics *metrics.Metrics
|
||||||
limiter *ratelimit.Limiter
|
limiter *ratelimit.Limiter
|
||||||
ledger *bans.Ledger
|
ledger *bans.Ledger
|
||||||
geojs *geojs.GeoJS
|
geojs *geojs.GeoJS
|
||||||
anomalies *anomaly.Counters
|
anomalies *anomaly.Counters
|
||||||
lookupFile *lookup.File
|
lookupFile *lookup.File
|
||||||
lists *reputation.Lists
|
|
||||||
dnsbl *reputation.DNSBL
|
|
||||||
abuseIPDB *reputation.AbuseIPDB
|
|
||||||
routeWatch *routewatch.Client
|
|
||||||
rules *rules.Files
|
|
||||||
coreRuleSet CoreRuleSetInspector
|
|
||||||
alerts *alerts.Queue
|
|
||||||
// waitForGeoJS is true when a setting needs each request's answer from
|
// waitForGeoJS is true when a setting needs each request's answer from
|
||||||
// GeoJS before the request goes on.
|
// GeoJS before the request goes on.
|
||||||
waitForGeoJS bool
|
waitForGeoJS bool
|
||||||
@@ -202,4 +293,42 @@ type handler struct {
|
|||||||
// awaitingReport holds the decision on each answered question by its id
|
// awaitingReport holds the decision on each answered question by its id
|
||||||
// until its report comes, and nil for a question still being handled.
|
// until its report comes, and nil for a question still being handled.
|
||||||
awaitingReport *lru.Cache[string, *decision]
|
awaitingReport *lru.Cache[string, *decision]
|
||||||
|
|
||||||
|
// The lists of heuristics, each in the order its heuristics run. A client
|
||||||
|
// in SWW_WAF_ALLOW_NETS skips them all.
|
||||||
|
|
||||||
|
// beforeLookup are the heuristics that run before the client's AS number
|
||||||
|
// and country are looked up, so that a client they refuse is not looked
|
||||||
|
// up. header_limits comes first: it only measures and counts, and a
|
||||||
|
// request it refuses causes no other work.
|
||||||
|
beforeLookup []heuristic
|
||||||
|
// afterLookup are the heuristics that run once the lookup has been made.
|
||||||
|
afterLookup []heuristic
|
||||||
|
// besideLookup are the heuristics that only read the request. Their work
|
||||||
|
// runs beside the lookup and afterLookup, in findBesideLookup, which
|
||||||
|
// changes nothing of the request. Their check then applies what that work
|
||||||
|
// found, and runs only once waf takes it.
|
||||||
|
besideLookup []heuristic
|
||||||
|
// afterBesideLookup are the heuristics that run once afterLookup and
|
||||||
|
// besideLookup have both let the request through. tag_deny runs a second
|
||||||
|
// time, on the tag rule_files and core_rule_set can add.
|
||||||
|
afterBesideLookup []heuristic
|
||||||
|
// afterAnswer are the heuristics that run on a request once waf has
|
||||||
|
// answered it, before its decision line is written. They ban the client,
|
||||||
|
// and do not change what the request got: their verdict's action is not
|
||||||
|
// used.
|
||||||
|
afterAnswer []heuristic
|
||||||
|
// onReport are the heuristics that run on an allowed request when
|
||||||
|
// rproxy's report of it comes, before its report line is written. Like
|
||||||
|
// afterAnswer, they only ban.
|
||||||
|
onReport []heuristic
|
||||||
|
|
||||||
|
// The heuristics of the lists that other steps of a request use too:
|
||||||
|
// refusedWhateverTheAnswer asks blocklists and rateLimits, and
|
||||||
|
// findBesideLookup does the work of trapPaths, ruleFiles and coreRuleSet.
|
||||||
|
blocklists blocklists
|
||||||
|
rateLimits rateLimits
|
||||||
|
trapPaths trapPaths
|
||||||
|
ruleFiles ruleFiles
|
||||||
|
coreRuleSet coreRuleSet
|
||||||
}
|
}
|
||||||
+34
-22
@@ -6,8 +6,10 @@ package waf
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"net/netip"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -18,28 +20,37 @@ import (
|
|||||||
// refused, and bans the client. A request exempt from the rate limits is exempt
|
// refused, and bans the client. A request exempt from the rate limits is exempt
|
||||||
// from the byte limits too. Its figures are the window, the count and the
|
// from the byte limits too. Its figures are the window, the count and the
|
||||||
// limit.
|
// limit.
|
||||||
type rateLimits struct{}
|
type rateLimits struct {
|
||||||
|
limiter *ratelimit.Limiter
|
||||||
|
exemptNets []netip.Prefix // SWW_WAF_RATE_LIMIT_EXEMPT_NETS
|
||||||
|
exemptPaths []string // SWW_WAF_RATE_LIMIT_EXEMPT_PATHS
|
||||||
|
banResponse int // SWW_WAF_BAN_RESPONSE
|
||||||
|
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
|
||||||
|
biasedThresholds biasedThresholds
|
||||||
|
banMaker banMaker
|
||||||
|
}
|
||||||
|
|
||||||
func (rateLimits) name() string { return "rate_limits" }
|
func (rateLimits) name() string { return "rate_limits" }
|
||||||
|
|
||||||
func (rateLimits) check(
|
func (r rateLimits) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
) *verdict {
|
) *verdict {
|
||||||
rq.counted = rq.countedByRateLimits()
|
rq.counted = r.countedByRateLimits(rq)
|
||||||
if !rq.counted {
|
if !rq.counted {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.rateLimitPercent, rq.bytesLimitPercent = rq.limitPercentages()
|
rq.rateLimitPercent, rq.bytesLimitPercent =
|
||||||
|
r.biasedThresholds.limitPercentages(rq)
|
||||||
rq.line.RateLimitPercent, rq.line.RateLimitPercentSetting =
|
rq.line.RateLimitPercent, rq.line.RateLimitPercentSetting =
|
||||||
rq.rateLimitPercent.logged()
|
rq.rateLimitPercent.logged()
|
||||||
rq.line.BytesLimitPercent, rq.line.BytesLimitPercentSetting =
|
rq.line.BytesLimitPercent, rq.line.BytesLimitPercentSetting =
|
||||||
rq.bytesLimitPercent.logged()
|
rq.bytesLimitPercent.logged()
|
||||||
|
|
||||||
counts, hit, over := rq.h.limiter.Count(
|
counts, hit, over := r.limiter.Count(
|
||||||
clientGroup(rq.h.config, rq.client),
|
clientGroup(r.ipv6GroupPrefix, rq.client),
|
||||||
now,
|
now,
|
||||||
rq.rateLimitPercent.percent,
|
rq.rateLimitPercent.percent,
|
||||||
)
|
)
|
||||||
@@ -49,28 +60,29 @@ func (rateLimits) check(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.banForLimit(now, hit, rq.h.config.BanResponse)
|
r.banMaker.banForLimit(rq, now, hit, r.banResponse)
|
||||||
|
|
||||||
return &verdict{
|
return &verdict{
|
||||||
action: requestlog.ActionClientIsRateLimited, figures: limitFigures(hit),
|
action: requestlog.ActionClientIsRateLimited, figures: limitFigures(hit),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// overAWholeRateLimit reports whether the heuristic rate_limits will refuse the
|
// overAWholeRateLimit reports whether the heuristic rate_limits will refuse rq
|
||||||
// request at now, whatever its client's limit percentages: the rate limits
|
// at now, whatever its client's limit percentages: the rate limits count it,
|
||||||
// count it, and one more request from its client takes it over a whole rate
|
// and one more request from its client takes it over a whole rate limit. It
|
||||||
// limit. It counts nothing.
|
// counts nothing.
|
||||||
func (rq *request) overAWholeRateLimit(now time.Time) bool {
|
func (r rateLimits) overAWholeRateLimit(rq *request, now time.Time) bool {
|
||||||
return rq.countedByRateLimits() &&
|
return r.countedByRateLimits(rq) &&
|
||||||
rq.h.limiter.OverARateLimit(clientGroup(rq.h.config, rq.client), now)
|
r.limiter.OverARateLimit(
|
||||||
|
clientGroup(r.ipv6GroupPrefix, rq.client),
|
||||||
|
now,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// countedByRateLimits reports whether the rate limits count the request: its
|
// countedByRateLimits reports whether the rate limits count rq: its client is
|
||||||
// client is not in SWW_WAF_RATE_LIMIT_EXEMPT_NETS, and its path is not exempt
|
// not in SWW_WAF_RATE_LIMIT_EXEMPT_NETS, and its path is not exempt under
|
||||||
// under SWW_WAF_RATE_LIMIT_EXEMPT_PATHS.
|
// SWW_WAF_RATE_LIMIT_EXEMPT_PATHS.
|
||||||
func (rq *request) countedByRateLimits() bool {
|
func (r rateLimits) countedByRateLimits(rq *request) bool {
|
||||||
cfg := rq.h.config
|
return !isInside(rq.client, r.exemptNets) &&
|
||||||
|
!pathExempt(rq.in, r.exemptPaths)
|
||||||
return !isInside(rq.client, cfg.RateLimitExemptNets) &&
|
|
||||||
!pathExempt(rq.in, cfg.RateLimitExemptPaths)
|
|
||||||
}
|
}
|
||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"net/http"
|
"net/http"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -18,17 +19,22 @@ import (
|
|||||||
// 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.
|
||||||
// Its figures are the window, the count and the limit.
|
// Its figures are the window, the count and the limit.
|
||||||
type refusalLimit struct{}
|
type refusalLimit struct {
|
||||||
|
limiter *ratelimit.Limiter
|
||||||
|
perMinute int64 // SWW_WAF_REFUSALS_LIMIT_PER_MINUTE
|
||||||
|
banResponse int // SWW_WAF_BAN_RESPONSE
|
||||||
|
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
|
||||||
|
banMaker banMaker
|
||||||
|
}
|
||||||
|
|
||||||
func (refusalLimit) name() string { return "refusal_limit" }
|
func (refusalLimit) name() string { return "refusal_limit" }
|
||||||
|
|
||||||
func (refusalLimit) check(
|
func (r refusalLimit) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
) *verdict {
|
) *verdict {
|
||||||
cfg := rq.h.config
|
if r.perMinute == 0 {
|
||||||
if cfg.RefusalsLimitPerMinute == 0 {
|
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -36,10 +42,10 @@ func (refusalLimit) check(
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
hit, over := rq.h.limiter.CountRefusal(
|
hit, over := r.limiter.CountRefusal(
|
||||||
clientGroup(rq.h.config, rq.client),
|
clientGroup(r.ipv6GroupPrefix, rq.client),
|
||||||
now,
|
now,
|
||||||
cfg.RefusalsLimitPerMinute,
|
r.perMinute,
|
||||||
)
|
)
|
||||||
if !over {
|
if !over {
|
||||||
return nil
|
return nil
|
||||||
@@ -54,10 +60,10 @@ func (refusalLimit) check(
|
|||||||
status = http.StatusForbidden
|
status = http.StatusForbidden
|
||||||
case requestlog.ActionTemporarilyBanned,
|
case requestlog.ActionTemporarilyBanned,
|
||||||
requestlog.ActionPermanentlyBanned:
|
requestlog.ActionPermanentlyBanned:
|
||||||
status = cfg.BanResponse
|
status = r.banResponse
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.banForLimit(now, hit, status)
|
r.banMaker.banForLimit(rq, now, hit, status)
|
||||||
|
|
||||||
return &verdict{figures: limitFigures(hit)}
|
return &verdict{figures: limitFigures(hit)}
|
||||||
}
|
}
|
||||||
@@ -5,22 +5,35 @@ package waf
|
|||||||
import (
|
import (
|
||||||
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/bans"
|
"sneak.berlin/go/smallwebwaf/internal/bans"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/metrics"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// reputationHitNoter notes the reputation sources that list a request's
|
||||||
|
// client, for the reputation heuristics.
|
||||||
|
type reputationHitNoter struct {
|
||||||
|
metrics *metrics.Metrics
|
||||||
|
alerts *alerts.Queue
|
||||||
|
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
|
||||||
|
}
|
||||||
|
|
||||||
// noteListed notes each of sources, the URLs of the blocklists or the
|
// noteListed notes each of sources, the URLs of the blocklists or the
|
||||||
// DNSBL zones, their keys masked, that list the client, as noteHit does,
|
// DNSBL zones, their keys masked, that list rq's client, as noteHit does,
|
||||||
// with reason.
|
// with reason.
|
||||||
func (rq *request) noteListed(sources []string, reason string) {
|
func (n reputationHitNoter) noteListed(
|
||||||
|
rq *request, sources []string, reason string,
|
||||||
|
) {
|
||||||
for _, source := range sources {
|
for _, source := range sources {
|
||||||
rq.noteHit(bans.ReputationHit{Source: source}, reason)
|
n.noteHit(rq, bans.ReputationHit{Source: source}, reason)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// noteHit adds hit's source, which lists the client, to the log line's
|
// noteHit adds hit's source, which lists rq's client, to the log line's
|
||||||
// reputation, and hit to the notes of a ban the request makes, counts the
|
// reputation, and hit to the notes of a ban the request makes, counts the
|
||||||
// source in the metrics, and raises a reputation_hit alert with reason,
|
// source in the metrics, and raises a reputation_hit alert with reason,
|
||||||
// whose detail gives hit's source and score.
|
// whose detail gives hit's source and score.
|
||||||
func (rq *request) noteHit(hit bans.ReputationHit, reason string) {
|
func (n reputationHitNoter) noteHit(
|
||||||
|
rq *request, hit bans.ReputationHit, reason string,
|
||||||
|
) {
|
||||||
detail := map[string]any{"source": hit.Source}
|
detail := map[string]any{"source": hit.Source}
|
||||||
if hit.Score != nil {
|
if hit.Score != nil {
|
||||||
detail["score"] = *hit.Score
|
detail["score"] = *hit.Score
|
||||||
@@ -28,12 +41,12 @@ func (rq *request) noteHit(hit bans.ReputationHit, reason string) {
|
|||||||
|
|
||||||
rq.line.Reputation = append(rq.line.Reputation, hit.Source)
|
rq.line.Reputation = append(rq.line.Reputation, hit.Source)
|
||||||
rq.reputation = append(rq.reputation, hit)
|
rq.reputation = append(rq.reputation, hit)
|
||||||
rq.h.metrics.ReputationHit(hit.Source)
|
n.metrics.ReputationHit(hit.Source)
|
||||||
rq.h.alerts.Raise(alerts.Alert{
|
n.alerts.Raise(alerts.Alert{
|
||||||
Event: alerts.EventReputationHit,
|
Event: alerts.EventReputationHit,
|
||||||
Host: rq.site,
|
Host: rq.site,
|
||||||
Client: rq.client,
|
Client: rq.client,
|
||||||
Netblock: clientGroup(rq.h.config, rq.client),
|
Netblock: clientGroup(n.ipv6GroupPrefix, rq.client),
|
||||||
ASN: rq.line.ASN,
|
ASN: rq.line.ASN,
|
||||||
ASName: rq.line.ASName,
|
ASName: rq.line.ASName,
|
||||||
Country: rq.line.Country,
|
Country: rq.line.Country,
|
||||||
|
|||||||
+13
-8
@@ -122,8 +122,11 @@ func (h *handler) startRequest(
|
|||||||
RequestID: requestID(r, isQuestion),
|
RequestID: requestID(r, isQuestion),
|
||||||
PeerIP: peer.String(),
|
PeerIP: peer.String(),
|
||||||
ForwardedFor: strings.Join(forwardedFor, ", "),
|
ForwardedFor: strings.Join(forwardedFor, ", "),
|
||||||
ClientGroup: clientGroup(h.config, client).String(),
|
ClientGroup: clientGroup(
|
||||||
ContentType: r.Header.Get("Content-Type"),
|
h.config.IPv6GroupPrefix,
|
||||||
|
client,
|
||||||
|
).String(),
|
||||||
|
ContentType: r.Header.Get("Content-Type"),
|
||||||
RequestHeaders: requestHeaders(
|
RequestHeaders: requestHeaders(
|
||||||
r,
|
r,
|
||||||
h.config.LogRequestHeaders,
|
h.config.LogRequestHeaders,
|
||||||
@@ -233,7 +236,7 @@ func (rq *request) checkClient(ctx context.Context) *verdict {
|
|||||||
|
|
||||||
now := rq.h.now()
|
now := rq.h.now()
|
||||||
|
|
||||||
v := rq.runHeuristics(ctx, beforeLookup(), now)
|
v := rq.runHeuristics(ctx, rq.h.beforeLookup, now)
|
||||||
if v != nil {
|
if v != nil {
|
||||||
return v
|
return v
|
||||||
}
|
}
|
||||||
@@ -265,7 +268,7 @@ func (rq *request) runAfterLookup(
|
|||||||
// again: a request counted at the time it arrived could be counted
|
// again: a request counted at the time it arrived could be counted
|
||||||
// after a later one of its client's, which the rate limits would take
|
// after a later one of its client's, which the rate limits would take
|
||||||
// for the clock set back.
|
// for the clock set back.
|
||||||
return rq.runHeuristics(ctx, afterLookup(), rq.h.now())
|
return rq.runHeuristics(ctx, rq.h.afterLookup, rq.h.now())
|
||||||
}
|
}
|
||||||
|
|
||||||
// pathExempt reports whether r is exempt under prefixes,
|
// pathExempt reports whether r is exempt under prefixes,
|
||||||
@@ -375,7 +378,7 @@ func (rq *request) addToHistory() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
rq.h.limiter.AddToHistory(
|
rq.h.limiter.AddToHistory(
|
||||||
clientGroup(rq.h.config, rq.client),
|
clientGroup(rq.h.config.IPv6GroupPrefix, rq.client),
|
||||||
rq.h.now(),
|
rq.h.now(),
|
||||||
request,
|
request,
|
||||||
)
|
)
|
||||||
@@ -404,11 +407,11 @@ func (rq *request) countAnomalies() {
|
|||||||
rq.h.anomalies.Count(rq.h.now(), anomaly.Request{
|
rq.h.anomalies.Count(rq.h.now(), anomaly.Request{
|
||||||
Host: rq.site,
|
Host: rq.site,
|
||||||
Client: rq.client,
|
Client: rq.client,
|
||||||
ClientGroup: clientGroup(rq.h.config, rq.client),
|
ClientGroup: clientGroup(rq.h.config.IPv6GroupPrefix, rq.client),
|
||||||
ASN: answer.ASN,
|
ASN: answer.ASN,
|
||||||
ASName: answer.ASName,
|
ASName: answer.ASName,
|
||||||
Country: answer.Country,
|
Country: answer.Country,
|
||||||
Bytes: rq.countedBytes(),
|
Bytes: rq.countedBytes(rq.h.config.BytesCounted),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -435,7 +438,9 @@ func (rq *request) answerAtTheEnd() (geojs.Answer, bool) {
|
|||||||
return rq.lookupAnswer, true
|
return rq.lookupAnswer, true
|
||||||
}
|
}
|
||||||
|
|
||||||
return rq.h.geojs.Kept(clientGroup(rq.h.config, rq.client))
|
return rq.h.geojs.Kept(
|
||||||
|
clientGroup(rq.h.config.IPv6GroupPrefix, rq.client),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// responseWriter is waf's answer to a request. It notes the status and
|
// responseWriter is waf's answer to a request. It notes the status and
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ import (
|
|||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -248,7 +248,7 @@ func TestTimingsAreInOrder(t *testing.T) {
|
|||||||
wantStatus(t, do(t, req), http.StatusForbidden)
|
wantStatus(t, do(t, req), http.StatusForbidden)
|
||||||
refused := out.endedLines(t, 2)[1]
|
refused := out.endedLines(t, 2)[1]
|
||||||
|
|
||||||
wantStatus(t, get(t, server.Addr, waf.HealthPath), http.StatusOK)
|
wantStatus(t, get(t, server.Addr, wafprotocol.HealthPath), http.StatusOK)
|
||||||
health := out.endedLines(t, 3)[2]
|
health := out.endedLines(t, 3)[2]
|
||||||
|
|
||||||
// A request passed to the app has every timing; one refused, none of
|
// A request passed to the app has every timing; one refused, none of
|
||||||
|
|||||||
@@ -8,6 +8,7 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/routewatch"
|
||||||
)
|
)
|
||||||
|
|
||||||
// routeWatchTags adds to the request the tags asn=<number> and prefix=<netblock>
|
// routeWatchTags adds to the request the tags asn=<number> and prefix=<netblock>
|
||||||
@@ -17,22 +18,26 @@ import (
|
|||||||
// SWW_WAF_ROUTEWATCH_URL is unset it does nothing. Answers are kept by client and
|
// SWW_WAF_ROUTEWATCH_URL is unset it does nothing. Answers are kept by client and
|
||||||
// asked for by the request's address, and a route without an origin AS gives only
|
// asked for by the request's address, and a route without an origin AS gives only
|
||||||
// the prefix= tag.
|
// the prefix= tag.
|
||||||
type routeWatchTags struct{}
|
type routeWatchTags struct {
|
||||||
|
// routeWatch is nil while SWW_WAF_ROUTEWATCH_URL is unset.
|
||||||
|
routeWatch *routewatch.Client
|
||||||
|
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
|
||||||
|
}
|
||||||
|
|
||||||
func (routeWatchTags) name() string { return "routewatch_tags" }
|
func (routeWatchTags) name() string { return "routewatch_tags" }
|
||||||
|
|
||||||
func (routeWatchTags) check(
|
func (r routeWatchTags) check(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
_ time.Time,
|
_ time.Time,
|
||||||
) *verdict {
|
) *verdict {
|
||||||
if rq.h.routeWatch == nil {
|
if r.routeWatch == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
route, missing := rq.h.routeWatch.Route(
|
route, missing := r.routeWatch.Route(
|
||||||
ctx,
|
ctx,
|
||||||
clientGroup(rq.h.config, rq.client),
|
clientGroup(r.ipv6GroupPrefix, rq.client),
|
||||||
rq.client,
|
rq.client,
|
||||||
)
|
)
|
||||||
if missing != "" {
|
if missing != "" {
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ import (
|
|||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/bans"
|
"sneak.berlin/go/smallwebwaf/internal/bans"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/metrics"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/rules"
|
"sneak.berlin/go/smallwebwaf/internal/rules"
|
||||||
)
|
)
|
||||||
@@ -22,11 +23,15 @@ import (
|
|||||||
// 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
|
||||||
// client's history. Its figures are the rule's id and action.
|
// client's history. Its figures are the rule's id and action.
|
||||||
type ruleFiles struct{}
|
type ruleFiles struct {
|
||||||
|
rules *rules.Files
|
||||||
|
metrics *metrics.Metrics
|
||||||
|
banMaker banMaker
|
||||||
|
}
|
||||||
|
|
||||||
func (ruleFiles) name() string { return "rule_files" }
|
func (ruleFiles) name() string { return "rule_files" }
|
||||||
|
|
||||||
func (ruleFiles) check(
|
func (r ruleFiles) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
@@ -35,7 +40,7 @@ func (ruleFiles) check(
|
|||||||
|
|
||||||
for _, rule := range matched {
|
for _, rule := range matched {
|
||||||
rq.line.RuleIDs = append(rq.line.RuleIDs, rule.ID)
|
rq.line.RuleIDs = append(rq.line.RuleIDs, rule.ID)
|
||||||
rq.h.metrics.RuleMatched(rule.ID, rule.Action)
|
r.metrics.RuleMatched(rule.ID, rule.Action)
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(matched) == 0 {
|
if len(matched) == 0 {
|
||||||
@@ -60,7 +65,8 @@ func (ruleFiles) check(
|
|||||||
rq.attack = true
|
rq.attack = true
|
||||||
|
|
||||||
return &verdict{
|
return &verdict{
|
||||||
action: rq.banForAttack(
|
action: r.banMaker.banForAttack(
|
||||||
|
rq,
|
||||||
now,
|
now,
|
||||||
bans.Notes{RuleID: last.ID, Target: last.Target},
|
bans.Notes{RuleID: last.ID, Target: last.Target},
|
||||||
),
|
),
|
||||||
|
|||||||
@@ -12,13 +12,19 @@ import (
|
|||||||
|
|
||||||
// tagDeny refuses a request that carries a tag in SWW_WAF_TAG_DENY. Its figure is
|
// tagDeny refuses a request that carries a tag in SWW_WAF_TAG_DENY. 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
|
||||||
|
}
|
||||||
|
|
||||||
func (tagDeny) name() string { return "tag_deny" }
|
func (tagDeny) name() string { return "tag_deny" }
|
||||||
|
|
||||||
func (tagDeny) check(_ context.Context, rq *request, _ time.Time) *verdict {
|
func (t tagDeny) check(
|
||||||
|
_ context.Context,
|
||||||
|
rq *request,
|
||||||
|
_ time.Time,
|
||||||
|
) *verdict {
|
||||||
for _, tag := range rq.line.Tags {
|
for _, tag := range rq.line.Tags {
|
||||||
if slices.Contains(rq.h.config.TagDeny, tag) {
|
if slices.Contains(t.tags, tag) {
|
||||||
return &verdict{
|
return &verdict{
|
||||||
action: requestlog.ActionClientDenied,
|
action: requestlog.ActionClientDenied,
|
||||||
figures: map[string]any{"tag": tag},
|
figures: map[string]any{"tag": tag},
|
||||||
|
|||||||
@@ -6,17 +6,25 @@ package waf
|
|||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/reputation"
|
||||||
)
|
)
|
||||||
|
|
||||||
// tagLists adds to the request one tag for each list of SWW_WAF_TAG_LISTS that
|
// tagLists adds to the request one tag for each list of SWW_WAF_TAG_LISTS that
|
||||||
// holds the client, the tag being the list's name. It refuses nothing, and runs
|
// holds the client, the tag being the list's name. It refuses nothing, and runs
|
||||||
// first so that every refusal's log line carries these tags.
|
// first so that every refusal's log line carries these tags.
|
||||||
type tagLists struct{}
|
type tagLists struct {
|
||||||
|
lists *reputation.Lists
|
||||||
|
}
|
||||||
|
|
||||||
func (tagLists) name() string { return "tag_lists" }
|
func (tagLists) name() string { return "tag_lists" }
|
||||||
|
|
||||||
func (tagLists) check(_ context.Context, rq *request, _ time.Time) *verdict {
|
func (t tagLists) check(
|
||||||
for _, name := range rq.h.lists.TagsOf(rq.client) {
|
_ context.Context,
|
||||||
|
rq *request,
|
||||||
|
_ time.Time,
|
||||||
|
) *verdict {
|
||||||
|
for _, name := range t.lists.TagsOf(rq.client) {
|
||||||
rq.addTag(name)
|
rq.addTag(name)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -16,11 +16,14 @@ import (
|
|||||||
// it bans the client's netblock, or in observe mode raises the alert for the
|
// it bans the client's netblock, or in observe mode raises the alert for the
|
||||||
// ban it would have made. The ban's notes give the path as sent, and so does
|
// ban it would have made. The ban's 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
|
||||||
|
banMaker banMaker
|
||||||
|
}
|
||||||
|
|
||||||
func (trapPaths) name() string { return "trap_paths" }
|
func (trapPaths) name() string { return "trap_paths" }
|
||||||
|
|
||||||
func (trapPaths) check(
|
func (t trapPaths) check(
|
||||||
_ context.Context,
|
_ context.Context,
|
||||||
rq *request,
|
rq *request,
|
||||||
now time.Time,
|
now time.Time,
|
||||||
@@ -33,18 +36,22 @@ func (trapPaths) check(
|
|||||||
rq.attack = true
|
rq.attack = true
|
||||||
|
|
||||||
return &verdict{
|
return &verdict{
|
||||||
action: rq.banForAttack(now, bans.Notes{TrapPath: path}),
|
action: t.banMaker.banForAttack(
|
||||||
|
rq,
|
||||||
|
now,
|
||||||
|
bans.Notes{TrapPath: path},
|
||||||
|
),
|
||||||
figures: map[string]any{"path": path},
|
figures: map[string]any{"path": path},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// trapPath returns the request's path as sent, when its path as a path rule
|
// trapPath returns rq's path as sent, when its path as a path rule sees it,
|
||||||
// sees it, without the query, as sent or once percent-decoded, is in
|
// without the query, as sent or once percent-decoded, is in
|
||||||
// SWW_WAF_TRAP_PATHS, and "" otherwise.
|
// SWW_WAF_TRAP_PATHS, and "" otherwise.
|
||||||
func (rq *request) trapPath() string {
|
func (t trapPaths) trapPath(rq *request) string {
|
||||||
path := rules.Path(rq.in)
|
path := rules.Path(rq.in)
|
||||||
if !slices.Contains(rq.h.config.TrapPaths, path) &&
|
if !slices.Contains(t.paths, path) &&
|
||||||
!slices.Contains(rq.h.config.TrapPaths, rules.DecodeOnce(path)) {
|
!slices.Contains(t.paths, rules.DecodeOnce(path)) {
|
||||||
return ""
|
return ""
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
+65
-235
@@ -1,75 +1,21 @@
|
|||||||
package waf
|
package waf
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"bytes"
|
|
||||||
"context"
|
"context"
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/netip"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
"unicode/utf8"
|
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
// The headers of rproxy's question and of waf's answer, as
|
|
||||||
// "waf" in SPEC.md gives them.
|
|
||||||
const (
|
|
||||||
// ClientHeader marks a request as rproxy's question, and gives the
|
|
||||||
// visitor's address.
|
|
||||||
ClientHeader = "X-Sww-Client"
|
|
||||||
// PeerHeader gives the address of rproxy's own TCP peer.
|
|
||||||
PeerHeader = "X-Sww-Peer"
|
|
||||||
// ContentLengthHeader gives the body length the visitor announced.
|
|
||||||
ContentLengthHeader = "X-Sww-Content-Length"
|
|
||||||
// DispositionHeader gives waf's answer.
|
|
||||||
DispositionHeader = "X-Sww-Disposition"
|
|
||||||
)
|
|
||||||
|
|
||||||
// The values of DispositionHeader.
|
|
||||||
const (
|
|
||||||
// DispositionAllow tells rproxy to pass the request to the app.
|
|
||||||
DispositionAllow = "allow"
|
|
||||||
// DispositionDeny tells rproxy to give the visitor the answer's status,
|
|
||||||
// headers and body.
|
|
||||||
DispositionDeny = "deny"
|
|
||||||
// DispositionClose tells rproxy to close the visitor's connection
|
|
||||||
// without an answer, which SWW_WAF_BAN_RESPONSE asks for when it is close.
|
|
||||||
// waf closing the question's connection instead would read as
|
|
||||||
// waf being down, and rproxy would then let the request through.
|
|
||||||
DispositionClose = "close"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ReportPath is where rproxy sends the report of each request waf
|
|
||||||
// answered.
|
|
||||||
const ReportPath = "/_sww/report"
|
|
||||||
|
|
||||||
// QuestionBodyMaxBytes is the most of a visitor's body a question carries.
|
|
||||||
const QuestionBodyMaxBytes = 64 << 10
|
|
||||||
|
|
||||||
const (
|
const (
|
||||||
// maxAwaitingReport is the most answered requests held until their
|
// maxAwaitingReport is the most answered requests held until their
|
||||||
// reports come. Past it, the request answered longest ago is dropped.
|
// reports come. Past it, the request answered longest ago is dropped.
|
||||||
maxAwaitingReport = 10000
|
maxAwaitingReport = 10000
|
||||||
// maxRequestIDBytes is the longest id a question may give.
|
|
||||||
maxRequestIDBytes = 128
|
|
||||||
// reportBodyMaxBytes is the most of a report's body that is read. It is
|
|
||||||
// far above any report's.
|
|
||||||
reportBodyMaxBytes = 1 << 20
|
|
||||||
// maxHTTPStatus is the highest status a report may give.
|
|
||||||
maxHTTPStatus = 599
|
|
||||||
// maxReportedBytes is the most bytes a report may give for each way, 1
|
|
||||||
// PiB, so that adding them up cannot overflow.
|
|
||||||
maxReportedBytes = 1 << 50
|
|
||||||
// maxReportedMilliseconds is the longest duration a report may give,
|
|
||||||
// about 31 years, so that it fits a time.Duration.
|
|
||||||
maxReportedMilliseconds = 1e12
|
|
||||||
// wafTimeout bounds how long a request to waf takes to
|
// wafTimeout bounds how long a request to waf takes to
|
||||||
// arrive, and its answer to leave, and wafIdleTimeout how long a
|
// arrive, and its answer to leave, and wafIdleTimeout how long a
|
||||||
// kept-open connection waits for its next request.
|
// kept-open connection waits for its next request.
|
||||||
@@ -77,26 +23,6 @@ const (
|
|||||||
wafIdleTimeout = 120 * time.Second
|
wafIdleTimeout = 120 * time.Second
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
|
||||||
errReportFieldMissing = errors.New("a field is missing")
|
|
||||||
errReportValue = errors.New("a value is out of range")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Report is the JSON object rproxy posts to ReportPath once the visitor's
|
|
||||||
// answer has ended, its fields named as the request log's of the same
|
|
||||||
// meaning. RequestID is the question's id. Status is what the visitor got, 0
|
|
||||||
// if nothing. The durations are in milliseconds.
|
|
||||||
//
|
|
||||||
//nolint:tagliatelle // docs/request-log.md names the fields in snake_case
|
|
||||||
type Report struct {
|
|
||||||
RequestID string `json:"request_id"`
|
|
||||||
Status int `json:"status"`
|
|
||||||
RequestBytes int64 `json:"request_bytes"`
|
|
||||||
ResponseBytes int64 `json:"response_bytes"`
|
|
||||||
DurationTotalMS float64 `json:"duration_total_ms"`
|
|
||||||
DurationUpstreamTotalMS float64 `json:"duration_upstream_total_ms"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// New returns the server `sww waf` runs. It answers
|
// New returns the server `sww waf` runs. It answers
|
||||||
// rproxy's questions, takes rproxy's reports and answers its own endpoints. It
|
// rproxy's questions, takes rproxy's reports and answers its own endpoints. It
|
||||||
// passes nothing to an app. rproxy applies the size and time limits to the
|
// passes nothing to an app. rproxy applies the size and time limits to the
|
||||||
@@ -123,19 +49,19 @@ func New(params Params) *Server {
|
|||||||
GeoJS: h.geojs,
|
GeoJS: h.geojs,
|
||||||
Anomalies: h.anomalies,
|
Anomalies: h.anomalies,
|
||||||
LookupFile: h.lookupFile,
|
LookupFile: h.lookupFile,
|
||||||
Lists: h.lists,
|
Lists: params.Lists,
|
||||||
DNSBL: h.dnsbl,
|
DNSBL: params.DNSBL,
|
||||||
AbuseIPDB: h.abuseIPDB,
|
AbuseIPDB: params.AbuseIPDB,
|
||||||
RouteWatch: h.routeWatch,
|
RouteWatch: params.RouteWatch,
|
||||||
Metrics: h.metrics,
|
Metrics: h.metrics,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// ServeHTTP handles one request to waf: a request carrying
|
// ServeHTTP handles one request to waf: a request carrying
|
||||||
// ClientHeader is rproxy's question, and any other is for waf
|
// wafprotocol.ClientHeader is rproxy's question, and any other is for waf
|
||||||
// itself.
|
// itself.
|
||||||
func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||||
if len(r.Header.Values(ClientHeader)) > 0 {
|
if len(r.Header.Values(wafprotocol.ClientHeader)) > 0 {
|
||||||
h.answerQuestion(w, r)
|
h.answerQuestion(w, r)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -154,27 +80,26 @@ func (rq *request) refusedWhateverTheAnswer(now time.Time) bool {
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
return rq.refusedByBlocklists(rq.h.lists.ListedBy(rq.client)) ||
|
listedBy := rq.h.blocklists.lists.ListedBy(rq.client)
|
||||||
rq.overAWholeRateLimit(now)
|
|
||||||
|
return rq.h.blocklists.refusedByBlocklists(listedBy) ||
|
||||||
|
rq.h.rateLimits.overAWholeRateLimit(rq, now)
|
||||||
}
|
}
|
||||||
|
|
||||||
// answerQuestion runs the checks on the visitor's request a question
|
// answerQuestion runs the checks on the visitor's request a question
|
||||||
// carries, and answers rproxy what to do with it. A denied request's counting
|
// carries, and answers rproxy what to do with it. A denied request's counting
|
||||||
// is finished here, and an allowed one's by its report.
|
// is finished here, and an allowed one's by its report.
|
||||||
func (h *handler) answerQuestion(w http.ResponseWriter, r *http.Request) {
|
func (h *handler) answerQuestion(w http.ResponseWriter, r *http.Request) {
|
||||||
client, body, ok := h.readQuestion(w, r)
|
question, ok := h.readQuestion(w, r)
|
||||||
if !ok {
|
if !ok {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
// One that cannot be read leaves the log line's peer_ip invalid.
|
|
||||||
peer, _ := netip.ParseAddr(r.Header.Get(PeerHeader))
|
|
||||||
|
|
||||||
rq := h.startRequest(
|
rq := h.startRequest(
|
||||||
w,
|
w,
|
||||||
asTheVisitorSentIt(r, body),
|
question.Visitor,
|
||||||
client.Unmap(),
|
question.Client,
|
||||||
peer.Unmap(),
|
question.Peer,
|
||||||
true,
|
true,
|
||||||
)
|
)
|
||||||
// These run even when a check panics. finish runs first, so that what is
|
// These run even when a check panics. finish runs first, so that what is
|
||||||
@@ -189,12 +114,15 @@ func (h *handler) answerQuestion(w http.ResponseWriter, r *http.Request) {
|
|||||||
rq.line.WAFLine = requestlog.WAFLineDecision
|
rq.line.WAFLine = requestlog.WAFLineDecision
|
||||||
refused := rq.check(r.Context())
|
refused := rq.check(r.Context())
|
||||||
rq.checked = time.Now()
|
rq.checked = time.Now()
|
||||||
underOwnPrefix := strings.HasPrefix(r.URL.Path, ownEndpointPrefix)
|
underOwnPrefix := strings.HasPrefix(
|
||||||
|
r.URL.Path,
|
||||||
|
wafprotocol.OwnEndpointPrefix,
|
||||||
|
)
|
||||||
|
|
||||||
if refused == nil && !underOwnPrefix {
|
if refused == nil && !underOwnPrefix {
|
||||||
rq.allow()
|
rq.allow()
|
||||||
// In observe mode, what enforce mode would have refused counts here.
|
// In observe mode, what enforce mode would have refused counts here.
|
||||||
rq.runBanningHeuristics(r.Context(), afterAnswer())
|
rq.runBanningHeuristics(r.Context(), rq.h.afterAnswer)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -205,7 +133,10 @@ func (h *handler) answerQuestion(w http.ResponseWriter, r *http.Request) {
|
|||||||
// The app never sees this prefix. waf's own endpoints are at its
|
// The app never sees this prefix. waf's own endpoints are at its
|
||||||
// own address, so this answers as a path with no endpoint does.
|
// own address, so this answers as a path with no endpoint does.
|
||||||
rq.line.Action = requestlog.ActionOwnEndpoint
|
rq.line.Action = requestlog.ActionOwnEndpoint
|
||||||
rq.out.Header().Set(DispositionHeader, DispositionDeny)
|
wafprotocol.SetAnswerHeaders(
|
||||||
|
rq.out.Header(),
|
||||||
|
wafprotocol.Answer{Disposition: wafprotocol.DispositionDeny},
|
||||||
|
)
|
||||||
http.Error(
|
http.Error(
|
||||||
rq.out,
|
rq.out,
|
||||||
http.StatusText(http.StatusNotFound),
|
http.StatusText(http.StatusNotFound),
|
||||||
@@ -213,48 +144,22 @@ func (h *handler) answerQuestion(w http.ResponseWriter, r *http.Request) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.banAndCount(r.Context(), afterAnswer())
|
rq.banAndCount(r.Context(), rq.h.afterAnswer)
|
||||||
}
|
}
|
||||||
|
|
||||||
// readQuestion returns the visitor's address and the body a question carries,
|
// readQuestion reads a question, and reports whether waf takes it. It answers
|
||||||
// and whether waf takes the question. It answers a question it does not
|
// a question it does not take with 400 and no disposition. rproxy passes that
|
||||||
// take with 400 and no disposition. rproxy passes that 400 to the visitor,
|
// 400 to the visitor, and SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION does
|
||||||
// and SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION does not apply. The id of
|
// not apply. The id of a question waf takes is held from here on, without a
|
||||||
// a question waf takes is held from here on, without a decision yet, so
|
// decision yet, so that another question with that id is refused while this
|
||||||
// that another question with that id is refused while this one is being
|
// one is being handled.
|
||||||
// handled.
|
|
||||||
//
|
//
|
||||||
// The body is read before any check, since Go's server does not send an answer
|
// A question whose body stops arriving gets no answer, and is not looked at.
|
||||||
// until it has read the body. A question whose body stops arriving gets no
|
|
||||||
// answer, and is not looked at.
|
|
||||||
func (h *handler) readQuestion(
|
func (h *handler) readQuestion(
|
||||||
w http.ResponseWriter, r *http.Request,
|
w http.ResponseWriter, r *http.Request,
|
||||||
) (netip.Addr, []byte, bool) {
|
) (wafprotocol.Question, bool) {
|
||||||
client, err := netip.ParseAddr(r.Header.Get(ClientHeader))
|
question, err := wafprotocol.ReadQuestion(w, r)
|
||||||
if err != nil || client.Zone() != "" {
|
if errors.Is(err, wafprotocol.ErrBodyStoppedArriving) {
|
||||||
h.refuseQuestion(w, ClientHeader+" is not an address without a zone")
|
|
||||||
|
|
||||||
return netip.Addr{}, nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
id := r.Header.Get(requestIDHeader)
|
|
||||||
if id == "" || len(id) > maxRequestIDBytes || !utf8.ValidString(id) {
|
|
||||||
h.refuseQuestion(w, requestIDHeader+" is not a valid id")
|
|
||||||
|
|
||||||
return netip.Addr{}, nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
body, err := io.ReadAll(
|
|
||||||
http.MaxBytesReader(w, r.Body, QuestionBodyMaxBytes),
|
|
||||||
)
|
|
||||||
|
|
||||||
if _, tooLarge := errors.AsType[*http.MaxBytesError](err); tooLarge {
|
|
||||||
h.refuseQuestion(w, "the body is over 64 KiB")
|
|
||||||
|
|
||||||
return netip.Addr{}, nil, false
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
h.processLog.Warn(
|
h.processLog.Warn(
|
||||||
"a question's body stopped arriving",
|
"a question's body stopped arriving",
|
||||||
"error",
|
"error",
|
||||||
@@ -265,17 +170,23 @@ func (h *handler) readQuestion(
|
|||||||
panic(http.ErrAbortHandler)
|
panic(http.ErrAbortHandler)
|
||||||
}
|
}
|
||||||
|
|
||||||
held, _ := h.awaitingReport.ContainsOrAdd(id, nil)
|
if err != nil {
|
||||||
|
h.refuseQuestion(w, err.Error())
|
||||||
|
|
||||||
|
return question, false
|
||||||
|
}
|
||||||
|
|
||||||
|
held, _ := h.awaitingReport.ContainsOrAdd(question.RequestID, nil)
|
||||||
if held {
|
if held {
|
||||||
h.refuseQuestion(
|
h.refuseQuestion(
|
||||||
w,
|
w,
|
||||||
requestIDHeader+" is the id of a request waf holds",
|
wafprotocol.RequestIDHeader+" is the id of a request waf holds",
|
||||||
)
|
)
|
||||||
|
|
||||||
return netip.Addr{}, nil, false
|
return question, false
|
||||||
}
|
}
|
||||||
|
|
||||||
return client, body, true
|
return question, true
|
||||||
}
|
}
|
||||||
|
|
||||||
// refuseQuestion answers a question waf does not take, for reason.
|
// refuseQuestion answers a question waf does not take, for reason.
|
||||||
@@ -284,48 +195,18 @@ func (h *handler) refuseQuestion(w http.ResponseWriter, reason string) {
|
|||||||
http.Error(w, reason, http.StatusBadRequest)
|
http.Error(w, reason, http.StatusBadRequest)
|
||||||
}
|
}
|
||||||
|
|
||||||
// asTheVisitorSentIt returns a copy of r, a question, as the checks and the
|
// allow answers a question with wafprotocol.DispositionAllow and, while
|
||||||
// log line are to see it: without the headers rproxy adds for waf,
|
|
||||||
// with body, which has been read of r, and with the length the visitor
|
|
||||||
// announced, as -1 when it announced none. The question's own length covers
|
|
||||||
// only the part of the body it carries.
|
|
||||||
func asTheVisitorSentIt(r *http.Request, body []byte) *http.Request {
|
|
||||||
sent := r.Clone(r.Context())
|
|
||||||
announced := sent.Header.Get(ContentLengthHeader)
|
|
||||||
|
|
||||||
sent.Header.Del(ClientHeader)
|
|
||||||
sent.Header.Del(PeerHeader)
|
|
||||||
sent.Header.Del(ContentLengthHeader)
|
|
||||||
sent.Header.Del("Content-Length")
|
|
||||||
|
|
||||||
sent.ContentLength = -1
|
|
||||||
|
|
||||||
length, err := strconv.ParseInt(announced, 10, 64)
|
|
||||||
if err == nil && length >= 0 {
|
|
||||||
sent.ContentLength = length
|
|
||||||
sent.Header.Set("Content-Length", announced)
|
|
||||||
}
|
|
||||||
|
|
||||||
sent.Body = http.NoBody
|
|
||||||
if len(body) > 0 {
|
|
||||||
sent.Body = io.NopCloser(bytes.NewReader(body))
|
|
||||||
}
|
|
||||||
|
|
||||||
return sent
|
|
||||||
}
|
|
||||||
|
|
||||||
// allow answers a question with DispositionAllow and, while
|
|
||||||
// SWW_WAF_ADD_LOOKUP_HEADERS is true, the client's AS number and country.
|
// SWW_WAF_ADD_LOOKUP_HEADERS is true, the client's AS number and country.
|
||||||
func (rq *request) allow() {
|
func (rq *request) allow() {
|
||||||
rq.allowed = true
|
rq.allowed = true
|
||||||
|
|
||||||
header := rq.out.Header()
|
answer := wafprotocol.Answer{Disposition: wafprotocol.DispositionAllow}
|
||||||
header.Set(DispositionHeader, DispositionAllow)
|
|
||||||
|
|
||||||
if rq.h.config.AddLookupHeaders {
|
if rq.h.config.AddLookupHeaders {
|
||||||
setLookupHeaders(header, rq.line.ASN, rq.line.Country)
|
answer.ASN = rq.line.ASN
|
||||||
|
answer.Country = rq.line.Country
|
||||||
}
|
}
|
||||||
|
|
||||||
|
wafprotocol.SetAnswerHeaders(rq.out.Header(), answer)
|
||||||
rq.out.WriteHeader(http.StatusOK)
|
rq.out.WriteHeader(http.StatusOK)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -343,13 +224,19 @@ func (rq *request) deny(r refusal) {
|
|||||||
if r.status == 0 {
|
if r.status == 0 {
|
||||||
// SWW_WAF_BAN_RESPONSE is close. Written past rq.out, since the log line's
|
// SWW_WAF_BAN_RESPONSE is close. Written past rq.out, since the log line's
|
||||||
// status stays 0: the visitor is sent nothing.
|
// status stays 0: the visitor is sent nothing.
|
||||||
rq.out.Header().Set(DispositionHeader, DispositionClose)
|
wafprotocol.SetAnswerHeaders(
|
||||||
|
rq.out.Header(),
|
||||||
|
wafprotocol.Answer{Disposition: wafprotocol.DispositionClose},
|
||||||
|
)
|
||||||
rq.out.ResponseWriter.WriteHeader(http.StatusOK)
|
rq.out.ResponseWriter.WriteHeader(http.StatusOK)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
rq.out.Header().Set(DispositionHeader, DispositionDeny)
|
wafprotocol.SetAnswerHeaders(
|
||||||
|
rq.out.Header(),
|
||||||
|
wafprotocol.Answer{Disposition: wafprotocol.DispositionDeny},
|
||||||
|
)
|
||||||
http.Error(rq.out, http.StatusText(r.status), r.status)
|
http.Error(rq.out, http.StatusText(r.status), r.status)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -357,7 +244,7 @@ func (rq *request) deny(r refusal) {
|
|||||||
// runs on it: the address is on the private network, where the peers are
|
// runs on it: the address is on the private network, where the peers are
|
||||||
// rproxy and the admin's tools, not visitors.
|
// rproxy and the admin's tools, not visitors.
|
||||||
func (h *handler) answerOwnEndpoint(w http.ResponseWriter, r *http.Request) {
|
func (h *handler) answerOwnEndpoint(w http.ResponseWriter, r *http.Request) {
|
||||||
if r.Method == http.MethodPost && r.URL.Path == ReportPath {
|
if r.Method == http.MethodPost && r.URL.Path == wafprotocol.ReportPath {
|
||||||
h.takeReport(w, r)
|
h.takeReport(w, r)
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -368,7 +255,7 @@ func (h *handler) answerOwnEndpoint(w http.ResponseWriter, r *http.Request) {
|
|||||||
rq := h.startRequest(w, r, peer, peer, false)
|
rq := h.startRequest(w, r, peer, peer, false)
|
||||||
defer rq.finish()
|
defer rq.finish()
|
||||||
|
|
||||||
if r.Method == http.MethodGet && r.URL.Path == HealthPath {
|
if r.Method == http.MethodGet && r.URL.Path == wafprotocol.HealthPath {
|
||||||
rq.answerHealth()
|
rq.answerHealth()
|
||||||
|
|
||||||
return
|
return
|
||||||
@@ -377,11 +264,11 @@ func (h *handler) answerOwnEndpoint(w http.ResponseWriter, r *http.Request) {
|
|||||||
rq.answerAdmin()
|
rq.answerAdmin()
|
||||||
}
|
}
|
||||||
|
|
||||||
// takeReport answers POST ReportPath: it finishes the request the report
|
// takeReport answers POST wafprotocol.ReportPath: it finishes the request the
|
||||||
// names, if it holds that request's decision, and ignores the report
|
// report names, if it holds that request's decision, and ignores the report
|
||||||
// otherwise.
|
// otherwise.
|
||||||
func (h *handler) takeReport(w http.ResponseWriter, r *http.Request) {
|
func (h *handler) takeReport(w http.ResponseWriter, r *http.Request) {
|
||||||
report, err := readReport(w, r)
|
report, err := wafprotocol.ReadReport(w, r)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
h.processLog.Warn("a report is refused", "error", err.Error())
|
h.processLog.Warn("a report is refused", "error", err.Error())
|
||||||
http.Error(w, "the body is not a report", http.StatusBadRequest)
|
http.Error(w, "the body is not a report", http.StatusBadRequest)
|
||||||
@@ -399,63 +286,6 @@ func (h *handler) takeReport(w http.ResponseWriter, r *http.Request) {
|
|||||||
w.WriteHeader(http.StatusNoContent)
|
w.WriteHeader(http.StatusNoContent)
|
||||||
}
|
}
|
||||||
|
|
||||||
// readReport reads a report from r's body, which must be one JSON object with
|
|
||||||
// all of Report's fields, in the ranges SPEC.md gives.
|
|
||||||
func readReport(w http.ResponseWriter, r *http.Request) (Report, error) {
|
|
||||||
var report Report
|
|
||||||
|
|
||||||
body, err := io.ReadAll(
|
|
||||||
http.MaxBytesReader(w, r.Body, reportBodyMaxBytes),
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
return report, fmt.Errorf("read the body: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var fields map[string]json.RawMessage
|
|
||||||
|
|
||||||
err = json.Unmarshal(body, &fields)
|
|
||||||
if err != nil {
|
|
||||||
return report, fmt.Errorf("decode the body: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, name := range []string{
|
|
||||||
"request_id", "status", "request_bytes", "response_bytes",
|
|
||||||
"duration_total_ms", "duration_upstream_total_ms",
|
|
||||||
} {
|
|
||||||
value, there := fields[name]
|
|
||||||
if !there || string(value) == "null" {
|
|
||||||
return report, fmt.Errorf("%w: %s", errReportFieldMissing, name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
err = json.Unmarshal(body, &report)
|
|
||||||
if err != nil {
|
|
||||||
return report, fmt.Errorf("decode the body: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return report, report.checkRanges()
|
|
||||||
}
|
|
||||||
|
|
||||||
// checkRanges returns an error for a value of the report that cannot be true.
|
|
||||||
func (report *Report) checkRanges() error {
|
|
||||||
switch {
|
|
||||||
case report.Status != 0 &&
|
|
||||||
(report.Status < http.StatusContinue || report.Status > maxHTTPStatus):
|
|
||||||
return fmt.Errorf("%w: status", errReportValue)
|
|
||||||
case report.RequestBytes < 0 || report.RequestBytes > maxReportedBytes:
|
|
||||||
return fmt.Errorf("%w: request_bytes", errReportValue)
|
|
||||||
case report.ResponseBytes < 0 || report.ResponseBytes > maxReportedBytes:
|
|
||||||
return fmt.Errorf("%w: response_bytes", errReportValue)
|
|
||||||
case report.DurationTotalMS < 0 || report.DurationTotalMS > maxReportedMilliseconds:
|
|
||||||
return fmt.Errorf("%w: duration_total_ms", errReportValue)
|
|
||||||
case report.DurationUpstreamTotalMS < 0 ||
|
|
||||||
report.DurationUpstreamTotalMS > maxReportedMilliseconds:
|
|
||||||
return fmt.Errorf("%w: duration_upstream_total_ms", errReportValue)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// finishWith finishes a request with what its report says, and writes the
|
// finishWith finishes a request with what its report says, and writes the
|
||||||
// request's last log line, which holds its decision's fields and the report's.
|
// request's last log line, which holds its decision's fields and the report's.
|
||||||
// For an allowed request it first runs the heuristics of onReport, and adds the
|
// For an allowed request it first runs the heuristics of onReport, and adds the
|
||||||
@@ -465,7 +295,7 @@ func (report *Report) checkRanges() error {
|
|||||||
func (h *handler) finishWith(
|
func (h *handler) finishWith(
|
||||||
ctx context.Context,
|
ctx context.Context,
|
||||||
held *decision,
|
held *decision,
|
||||||
report Report,
|
report wafprotocol.Report,
|
||||||
) {
|
) {
|
||||||
rq := &request{
|
rq := &request{
|
||||||
decision: *held,
|
decision: *held,
|
||||||
@@ -486,7 +316,7 @@ func (h *handler) finishWith(
|
|||||||
if rq.allowed {
|
if rq.allowed {
|
||||||
rq.line.DurationUpstreamTotalMS = &report.DurationUpstreamTotalMS
|
rq.line.DurationUpstreamTotalMS = &report.DurationUpstreamTotalMS
|
||||||
|
|
||||||
rq.banAndCount(ctx, onReport())
|
rq.banAndCount(ctx, rq.h.onReport)
|
||||||
|
|
||||||
rq.h.metrics.RequestReported(
|
rq.h.metrics.RequestReported(
|
||||||
&rq.line,
|
&rq.line,
|
||||||
|
|||||||
+195
-86
@@ -22,6 +22,7 @@ import (
|
|||||||
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/waf"
|
"sneak.berlin/go/smallwebwaf/internal/waf"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -106,8 +107,8 @@ func (s *WAF) questionWith(
|
|||||||
|
|
||||||
req := newRequest(s.t, method, s.addr, path, body)
|
req := newRequest(s.t, method, s.addr, path, body)
|
||||||
req.Host = host
|
req.Host = host
|
||||||
req.Header.Set(waf.ClientHeader, from)
|
req.Header.Set(wafprotocol.ClientHeader, from)
|
||||||
req.Header.Set(waf.PeerHeader, rproxyPeer)
|
req.Header.Set(wafprotocol.PeerHeader, rproxyPeer)
|
||||||
req.Header.Set(requestIDHeader, rand.Text())
|
req.Header.Set(requestIDHeader, rand.Text())
|
||||||
|
|
||||||
return req
|
return req
|
||||||
@@ -134,13 +135,18 @@ func (s *WAF) allowed(from string) string {
|
|||||||
s.t.Helper()
|
s.t.Helper()
|
||||||
|
|
||||||
req := s.question(siteA, from, "/")
|
req := s.question(siteA, from, "/")
|
||||||
wantDisposition(s.t, do(s.t, req), http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
s.t,
|
||||||
|
do(s.t, req),
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
|
|
||||||
return req.Header.Get(requestIDHeader)
|
return req.Header.Get(requestIDHeader)
|
||||||
}
|
}
|
||||||
|
|
||||||
// report sends rproxy's report and returns the answer.
|
// report sends rproxy's report and returns the answer.
|
||||||
func (s *WAF) report(report waf.Report) answer {
|
func (s *WAF) report(report wafprotocol.Report) answer {
|
||||||
s.t.Helper()
|
s.t.Helper()
|
||||||
|
|
||||||
body, err := json.Marshal(report)
|
body, err := json.Marshal(report)
|
||||||
@@ -155,8 +161,11 @@ func (s *WAF) report(report waf.Report) answer {
|
|||||||
func (s *WAF) reportBody(body string) answer {
|
func (s *WAF) reportBody(body string) answer {
|
||||||
s.t.Helper()
|
s.t.Helper()
|
||||||
|
|
||||||
return do(s.t, newRequest(s.t, http.MethodPost, s.addr, waf.ReportPath,
|
return do(
|
||||||
strings.NewReader(body)))
|
s.t,
|
||||||
|
newRequest(s.t, http.MethodPost, s.addr, wafprotocol.ReportPath,
|
||||||
|
strings.NewReader(body)),
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// passedOn asks about a request from the visitor at from on siteA, and reports
|
// passedOn asks about a request from the visitor at from on siteA, and reports
|
||||||
@@ -164,7 +173,7 @@ func (s *WAF) reportBody(body string) answer {
|
|||||||
func (s *WAF) passedOn(from string) {
|
func (s *WAF) passedOn(from string) {
|
||||||
s.t.Helper()
|
s.t.Helper()
|
||||||
|
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: s.allowed(from),
|
RequestID: s.allowed(from),
|
||||||
Status: http.StatusOK,
|
Status: http.StatusOK,
|
||||||
RequestBytes: bodyBytes,
|
RequestBytes: bodyBytes,
|
||||||
@@ -210,7 +219,7 @@ func wantDisposition(
|
|||||||
t.Helper()
|
t.Helper()
|
||||||
wantStatus(t, got, status)
|
wantStatus(t, got, status)
|
||||||
|
|
||||||
if answered := got.header.Get(waf.DispositionHeader); answered !=
|
if answered := got.header.Get(wafprotocol.DispositionHeader); answered !=
|
||||||
disposition {
|
disposition {
|
||||||
t.Errorf(
|
t.Errorf(
|
||||||
"answered with disposition %q, want %q",
|
"answered with disposition %q, want %q",
|
||||||
@@ -272,10 +281,10 @@ func TestQuestionAllowedIsAnsweredAndLogged(t *testing.T) {
|
|||||||
req := s.question(siteA, client, "/page?q=1&token=visible")
|
req := s.question(siteA, client, "/page?q=1&token=visible")
|
||||||
req.Header.Set(requestIDHeader, "the-id")
|
req.Header.Set(requestIDHeader, "the-id")
|
||||||
req.Header.Set("X-Forwarded-Proto", "https")
|
req.Header.Set("X-Forwarded-Proto", "https")
|
||||||
req.Header.Set(waf.ContentLengthHeader, "1234")
|
req.Header.Set(wafprotocol.ContentLengthHeader, "1234")
|
||||||
|
|
||||||
got := do(t, req)
|
got := do(t, req)
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
wantBody(t, got, "")
|
wantBody(t, got, "")
|
||||||
|
|
||||||
if id := got.header.Get(requestIDHeader); id != "" {
|
if id := got.header.Get(requestIDHeader); id != "" {
|
||||||
@@ -308,7 +317,12 @@ func TestIPv6VisitorIsCountedInItsGroup(t *testing.T) {
|
|||||||
s.allowed("2001:db8::1")
|
s.allowed("2001:db8::1")
|
||||||
|
|
||||||
got := s.ask("2001:db8::2", "/")
|
got := s.ask("2001:db8::2", "/")
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestIPv4VisitorInIPv6FormIsTheIPv4Client(t *testing.T) {
|
func TestIPv4VisitorInIPv6FormIsTheIPv4Client(t *testing.T) {
|
||||||
@@ -317,9 +331,14 @@ func TestIPv4VisitorInIPv6FormIsTheIPv4Client(t *testing.T) {
|
|||||||
s := startWAF(t, "", map[string]string{denyNets: client})
|
s := startWAF(t, "", map[string]string{denyNets: client})
|
||||||
|
|
||||||
req := s.question(siteA, "::ffff:"+client, "/")
|
req := s.question(siteA, "::ffff:"+client, "/")
|
||||||
req.Header.Set(waf.PeerHeader, "::ffff:"+rproxyPeer)
|
req.Header.Set(wafprotocol.PeerHeader, "::ffff:"+rproxyPeer)
|
||||||
|
|
||||||
wantDisposition(t, do(t, req), http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, req),
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
if line.ClientIP != client || line.PeerIP != rproxyPeer {
|
if line.ClientIP != client || line.PeerIP != rproxyPeer {
|
||||||
@@ -339,13 +358,13 @@ func TestMalformedQuestionGets400AndAWarningAndNoLine(t *testing.T) {
|
|||||||
change func(*http.Request)
|
change func(*http.Request)
|
||||||
}{
|
}{
|
||||||
{"client not an address", func(req *http.Request) {
|
{"client not an address", func(req *http.Request) {
|
||||||
req.Header.Set(waf.ClientHeader, "not an address")
|
req.Header.Set(wafprotocol.ClientHeader, "not an address")
|
||||||
}},
|
}},
|
||||||
{"client empty", func(req *http.Request) {
|
{"client empty", func(req *http.Request) {
|
||||||
req.Header.Set(waf.ClientHeader, "")
|
req.Header.Set(wafprotocol.ClientHeader, "")
|
||||||
}},
|
}},
|
||||||
{"client address with a zone", func(req *http.Request) {
|
{"client address with a zone", func(req *http.Request) {
|
||||||
req.Header.Set(waf.ClientHeader, "2001:db8::1%eth0")
|
req.Header.Set(wafprotocol.ClientHeader, "2001:db8::1%eth0")
|
||||||
}},
|
}},
|
||||||
{"id absent", func(req *http.Request) {
|
{"id absent", func(req *http.Request) {
|
||||||
req.Header.Del(requestIDHeader)
|
req.Header.Del(requestIDHeader)
|
||||||
@@ -390,7 +409,12 @@ func TestLongestValidIDIsTaken(t *testing.T) {
|
|||||||
|
|
||||||
req := s.question(siteA, client, "/")
|
req := s.question(siteA, client, "/")
|
||||||
req.Header.Set(requestIDHeader, strings.Repeat("x", 128))
|
req.Header.Set(requestIDHeader, strings.Repeat("x", 128))
|
||||||
wantDisposition(t, do(t, req), http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, req),
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestQuestionWithABodyOver64KiBGets400(t *testing.T) {
|
func TestQuestionWithABodyOver64KiBGets400(t *testing.T) {
|
||||||
@@ -399,16 +423,18 @@ func TestQuestionWithABodyOver64KiBGets400(t *testing.T) {
|
|||||||
s := startWAF(t, "", nil)
|
s := startWAF(t, "", nil)
|
||||||
|
|
||||||
over := strings.NewReader(
|
over := strings.NewReader(
|
||||||
strings.Repeat("x", waf.QuestionBodyMaxBytes+1),
|
strings.Repeat("x", wafprotocol.QuestionBodyMaxBytes+1),
|
||||||
)
|
)
|
||||||
got := do(t, s.questionWith(http.MethodPost, siteA, client, "/", over))
|
got := do(t, s.questionWith(http.MethodPost, siteA, client, "/", over))
|
||||||
wantDisposition(t, got, http.StatusBadRequest, "")
|
wantDisposition(t, got, http.StatusBadRequest, "")
|
||||||
wantProcessMessages(t, s, "a question is refused", 1)
|
wantProcessMessages(t, s, "a question is refused", 1)
|
||||||
wantNoRequestLines(t, s)
|
wantNoRequestLines(t, s)
|
||||||
|
|
||||||
whole := strings.NewReader(strings.Repeat("x", waf.QuestionBodyMaxBytes))
|
whole := strings.NewReader(
|
||||||
|
strings.Repeat("x", wafprotocol.QuestionBodyMaxBytes),
|
||||||
|
)
|
||||||
got = do(t, s.questionWith(http.MethodPost, siteA, client, "/", whole))
|
got = do(t, s.questionWith(http.MethodPost, siteA, client, "/", whole))
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestQuestionWithAHeldIDIsRefused(t *testing.T) {
|
func TestQuestionWithAHeldIDIsRefused(t *testing.T) {
|
||||||
@@ -424,12 +450,12 @@ func TestQuestionWithAHeldIDIsRefused(t *testing.T) {
|
|||||||
wantProcessMessages(t, s, "a question is refused", 1)
|
wantProcessMessages(t, s, "a question is refused", 1)
|
||||||
|
|
||||||
// A denied request's id is held as well.
|
// A denied request's id is held as well.
|
||||||
denied := s.question(siteA, otherClient, waf.HealthPath)
|
denied := s.question(siteA, otherClient, wafprotocol.HealthPath)
|
||||||
wantDisposition(
|
wantDisposition(
|
||||||
t,
|
t,
|
||||||
do(t, denied),
|
do(t, denied),
|
||||||
http.StatusNotFound,
|
http.StatusNotFound,
|
||||||
waf.DispositionDeny,
|
wafprotocol.DispositionDeny,
|
||||||
)
|
)
|
||||||
|
|
||||||
again = s.question(siteA, client, "/")
|
again = s.question(siteA, client, "/")
|
||||||
@@ -437,7 +463,9 @@ func TestQuestionWithAHeldIDIsRefused(t *testing.T) {
|
|||||||
wantDisposition(t, do(t, again), http.StatusBadRequest, "")
|
wantDisposition(t, do(t, again), http.StatusBadRequest, "")
|
||||||
|
|
||||||
// The report ends the holding, and the refused questions changed nothing.
|
// The report ends the holding, and the refused questions changed nothing.
|
||||||
got := s.report(waf.Report{RequestID: id, ResponseBytes: answerBytes})
|
got := s.report(
|
||||||
|
wafprotocol.Report{RequestID: id, ResponseBytes: answerBytes},
|
||||||
|
)
|
||||||
wantStatus(t, got, http.StatusNoContent)
|
wantStatus(t, got, http.StatusNoContent)
|
||||||
|
|
||||||
if history := s.history(); history.ResponseBytes != answerBytes {
|
if history := s.history(); history.ResponseBytes != answerBytes {
|
||||||
@@ -446,7 +474,12 @@ func TestQuestionWithAHeldIDIsRefused(t *testing.T) {
|
|||||||
|
|
||||||
again = s.question(siteA, client, "/")
|
again = s.question(siteA, client, "/")
|
||||||
again.Header.Set(requestIDHeader, id)
|
again.Header.Set(requestIDHeader, id)
|
||||||
wantDisposition(t, do(t, again), http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, again),
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReportNeverReachesAQuestionStillBeingHandled(t *testing.T) {
|
func TestReportNeverReachesAQuestionStillBeingHandled(t *testing.T) {
|
||||||
@@ -481,7 +514,7 @@ func TestReportNeverReachesAQuestionStillBeingHandled(t *testing.T) {
|
|||||||
|
|
||||||
// A report for a question not yet answered is ignored, and that question's
|
// A report for a question not yet answered is ignored, and that question's
|
||||||
// id is taken.
|
// id is taken.
|
||||||
got := s.report(waf.Report{RequestID: id, ResponseBytes: 1000})
|
got := s.report(wafprotocol.Report{RequestID: id, ResponseBytes: 1000})
|
||||||
wantStatus(t, got, http.StatusNoContent)
|
wantStatus(t, got, http.StatusNoContent)
|
||||||
|
|
||||||
// This would wait on the same lookup were the id not taken.
|
// This would wait on the same lookup were the id not taken.
|
||||||
@@ -496,7 +529,7 @@ func TestReportNeverReachesAQuestionStillBeingHandled(t *testing.T) {
|
|||||||
|
|
||||||
select {
|
select {
|
||||||
case got := <-answered:
|
case got := <-answered:
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
case <-time.After(waitLimit):
|
case <-time.After(waitLimit):
|
||||||
t.Fatal("the question got no answer")
|
t.Fatal("the question got no answer")
|
||||||
}
|
}
|
||||||
@@ -515,7 +548,9 @@ func TestReportNeverReachesAQuestionStillBeingHandled(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// The true report comes after, and is the one that counts.
|
// The true report comes after, and is the one that counts.
|
||||||
got = s.report(waf.Report{RequestID: id, ResponseBytes: answerBytes})
|
got = s.report(
|
||||||
|
wafprotocol.Report{RequestID: id, ResponseBytes: answerBytes},
|
||||||
|
)
|
||||||
wantStatus(t, got, http.StatusNoContent)
|
wantStatus(t, got, http.StatusNoContent)
|
||||||
|
|
||||||
if history := s.history(); history.ResponseBytes != answerBytes {
|
if history := s.history(); history.ResponseBytes != answerBytes {
|
||||||
@@ -533,17 +568,17 @@ func TestPeerAbsentOrUnreadableIsAnsweredAndLoggedInvalid(t *testing.T) {
|
|||||||
s := startWAF(t, "", nil)
|
s := startWAF(t, "", nil)
|
||||||
|
|
||||||
req := s.question(siteA, client, "/")
|
req := s.question(siteA, client, "/")
|
||||||
req.Header.Del(waf.PeerHeader)
|
req.Header.Del(wafprotocol.PeerHeader)
|
||||||
|
|
||||||
if peer != "" {
|
if peer != "" {
|
||||||
req.Header.Set(waf.PeerHeader, peer)
|
req.Header.Set(wafprotocol.PeerHeader, peer)
|
||||||
}
|
}
|
||||||
|
|
||||||
wantDisposition(
|
wantDisposition(
|
||||||
t,
|
t,
|
||||||
do(t, req),
|
do(t, req),
|
||||||
http.StatusOK,
|
http.StatusOK,
|
||||||
waf.DispositionAllow,
|
wafprotocol.DispositionAllow,
|
||||||
)
|
)
|
||||||
|
|
||||||
if line := s.out.requestLine(t); line.PeerIP != "invalid IP" {
|
if line := s.out.requestLine(t); line.PeerIP != "invalid IP" {
|
||||||
@@ -571,12 +606,12 @@ func TestContentLengthUnreadableOrNegativeCountsAsAbsent(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
req := s.question(siteA, client, "/")
|
req := s.question(siteA, client, "/")
|
||||||
req.Header.Set(waf.ContentLengthHeader, announced)
|
req.Header.Set(wafprotocol.ContentLengthHeader, announced)
|
||||||
wantDisposition(
|
wantDisposition(
|
||||||
t,
|
t,
|
||||||
do(t, req),
|
do(t, req),
|
||||||
http.StatusOK,
|
http.StatusOK,
|
||||||
waf.DispositionAllow,
|
wafprotocol.DispositionAllow,
|
||||||
)
|
)
|
||||||
|
|
||||||
if line := s.out.requestLine(t); line.ContentLength != 0 {
|
if line := s.out.requestLine(t); line.ContentLength != 0 {
|
||||||
@@ -595,13 +630,18 @@ func TestHeaderSentTwiceUsesItsFirstValue(t *testing.T) {
|
|||||||
s := startWAF(t, "", nil)
|
s := startWAF(t, "", nil)
|
||||||
|
|
||||||
req := s.question(siteA, client, "/")
|
req := s.question(siteA, client, "/")
|
||||||
req.Header.Add(waf.ClientHeader, otherClient)
|
req.Header.Add(wafprotocol.ClientHeader, otherClient)
|
||||||
req.Header.Add(waf.PeerHeader, "172.18.0.3")
|
req.Header.Add(wafprotocol.PeerHeader, "172.18.0.3")
|
||||||
req.Header.Set(requestIDHeader, "first")
|
req.Header.Set(requestIDHeader, "first")
|
||||||
req.Header.Add(requestIDHeader, "second")
|
req.Header.Add(requestIDHeader, "second")
|
||||||
req.Header.Set(waf.ContentLengthHeader, "1234")
|
req.Header.Set(wafprotocol.ContentLengthHeader, "1234")
|
||||||
req.Header.Add(waf.ContentLengthHeader, "5678")
|
req.Header.Add(wafprotocol.ContentLengthHeader, "5678")
|
||||||
wantDisposition(t, do(t, req), http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, req),
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
if line.ClientIP != client || line.PeerIP != rproxyPeer ||
|
if line.ClientIP != client || line.PeerIP != rproxyPeer ||
|
||||||
@@ -630,7 +670,7 @@ func sendQuestionWithPartOfItsBody(t *testing.T, conn net.Conn) {
|
|||||||
_, err := fmt.Fprintf(conn,
|
_, err := fmt.Fprintf(conn,
|
||||||
"POST / HTTP/1.1\r\nHost: %s\r\n%s: %s\r\n%s: an-id\r\n"+
|
"POST / HTTP/1.1\r\nHost: %s\r\n%s: %s\r\n%s: an-id\r\n"+
|
||||||
"Content-Length: 100\r\n\r\npart",
|
"Content-Length: 100\r\n\r\npart",
|
||||||
siteA, waf.ClientHeader, client, requestIDHeader)
|
siteA, wafprotocol.ClientHeader, client, requestIDHeader)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("send the question: %v", err)
|
t.Fatalf("send the question: %v", err)
|
||||||
}
|
}
|
||||||
@@ -699,7 +739,7 @@ func TestQuestionWhoseBodyStopsArrivingGetsNoAnswer(t *testing.T) {
|
|||||||
t,
|
t,
|
||||||
do(t, again),
|
do(t, again),
|
||||||
http.StatusOK,
|
http.StatusOK,
|
||||||
waf.DispositionAllow,
|
wafprotocol.DispositionAllow,
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
@@ -717,7 +757,7 @@ func TestQuestionDeniedGetsTheBanResponse(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
got := s.ask(client, "/")
|
got := s.ask(client, "/")
|
||||||
wantDisposition(t, got, status, waf.DispositionDeny)
|
wantDisposition(t, got, status, wafprotocol.DispositionDeny)
|
||||||
wantBody(t, got, http.StatusText(status)+"\n")
|
wantBody(t, got, http.StatusText(status)+"\n")
|
||||||
wantLine(
|
wantLine(
|
||||||
t,
|
t,
|
||||||
@@ -737,7 +777,7 @@ func TestBanResponseCloseIsAnAnswerOfItsOwn(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
got := s.ask(client, "/")
|
got := s.ask(client, "/")
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionClose)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionClose)
|
||||||
wantBody(t, got, "")
|
wantBody(t, got, "")
|
||||||
// The visitor is sent nothing.
|
// The visitor is sent nothing.
|
||||||
wantLine(t, s.out.requestLine(t), 0, requestlog.ActionClientDenied)
|
wantLine(t, s.out.requestLine(t), 0, requestlog.ActionClientDenied)
|
||||||
@@ -761,12 +801,22 @@ func TestBlockRuleIsDeniedWith403AndABanRuleWithTheBanResponse(
|
|||||||
})
|
})
|
||||||
|
|
||||||
got := s.ask(client, "/blocked")
|
got := s.ask(client, "/blocked")
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
wantLine(t, s.out.requestLine(t), http.StatusForbidden,
|
wantLine(t, s.out.requestLine(t), http.StatusForbidden,
|
||||||
requestlog.ActionBlockedByBlockRule)
|
requestlog.ActionBlockedByBlockRule)
|
||||||
|
|
||||||
got = s.ask(client, "/.env")
|
got = s.ask(client, "/.env")
|
||||||
wantDisposition(t, got, http.StatusTooManyRequests, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusTooManyRequests,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
wantLine(t, s.out.requestLines(t, 2)[1], http.StatusTooManyRequests,
|
wantLine(t, s.out.requestLines(t, 2)[1], http.StatusTooManyRequests,
|
||||||
requestlog.ActionTemporarilyBanned)
|
requestlog.ActionTemporarilyBanned)
|
||||||
}
|
}
|
||||||
@@ -781,10 +831,15 @@ func TestQuestionUnderTheOwnPrefixIsDeniedWith404AfterTheChecks(
|
|||||||
})
|
})
|
||||||
|
|
||||||
for _, path := range []string{
|
for _, path := range []string{
|
||||||
waf.HealthPath, waf.MetricsPath, waf.ReportPath,
|
wafprotocol.HealthPath, waf.MetricsPath, wafprotocol.ReportPath,
|
||||||
} {
|
} {
|
||||||
got := s.ask(client, path)
|
got := s.ask(client, path)
|
||||||
wantDisposition(t, got, http.StatusNotFound, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusNotFound,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
wantLine(
|
wantLine(
|
||||||
@@ -795,7 +850,12 @@ func TestQuestionUnderTheOwnPrefixIsDeniedWith404AfterTheChecks(
|
|||||||
)
|
)
|
||||||
|
|
||||||
got := s.ask(otherClient, waf.MetricsPath)
|
got := s.ask(otherClient, waf.MetricsPath)
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestObserveModeAllowsAndLogsWhatEnforceModeWouldHaveDone(t *testing.T) {
|
func TestObserveModeAllowsAndLogsWhatEnforceModeWouldHaveDone(t *testing.T) {
|
||||||
@@ -804,7 +864,7 @@ func TestObserveModeAllowsAndLogsWhatEnforceModeWouldHaveDone(t *testing.T) {
|
|||||||
s := startWAF(t, "", map[string]string{mode: observe, denyNets: client})
|
s := startWAF(t, "", map[string]string{mode: observe, denyNets: client})
|
||||||
|
|
||||||
got := s.ask(client, "/")
|
got := s.ask(client, "/")
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
wantLine(t, line, http.StatusOK, requestlog.ActionForward)
|
wantLine(t, line, http.StatusOK, requestlog.ActionForward)
|
||||||
@@ -822,7 +882,7 @@ func TestObserveModeRefusalAnsweredAllowCountsForTheRefusalLimit(
|
|||||||
|
|
||||||
for range 2 {
|
for range 2 {
|
||||||
got := s.ask(client, "/blocked")
|
got := s.ask(client, "/blocked")
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
}
|
}
|
||||||
|
|
||||||
lines := s.out.requestLines(t, 2)
|
lines := s.out.requestLines(t, 2)
|
||||||
@@ -846,7 +906,12 @@ func TestDeniedQuestionCountsForTheRefusalLimit(t *testing.T) {
|
|||||||
|
|
||||||
for range 2 {
|
for range 2 {
|
||||||
got := s.ask(client, "/blocked")
|
got := s.ask(client, "/blocked")
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
lines := s.out.requestLines(t, 2)
|
lines := s.out.requestLines(t, 2)
|
||||||
@@ -882,7 +947,12 @@ func TestAllowCarriesTheLookupHeadersWhileTheSettingIsSet(t *testing.T) {
|
|||||||
})
|
})
|
||||||
|
|
||||||
got := s.ask(fromDE, "/")
|
got := s.ask(fromDE, "/")
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
|
|
||||||
asn, country := got.header.Get(
|
asn, country := got.header.Get(
|
||||||
"X-Client-Asn",
|
"X-Client-Asn",
|
||||||
@@ -916,7 +986,7 @@ func TestReportCountsTowardAByteLimitWhichThenBans(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// 100 bytes are over the limit of 99.
|
// 100 bytes are over the limit of 99.
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: id, Status: http.StatusBadGateway,
|
RequestID: id, Status: http.StatusBadGateway,
|
||||||
RequestBytes: bodyBytes, ResponseBytes: answerBytes,
|
RequestBytes: bodyBytes, ResponseBytes: answerBytes,
|
||||||
})
|
})
|
||||||
@@ -940,7 +1010,12 @@ func TestReportCountsTowardAByteLimitWhichThenBans(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
got = s.ask(client, "/")
|
got = s.ask(client, "/")
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReportCountsAtThePercentageItsQuestionWasGiven(t *testing.T) {
|
func TestReportCountsAtThePercentageItsQuestionWasGiven(t *testing.T) {
|
||||||
@@ -958,12 +1033,12 @@ func TestReportCountsAtThePercentageItsQuestionWasGiven(t *testing.T) {
|
|||||||
t,
|
t,
|
||||||
s.ask(fromKP, "/"),
|
s.ask(fromKP, "/"),
|
||||||
http.StatusOK,
|
http.StatusOK,
|
||||||
waf.DispositionAllow,
|
wafprotocol.DispositionAllow,
|
||||||
)
|
)
|
||||||
|
|
||||||
s.passedOn(fromDE)
|
s.passedOn(fromDE)
|
||||||
wantDisposition(t, s.ask(fromDE, "/"), http.StatusForbidden,
|
wantDisposition(t, s.ask(fromDE, "/"), http.StatusForbidden,
|
||||||
waf.DispositionDeny)
|
wafprotocol.DispositionDeny)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestReportAddsTheRequestToItsClientsHistoryAndTheAnomalyCounters(
|
func TestReportAddsTheRequestToItsClientsHistoryAndTheAnomalyCounters(
|
||||||
@@ -989,7 +1064,7 @@ func TestReportAddsTheRequestToItsClientsHistoryAndTheAnomalyCounters(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: id, Status: http.StatusBadGateway,
|
RequestID: id, Status: http.StatusBadGateway,
|
||||||
RequestBytes: bodyBytes, ResponseBytes: answerBytes,
|
RequestBytes: bodyBytes, ResponseBytes: answerBytes,
|
||||||
})
|
})
|
||||||
@@ -1021,7 +1096,7 @@ func TestDeniedRequestIsFinishedAtItsDecision(t *testing.T) {
|
|||||||
t,
|
t,
|
||||||
do(t, denied),
|
do(t, denied),
|
||||||
http.StatusForbidden,
|
http.StatusForbidden,
|
||||||
waf.DispositionDeny,
|
wafprotocol.DispositionDeny,
|
||||||
)
|
)
|
||||||
|
|
||||||
counters := s.server.Anomalies.Snapshot()
|
counters := s.server.Anomalies.Snapshot()
|
||||||
@@ -1039,7 +1114,7 @@ func TestDeniedRequestIsFinishedAtItsDecision(t *testing.T) {
|
|||||||
|
|
||||||
wantMetric(t, s.metrics(), series, 1)
|
wantMetric(t, s.metrics(), series, 1)
|
||||||
|
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: denied.Header.Get(
|
RequestID: denied.Header.Get(
|
||||||
requestIDHeader,
|
requestIDHeader,
|
||||||
), Status: http.StatusForbidden,
|
), Status: http.StatusForbidden,
|
||||||
@@ -1082,7 +1157,7 @@ func TestMetricsCountAnAllowedRequestFromItsReport(t *testing.T) {
|
|||||||
1,
|
1,
|
||||||
) // the scrape itself
|
) // the scrape itself
|
||||||
|
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: id, Status: http.StatusBadGateway,
|
RequestID: id, Status: http.StatusBadGateway,
|
||||||
RequestBytes: bodyBytes, ResponseBytes: answerBytes,
|
RequestBytes: bodyBytes, ResponseBytes: answerBytes,
|
||||||
DurationTotalMS: 5, DurationUpstreamTotalMS: 4,
|
DurationTotalMS: 5, DurationUpstreamTotalMS: 4,
|
||||||
@@ -1100,7 +1175,7 @@ func TestMetricsCountAnAllowedRequestFromItsReport(t *testing.T) {
|
|||||||
// check needs a server that has not been scraped yet.
|
// check needs a server that has not been scraped yet.
|
||||||
unscraped := startWAF(t, "", map[string]string{metricsToken: token})
|
unscraped := startWAF(t, "", map[string]string{metricsToken: token})
|
||||||
|
|
||||||
got = unscraped.report(waf.Report{
|
got = unscraped.report(wafprotocol.Report{
|
||||||
RequestID: unscraped.allowed(client), Status: http.StatusBadGateway,
|
RequestID: unscraped.allowed(client), Status: http.StatusBadGateway,
|
||||||
DurationTotalMS: 5,
|
DurationTotalMS: 5,
|
||||||
})
|
})
|
||||||
@@ -1118,7 +1193,7 @@ func TestReportForARequestNotHeldIsIgnored(t *testing.T) {
|
|||||||
|
|
||||||
s := startWAF(t, "", map[string]string{bytesLimitPerMinute: byteLimit})
|
s := startWAF(t, "", map[string]string{bytesLimitPerMinute: byteLimit})
|
||||||
|
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: "no-such-request", ResponseBytes: 1000,
|
RequestID: "no-such-request", ResponseBytes: 1000,
|
||||||
})
|
})
|
||||||
wantStatus(t, got, http.StatusNoContent)
|
wantStatus(t, got, http.StatusNoContent)
|
||||||
@@ -1137,7 +1212,9 @@ func TestReportForARequestNotHeldIsIgnored(t *testing.T) {
|
|||||||
// A second report of the same request does not count it twice.
|
// A second report of the same request does not count it twice.
|
||||||
id := s.allowed(client)
|
id := s.allowed(client)
|
||||||
for range 2 {
|
for range 2 {
|
||||||
got = s.report(waf.Report{RequestID: id, ResponseBytes: answerBytes})
|
got = s.report(
|
||||||
|
wafprotocol.Report{RequestID: id, ResponseBytes: answerBytes},
|
||||||
|
)
|
||||||
wantStatus(t, got, http.StatusNoContent)
|
wantStatus(t, got, http.StatusNoContent)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1347,7 +1424,7 @@ func TestBytesAtTheirMostEachWayBanRatherThanOverflow(t *testing.T) {
|
|||||||
|
|
||||||
s := startWAF(t, "", map[string]string{bytesLimitPerMinute: byteLimit})
|
s := startWAF(t, "", map[string]string{bytesLimitPerMinute: byteLimit})
|
||||||
|
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: s.allowed(client), Status: http.StatusOK,
|
RequestID: s.allowed(client), Status: http.StatusOK,
|
||||||
RequestBytes: reportedBytesLimit, ResponseBytes: reportedBytesLimit,
|
RequestBytes: reportedBytesLimit, ResponseBytes: reportedBytesLimit,
|
||||||
})
|
})
|
||||||
@@ -1441,9 +1518,14 @@ func TestReportWritesTheLastLineWithTheDecisionsAndTheReportsFields(
|
|||||||
req.Header.Set("X-Forwarded-Proto", "https")
|
req.Header.Set("X-Forwarded-Proto", "https")
|
||||||
id := req.Header.Get(requestIDHeader)
|
id := req.Header.Get(requestIDHeader)
|
||||||
|
|
||||||
wantDisposition(t, do(t, req), http.StatusOK, waf.DispositionAllow)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
do(t, req),
|
||||||
|
http.StatusOK,
|
||||||
|
wafprotocol.DispositionAllow,
|
||||||
|
)
|
||||||
|
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: id, Status: http.StatusCreated,
|
RequestID: id, Status: http.StatusCreated,
|
||||||
RequestBytes: bodyBytes, ResponseBytes: answerBytes,
|
RequestBytes: bodyBytes, ResponseBytes: answerBytes,
|
||||||
DurationTotalMS: 12.5, DurationUpstreamTotalMS: 10.25,
|
DurationTotalMS: 12.5, DurationUpstreamTotalMS: 10.25,
|
||||||
@@ -1490,7 +1572,7 @@ func TestEveryDeniedRequestsReportGetsItsLastLine(t *testing.T) {
|
|||||||
"close", map[string]string{denyNets: client, banResponse: banResponseClose}, "/",
|
"close", map[string]string{denyNets: client, banResponse: banResponseClose}, "/",
|
||||||
0, requestlog.ActionClientDenied,
|
0, requestlog.ActionClientDenied,
|
||||||
},
|
},
|
||||||
{"own prefix", nil, waf.HealthPath, http.StatusNotFound,
|
{"own prefix", nil, wafprotocol.HealthPath, http.StatusNotFound,
|
||||||
requestlog.ActionOwnEndpoint},
|
requestlog.ActionOwnEndpoint},
|
||||||
} {
|
} {
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
@@ -1502,7 +1584,7 @@ func TestEveryDeniedRequestsReportGetsItsLastLine(t *testing.T) {
|
|||||||
id := req.Header.Get(requestIDHeader)
|
id := req.Header.Get(requestIDHeader)
|
||||||
do(t, req)
|
do(t, req)
|
||||||
|
|
||||||
got := s.report(waf.Report{
|
got := s.report(wafprotocol.Report{
|
||||||
RequestID: id, Status: tc.status, ResponseBytes: 8, DurationTotalMS: 3,
|
RequestID: id, Status: tc.status, ResponseBytes: 8, DurationTotalMS: 3,
|
||||||
})
|
})
|
||||||
wantStatus(t, got, http.StatusNoContent)
|
wantStatus(t, got, http.StatusNoContent)
|
||||||
@@ -1542,13 +1624,13 @@ func TestOldestAnsweredRequestIsDroppedPastTheBound(t *testing.T) {
|
|||||||
t,
|
t,
|
||||||
readAnswer(res),
|
readAnswer(res),
|
||||||
http.StatusOK,
|
http.StatusOK,
|
||||||
waf.DispositionAllow,
|
wafprotocol.DispositionAllow,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
// The table is full again with next and those, without oldest.
|
// The table is full again with next and those, without oldest.
|
||||||
got := s.report(
|
got := s.report(
|
||||||
waf.Report{RequestID: oldest, ResponseBytes: answerBytes},
|
wafprotocol.Report{RequestID: oldest, ResponseBytes: answerBytes},
|
||||||
)
|
)
|
||||||
wantStatus(t, got, http.StatusNoContent)
|
wantStatus(t, got, http.StatusNoContent)
|
||||||
|
|
||||||
@@ -1559,7 +1641,9 @@ func TestOldestAnsweredRequestIsDroppedPastTheBound(t *testing.T) {
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
got = s.report(waf.Report{RequestID: next, ResponseBytes: answerBytes})
|
got = s.report(
|
||||||
|
wafprotocol.Report{RequestID: next, ResponseBytes: answerBytes},
|
||||||
|
)
|
||||||
wantStatus(t, got, http.StatusNoContent)
|
wantStatus(t, got, http.StatusNoContent)
|
||||||
|
|
||||||
if counted := s.history().Requests; counted != 1 {
|
if counted := s.history().Requests; counted != 1 {
|
||||||
@@ -1580,10 +1664,20 @@ func TestBanMadeThroughOneHostRefusesTheClientOnAnother(t *testing.T) {
|
|||||||
)
|
)
|
||||||
|
|
||||||
got := do(t, s.question(siteA, client, "/.env"))
|
got := do(t, s.question(siteA, client, "/.env"))
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
|
|
||||||
got = do(t, s.question(siteB, client, "/"))
|
got = do(t, s.question(siteB, client, "/"))
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
|
|
||||||
lines := s.out.requestLines(t, 2)
|
lines := s.out.requestLines(t, 2)
|
||||||
if lines[0].Host != siteA || lines[1].Host != siteB {
|
if lines[0].Host != siteA || lines[1].Host != siteB {
|
||||||
@@ -1621,7 +1715,12 @@ func TestRequestsOnEverySiteCountTowardOneSetOfLimits(t *testing.T) {
|
|||||||
s.allowed(client)
|
s.allowed(client)
|
||||||
|
|
||||||
got := do(t, s.question(siteB, client, "/"))
|
got := do(t, s.question(siteB, client, "/"))
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestOwnEndpointsAnswerOnlyWithoutTheClientHeader(t *testing.T) {
|
func TestOwnEndpointsAnswerOnlyWithoutTheClientHeader(t *testing.T) {
|
||||||
@@ -1636,13 +1735,13 @@ func TestOwnEndpointsAnswerOnlyWithoutTheClientHeader(t *testing.T) {
|
|||||||
path, authorization string
|
path, authorization string
|
||||||
want int
|
want int
|
||||||
}{
|
}{
|
||||||
{waf.HealthPath, "", http.StatusOK},
|
{wafprotocol.HealthPath, "", http.StatusOK},
|
||||||
{waf.MetricsPath, bearer, http.StatusOK},
|
{waf.MetricsPath, bearer, http.StatusOK},
|
||||||
{waf.MetricsPath, "", http.StatusUnauthorized},
|
{waf.MetricsPath, "", http.StatusUnauthorized},
|
||||||
{waf.BansPath, adminBearer, http.StatusOK},
|
{waf.BansPath, adminBearer, http.StatusOK},
|
||||||
{waf.BansPath, "", http.StatusUnauthorized},
|
{waf.BansPath, "", http.StatusUnauthorized},
|
||||||
{waf.ClientsPath + client, adminBearer, http.StatusOK},
|
{waf.ClientsPath + client, adminBearer, http.StatusOK},
|
||||||
{waf.ReportPath, "", http.StatusNotFound},
|
{wafprotocol.ReportPath, "", http.StatusNotFound},
|
||||||
{"/_sww/other", "", http.StatusNotFound},
|
{"/_sww/other", "", http.StatusNotFound},
|
||||||
{"/", "", http.StatusNotFound},
|
{"/", "", http.StatusNotFound},
|
||||||
} {
|
} {
|
||||||
@@ -1659,10 +1758,10 @@ func TestOwnEndpointsAnswerOnlyWithoutTheClientHeader(t *testing.T) {
|
|||||||
t,
|
t,
|
||||||
do(t, req),
|
do(t, req),
|
||||||
http.StatusNotFound,
|
http.StatusNotFound,
|
||||||
waf.DispositionDeny,
|
wafprotocol.DispositionDeny,
|
||||||
)
|
)
|
||||||
} else {
|
} else {
|
||||||
wantDisposition(t, do(t, req), http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, do(t, req), http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1672,11 +1771,11 @@ func TestOwnEndpointsLinesDoNotSayWhichOfTheTwoTheyAre(t *testing.T) {
|
|||||||
|
|
||||||
s := startWAF(t, "", nil)
|
s := startWAF(t, "", nil)
|
||||||
|
|
||||||
wantStatus(t, get(t, s.addr, waf.HealthPath), http.StatusOK)
|
wantStatus(t, get(t, s.addr, wafprotocol.HealthPath), http.StatusOK)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
if _, there := line.fields["waf_line"]; there ||
|
if _, there := line.fields["waf_line"]; there ||
|
||||||
line.Path != waf.HealthPath {
|
line.Path != wafprotocol.HealthPath {
|
||||||
t.Errorf("the health check's log line is %+v", line.fields)
|
t.Errorf("the health check's log line is %+v", line.fields)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -1688,7 +1787,7 @@ func TestALargeBodyAnnouncedAndLongHeadersAreNoReasonToRefuse(t *testing.T) {
|
|||||||
|
|
||||||
req := s.questionWith(http.MethodPost, siteA, client, "/",
|
req := s.questionWith(http.MethodPost, siteA, client, "/",
|
||||||
strings.NewReader("a body"))
|
strings.NewReader("a body"))
|
||||||
req.Header.Set(waf.ContentLengthHeader, "1073741824")
|
req.Header.Set(wafprotocol.ContentLengthHeader, "1073741824")
|
||||||
req.Header.Set(forwardedFor, otherClient)
|
req.Header.Set(forwardedFor, otherClient)
|
||||||
|
|
||||||
// 40,000 bytes of headers, over rproxy's 32 KiB, in lines within the
|
// 40,000 bytes of headers, over rproxy's 32 KiB, in lines within the
|
||||||
@@ -1698,7 +1797,7 @@ func TestALargeBodyAnnouncedAndLongHeadersAreNoReasonToRefuse(t *testing.T) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
got := do(t, req)
|
got := do(t, req)
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
|
|
||||||
line := s.out.requestLine(t)
|
line := s.out.requestLine(t)
|
||||||
if line.ClientIP != client || line.ContentLength != 1<<30 {
|
if line.ClientIP != client || line.ContentLength != 1<<30 {
|
||||||
@@ -1776,7 +1875,7 @@ carried header:Content-Length block ^6$
|
|||||||
strings.NewReader("a body"))
|
strings.NewReader("a body"))
|
||||||
|
|
||||||
if tc.announced != "" {
|
if tc.announced != "" {
|
||||||
req.Header.Set(waf.ContentLengthHeader, tc.announced)
|
req.Header.Set(wafprotocol.ContentLengthHeader, tc.announced)
|
||||||
}
|
}
|
||||||
|
|
||||||
wantStatus(t, do(t, req), tc.want)
|
wantStatus(t, do(t, req), tc.want)
|
||||||
@@ -1794,19 +1893,24 @@ func TestCoreRuleSetReadsTheBodyAQuestionCarries(t *testing.T) {
|
|||||||
req := s.questionWith(http.MethodPost, siteA, client, "/",
|
req := s.questionWith(http.MethodPost, siteA, client, "/",
|
||||||
strings.NewReader(body))
|
strings.NewReader(body))
|
||||||
req.Header.Set("Content-Type", contentType)
|
req.Header.Set("Content-Type", contentType)
|
||||||
req.Header.Set(waf.ContentLengthHeader, "100000")
|
req.Header.Set(wafprotocol.ContentLengthHeader, "100000")
|
||||||
|
|
||||||
return do(t, req)
|
return do(t, req)
|
||||||
}
|
}
|
||||||
|
|
||||||
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,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
|
|
||||||
// The first 8 KiB of a longer JSON body cannot be parsed, which is no
|
// The first 8 KiB of a longer JSON body cannot be parsed, which is no
|
||||||
// attack, so the Core Rule Set does not read it.
|
// attack, so the Core Rule Set does not read it.
|
||||||
cut := `{"text":"` + strings.Repeat("x", 8<<10)
|
cut := `{"text":"` + strings.Repeat("x", 8<<10)
|
||||||
got = ask("application/json", cut)
|
got = ask("application/json", cut)
|
||||||
wantDisposition(t, got, http.StatusOK, waf.DispositionAllow)
|
wantDisposition(t, got, http.StatusOK, wafprotocol.DispositionAllow)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestCoreRuleSetAlertNamesTheSite(t *testing.T) {
|
func TestCoreRuleSetAlertNamesTheSite(t *testing.T) {
|
||||||
@@ -1815,7 +1919,12 @@ func TestCoreRuleSetAlertNamesTheSite(t *testing.T) {
|
|||||||
s := startWAF(t, "", map[string]string{coreRuleSetMode: block})
|
s := startWAF(t, "", map[string]string{coreRuleSetMode: block})
|
||||||
|
|
||||||
got := s.ask(client, sqlInjection)
|
got := s.ask(client, sqlInjection)
|
||||||
wantDisposition(t, got, http.StatusForbidden, waf.DispositionDeny)
|
wantDisposition(
|
||||||
|
t,
|
||||||
|
got,
|
||||||
|
http.StatusForbidden,
|
||||||
|
wafprotocol.DispositionDeny,
|
||||||
|
)
|
||||||
|
|
||||||
waiting := s.queue.Snapshot().Waiting[alerts.DestinationWebhook]
|
waiting := s.queue.Snapshot().Waiting[alerts.DestinationWebhook]
|
||||||
if len(waiting) != 1 ||
|
if len(waiting) != 1 ||
|
||||||
@@ -1836,7 +1945,7 @@ func TestReputationHitAlertNamesTheSite(t *testing.T) {
|
|||||||
loadLists(t, s.server, map[string][]string{dropURL: {client}})
|
loadLists(t, s.server, map[string][]string{dropURL: {client}})
|
||||||
|
|
||||||
wantDisposition(t, s.ask(client, "/"), http.StatusForbidden,
|
wantDisposition(t, s.ask(client, "/"), http.StatusForbidden,
|
||||||
waf.DispositionDeny)
|
wafprotocol.DispositionDeny)
|
||||||
|
|
||||||
waiting := s.queue.Snapshot().Waiting[alerts.DestinationWebhook]
|
waiting := s.queue.Snapshot().Waiting[alerts.DestinationWebhook]
|
||||||
if len(waiting) != 1 || waiting[0].Event != alerts.EventReputationHit ||
|
if len(waiting) != 1 || waiting[0].Event != alerts.EventReputationHit ||
|
||||||
|
|||||||
@@ -0,0 +1,46 @@
|
|||||||
|
package wafprotocol
|
||||||
|
|
||||||
|
import "net/http"
|
||||||
|
|
||||||
|
// Answer is what waf's answer to a question tells rproxy in its headers.
|
||||||
|
// The status, the other headers and the body of an answer of deny are what
|
||||||
|
// the visitor gets.
|
||||||
|
type Answer struct {
|
||||||
|
// Disposition is what rproxy does with the request: DispositionAllow,
|
||||||
|
// DispositionDeny or DispositionClose.
|
||||||
|
Disposition string
|
||||||
|
// ASN and Country are the client's AS number and country, each empty
|
||||||
|
// when the answer does not give it.
|
||||||
|
ASN, Country string
|
||||||
|
}
|
||||||
|
|
||||||
|
// SetAnswerHeaders sets the headers of waf's answer that tell rproxy answer,
|
||||||
|
// leaving out an ASN or Country that is empty.
|
||||||
|
func SetAnswerHeaders(header http.Header, answer Answer) {
|
||||||
|
header.Set(DispositionHeader, answer.Disposition)
|
||||||
|
|
||||||
|
if answer.ASN != "" {
|
||||||
|
header.Set(ASNHeader, answer.ASN)
|
||||||
|
}
|
||||||
|
|
||||||
|
if answer.Country != "" {
|
||||||
|
header.Set(CountryHeader, answer.Country)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadAnswer returns what the headers of waf's answer tell rproxy, and
|
||||||
|
// whether they give a valid disposition.
|
||||||
|
func ReadAnswer(header http.Header) (Answer, bool) {
|
||||||
|
disposition := header.Get(DispositionHeader)
|
||||||
|
|
||||||
|
switch disposition {
|
||||||
|
case DispositionAllow, DispositionDeny, DispositionClose:
|
||||||
|
return Answer{
|
||||||
|
Disposition: disposition,
|
||||||
|
ASN: header.Get(ASNHeader),
|
||||||
|
Country: header.Get(CountryHeader),
|
||||||
|
}, true
|
||||||
|
}
|
||||||
|
|
||||||
|
return Answer{}, false
|
||||||
|
}
|
||||||
@@ -0,0 +1,189 @@
|
|||||||
|
package wafprotocol
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/netip"
|
||||||
|
"net/url"
|
||||||
|
"strconv"
|
||||||
|
"unicode/utf8"
|
||||||
|
)
|
||||||
|
|
||||||
|
// maxRequestIDBytes is the longest id a question may give.
|
||||||
|
const maxRequestIDBytes = 128
|
||||||
|
|
||||||
|
// ErrBodyStoppedArriving is the error ReadQuestion wraps when the question's
|
||||||
|
// body stops arriving. Every other error it returns is why waf refuses the
|
||||||
|
// question.
|
||||||
|
var ErrBodyStoppedArriving = errors.New("the body stopped arriving")
|
||||||
|
|
||||||
|
// Why waf refuses a question. Each is also the body of the refusal.
|
||||||
|
var (
|
||||||
|
errClientNotAnAddress = errors.New(
|
||||||
|
ClientHeader + " is not an address without a zone",
|
||||||
|
)
|
||||||
|
errRequestIDNotValid = errors.New(RequestIDHeader + " is not a valid id")
|
||||||
|
errBodyTooLarge = errors.New("the body is over 64 KiB")
|
||||||
|
)
|
||||||
|
|
||||||
|
// QuestionParams are what NewQuestion needs.
|
||||||
|
type QuestionParams struct {
|
||||||
|
// Visitor is the visitor's request.
|
||||||
|
Visitor *http.Request
|
||||||
|
// PathAsSent is Visitor's path as the visitor sent it, which the question
|
||||||
|
// sends unchanged.
|
||||||
|
PathAsSent string
|
||||||
|
// Body is the part of Visitor's body the question carries, at most
|
||||||
|
// QuestionBodyMaxBytes.
|
||||||
|
Body []byte
|
||||||
|
// WAFBackend is waf's address. The question takes its scheme and host.
|
||||||
|
WAFBackend *url.URL
|
||||||
|
// Client is the visitor's address, and Peer that of rproxy's own TCP
|
||||||
|
// peer.
|
||||||
|
Client, Peer netip.Addr
|
||||||
|
// RequestID is the request's id.
|
||||||
|
RequestID string
|
||||||
|
// Scheme is how the visitor reached rproxy, or the trusted proxy in front
|
||||||
|
// of it.
|
||||||
|
Scheme string
|
||||||
|
}
|
||||||
|
|
||||||
|
// Question is a question as waf reads it.
|
||||||
|
type Question struct {
|
||||||
|
// Client is the visitor's address.
|
||||||
|
Client netip.Addr
|
||||||
|
// Peer is the address of rproxy's own TCP peer. It is not valid when the
|
||||||
|
// question gives none that can be read.
|
||||||
|
Peer netip.Addr
|
||||||
|
// RequestID is the request's id.
|
||||||
|
RequestID string
|
||||||
|
// Visitor is the visitor's request, as asTheVisitorSentIt gives it.
|
||||||
|
Visitor *http.Request
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewQuestion returns the question about a visitor's request, as "The
|
||||||
|
// question" in SPEC.md gives it: the request as the visitor sent it, with the
|
||||||
|
// part of the body it carries and rproxy's headers.
|
||||||
|
func NewQuestion(
|
||||||
|
ctx context.Context,
|
||||||
|
params QuestionParams,
|
||||||
|
) (*http.Request, error) {
|
||||||
|
in := params.Visitor
|
||||||
|
|
||||||
|
question, err := http.NewRequestWithContext(
|
||||||
|
ctx,
|
||||||
|
in.Method,
|
||||||
|
params.WAFBackend.String(),
|
||||||
|
bytes.NewReader(params.Body),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("make the question: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
backend := question.URL
|
||||||
|
target := *in.URL
|
||||||
|
target.Scheme = backend.Scheme
|
||||||
|
target.Host = backend.Host
|
||||||
|
target.Opaque = params.PathAsSent
|
||||||
|
question.URL = &target
|
||||||
|
question.Host = in.Host
|
||||||
|
|
||||||
|
// The length NewRequestWithContext set is that of the body carried. This
|
||||||
|
// line makes a body whose length the visitor did not announce go chunked,
|
||||||
|
// as "The question" in SPEC.md requires.
|
||||||
|
question.TransferEncoding = in.TransferEncoding
|
||||||
|
|
||||||
|
question.Header = in.Header.Clone()
|
||||||
|
question.Header.Set(ClientHeader, params.Client.String())
|
||||||
|
question.Header.Set(PeerHeader, params.Peer.String())
|
||||||
|
question.Header.Del(ContentLengthHeader)
|
||||||
|
|
||||||
|
announced := in.Header.Get("Content-Length")
|
||||||
|
if announced != "" {
|
||||||
|
question.Header.Set(ContentLengthHeader, announced)
|
||||||
|
}
|
||||||
|
|
||||||
|
question.Header.Set(RequestIDHeader, params.RequestID)
|
||||||
|
question.Header.Set("X-Forwarded-Proto", params.Scheme)
|
||||||
|
|
||||||
|
// Go's client adds a User-Agent of its own to a request without the key.
|
||||||
|
_, sent := question.Header["User-Agent"]
|
||||||
|
if !sent {
|
||||||
|
question.Header["User-Agent"] = nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return question, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadQuestion reads the question r, with the body it carries. An error
|
||||||
|
// wrapping ErrBodyStoppedArriving means the body stopped arriving. Any other
|
||||||
|
// error is why waf refuses the question, and the question's body is then not
|
||||||
|
// read. The body is read whole, since Go's server does not send an answer
|
||||||
|
// until it has read the body.
|
||||||
|
func ReadQuestion(w http.ResponseWriter, r *http.Request) (Question, error) {
|
||||||
|
client, err := netip.ParseAddr(r.Header.Get(ClientHeader))
|
||||||
|
if err != nil || client.Zone() != "" {
|
||||||
|
return Question{}, errClientNotAnAddress
|
||||||
|
}
|
||||||
|
|
||||||
|
id := r.Header.Get(RequestIDHeader)
|
||||||
|
if id == "" || len(id) > maxRequestIDBytes || !utf8.ValidString(id) {
|
||||||
|
return Question{}, errRequestIDNotValid
|
||||||
|
}
|
||||||
|
|
||||||
|
body, err := io.ReadAll(
|
||||||
|
http.MaxBytesReader(w, r.Body, QuestionBodyMaxBytes),
|
||||||
|
)
|
||||||
|
|
||||||
|
if _, tooLarge := errors.AsType[*http.MaxBytesError](err); tooLarge {
|
||||||
|
return Question{}, errBodyTooLarge
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
return Question{}, fmt.Errorf("%w: %w", ErrBodyStoppedArriving, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// One that cannot be read leaves the log line's peer_ip invalid.
|
||||||
|
peer, _ := netip.ParseAddr(r.Header.Get(PeerHeader))
|
||||||
|
|
||||||
|
return Question{
|
||||||
|
Client: client.Unmap(),
|
||||||
|
Peer: peer.Unmap(),
|
||||||
|
RequestID: id,
|
||||||
|
Visitor: asTheVisitorSentIt(r, body),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// asTheVisitorSentIt returns a copy of r, a question, as the checks and the
|
||||||
|
// log line are to see it: without the headers rproxy adds for waf,
|
||||||
|
// with body, which has been read of r, and with the length the visitor
|
||||||
|
// announced, as -1 when it announced none. The question's own length covers
|
||||||
|
// only the part of the body it carries.
|
||||||
|
func asTheVisitorSentIt(r *http.Request, body []byte) *http.Request {
|
||||||
|
sent := r.Clone(r.Context())
|
||||||
|
announced := sent.Header.Get(ContentLengthHeader)
|
||||||
|
|
||||||
|
sent.Header.Del(ClientHeader)
|
||||||
|
sent.Header.Del(PeerHeader)
|
||||||
|
sent.Header.Del(ContentLengthHeader)
|
||||||
|
sent.Header.Del("Content-Length")
|
||||||
|
|
||||||
|
sent.ContentLength = -1
|
||||||
|
|
||||||
|
length, err := strconv.ParseInt(announced, 10, 64)
|
||||||
|
if err == nil && length >= 0 {
|
||||||
|
sent.ContentLength = length
|
||||||
|
sent.Header.Set("Content-Length", announced)
|
||||||
|
}
|
||||||
|
|
||||||
|
sent.Body = http.NoBody
|
||||||
|
if len(body) > 0 {
|
||||||
|
sent.Body = io.NopCloser(bytes.NewReader(body))
|
||||||
|
}
|
||||||
|
|
||||||
|
return sent
|
||||||
|
}
|
||||||
@@ -0,0 +1,123 @@
|
|||||||
|
package wafprotocol
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
// reportBodyMaxBytes is the most of a report's body that is read. It is
|
||||||
|
// far above any report's.
|
||||||
|
reportBodyMaxBytes = 1 << 20
|
||||||
|
// maxReportedBytes is the most bytes a report may give for each way, 1
|
||||||
|
// PiB, so that adding them up cannot overflow.
|
||||||
|
maxReportedBytes = 1 << 50
|
||||||
|
// maxReportedMilliseconds is the longest duration a report may give,
|
||||||
|
// about 31 years, so that it fits a time.Duration.
|
||||||
|
maxReportedMilliseconds = 1e12
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
errReportFieldMissing = errors.New("a field is missing")
|
||||||
|
errReportValue = errors.New("a value is out of range")
|
||||||
|
)
|
||||||
|
|
||||||
|
// Report is the JSON object rproxy posts to ReportPath once the visitor's
|
||||||
|
// answer has ended, its fields named as the request log's of the same
|
||||||
|
// meaning. RequestID is the question's id. Status is what the visitor got, 0
|
||||||
|
// if nothing. The durations are in milliseconds.
|
||||||
|
//
|
||||||
|
//nolint:tagliatelle // docs/request-log.md names the fields in snake_case
|
||||||
|
type Report struct {
|
||||||
|
RequestID string `json:"request_id"`
|
||||||
|
Status int `json:"status"`
|
||||||
|
RequestBytes int64 `json:"request_bytes"`
|
||||||
|
ResponseBytes int64 `json:"response_bytes"`
|
||||||
|
DurationTotalMS float64 `json:"duration_total_ms"`
|
||||||
|
DurationUpstreamTotalMS float64 `json:"duration_upstream_total_ms"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// NewReportRequest returns the request that posts report to reportURL, which
|
||||||
|
// is waf's ReportPath.
|
||||||
|
func NewReportRequest(
|
||||||
|
ctx context.Context,
|
||||||
|
reportURL string,
|
||||||
|
report *Report,
|
||||||
|
) (*http.Request, error) {
|
||||||
|
body, err := json.Marshal(report)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("encode the report: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := http.NewRequestWithContext(
|
||||||
|
ctx, http.MethodPost, reportURL, bytes.NewReader(body))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("make the request: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
req.Header.Set("Content-Type", "application/json")
|
||||||
|
|
||||||
|
return req, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// ReadReport reads a report from r's body, which must be one JSON object with
|
||||||
|
// all of Report's fields, in the ranges SPEC.md gives.
|
||||||
|
func ReadReport(w http.ResponseWriter, r *http.Request) (Report, error) {
|
||||||
|
var report Report
|
||||||
|
|
||||||
|
body, err := io.ReadAll(
|
||||||
|
http.MaxBytesReader(w, r.Body, reportBodyMaxBytes),
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
return report, fmt.Errorf("read the body: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var fields map[string]json.RawMessage
|
||||||
|
|
||||||
|
err = json.Unmarshal(body, &fields)
|
||||||
|
if err != nil {
|
||||||
|
return report, fmt.Errorf("decode the body: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, name := range []string{
|
||||||
|
"request_id", "status", "request_bytes", "response_bytes",
|
||||||
|
"duration_total_ms", "duration_upstream_total_ms",
|
||||||
|
} {
|
||||||
|
value, there := fields[name]
|
||||||
|
if !there || string(value) == "null" {
|
||||||
|
return report, fmt.Errorf("%w: %s", errReportFieldMissing, name)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
err = json.Unmarshal(body, &report)
|
||||||
|
if err != nil {
|
||||||
|
return report, fmt.Errorf("decode the body: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return report, report.checkRanges()
|
||||||
|
}
|
||||||
|
|
||||||
|
// checkRanges returns an error for a value of the report that cannot be true.
|
||||||
|
func (report *Report) checkRanges() error {
|
||||||
|
switch {
|
||||||
|
case report.Status != 0 &&
|
||||||
|
(report.Status < http.StatusContinue || report.Status > ReportStatusMax):
|
||||||
|
return fmt.Errorf("%w: status", errReportValue)
|
||||||
|
case report.RequestBytes < 0 || report.RequestBytes > maxReportedBytes:
|
||||||
|
return fmt.Errorf("%w: request_bytes", errReportValue)
|
||||||
|
case report.ResponseBytes < 0 || report.ResponseBytes > maxReportedBytes:
|
||||||
|
return fmt.Errorf("%w: response_bytes", errReportValue)
|
||||||
|
case report.DurationTotalMS < 0 || report.DurationTotalMS > maxReportedMilliseconds:
|
||||||
|
return fmt.Errorf("%w: duration_total_ms", errReportValue)
|
||||||
|
case report.DurationUpstreamTotalMS < 0 ||
|
||||||
|
report.DurationUpstreamTotalMS > maxReportedMilliseconds:
|
||||||
|
return fmt.Errorf("%w: duration_upstream_total_ms", errReportValue)
|
||||||
|
}
|
||||||
|
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,61 @@
|
|||||||
|
// Package wafprotocol holds the three messages rproxy and waf send each
|
||||||
|
// other, as "`waf`" in SPEC.md gives them. rproxy asks waf a question about
|
||||||
|
// each visitor's request, and waf answers it. Once the visitor's answer has
|
||||||
|
// ended, rproxy sends waf a report. This package writes and reads each
|
||||||
|
// message, and declares every name and limit both sides must agree on.
|
||||||
|
package wafprotocol
|
||||||
|
|
||||||
|
// The headers of the question and of the answer. Go writes every header name
|
||||||
|
// in this form, as it sends it and as it receives it, so X-Client-ASN arrives
|
||||||
|
// as X-Client-Asn; header names are not case-sensitive.
|
||||||
|
const (
|
||||||
|
// ClientHeader marks a request as rproxy's question, and gives the
|
||||||
|
// visitor's address.
|
||||||
|
ClientHeader = "X-Sww-Client"
|
||||||
|
// PeerHeader gives the address of rproxy's own TCP peer.
|
||||||
|
PeerHeader = "X-Sww-Peer"
|
||||||
|
// ContentLengthHeader gives the body length the visitor announced.
|
||||||
|
ContentLengthHeader = "X-Sww-Content-Length"
|
||||||
|
// RequestIDHeader gives the request's id, which rproxy makes. rproxy
|
||||||
|
// also sets it on the request it passes to the app.
|
||||||
|
RequestIDHeader = "X-Request-ID"
|
||||||
|
// DispositionHeader gives waf's answer.
|
||||||
|
DispositionHeader = "X-Sww-Disposition"
|
||||||
|
// ASNHeader and CountryHeader give the client's AS number and country in
|
||||||
|
// an answer of allow. rproxy passes them to the app.
|
||||||
|
ASNHeader = "X-Client-Asn"
|
||||||
|
CountryHeader = "X-Client-Country"
|
||||||
|
)
|
||||||
|
|
||||||
|
// The values of DispositionHeader.
|
||||||
|
const (
|
||||||
|
// DispositionAllow tells rproxy to pass the request to the app.
|
||||||
|
DispositionAllow = "allow"
|
||||||
|
// DispositionDeny tells rproxy to give the visitor the answer's status,
|
||||||
|
// headers and body.
|
||||||
|
DispositionDeny = "deny"
|
||||||
|
// DispositionClose tells rproxy to close the visitor's connection
|
||||||
|
// without an answer, which SWW_WAF_BAN_RESPONSE asks for when it is close.
|
||||||
|
// waf closing the question's connection instead would read as
|
||||||
|
// waf being down, and rproxy would then let the request through.
|
||||||
|
DispositionClose = "close"
|
||||||
|
)
|
||||||
|
|
||||||
|
// OwnEndpointPrefix starts the path of every request for sww itself: waf's
|
||||||
|
// own endpoints and rproxy's health endpoint. The app never sees a path under
|
||||||
|
// it.
|
||||||
|
const OwnEndpointPrefix = "/_sww/"
|
||||||
|
|
||||||
|
// HealthPath is the health endpoint of waf and of rproxy, which the
|
||||||
|
// container's health check asks.
|
||||||
|
const HealthPath = "/_sww/healthz"
|
||||||
|
|
||||||
|
// ReportPath is where rproxy sends the report of each request waf
|
||||||
|
// answered.
|
||||||
|
const ReportPath = "/_sww/report"
|
||||||
|
|
||||||
|
// QuestionBodyMaxBytes is the most of a visitor's body a question carries.
|
||||||
|
const QuestionBodyMaxBytes = 64 << 10
|
||||||
|
|
||||||
|
// ReportStatusMax is the highest status a report may give.
|
||||||
|
const ReportStatusMax = 599
|
||||||
@@ -0,0 +1,204 @@
|
|||||||
|
package wafprotocol_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"io"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"net/netip"
|
||||||
|
"net/url"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
|
)
|
||||||
|
|
||||||
|
// requestID is the id the tests' questions and reports give.
|
||||||
|
const requestID = "an-id"
|
||||||
|
|
||||||
|
// questionRead is what the server startQuestionReader starts read of a
|
||||||
|
// question: the question, and the body it carries.
|
||||||
|
type questionRead struct {
|
||||||
|
question wafprotocol.Question
|
||||||
|
body string
|
||||||
|
}
|
||||||
|
|
||||||
|
// startQuestionReader starts a server that reads each question it gets with
|
||||||
|
// ReadQuestion. It returns the server's URL and the channel what it reads goes
|
||||||
|
// to.
|
||||||
|
func startQuestionReader(t *testing.T) (*url.URL, <-chan questionRead) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
read := make(chan questionRead, 1)
|
||||||
|
server := httptest.NewServer(http.HandlerFunc(
|
||||||
|
func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
question, err := wafprotocol.ReadQuestion(w, r)
|
||||||
|
if err != nil {
|
||||||
|
t.Errorf("read the question: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var body []byte
|
||||||
|
if question.Visitor != nil {
|
||||||
|
body, _ = io.ReadAll(question.Visitor.Body)
|
||||||
|
}
|
||||||
|
|
||||||
|
read <- questionRead{question, string(body)}
|
||||||
|
},
|
||||||
|
))
|
||||||
|
t.Cleanup(server.Close)
|
||||||
|
|
||||||
|
serverURL, err := url.Parse(server.URL)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("parse the server's URL: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return serverURL, read
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestQuestionReadsAsWritten sends a question NewQuestion writes over HTTP,
|
||||||
|
// and checks that ReadQuestion gives back the visitor's request and what
|
||||||
|
// rproxy added.
|
||||||
|
func TestQuestionReadsAsWritten(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
const (
|
||||||
|
target = "/a%2Fb?q=1"
|
||||||
|
body = "name=value"
|
||||||
|
held = "name"
|
||||||
|
)
|
||||||
|
|
||||||
|
client := netip.MustParseAddr("2001:db8::1")
|
||||||
|
peer := netip.MustParseAddr("192.0.2.1")
|
||||||
|
backend, read := startQuestionReader(t)
|
||||||
|
|
||||||
|
visitor := httptest.NewRequestWithContext(
|
||||||
|
t.Context(),
|
||||||
|
http.MethodPost,
|
||||||
|
"http://site.example.com"+target,
|
||||||
|
strings.NewReader(body),
|
||||||
|
)
|
||||||
|
visitor.Header.Set("Content-Length", "10")
|
||||||
|
visitor.Header.Set("User-Agent", "a visitor")
|
||||||
|
visitor.Header.Set(wafprotocol.PeerHeader, "the visitor's own")
|
||||||
|
|
||||||
|
question, err := wafprotocol.NewQuestion(
|
||||||
|
t.Context(),
|
||||||
|
wafprotocol.QuestionParams{
|
||||||
|
Visitor: visitor,
|
||||||
|
PathAsSent: "/a%2Fb",
|
||||||
|
Body: []byte(held),
|
||||||
|
WAFBackend: backend,
|
||||||
|
Client: client,
|
||||||
|
Peer: peer,
|
||||||
|
RequestID: requestID,
|
||||||
|
Scheme: "https",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("write the question: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
res, err := http.DefaultTransport.RoundTrip(question)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("send the question: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
_ = res.Body.Close()
|
||||||
|
|
||||||
|
got := <-read
|
||||||
|
if got.question.Visitor == nil {
|
||||||
|
t.FailNow()
|
||||||
|
}
|
||||||
|
|
||||||
|
if got.question.Client != client || got.question.Peer != peer ||
|
||||||
|
got.question.RequestID != requestID {
|
||||||
|
t.Errorf("read %+v", got.question)
|
||||||
|
}
|
||||||
|
|
||||||
|
sent := got.question.Visitor
|
||||||
|
if sent.Host != "site.example.com" || sent.RequestURI != target ||
|
||||||
|
sent.ContentLength != int64(len(body)) || got.body != held {
|
||||||
|
t.Errorf(
|
||||||
|
"read %s at %s, of length %d, carrying %q",
|
||||||
|
sent.RequestURI, sent.Host, sent.ContentLength, got.body,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
for name, want := range map[string]string{
|
||||||
|
"Content-Length": "10",
|
||||||
|
"User-Agent": "a visitor",
|
||||||
|
"X-Forwarded-Proto": "https",
|
||||||
|
wafprotocol.RequestIDHeader: requestID,
|
||||||
|
wafprotocol.ClientHeader: "",
|
||||||
|
wafprotocol.PeerHeader: "",
|
||||||
|
wafprotocol.ContentLengthHeader: "",
|
||||||
|
} {
|
||||||
|
if sent.Header.Get(name) != want {
|
||||||
|
t.Errorf("%s is %q, want %q", name, sent.Header.Get(name), want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestAnswerReadsAsWritten checks that ReadAnswer gives back what
|
||||||
|
// SetAnswerHeaders sets, and that headers without a valid disposition give
|
||||||
|
// nothing.
|
||||||
|
func TestAnswerReadsAsWritten(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
for _, want := range []wafprotocol.Answer{
|
||||||
|
{Disposition: wafprotocol.DispositionAllow, ASN: "64496", Country: "DE"},
|
||||||
|
{Disposition: wafprotocol.DispositionAllow, Country: "DE"},
|
||||||
|
{Disposition: wafprotocol.DispositionDeny},
|
||||||
|
{Disposition: wafprotocol.DispositionClose},
|
||||||
|
} {
|
||||||
|
header := http.Header{}
|
||||||
|
wafprotocol.SetAnswerHeaders(header, want)
|
||||||
|
|
||||||
|
got, valid := wafprotocol.ReadAnswer(header)
|
||||||
|
if !valid || got != want {
|
||||||
|
t.Errorf("read %+v (valid: %t), want %+v", got, valid, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
header := http.Header{}
|
||||||
|
header.Set(wafprotocol.DispositionHeader, "maybe")
|
||||||
|
header.Set(wafprotocol.ASNHeader, "64496")
|
||||||
|
|
||||||
|
got, valid := wafprotocol.ReadAnswer(header)
|
||||||
|
if valid || got != (wafprotocol.Answer{}) {
|
||||||
|
t.Errorf("read %+v (valid: %t), want nothing", got, valid)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestReportReadsAsWritten checks that ReadReport gives back the report
|
||||||
|
// NewReportRequest posts.
|
||||||
|
func TestReportReadsAsWritten(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
want := wafprotocol.Report{
|
||||||
|
RequestID: requestID,
|
||||||
|
Status: http.StatusOK,
|
||||||
|
RequestBytes: 10,
|
||||||
|
ResponseBytes: 20,
|
||||||
|
DurationTotalMS: 1.5,
|
||||||
|
DurationUpstreamTotalMS: 0.5,
|
||||||
|
}
|
||||||
|
|
||||||
|
req, err := wafprotocol.NewReportRequest(
|
||||||
|
t.Context(),
|
||||||
|
"http://waf.example.com"+wafprotocol.ReportPath,
|
||||||
|
&want,
|
||||||
|
)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("write the report: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if req.Method != http.MethodPost ||
|
||||||
|
req.URL.Path != wafprotocol.ReportPath {
|
||||||
|
t.Errorf("the report is %s %s", req.Method, req.URL.Path)
|
||||||
|
}
|
||||||
|
|
||||||
|
got, err := wafprotocol.ReadReport(httptest.NewRecorder(), req)
|
||||||
|
if err != nil || got != want {
|
||||||
|
t.Errorf("read %+v (%v), want %+v", got, err, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in new issue
Block a user