Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ef88f309fc |
No files matched your search
@@ -0,0 +1,56 @@
|
|||||||
|
package waf
|
||||||
|
|
||||||
|
// The heuristic active_ban. It reads SWW_WAF_MODE; the bans are the ban
|
||||||
|
// ledger's.
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// activeBan refuses a client a ban covers: a ban on a netblock the client is
|
||||||
|
// in, in force at now. It notes for the log line when that ban ends. A request
|
||||||
|
// that makes the ban permanent, or in observe mode would have, raises the alert
|
||||||
|
// for it. Its figures are the ban's netblock and when it ends.
|
||||||
|
type activeBan struct {
|
||||||
|
banMaker banMaker
|
||||||
|
}
|
||||||
|
|
||||||
|
func (activeBan) name() string { return "active_ban" }
|
||||||
|
|
||||||
|
func (a activeBan) check(
|
||||||
|
_ context.Context,
|
||||||
|
rq *request,
|
||||||
|
now time.Time,
|
||||||
|
) *verdict {
|
||||||
|
ledger := a.banMaker.ledger
|
||||||
|
|
||||||
|
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)
|
||||||
|
|
||||||
|
var expires string
|
||||||
|
if banned {
|
||||||
|
expires = banExpires(ban)
|
||||||
|
rq.line.BanExpires = expires
|
||||||
|
}
|
||||||
|
|
||||||
|
if madePermanent {
|
||||||
|
ban.Expires = time.Time{} // the ban made permanent, which Find leaves as it is
|
||||||
|
a.banMaker.alertBan(rq, ban)
|
||||||
|
}
|
||||||
|
|
||||||
|
if !banned {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
return &verdict{
|
||||||
|
action: banAction(ban.Permanent()),
|
||||||
|
figures: map[string]any{
|
||||||
|
figureNetblock: ban.Netblock.String(), "ban_expires": expires,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
+2
-50
@@ -1,10 +1,9 @@
|
|||||||
package waf
|
package waf
|
||||||
|
|
||||||
// The heuristic active_ban, and banMaker, which makes the bans of several
|
// banMaker, which makes the bans of several heuristics. The bans are the ban
|
||||||
// heuristics. active_ban reads SWW_WAF_MODE; the bans are the ban ledger's.
|
// ledger's.
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"net/netip"
|
"net/netip"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
@@ -22,53 +21,6 @@ func (rq *request) banResponse(action requestlog.Action) *refusal {
|
|||||||
return &refusal{status: rq.h.config.BanResponse, action: action}
|
return &refusal{status: rq.h.config.BanResponse, action: action}
|
||||||
}
|
}
|
||||||
|
|
||||||
// activeBan refuses a client a ban covers: a ban on a netblock the client is
|
|
||||||
// in, in force at now. It notes for the log line when that ban ends. A request
|
|
||||||
// that makes the ban permanent, or in observe mode would have, raises the alert
|
|
||||||
// for it. Its figures are the ban's netblock and when it ends.
|
|
||||||
type activeBan struct {
|
|
||||||
banMaker banMaker
|
|
||||||
}
|
|
||||||
|
|
||||||
func (activeBan) name() string { return "active_ban" }
|
|
||||||
|
|
||||||
func (a activeBan) check(
|
|
||||||
_ context.Context,
|
|
||||||
rq *request,
|
|
||||||
now time.Time,
|
|
||||||
) *verdict {
|
|
||||||
ledger := a.banMaker.ledger
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
var expires string
|
|
||||||
if banned {
|
|
||||||
expires = banExpires(ban)
|
|
||||||
rq.line.BanExpires = expires
|
|
||||||
}
|
|
||||||
|
|
||||||
if madePermanent {
|
|
||||||
ban.Expires = time.Time{} // the ban made permanent, which Find leaves as it is
|
|
||||||
a.banMaker.alertBan(rq, ban)
|
|
||||||
}
|
|
||||||
|
|
||||||
if !banned {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return &verdict{
|
|
||||||
action: banAction(ban.Permanent()),
|
|
||||||
figures: map[string]any{
|
|
||||||
figureNetblock: ban.Netblock.String(), "ban_expires": expires,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// banAction is the action of a request refused under a ban or for making one:
|
// banAction is the action of a request refused under a ban or for making one:
|
||||||
// permanent says the ban never runs out.
|
// permanent says the ban never runs out.
|
||||||
func banAction(permanent bool) requestlog.Action {
|
func banAction(permanent bool) requestlog.Action {
|
||||||
|
|||||||
@@ -80,6 +80,26 @@ func (rq *request) startLookUp(
|
|||||||
return result
|
return result
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// refusedWhateverTheAnswer reports whether the request is one that does not wait
|
||||||
|
// for GeoJS, since the checks will refuse it at now whatever GeoJS answers about
|
||||||
|
// its client: a heuristic of afterLookup that implements refusesWithoutLookup
|
||||||
|
// says it will refuse it. In observe mode, which refuses nothing, none is.
|
||||||
|
// rproxy lets a request through when waf answers too late.
|
||||||
|
func (rq *request) refusedWhateverTheAnswer(now time.Time) bool {
|
||||||
|
if rq.h.config.Observe {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, each := range rq.h.afterLookup {
|
||||||
|
knows, ok := each.(refusesWithoutLookup)
|
||||||
|
if ok && knows.refusesWhateverTheLookupAnswers(rq, now) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
// noteLookup notes result for the log line and as the request's asn= and
|
// noteLookup notes result for the log line and as the request's asn= and
|
||||||
// country= tags.
|
// country= tags.
|
||||||
func (rq *request) noteLookup(result lookupResult) {
|
func (rq *request) noteLookup(result lookupResult) {
|
||||||
|
|||||||
@@ -1,322 +0,0 @@
|
|||||||
// Package waf is the server the waf command runs. It answers
|
|
||||||
// rproxy's questions, takes rproxy's reports and answers its own endpoints, and
|
|
||||||
// writes a log line for each. It also bans the clients on AbuseIPDB's
|
|
||||||
// blacklist each time the reputation package fetches it.
|
|
||||||
package waf
|
|
||||||
|
|
||||||
import (
|
|
||||||
"cmp"
|
|
||||||
"io"
|
|
||||||
"log/slog"
|
|
||||||
"net/http"
|
|
||||||
"net/netip"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
lru "github.com/hashicorp/golang-lru/v2"
|
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/anomaly"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/bans"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/config"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/coreruleset"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/geojs"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/lookup"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/metrics"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/reputation"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/routewatch"
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/rules"
|
|
||||||
)
|
|
||||||
|
|
||||||
// MetricsPath is where the metrics are, for a request that carries
|
|
||||||
// SWW_WAF_METRICS_TOKEN.
|
|
||||||
const MetricsPath = "/_sww/metrics"
|
|
||||||
|
|
||||||
// BansPath is where an admin lists and adds bans, and, followed by / and
|
|
||||||
// a client's address, lifts them, with SWW_WAF_ADMIN_TOKEN.
|
|
||||||
const BansPath = "/_sww/bans"
|
|
||||||
|
|
||||||
// ClientsPath is where an admin asks what waf knows of a client, by
|
|
||||||
// the client's address after it, with SWW_WAF_ADMIN_TOKEN.
|
|
||||||
const ClientsPath = "/_sww/clients/"
|
|
||||||
|
|
||||||
// Params are what New needs.
|
|
||||||
type Params struct {
|
|
||||||
Config *config.WAF
|
|
||||||
// RequestLog receives two JSON lines per question, one at its decision and
|
|
||||||
// one when its report comes, and one per request to waf's own
|
|
||||||
// endpoints.
|
|
||||||
RequestLog io.Writer
|
|
||||||
// ProcessLog receives the process's own messages.
|
|
||||||
ProcessLog *slog.Logger
|
|
||||||
// Metrics count what waf does. Whoever builds them adds the metrics
|
|
||||||
// read from the other parts.
|
|
||||||
Metrics *metrics.Metrics
|
|
||||||
// Limiter is the table of clients the rate limits count, with each
|
|
||||||
// client's history.
|
|
||||||
Limiter *ratelimit.Limiter
|
|
||||||
// Ledger holds the bans.
|
|
||||||
Ledger *bans.Ledger
|
|
||||||
// Anomalies are the counters of the anomaly thresholds.
|
|
||||||
Anomalies *anomaly.Counters
|
|
||||||
// Lists are the lists fetched from URLs, DNSBL the DNSBL zones'
|
|
||||||
// verdicts, and AbuseIPDB AbuseIPDB's scores and the checks spent.
|
|
||||||
Lists *reputation.Lists
|
|
||||||
DNSBL *reputation.DNSBL
|
|
||||||
AbuseIPDB *reputation.AbuseIPDB
|
|
||||||
// RouteWatch asks routewatch about clients, and is nil while
|
|
||||||
// SWW_WAF_ROUTEWATCH_URL is unset.
|
|
||||||
RouteWatch *routewatch.Client
|
|
||||||
// GeoJS looks clients' AS numbers and countries up while
|
|
||||||
// SWW_WAF_LOOKUP_SOURCE is geojs. It is given AddLookup as its Answered
|
|
||||||
// and GeoJSFailed as its Failed.
|
|
||||||
GeoJS *geojs.GeoJS
|
|
||||||
// LookupFile is the lookup database they are looked up in while
|
|
||||||
// SWW_WAF_LOOKUP_SOURCE is file, and nil otherwise.
|
|
||||||
LookupFile *lookup.File
|
|
||||||
// CoreRuleSet is what inspects requests while
|
|
||||||
// SWW_WAF_CORE_RULE_SET_MODE is not off, and nil while it is.
|
|
||||||
CoreRuleSet CoreRuleSetInspector
|
|
||||||
// Now tells the time by which requests are counted for the rate
|
|
||||||
// limits, bans are made and run out, and GeoJS's answers are kept,
|
|
||||||
// normally time.Now in UTC, the time the state files give.
|
|
||||||
Now func() time.Time
|
|
||||||
// Rules are the rule files' rules, which each request is checked
|
|
||||||
// against.
|
|
||||||
Rules *rules.Files
|
|
||||||
// Alerts receive the alert for each ban waf makes or makes
|
|
||||||
// permanent, for each count over an anomaly threshold, for each request
|
|
||||||
// whose client a blocklist, a DNSBL zone or AbuseIPDB lists, for each
|
|
||||||
// request the Core Rule Set scores at or over
|
|
||||||
// SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD, and for GeoJS failing, a fetch of a list
|
|
||||||
// failing, a query to a DNSBL zone or a check with AbuseIPDB failing,
|
|
||||||
// or the day's AbuseIPDB checks used up.
|
|
||||||
Alerts *alerts.Queue
|
|
||||||
// BesideLookupTimeLimit is how long the heuristics of besideLookup have
|
|
||||||
// for a request. Zero means besideLookupTimeLimit. Tests that run the
|
|
||||||
// Core Rule Set lengthen it, since the race detector and a busy host can
|
|
||||||
// slow an inspection past besideLookupTimeLimit.
|
|
||||||
BesideLookupTimeLimit time.Duration
|
|
||||||
}
|
|
||||||
|
|
||||||
// CoreRuleSetInspector inspects a request with the Core Rule Set, as
|
|
||||||
// coreruleset.CoreRuleSet's Inspect says. Tests give waf a stand-in for it.
|
|
||||||
type CoreRuleSetInspector interface {
|
|
||||||
Inspect(
|
|
||||||
r *http.Request, client netip.Addr, body io.Reader,
|
|
||||||
) (coreruleset.Result, []byte, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Server is the server waf runs.
|
|
||||||
type Server struct {
|
|
||||||
httpServer *http.Server
|
|
||||||
h *handler
|
|
||||||
}
|
|
||||||
|
|
||||||
// newHandler returns the handler with what every request shares, the parts
|
|
||||||
// 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 {
|
|
||||||
awaitingReport, err := lru.New[string, *decision](maxAwaitingReport)
|
|
||||||
if err != nil {
|
|
||||||
panic(err) // New fails only for a size below one
|
|
||||||
}
|
|
||||||
|
|
||||||
cfg := params.Config
|
|
||||||
h := &handler{
|
|
||||||
config: cfg,
|
|
||||||
requestLog: params.RequestLog,
|
|
||||||
processLog: params.ProcessLog,
|
|
||||||
now: params.Now,
|
|
||||||
metrics: params.Metrics,
|
|
||||||
awaitingReport: awaitingReport,
|
|
||||||
limiter: params.Limiter,
|
|
||||||
ledger: params.Ledger,
|
|
||||||
geojs: params.GeoJS,
|
|
||||||
anomalies: params.Anomalies,
|
|
||||||
lookupFile: params.LookupFile,
|
|
||||||
// The country list, the headers, the tag settings that name an asn=
|
|
||||||
// or country= tag and the biased thresholds act on the answer before
|
|
||||||
// the request goes on.
|
|
||||||
waitForGeoJS: len(cfg.ExclusivelyAllowedCountries) > 0 ||
|
|
||||||
cfg.AddLookupHeaders ||
|
|
||||||
cfg.TagsNeedLookup() ||
|
|
||||||
biasedThresholdsSet(cfg),
|
|
||||||
besideLookupLimit: cmp.Or(
|
|
||||||
params.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.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},
|
|
||||||
blocklists{
|
|
||||||
lists: params.Lists,
|
|
||||||
action: cfg.BlocklistAction,
|
|
||||||
hitNoter: hitNoter,
|
|
||||||
},
|
|
||||||
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},
|
|
||||||
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.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,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
h.ownEndpoints = h.routes()
|
|
||||||
|
|
||||||
return h
|
|
||||||
}
|
|
||||||
|
|
||||||
// handler is waf's handler. It holds what every request shares; what
|
|
||||||
// belongs to one request is in a request.
|
|
||||||
type handler struct {
|
|
||||||
config *config.WAF
|
|
||||||
requestLog io.Writer
|
|
||||||
processLog *slog.Logger
|
|
||||||
now func() time.Time
|
|
||||||
metrics *metrics.Metrics
|
|
||||||
limiter *ratelimit.Limiter
|
|
||||||
ledger *bans.Ledger
|
|
||||||
geojs *geojs.GeoJS
|
|
||||||
anomalies *anomaly.Counters
|
|
||||||
lookupFile *lookup.File
|
|
||||||
// waitForGeoJS is true when a setting needs each request's answer from
|
|
||||||
// GeoJS before the request goes on.
|
|
||||||
waitForGeoJS bool
|
|
||||||
// besideLookupLimit is how long the heuristics of besideLookup have for a
|
|
||||||
// request, as Params.BesideLookupTimeLimit says.
|
|
||||||
besideLookupLimit time.Duration
|
|
||||||
// awaitingReport holds the decision on each answered question by its id
|
|
||||||
// until its report comes, and nil for a question still being handled.
|
|
||||||
awaitingReport *lru.Cache[string, *decision]
|
|
||||||
// ownEndpoints answers every request that is not a question, as routes
|
|
||||||
// lists the endpoints.
|
|
||||||
ownEndpoints http.Handler
|
|
||||||
|
|
||||||
// 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 besideLookup, whose work findBesideLookup does.
|
|
||||||
trapPaths trapPaths
|
|
||||||
ruleFiles ruleFiles
|
|
||||||
coreRuleSet coreRuleSet
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,235 @@
|
|||||||
|
package waf
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"net/http"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
|
)
|
||||||
|
|
||||||
|
// 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
|
||||||
|
// is finished here, and an allowed one's by its report.
|
||||||
|
func (h *handler) answerQuestion(w http.ResponseWriter, r *http.Request) {
|
||||||
|
question, ok := h.readQuestion(w, r)
|
||||||
|
if !ok {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
rq := h.startRequest(
|
||||||
|
w,
|
||||||
|
question.Visitor,
|
||||||
|
question.Client,
|
||||||
|
question.Peer,
|
||||||
|
true,
|
||||||
|
)
|
||||||
|
// These run even when a check panics. finish runs first, so that what is
|
||||||
|
// held has the finished log line. Go's server sends the answer only once
|
||||||
|
// this function has returned, so the report cannot come before it is held.
|
||||||
|
defer func() {
|
||||||
|
rq.finish()
|
||||||
|
rq.holdForReport()
|
||||||
|
}()
|
||||||
|
|
||||||
|
rq.site = r.Host
|
||||||
|
rq.line.WAFLine = requestlog.WAFLineDecision
|
||||||
|
refused := rq.check(r.Context())
|
||||||
|
rq.checked = time.Now()
|
||||||
|
underOwnPrefix := strings.HasPrefix(
|
||||||
|
r.URL.Path,
|
||||||
|
wafprotocol.OwnEndpointPrefix,
|
||||||
|
)
|
||||||
|
|
||||||
|
if refused == nil && !underOwnPrefix {
|
||||||
|
rq.allow()
|
||||||
|
// In observe mode, what enforce mode would have refused counts here.
|
||||||
|
rq.runBanningHeuristics(r.Context(), rq.h.afterAnswer)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if refused != nil {
|
||||||
|
rq.deny(*refused)
|
||||||
|
} else {
|
||||||
|
// 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.
|
||||||
|
rq.line.Action = requestlog.ActionOwnEndpoint
|
||||||
|
wafprotocol.SetAnswerHeaders(
|
||||||
|
rq.out.Header(),
|
||||||
|
wafprotocol.Answer{Disposition: wafprotocol.DispositionDeny},
|
||||||
|
)
|
||||||
|
http.Error(
|
||||||
|
rq.out,
|
||||||
|
http.StatusText(http.StatusNotFound),
|
||||||
|
http.StatusNotFound,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
rq.banAndCount(r.Context(), rq.h.afterAnswer)
|
||||||
|
}
|
||||||
|
|
||||||
|
// readQuestion reads a question, and reports whether waf takes it. It answers
|
||||||
|
// a question it does not take with 400 and no disposition. rproxy passes that
|
||||||
|
// 400 to the visitor, and SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION does
|
||||||
|
// not apply. The id of a question waf takes is held from here on, without a
|
||||||
|
// decision yet, so that another question with that id is refused while this
|
||||||
|
// one is being handled.
|
||||||
|
//
|
||||||
|
// A question whose body stops arriving gets no answer, and is not looked at.
|
||||||
|
func (h *handler) readQuestion(
|
||||||
|
w http.ResponseWriter, r *http.Request,
|
||||||
|
) (wafprotocol.Question, bool) {
|
||||||
|
question, err := wafprotocol.ReadQuestion(w, r)
|
||||||
|
if errors.Is(err, wafprotocol.ErrBodyStoppedArriving) {
|
||||||
|
h.processLog.Warn(
|
||||||
|
"a question's body stopped arriving",
|
||||||
|
"error",
|
||||||
|
err.Error(),
|
||||||
|
)
|
||||||
|
// This panic has Go's server close the connection without an answer,
|
||||||
|
// and log nothing.
|
||||||
|
panic(http.ErrAbortHandler)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err != nil {
|
||||||
|
h.refuseQuestion(w, err.Error())
|
||||||
|
|
||||||
|
return question, false
|
||||||
|
}
|
||||||
|
|
||||||
|
held, _ := h.awaitingReport.ContainsOrAdd(question.RequestID, nil)
|
||||||
|
if held {
|
||||||
|
h.refuseQuestion(
|
||||||
|
w,
|
||||||
|
wafprotocol.RequestIDHeader+" is the id of a request waf holds",
|
||||||
|
)
|
||||||
|
|
||||||
|
return question, false
|
||||||
|
}
|
||||||
|
|
||||||
|
return question, true
|
||||||
|
}
|
||||||
|
|
||||||
|
// refuseQuestion answers a question waf does not take, for reason.
|
||||||
|
func (h *handler) refuseQuestion(w http.ResponseWriter, reason string) {
|
||||||
|
h.processLog.Warn("a question is refused", "reason", reason)
|
||||||
|
http.Error(w, reason, http.StatusBadRequest)
|
||||||
|
}
|
||||||
|
|
||||||
|
// allow answers a question with wafprotocol.DispositionAllow and, while
|
||||||
|
// SWW_WAF_ADD_LOOKUP_HEADERS is true, the client's AS number and country.
|
||||||
|
func (rq *request) allow() {
|
||||||
|
rq.allowed = true
|
||||||
|
|
||||||
|
answer := wafprotocol.Answer{Disposition: wafprotocol.DispositionAllow}
|
||||||
|
if rq.h.config.AddLookupHeaders {
|
||||||
|
answer.ASN = rq.lookupAnswer.ASN
|
||||||
|
answer.Country = rq.lookupAnswer.Country
|
||||||
|
}
|
||||||
|
|
||||||
|
wafprotocol.SetAnswerHeaders(rq.out.Header(), answer)
|
||||||
|
rq.out.WriteHeader(http.StatusOK)
|
||||||
|
}
|
||||||
|
|
||||||
|
// holdForReport holds a copy of what the report's steps need, by the request's
|
||||||
|
// id. A report only ever reaches that copy, never the request being handled.
|
||||||
|
func (rq *request) holdForReport() {
|
||||||
|
held := rq.decision
|
||||||
|
rq.h.awaitingReport.Add(rq.line.RequestID, &held)
|
||||||
|
}
|
||||||
|
|
||||||
|
// deny answers a question with what the visitor is to get for r.
|
||||||
|
func (rq *request) deny(r refusal) {
|
||||||
|
rq.refused = &r
|
||||||
|
|
||||||
|
if r.status == 0 {
|
||||||
|
// SWW_WAF_BAN_RESPONSE is close. Written past rq.out, since the log line's
|
||||||
|
// status stays 0: the visitor is sent nothing.
|
||||||
|
wafprotocol.SetAnswerHeaders(
|
||||||
|
rq.out.Header(),
|
||||||
|
wafprotocol.Answer{Disposition: wafprotocol.DispositionClose},
|
||||||
|
)
|
||||||
|
rq.out.ResponseWriter.WriteHeader(http.StatusOK)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
wafprotocol.SetAnswerHeaders(
|
||||||
|
rq.out.Header(),
|
||||||
|
wafprotocol.Answer{Disposition: wafprotocol.DispositionDeny},
|
||||||
|
)
|
||||||
|
http.Error(rq.out, http.StatusText(r.status), r.status)
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleReport answers POST wafprotocol.ReportPath: it finishes the request
|
||||||
|
// the report names, if it holds that request's decision, and ignores the
|
||||||
|
// report otherwise.
|
||||||
|
func (h *handler) handleReport() http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
report, err := wafprotocol.ReadReport(w, r)
|
||||||
|
if err != nil {
|
||||||
|
h.processLog.Warn("a report is refused", "error", err.Error())
|
||||||
|
http.Error(w, "the body is not a report", http.StatusBadRequest)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
held, found := h.awaitingReport.Peek(report.RequestID)
|
||||||
|
// Remove reports true to one report only, of several that name the
|
||||||
|
// id. A question still being handled is held as nil.
|
||||||
|
if found && held != nil &&
|
||||||
|
h.awaitingReport.Remove(report.RequestID) {
|
||||||
|
h.finishWith(r.Context(), held, report)
|
||||||
|
}
|
||||||
|
|
||||||
|
w.WriteHeader(http.StatusNoContent)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 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.
|
||||||
|
// For an allowed request it first runs the heuristics of onReport, and adds the
|
||||||
|
// request to its client's history, the anomaly counters and the metrics, with
|
||||||
|
// the status and bytes the report gives. A denied request's counting was
|
||||||
|
// finished at its decision. ctx is the report's own context.
|
||||||
|
func (h *handler) finishWith(
|
||||||
|
ctx context.Context,
|
||||||
|
held *decision,
|
||||||
|
report wafprotocol.Report,
|
||||||
|
) {
|
||||||
|
rq := &request{
|
||||||
|
decision: *held,
|
||||||
|
h: h,
|
||||||
|
out: &responseWriter{
|
||||||
|
status: report.Status,
|
||||||
|
bytes: report.ResponseBytes,
|
||||||
|
},
|
||||||
|
requestBytes: report.RequestBytes,
|
||||||
|
}
|
||||||
|
|
||||||
|
rq.line.WAFLine = requestlog.WAFLineReport
|
||||||
|
rq.line.Status = report.Status
|
||||||
|
rq.line.RequestBytes = report.RequestBytes
|
||||||
|
rq.line.ResponseBytes = report.ResponseBytes
|
||||||
|
rq.line.DurationTotalMS = report.DurationTotalMS
|
||||||
|
|
||||||
|
if rq.allowed {
|
||||||
|
rq.line.DurationUpstreamTotalMS = &report.DurationUpstreamTotalMS
|
||||||
|
|
||||||
|
rq.banAndCount(ctx, rq.h.onReport)
|
||||||
|
|
||||||
|
rq.h.metrics.RequestReported(
|
||||||
|
&rq.line,
|
||||||
|
time.Duration(report.DurationTotalMS*float64(time.Millisecond)),
|
||||||
|
time.Duration(
|
||||||
|
report.DurationUpstreamTotalMS*float64(time.Millisecond),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
rq.writeLine()
|
||||||
|
}
|
||||||
+314
-246
@@ -1,18 +1,48 @@
|
|||||||
|
// Package waf is the server the waf command runs. It answers
|
||||||
|
// rproxy's questions, takes rproxy's reports and answers its own endpoints, and
|
||||||
|
// writes a log line for each. It also bans the clients on AbuseIPDB's
|
||||||
|
// blacklist each time the reputation package fetches it.
|
||||||
package waf
|
package waf
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"cmp"
|
||||||
"context"
|
"context"
|
||||||
"errors"
|
"io"
|
||||||
"log/slog"
|
"log/slog"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"net/netip"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"sneak.berlin/go/smallwebwaf/internal/requestlog"
|
lru "github.com/hashicorp/golang-lru/v2"
|
||||||
|
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/alerts"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/anomaly"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/bans"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/config"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/coreruleset"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/geojs"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/lookup"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/metrics"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/ratelimit"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/reputation"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/routewatch"
|
||||||
|
"sneak.berlin/go/smallwebwaf/internal/rules"
|
||||||
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
"sneak.berlin/go/smallwebwaf/internal/wafprotocol"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// MetricsPath is where the metrics are, for a request that carries
|
||||||
|
// SWW_WAF_METRICS_TOKEN.
|
||||||
|
const MetricsPath = "/_sww/metrics"
|
||||||
|
|
||||||
|
// BansPath is where an admin lists and adds bans, and, followed by / and
|
||||||
|
// a client's address, lifts them, with SWW_WAF_ADMIN_TOKEN.
|
||||||
|
const BansPath = "/_sww/bans"
|
||||||
|
|
||||||
|
// ClientsPath is where an admin asks what waf knows of a client, by
|
||||||
|
// the client's address after it, with SWW_WAF_ADMIN_TOKEN.
|
||||||
|
const ClientsPath = "/_sww/clients/"
|
||||||
|
|
||||||
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.
|
||||||
@@ -24,6 +54,79 @@ const (
|
|||||||
wafIdleTimeout = 120 * time.Second
|
wafIdleTimeout = 120 * time.Second
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Params are what New needs.
|
||||||
|
type Params struct {
|
||||||
|
Config *config.WAF
|
||||||
|
// RequestLog receives two JSON lines per question, one at its decision and
|
||||||
|
// one when its report comes, and one per request to waf's own
|
||||||
|
// endpoints.
|
||||||
|
RequestLog io.Writer
|
||||||
|
// ProcessLog receives the process's own messages.
|
||||||
|
ProcessLog *slog.Logger
|
||||||
|
// Metrics count what waf does. Whoever builds them adds the metrics
|
||||||
|
// read from the other parts.
|
||||||
|
Metrics *metrics.Metrics
|
||||||
|
// Limiter is the table of clients the rate limits count, with each
|
||||||
|
// client's history.
|
||||||
|
Limiter *ratelimit.Limiter
|
||||||
|
// Ledger holds the bans.
|
||||||
|
Ledger *bans.Ledger
|
||||||
|
// Anomalies are the counters of the anomaly thresholds.
|
||||||
|
Anomalies *anomaly.Counters
|
||||||
|
// Lists are the lists fetched from URLs, DNSBL the DNSBL zones'
|
||||||
|
// verdicts, and AbuseIPDB AbuseIPDB's scores and the checks spent.
|
||||||
|
Lists *reputation.Lists
|
||||||
|
DNSBL *reputation.DNSBL
|
||||||
|
AbuseIPDB *reputation.AbuseIPDB
|
||||||
|
// RouteWatch asks routewatch about clients, and is nil while
|
||||||
|
// SWW_WAF_ROUTEWATCH_URL is unset.
|
||||||
|
RouteWatch *routewatch.Client
|
||||||
|
// GeoJS looks clients' AS numbers and countries up while
|
||||||
|
// SWW_WAF_LOOKUP_SOURCE is geojs. It is given AddLookup as its Answered
|
||||||
|
// and GeoJSFailed as its Failed.
|
||||||
|
GeoJS *geojs.GeoJS
|
||||||
|
// LookupFile is the lookup database they are looked up in while
|
||||||
|
// SWW_WAF_LOOKUP_SOURCE is file, and nil otherwise.
|
||||||
|
LookupFile *lookup.File
|
||||||
|
// CoreRuleSet is what inspects requests while
|
||||||
|
// SWW_WAF_CORE_RULE_SET_MODE is not off, and nil while it is.
|
||||||
|
CoreRuleSet CoreRuleSetInspector
|
||||||
|
// Now tells the time by which requests are counted for the rate
|
||||||
|
// limits, bans are made and run out, and GeoJS's answers are kept,
|
||||||
|
// normally time.Now in UTC, the time the state files give.
|
||||||
|
Now func() time.Time
|
||||||
|
// Rules are the rule files' rules, which each request is checked
|
||||||
|
// against.
|
||||||
|
Rules *rules.Files
|
||||||
|
// Alerts receive the alert for each ban waf makes or makes
|
||||||
|
// permanent, for each count over an anomaly threshold, for each request
|
||||||
|
// whose client a blocklist, a DNSBL zone or AbuseIPDB lists, for each
|
||||||
|
// request the Core Rule Set scores at or over
|
||||||
|
// SWW_WAF_CORE_RULE_SET_SCORE_THRESHOLD, and for GeoJS failing, a fetch of a list
|
||||||
|
// failing, a query to a DNSBL zone or a check with AbuseIPDB failing,
|
||||||
|
// or the day's AbuseIPDB checks used up.
|
||||||
|
Alerts *alerts.Queue
|
||||||
|
// BesideLookupTimeLimit is how long the heuristics of besideLookup have
|
||||||
|
// for a request. Zero means besideLookupTimeLimit. Tests that run the
|
||||||
|
// Core Rule Set lengthen it, since the race detector and a busy host can
|
||||||
|
// slow an inspection past besideLookupTimeLimit.
|
||||||
|
BesideLookupTimeLimit time.Duration
|
||||||
|
}
|
||||||
|
|
||||||
|
// CoreRuleSetInspector inspects a request with the Core Rule Set, as
|
||||||
|
// coreruleset.CoreRuleSet's Inspect says. Tests give waf a stand-in for it.
|
||||||
|
type CoreRuleSetInspector interface {
|
||||||
|
Inspect(
|
||||||
|
r *http.Request, client netip.Addr, body io.Reader,
|
||||||
|
) (coreruleset.Result, []byte, error)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Server is the server waf runs.
|
||||||
|
type Server struct {
|
||||||
|
httpServer *http.Server
|
||||||
|
h *handler
|
||||||
|
}
|
||||||
|
|
||||||
// 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
|
||||||
@@ -70,6 +173,214 @@ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
s.h.ServeHTTP(w, r)
|
s.h.ServeHTTP(w, r)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// newHandler returns the handler with what every request shares, the parts
|
||||||
|
// 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 {
|
||||||
|
awaitingReport, err := lru.New[string, *decision](maxAwaitingReport)
|
||||||
|
if err != nil {
|
||||||
|
panic(err) // New fails only for a size below one
|
||||||
|
}
|
||||||
|
|
||||||
|
cfg := params.Config
|
||||||
|
h := &handler{
|
||||||
|
config: cfg,
|
||||||
|
requestLog: params.RequestLog,
|
||||||
|
processLog: params.ProcessLog,
|
||||||
|
now: params.Now,
|
||||||
|
metrics: params.Metrics,
|
||||||
|
awaitingReport: awaitingReport,
|
||||||
|
limiter: params.Limiter,
|
||||||
|
ledger: params.Ledger,
|
||||||
|
geojs: params.GeoJS,
|
||||||
|
anomalies: params.Anomalies,
|
||||||
|
lookupFile: params.LookupFile,
|
||||||
|
// The country list, the headers, the tag settings that name an asn=
|
||||||
|
// or country= tag and the biased thresholds act on the answer before
|
||||||
|
// the request goes on.
|
||||||
|
waitForGeoJS: len(cfg.ExclusivelyAllowedCountries) > 0 ||
|
||||||
|
cfg.AddLookupHeaders ||
|
||||||
|
cfg.TagsNeedLookup() ||
|
||||||
|
biasedThresholdsSet(cfg),
|
||||||
|
besideLookupLimit: cmp.Or(
|
||||||
|
params.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.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},
|
||||||
|
blocklists{
|
||||||
|
lists: params.Lists,
|
||||||
|
action: cfg.BlocklistAction,
|
||||||
|
hitNoter: hitNoter,
|
||||||
|
},
|
||||||
|
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},
|
||||||
|
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.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,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
h.ownEndpoints = h.routes()
|
||||||
|
|
||||||
|
return h
|
||||||
|
}
|
||||||
|
|
||||||
|
// handler is waf's handler. It holds what every request shares; what
|
||||||
|
// belongs to one request is in a request.
|
||||||
|
type handler struct {
|
||||||
|
config *config.WAF
|
||||||
|
requestLog io.Writer
|
||||||
|
processLog *slog.Logger
|
||||||
|
now func() time.Time
|
||||||
|
metrics *metrics.Metrics
|
||||||
|
limiter *ratelimit.Limiter
|
||||||
|
ledger *bans.Ledger
|
||||||
|
geojs *geojs.GeoJS
|
||||||
|
anomalies *anomaly.Counters
|
||||||
|
lookupFile *lookup.File
|
||||||
|
// waitForGeoJS is true when a setting needs each request's answer from
|
||||||
|
// GeoJS before the request goes on.
|
||||||
|
waitForGeoJS bool
|
||||||
|
// besideLookupLimit is how long the heuristics of besideLookup have for a
|
||||||
|
// request, as Params.BesideLookupTimeLimit says.
|
||||||
|
besideLookupLimit time.Duration
|
||||||
|
// awaitingReport holds the decision on each answered question by its id
|
||||||
|
// until its report comes, and nil for a question still being handled.
|
||||||
|
awaitingReport *lru.Cache[string, *decision]
|
||||||
|
// ownEndpoints answers every request that is not a question, as routes
|
||||||
|
// lists the endpoints.
|
||||||
|
ownEndpoints http.Handler
|
||||||
|
|
||||||
|
// 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 besideLookup, whose work findBesideLookup does.
|
||||||
|
trapPaths trapPaths
|
||||||
|
ruleFiles ruleFiles
|
||||||
|
coreRuleSet coreRuleSet
|
||||||
|
}
|
||||||
|
|
||||||
// ServeHTTP handles one request to waf: a request carrying
|
// ServeHTTP handles one request to waf: a request carrying
|
||||||
// wafprotocol.ClientHeader is rproxy's question, and any other is for one of
|
// wafprotocol.ClientHeader is rproxy's question, and any other is for one of
|
||||||
// waf's own endpoints.
|
// waf's own endpoints.
|
||||||
@@ -82,246 +393,3 @@ func (h *handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
|
|
||||||
h.ownEndpoints.ServeHTTP(w, r)
|
h.ownEndpoints.ServeHTTP(w, r)
|
||||||
}
|
}
|
||||||
|
|
||||||
// refusedWhateverTheAnswer reports whether the request is one that does not wait
|
|
||||||
// for GeoJS, since the checks will refuse it at now whatever GeoJS answers about
|
|
||||||
// its client: a heuristic of afterLookup that implements refusesWithoutLookup
|
|
||||||
// says it will refuse it. In observe mode, which refuses nothing, none is.
|
|
||||||
// rproxy lets a request through when waf answers too late.
|
|
||||||
func (rq *request) refusedWhateverTheAnswer(now time.Time) bool {
|
|
||||||
if rq.h.config.Observe {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, each := range rq.h.afterLookup {
|
|
||||||
knows, ok := each.(refusesWithoutLookup)
|
|
||||||
if ok && knows.refusesWhateverTheLookupAnswers(rq, now) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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
|
|
||||||
// is finished here, and an allowed one's by its report.
|
|
||||||
func (h *handler) answerQuestion(w http.ResponseWriter, r *http.Request) {
|
|
||||||
question, ok := h.readQuestion(w, r)
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
rq := h.startRequest(
|
|
||||||
w,
|
|
||||||
question.Visitor,
|
|
||||||
question.Client,
|
|
||||||
question.Peer,
|
|
||||||
true,
|
|
||||||
)
|
|
||||||
// These run even when a check panics. finish runs first, so that what is
|
|
||||||
// held has the finished log line. Go's server sends the answer only once
|
|
||||||
// this function has returned, so the report cannot come before it is held.
|
|
||||||
defer func() {
|
|
||||||
rq.finish()
|
|
||||||
rq.holdForReport()
|
|
||||||
}()
|
|
||||||
|
|
||||||
rq.site = r.Host
|
|
||||||
rq.line.WAFLine = requestlog.WAFLineDecision
|
|
||||||
refused := rq.check(r.Context())
|
|
||||||
rq.checked = time.Now()
|
|
||||||
underOwnPrefix := strings.HasPrefix(
|
|
||||||
r.URL.Path,
|
|
||||||
wafprotocol.OwnEndpointPrefix,
|
|
||||||
)
|
|
||||||
|
|
||||||
if refused == nil && !underOwnPrefix {
|
|
||||||
rq.allow()
|
|
||||||
// In observe mode, what enforce mode would have refused counts here.
|
|
||||||
rq.runBanningHeuristics(r.Context(), rq.h.afterAnswer)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if refused != nil {
|
|
||||||
rq.deny(*refused)
|
|
||||||
} else {
|
|
||||||
// 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.
|
|
||||||
rq.line.Action = requestlog.ActionOwnEndpoint
|
|
||||||
wafprotocol.SetAnswerHeaders(
|
|
||||||
rq.out.Header(),
|
|
||||||
wafprotocol.Answer{Disposition: wafprotocol.DispositionDeny},
|
|
||||||
)
|
|
||||||
http.Error(
|
|
||||||
rq.out,
|
|
||||||
http.StatusText(http.StatusNotFound),
|
|
||||||
http.StatusNotFound,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
rq.banAndCount(r.Context(), rq.h.afterAnswer)
|
|
||||||
}
|
|
||||||
|
|
||||||
// readQuestion reads a question, and reports whether waf takes it. It answers
|
|
||||||
// a question it does not take with 400 and no disposition. rproxy passes that
|
|
||||||
// 400 to the visitor, and SWW_RPROXY_WAF_BACKEND_NO_ANSWER_DISPOSITION does
|
|
||||||
// not apply. The id of a question waf takes is held from here on, without a
|
|
||||||
// decision yet, so that another question with that id is refused while this
|
|
||||||
// one is being handled.
|
|
||||||
//
|
|
||||||
// A question whose body stops arriving gets no answer, and is not looked at.
|
|
||||||
func (h *handler) readQuestion(
|
|
||||||
w http.ResponseWriter, r *http.Request,
|
|
||||||
) (wafprotocol.Question, bool) {
|
|
||||||
question, err := wafprotocol.ReadQuestion(w, r)
|
|
||||||
if errors.Is(err, wafprotocol.ErrBodyStoppedArriving) {
|
|
||||||
h.processLog.Warn(
|
|
||||||
"a question's body stopped arriving",
|
|
||||||
"error",
|
|
||||||
err.Error(),
|
|
||||||
)
|
|
||||||
// This panic has Go's server close the connection without an answer,
|
|
||||||
// and log nothing.
|
|
||||||
panic(http.ErrAbortHandler)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err != nil {
|
|
||||||
h.refuseQuestion(w, err.Error())
|
|
||||||
|
|
||||||
return question, false
|
|
||||||
}
|
|
||||||
|
|
||||||
held, _ := h.awaitingReport.ContainsOrAdd(question.RequestID, nil)
|
|
||||||
if held {
|
|
||||||
h.refuseQuestion(
|
|
||||||
w,
|
|
||||||
wafprotocol.RequestIDHeader+" is the id of a request waf holds",
|
|
||||||
)
|
|
||||||
|
|
||||||
return question, false
|
|
||||||
}
|
|
||||||
|
|
||||||
return question, true
|
|
||||||
}
|
|
||||||
|
|
||||||
// refuseQuestion answers a question waf does not take, for reason.
|
|
||||||
func (h *handler) refuseQuestion(w http.ResponseWriter, reason string) {
|
|
||||||
h.processLog.Warn("a question is refused", "reason", reason)
|
|
||||||
http.Error(w, reason, http.StatusBadRequest)
|
|
||||||
}
|
|
||||||
|
|
||||||
// allow answers a question with wafprotocol.DispositionAllow and, while
|
|
||||||
// SWW_WAF_ADD_LOOKUP_HEADERS is true, the client's AS number and country.
|
|
||||||
func (rq *request) allow() {
|
|
||||||
rq.allowed = true
|
|
||||||
|
|
||||||
answer := wafprotocol.Answer{Disposition: wafprotocol.DispositionAllow}
|
|
||||||
if rq.h.config.AddLookupHeaders {
|
|
||||||
answer.ASN = rq.lookupAnswer.ASN
|
|
||||||
answer.Country = rq.lookupAnswer.Country
|
|
||||||
}
|
|
||||||
|
|
||||||
wafprotocol.SetAnswerHeaders(rq.out.Header(), answer)
|
|
||||||
rq.out.WriteHeader(http.StatusOK)
|
|
||||||
}
|
|
||||||
|
|
||||||
// holdForReport holds a copy of what the report's steps need, by the request's
|
|
||||||
// id. A report only ever reaches that copy, never the request being handled.
|
|
||||||
func (rq *request) holdForReport() {
|
|
||||||
held := rq.decision
|
|
||||||
rq.h.awaitingReport.Add(rq.line.RequestID, &held)
|
|
||||||
}
|
|
||||||
|
|
||||||
// deny answers a question with what the visitor is to get for r.
|
|
||||||
func (rq *request) deny(r refusal) {
|
|
||||||
rq.refused = &r
|
|
||||||
|
|
||||||
if r.status == 0 {
|
|
||||||
// SWW_WAF_BAN_RESPONSE is close. Written past rq.out, since the log line's
|
|
||||||
// status stays 0: the visitor is sent nothing.
|
|
||||||
wafprotocol.SetAnswerHeaders(
|
|
||||||
rq.out.Header(),
|
|
||||||
wafprotocol.Answer{Disposition: wafprotocol.DispositionClose},
|
|
||||||
)
|
|
||||||
rq.out.ResponseWriter.WriteHeader(http.StatusOK)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
wafprotocol.SetAnswerHeaders(
|
|
||||||
rq.out.Header(),
|
|
||||||
wafprotocol.Answer{Disposition: wafprotocol.DispositionDeny},
|
|
||||||
)
|
|
||||||
http.Error(rq.out, http.StatusText(r.status), r.status)
|
|
||||||
}
|
|
||||||
|
|
||||||
// handleReport answers POST wafprotocol.ReportPath: it finishes the request
|
|
||||||
// the report names, if it holds that request's decision, and ignores the
|
|
||||||
// report otherwise.
|
|
||||||
func (h *handler) handleReport() http.HandlerFunc {
|
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
|
||||||
report, err := wafprotocol.ReadReport(w, r)
|
|
||||||
if err != nil {
|
|
||||||
h.processLog.Warn("a report is refused", "error", err.Error())
|
|
||||||
http.Error(w, "the body is not a report", http.StatusBadRequest)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
held, found := h.awaitingReport.Peek(report.RequestID)
|
|
||||||
// Remove reports true to one report only, of several that name the
|
|
||||||
// id. A question still being handled is held as nil.
|
|
||||||
if found && held != nil &&
|
|
||||||
h.awaitingReport.Remove(report.RequestID) {
|
|
||||||
h.finishWith(r.Context(), held, report)
|
|
||||||
}
|
|
||||||
|
|
||||||
w.WriteHeader(http.StatusNoContent)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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.
|
|
||||||
// For an allowed request it first runs the heuristics of onReport, and adds the
|
|
||||||
// request to its client's history, the anomaly counters and the metrics, with
|
|
||||||
// the status and bytes the report gives. A denied request's counting was
|
|
||||||
// finished at its decision. ctx is the report's own context.
|
|
||||||
func (h *handler) finishWith(
|
|
||||||
ctx context.Context,
|
|
||||||
held *decision,
|
|
||||||
report wafprotocol.Report,
|
|
||||||
) {
|
|
||||||
rq := &request{
|
|
||||||
decision: *held,
|
|
||||||
h: h,
|
|
||||||
out: &responseWriter{
|
|
||||||
status: report.Status,
|
|
||||||
bytes: report.ResponseBytes,
|
|
||||||
},
|
|
||||||
requestBytes: report.RequestBytes,
|
|
||||||
}
|
|
||||||
|
|
||||||
rq.line.WAFLine = requestlog.WAFLineReport
|
|
||||||
rq.line.Status = report.Status
|
|
||||||
rq.line.RequestBytes = report.RequestBytes
|
|
||||||
rq.line.ResponseBytes = report.ResponseBytes
|
|
||||||
rq.line.DurationTotalMS = report.DurationTotalMS
|
|
||||||
|
|
||||||
if rq.allowed {
|
|
||||||
rq.line.DurationUpstreamTotalMS = &report.DurationUpstreamTotalMS
|
|
||||||
|
|
||||||
rq.banAndCount(ctx, rq.h.onReport)
|
|
||||||
|
|
||||||
rq.h.metrics.RequestReported(
|
|
||||||
&rq.line,
|
|
||||||
time.Duration(report.DurationTotalMS*float64(time.Millisecond)),
|
|
||||||
time.Duration(
|
|
||||||
report.DurationUpstreamTotalMS*float64(time.Millisecond),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
rq.writeLine()
|
|
||||||
}
|
|
||||||
Reference in new issue
Block a user