waf: a verdict carries the status the visitor gets (closes #443) #482

Merged
clawbot merged 2 commits from issue-443-verdict-status into next 2026-11-20 02:42:09 +01:00
17 changed files with 132 additions and 125 deletions

No files matched your search

+9 -5
View File
@@ -1,7 +1,8 @@
package waf package waf
// The heuristic abuseipdb. It reads SWW_WAF_ABUSEIPDB_KEY, // The heuristic abuseipdb. It reads SWW_WAF_ABUSEIPDB_KEY,
// SWW_WAF_ABUSEIPDB_MIN_SCORE and SWW_WAF_DNSBL_ABUSEIPDB_ACTION. // SWW_WAF_ABUSEIPDB_MIN_SCORE, SWW_WAF_DNSBL_ABUSEIPDB_ACTION and
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
@@ -16,10 +17,11 @@ import (
// abuseIPDB adds the tag abuseipdb and notes AbuseIPDB, as noteHit does, with // abuseIPDB adds the tag abuseipdb and notes AbuseIPDB, as noteHit does, with
// the score, when its score of the client is a hit, and refuses the request // the score, when its score of the client is a hit, and refuses the request
// when SWW_WAF_DNSBL_ABUSEIPDB_ACTION is deny, as dnsbl does for a zone. While // with SWW_WAF_BAN_RESPONSE when SWW_WAF_DNSBL_ABUSEIPDB_ACTION is deny, as
// SWW_WAF_ABUSEIPDB_KEY is unset it does nothing. A client without a score is // dnsbl does for a zone. While SWW_WAF_ABUSEIPDB_KEY is unset it does nothing.
// checked in the background, by the request's address, if its history counts // A client without a score is checked in the background, by the request's
// an offence, and the request does not wait for the answer. The score is then // address, if its history counts 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 {
@@ -30,6 +32,7 @@ type abuseIPDB struct {
keySet bool // SWW_WAF_ABUSEIPDB_KEY is set keySet bool // SWW_WAF_ABUSEIPDB_KEY is set
minScore int64 // SWW_WAF_ABUSEIPDB_MIN_SCORE minScore int64 // SWW_WAF_ABUSEIPDB_MIN_SCORE
action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION
banResponse int // SWW_WAF_BAN_RESPONSE
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
hitNoter reputationHitNoter hitNoter reputationHitNoter
} }
@@ -71,6 +74,7 @@ func (a abuseIPDB) check(
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: a.banResponse,
figures: map[string]any{ figures: map[string]any{
figureScore: score, "min_score": a.minScore, figureScore: score, "min_score": a.minScore,
}, },
+11 -13
View File
@@ -1,7 +1,8 @@
package waf package waf
// The heuristic active_ban, and banMaker, which makes the bans of several // The heuristic active_ban, and banMaker, which makes the bans of several
// heuristics. active_ban reads SWW_WAF_MODE; the bans are the ban ledger's. // heuristics. active_ban reads SWW_WAF_MODE and SWW_WAF_BAN_RESPONSE; the bans
// are the ban ledger's.
import ( import (
"context" "context"
@@ -16,16 +17,11 @@ import (
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// banResponse is a refusal answered with SWW_WAF_BAN_RESPONSE, and logged // activeBan refuses a client a ban covers, with SWW_WAF_BAN_RESPONSE: a ban on
// with action. // a netblock the client is in, in force at now. It notes for the log line when
func (rq *request) banResponse(action requestlog.Action) *refusal { // that ban ends. A request that makes the ban permanent, or in observe mode
return &refusal{status: rq.h.config.BanResponse, action: action} // would have, raises the alert for it. Its figures are the ban's netblock and
} // when it ends.
// activeBan refuses a client a ban covers: a ban on a netblock the client is
// in, in force at now. It notes for the log line when that ban ends. A request
// that makes the ban permanent, or in observe mode would have, raises the alert
// for it. Its figures are the ban's netblock and when it ends.
type activeBan struct { type activeBan struct {
banMaker banMaker banMaker banMaker
} }
@@ -63,6 +59,7 @@ func (a activeBan) check(
return &verdict{ return &verdict{
action: banAction(ban.Permanent()), action: banAction(ban.Permanent()),
status: a.banMaker.banResponse,
figures: map[string]any{ figures: map[string]any{
figureNetblock: ban.Netblock.String(), "ban_expires": expires, figureNetblock: ban.Netblock.String(), "ban_expires": expires,
}, },
@@ -118,8 +115,9 @@ type banMaker struct {
alerts *alerts.Queue alerts *alerts.Queue
// observe is true in observe mode (SWW_WAF_MODE). // observe is true in observe mode (SWW_WAF_MODE).
observe bool observe bool
// banResponse is SWW_WAF_BAN_RESPONSE, the status the notes of a ban for a // banResponse is SWW_WAF_BAN_RESPONSE: the status of a request refused
// clear sign of attack give. // under a ban or for a clear sign of attack, which the notes of a ban for
// a clear sign of attack give.
banResponse int banResponse int
// banScopeV4Prefix is SWW_WAF_BAN_SCOPE_V4_PREFIX and ipv6GroupPrefix // banScopeV4Prefix is SWW_WAF_BAN_SCOPE_V4_PREFIX and ipv6GroupPrefix
// SWW_WAF_IPV6_GROUP_PREFIX, which set the netblock a ban covers. // SWW_WAF_IPV6_GROUP_PREFIX, which set the netblock a ban covers.
+2
View File
@@ -4,6 +4,7 @@ package waf
import ( import (
"context" "context"
"net/http"
"sync/atomic" "sync/atomic"
"time" "time"
@@ -161,6 +162,7 @@ func (rq *request) applyFindings(
func (rq *request) timedOut(running string) *verdict { func (rq *request) timedOut(running string) *verdict {
v := &verdict{ v := &verdict{
action: requestlog.ActionChecksTimedOut, action: requestlog.ActionChecksTimedOut,
status: http.StatusServiceUnavailable,
figures: map[string]any{ figures: map[string]any{
"time_limit_ms": rq.h.besideLookupLimit.Milliseconds(), "time_limit_ms": rq.h.besideLookupLimit.Milliseconds(),
}, },
+11 -8
View File
@@ -1,7 +1,7 @@
package waf package waf
// The heuristic blocklists. It reads SWW_WAF_BLOCKLIST_ACTION, and the blocklists // The heuristic blocklists. It reads SWW_WAF_BLOCKLIST_ACTION and
// through the reputation lists. // SWW_WAF_BAN_RESPONSE, and the blocklists through the reputation lists.
import ( import (
"context" "context"
@@ -13,13 +13,15 @@ import (
) )
// blocklists notes the blocklists that list the client, as noteListed does, // blocklists notes the blocklists that list the client, as noteListed does,
// and refuses the request when SWW_WAF_BLOCKLIST_ACTION is deny. Being limit, it // and refuses the request with SWW_WAF_BAN_RESPONSE when
// lowers the client's limits instead (see limitPercentages), and being log, it // SWW_WAF_BLOCKLIST_ACTION is deny. Being limit, it lowers the client's limits
// does nothing more. Its figure is the blocklists that list the client. // instead (see limitPercentages), and being log, it does nothing more. Its
// figure is the blocklists that list the client.
type blocklists struct { type blocklists struct {
lists *reputation.Lists lists *reputation.Lists
action config.ReputationAction // SWW_WAF_BLOCKLIST_ACTION action config.ReputationAction // SWW_WAF_BLOCKLIST_ACTION
hitNoter reputationHitNoter banResponse int // SWW_WAF_BAN_RESPONSE
hitNoter reputationHitNoter
} }
func (blocklists) name() string { return "blocklists" } func (blocklists) name() string { return "blocklists" }
@@ -39,6 +41,7 @@ func (b blocklists) check(
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: b.banResponse,
figures: map[string]any{"lists": listedBy}, figures: map[string]any{"lists": listedBy},
} }
} }
+2
View File
@@ -5,6 +5,7 @@ package waf
import ( import (
"context" "context"
"net/http"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/alerts" "sneak.berlin/go/smallwebwaf/internal/alerts"
@@ -77,6 +78,7 @@ func (c coreRuleSet) check(
return &verdict{ return &verdict{
action: requestlog.ActionBlockedByCoreRuleSet, action: requestlog.ActionBlockedByCoreRuleSet,
status: http.StatusForbidden,
figures: map[string]any{ figures: map[string]any{
figureScore: result.Score, figureScore: result.Score,
"threshold": threshold, "threshold": threshold,
+8 -4
View File
@@ -1,6 +1,7 @@
package waf package waf
// The heuristic countries. It reads SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES. // The heuristic countries. It reads SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES and
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
@@ -13,10 +14,12 @@ import (
// countries refuses a request when SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES is set and // countries refuses a request when SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES is set and
// does not hold the client's country as it was looked up. A client without a // does not hold the client's country as it was looked up. A client without a
// country, or whose country cannot be found, is refused. Its figures are the // country, or whose country cannot be found, is refused. It refuses with
// country and the setting that refused it. // SWW_WAF_BAN_RESPONSE. Its figures are the country and the setting that
// refused it.
type countries struct { type countries struct {
allowed []string // SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES allowed []string // SWW_WAF_EXCLUSIVELY_ALLOWED_COUNTRIES
banResponse int // SWW_WAF_BAN_RESPONSE
} }
func (countries) name() string { return "countries" } func (countries) name() string { return "countries" }
@@ -35,6 +38,7 @@ func (c countries) check(
return &verdict{ return &verdict{
action: requestlog.ActionCountryDenied, action: requestlog.ActionCountryDenied,
status: c.banResponse,
figures: map[string]any{ figures: map[string]any{
"country": country, "country": country,
"setting": config.ExclusivelyAllowedCountriesSetting, "setting": config.ExclusivelyAllowedCountriesSetting,
+6 -4
View File
@@ -1,6 +1,6 @@
package waf package waf
// The heuristic deny_nets. It reads SWW_WAF_DENY_NETS. // The heuristic deny_nets. It reads SWW_WAF_DENY_NETS and SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
@@ -10,10 +10,11 @@ import (
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// denyNets refuses a client in SWW_WAF_DENY_NETS. Its figure is the netblock of // denyNets refuses a client in SWW_WAF_DENY_NETS, with SWW_WAF_BAN_RESPONSE.
// the setting the client is in. // Its figure is the netblock of the setting the client is in.
type denyNets struct { type denyNets struct {
netblocks []netip.Prefix // SWW_WAF_DENY_NETS netblocks []netip.Prefix // SWW_WAF_DENY_NETS
banResponse int // SWW_WAF_BAN_RESPONSE
} }
func (denyNets) name() string { return "deny_nets" } func (denyNets) name() string { return "deny_nets" }
@@ -27,6 +28,7 @@ func (d denyNets) check(
if netblock.Contains(rq.client) { if netblock.Contains(rq.client) {
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: d.banResponse,
figures: map[string]any{figureNetblock: netblock.String()}, figures: map[string]any{figureNetblock: netblock.String()},
} }
} }
+14 -10
View File
@@ -1,7 +1,8 @@
package waf package waf
// The heuristic dnsbl. It reads SWW_WAF_DNSBL_ABUSEIPDB_ACTION, and the DNSBL zones' // The heuristic dnsbl. It reads SWW_WAF_DNSBL_ABUSEIPDB_ACTION and
// verdicts through the DNSBL checker. // SWW_WAF_BAN_RESPONSE, and the DNSBL zones' verdicts through the DNSBL
// checker.
import ( import (
"context" "context"
@@ -15,15 +16,17 @@ import (
// dnsbl notes the DNSBL zones whose verdict lists the client, as noteListed // dnsbl notes the DNSBL zones whose verdict lists the client, as noteListed
// does, adds the tag dnsbl=<zone> for each, the zone's key masked, and refuses // does, adds the tag dnsbl=<zone> for each, the zone's key masked, and refuses
// the request when SWW_WAF_DNSBL_ABUSEIPDB_ACTION is deny. Being // the request with SWW_WAF_BAN_RESPONSE when SWW_WAF_DNSBL_ABUSEIPDB_ACTION is
// limit, it lowers the client's limits instead (see limitPercentages), and // deny. Being limit, it lowers the client's limits instead (see
// being log, it does nothing more. A zone without a verdict on the client is // limitPercentages), and being log, it does nothing more. A zone without a
// asked about it in the background, and the request does not wait for the // verdict on the client is asked about it in the background, and the request
// answer. Its figure is the zones that list the client, their keys masked. // does not wait for the answer. Its figure is the zones that list the client,
// their keys masked.
type dnsbl struct { type dnsbl struct {
dnsbl *reputation.DNSBL dnsbl *reputation.DNSBL
action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION action config.ReputationAction // SWW_WAF_DNSBL_ABUSEIPDB_ACTION
hitNoter reputationHitNoter banResponse int // SWW_WAF_BAN_RESPONSE
hitNoter reputationHitNoter
} }
func (dnsbl) name() string { return "dnsbl" } func (dnsbl) name() string { return "dnsbl" }
@@ -47,6 +50,7 @@ func (d dnsbl) check(
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: d.banResponse,
figures: map[string]any{"zones": listedBy}, figures: map[string]any{"zones": listedBy},
} }
} }
+3
View File
@@ -4,6 +4,7 @@ package waf
import ( import (
"context" "context"
"net/http"
"strings" "strings"
"time" "time"
@@ -39,6 +40,7 @@ func (headerLimits) check(
if requestLine > maxLineBytes { if requestLine > maxLineBytes {
return &verdict{ return &verdict{
action: requestlog.ActionRequestLineTooLong, action: requestlog.ActionRequestLineTooLong,
status: http.StatusRequestURITooLong,
figures: map[string]any{ figures: map[string]any{
"request_line_bytes": requestLine, "request_line_bytes": requestLine,
"request_line_bytes_limit": maxLineBytes, "request_line_bytes_limit": maxLineBytes,
@@ -56,6 +58,7 @@ func (headerLimits) check(
return &verdict{ return &verdict{
action: requestlog.ActionRequestHeaderTooLarge, action: requestlog.ActionRequestHeaderTooLarge,
status: http.StatusRequestHeaderFieldsTooLarge,
figures: map[string]any{ figures: map[string]any{
"longest_header_line_bytes": longest, "longest_header_line_bytes": longest,
"header_line_bytes_limit": maxLineBytes, "header_line_bytes_limit": maxLineBytes,
+5 -2
View File
@@ -42,10 +42,13 @@ type refusesWithoutLookup interface {
} }
// verdict is a heuristic refusing a request, or banning its client: the action // verdict is a heuristic refusing a request, or banning its client: the action
// the log line names, and the figures the heuristic acted on, by name, such as // the log line names, the status the visitor is answered with, and the figures
// the count and the limit. // the heuristic acted on, by name, such as the count and the limit. A status of
// 0 closes the visitor's connection without an answer. A verdict of afterAnswer
// or onReport refuses nothing, and has neither action nor status.
type verdict struct { type verdict struct {
action requestlog.Action action requestlog.Action
status int
figures map[string]any figures map[string]any
} }
+18 -11
View File
@@ -189,20 +189,25 @@ func newHandler(params Params) *handler {
routeWatch: params.RouteWatch, routeWatch: params.RouteWatch,
ipv6GroupPrefix: cfg.IPv6GroupPrefix, ipv6GroupPrefix: cfg.IPv6GroupPrefix,
}, },
denyNets{netblocks: cfg.DenyNets}, denyNets{netblocks: cfg.DenyNets, banResponse: cfg.BanResponse},
activeBan{banMaker: sharedBanMaker}, activeBan{banMaker: sharedBanMaker},
} }
h.afterLookup = []heuristic{ h.afterLookup = []heuristic{
countries{allowed: cfg.ExclusivelyAllowedCountries}, countries{
allowed: cfg.ExclusivelyAllowedCountries,
banResponse: cfg.BanResponse,
},
blocklists{ blocklists{
lists: params.Lists, lists: params.Lists,
action: cfg.BlocklistAction, action: cfg.BlocklistAction,
hitNoter: hitNoter, banResponse: cfg.BanResponse,
hitNoter: hitNoter,
}, },
dnsbl{ dnsbl{
dnsbl: params.DNSBL, dnsbl: params.DNSBL,
action: cfg.DNSBLAbuseIPDBAction, action: cfg.DNSBLAbuseIPDBAction,
hitNoter: hitNoter, banResponse: cfg.BanResponse,
hitNoter: hitNoter,
}, },
abuseIPDB{ abuseIPDB{
abuseIPDB: params.AbuseIPDB, abuseIPDB: params.AbuseIPDB,
@@ -210,10 +215,11 @@ func newHandler(params Params) *handler {
keySet: cfg.AbuseIPDBKey != "", keySet: cfg.AbuseIPDBKey != "",
minScore: cfg.AbuseIPDBMinScore, minScore: cfg.AbuseIPDBMinScore,
action: cfg.DNSBLAbuseIPDBAction, action: cfg.DNSBLAbuseIPDBAction,
banResponse: cfg.BanResponse,
ipv6GroupPrefix: cfg.IPv6GroupPrefix, ipv6GroupPrefix: cfg.IPv6GroupPrefix,
hitNoter: hitNoter, hitNoter: hitNoter,
}, },
tagDeny{tags: cfg.TagDeny}, tagDeny{tags: cfg.TagDeny, banResponse: cfg.BanResponse},
rateLimits{ rateLimits{
limiter: params.Limiter, limiter: params.Limiter,
exemptNets: cfg.RateLimitExemptNets, exemptNets: cfg.RateLimitExemptNets,
@@ -235,12 +241,13 @@ func newHandler(params Params) *handler {
}, },
} }
h.besideLookup = []heuristic{h.trapPaths, h.ruleFiles, h.coreRuleSet} h.besideLookup = []heuristic{h.trapPaths, h.ruleFiles, h.coreRuleSet}
h.afterBesideLookup = []heuristic{tagDeny{tags: cfg.TagDeny}} h.afterBesideLookup = []heuristic{
tagDeny{tags: cfg.TagDeny, banResponse: cfg.BanResponse},
}
h.afterAnswer = []heuristic{ h.afterAnswer = []heuristic{
refusalLimit{ refusalLimit{
limiter: params.Limiter, limiter: params.Limiter,
perMinute: cfg.RefusalsLimitPerMinute, perMinute: cfg.RefusalsLimitPerMinute,
banResponse: cfg.BanResponse,
ipv6GroupPrefix: cfg.IPv6GroupPrefix, ipv6GroupPrefix: cfg.IPv6GroupPrefix,
banMaker: sharedBanMaker, banMaker: sharedBanMaker,
}, },
+6 -4
View File
@@ -17,9 +17,9 @@ import (
// countedByRateLimits exempts it, by the client's limit percentages, which it // countedByRateLimits exempts it, by the client's limit percentages, which it
// notes for the log line with the client's counts. A request that takes the // notes for the log line with the client's counts. A request that takes the
// client over a rate limit, as its limit percentage lowers it, breaks it: it is // client over a rate limit, as its limit percentage lowers it, breaks it: it is
// refused, and bans the client. A request exempt from the rate limits is exempt // refused with SWW_WAF_BAN_RESPONSE, and bans the client. A request exempt
// from the byte limits too. Its figures are the window, the count and the // from the rate limits is exempt from the byte limits too. Its figures are the
// limit. // window, the count and the limit.
type rateLimits struct { type rateLimits struct {
limiter *ratelimit.Limiter limiter *ratelimit.Limiter
exemptNets []netip.Prefix // SWW_WAF_RATE_LIMIT_EXEMPT_NETS exemptNets []netip.Prefix // SWW_WAF_RATE_LIMIT_EXEMPT_NETS
@@ -63,7 +63,9 @@ func (r rateLimits) check(
r.banMaker.banForLimit(rq, now, hit, r.banResponse) r.banMaker.banForLimit(rq, now, hit, r.banResponse)
return &verdict{ return &verdict{
action: requestlog.ActionClientIsRateLimited, figures: limitFigures(hit), action: requestlog.ActionClientIsRateLimited,
status: r.banResponse,
figures: limitFigures(hit),
} }
} }
+4 -27
View File
@@ -1,15 +1,12 @@
package waf package waf
// The heuristic refusal_limit. It reads SWW_WAF_REFUSALS_LIMIT_PER_MINUTE and // The heuristic refusal_limit. It reads SWW_WAF_REFUSALS_LIMIT_PER_MINUTE.
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
"net/http"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/ratelimit" "sneak.berlin/go/smallwebwaf/internal/ratelimit"
"sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// refusalLimit counts the request once it has been answered, if waf // refusalLimit counts the request once it has been answered, if waf
@@ -18,11 +15,11 @@ import (
// SWW_WAF_REFUSALS_LIMIT_PER_MINUTE such refusals of the client within a minute break // SWW_WAF_REFUSALS_LIMIT_PER_MINUTE such refusals of the client within a minute break
// a limit, which bans the client. A client in SWW_WAF_ALLOW_NETS, which the // a limit, which bans the client. A client in SWW_WAF_ALLOW_NETS, which the
// heuristics skip, is not counted, and nothing is while the limit is off. // heuristics skip, is not counted, and nothing is while the limit is off.
// Its figures are the window, the count and the limit. // The ban's notes give the status the client was sent, or in observe mode
// would have been. Its figures are the window, the count and the limit.
type refusalLimit struct { type refusalLimit struct {
limiter *ratelimit.Limiter limiter *ratelimit.Limiter
perMinute int64 // SWW_WAF_REFUSALS_LIMIT_PER_MINUTE perMinute int64 // SWW_WAF_REFUSALS_LIMIT_PER_MINUTE
banResponse int // SWW_WAF_BAN_RESPONSE
ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX ipv6GroupPrefix int // SWW_WAF_IPV6_GROUP_PREFIX
banMaker banMaker banMaker banMaker
} }
@@ -51,27 +48,7 @@ func (r refusalLimit) check(
return nil return nil
} }
// What the client was sent, or in observe mode would have been. r.banMaker.banForLimit(rq, now, hit, rq.refusalStatus)
status := rq.out.status
switch rq.wouldAction {
case requestlog.ActionBlockedByBlockRule,
requestlog.ActionBlockedByCoreRuleSet:
status = http.StatusForbidden
case requestlog.ActionTemporarilyBanned,
requestlog.ActionPermanentlyBanned:
status = r.banResponse
case requestlog.ActionForward,
requestlog.ActionRequestLineTooLong,
requestlog.ActionRequestHeaderTooLarge,
requestlog.ActionClientIsRateLimited,
requestlog.ActionClientDenied,
requestlog.ActionCountryDenied,
requestlog.ActionChecksTimedOut,
requestlog.ActionOwnEndpoint:
}
r.banMaker.banForLimit(rq, now, hit, status)
return &verdict{figures: limitFigures(hit)} return &verdict{figures: limitFigures(hit)}
} }
+12 -25
View File
@@ -69,6 +69,10 @@ type decision struct {
// its client's history counts. trapPaths and ruleFiles set attack, // its client's history counts. trapPaths and ruleFiles set attack,
// ruleFiles blockedByBlockRule, and coreRuleSet blockedByCoreRuleSet. // ruleFiles blockedByBlockRule, and coreRuleSet blockedByCoreRuleSet.
attack, blockedByBlockRule, blockedByCoreRuleSet bool attack, blockedByBlockRule, blockedByCoreRuleSet bool
// refusalStatus is the status of the verdict that refused the request, or
// in observe mode would have: what the visitor was answered with, or would
// have been. check sets it.
refusalStatus int
// wouldAction is, in observe mode, the action enforce mode would have // wouldAction is, in observe mode, the action enforce mode would have
// refused the request with, one of requestlog's Action constants, and "" // refused the request with, one of requestlog's Action constants, and ""
// otherwise. check sets it. // otherwise. check sets it.
@@ -203,9 +207,8 @@ func requestHeaders(r *http.Request, names []string) map[string]string {
// check is the one place where a request can be refused. It returns nil to let // check is the one place where a request can be refused. It returns nil to let
// the request through. The heuristics of checkClient decide: a request they // the request through. The heuristics of checkClient decide: a request they
// refuse is answered with SWW_WAF_BAN_RESPONSE, 403 for a block rule or the Core // refuse is answered with the status and logged with the action of the verdict
// Rule Set, 503 for heuristics that ran out of time, or 414 or 431 for the // that refused it. In observe mode nothing is refused, and the log line names
// header limits. In observe mode nothing is refused, and the log line names
// what enforce mode would have done. ctx is the request's own context. // what enforce mode would have done. ctx is the request's own context.
func (rq *request) check(ctx context.Context) *refusal { func (rq *request) check(ctx context.Context) *refusal {
v := rq.checkClient(ctx) v := rq.checkClient(ctx)
@@ -213,32 +216,16 @@ func (rq *request) check(ctx context.Context) *refusal {
return nil return nil
} }
action := v.action rq.refusalStatus = v.status
switch { if rq.h.config.Observe {
case rq.h.config.Observe: rq.wouldAction = v.action
rq.wouldAction = action rq.line.WouldAction = v.action
rq.line.WouldAction = action
return nil return nil
case action == requestlog.ActionBlockedByBlockRule ||
action == requestlog.ActionBlockedByCoreRuleSet:
return &refusal{status: http.StatusForbidden, action: action}
case action == requestlog.ActionChecksTimedOut:
return &refusal{
status: http.StatusServiceUnavailable,
action: action,
}
case action == requestlog.ActionRequestLineTooLong:
return &refusal{status: http.StatusRequestURITooLong, action: action}
case action == requestlog.ActionRequestHeaderTooLarge:
return &refusal{
status: http.StatusRequestHeaderFieldsTooLarge,
action: action,
}
default:
return rq.banResponse(action)
} }
return &refusal{status: v.status, action: v.action}
} }
// checkClient runs the heuristics on the request, and returns the first // checkClient runs the heuristics on the request, and returns the first
+8 -3
View File
@@ -1,10 +1,12 @@
package waf package waf
// The heuristic rule_files. It reads the rules of the rule files, which // The heuristic rule_files. It reads the rules of the rule files, which
// SWW_WAF_RULE_FILES_DIR and SWW_WAF_RULE_FILES_ENABLED name. // SWW_WAF_RULE_FILES_DIR and SWW_WAF_RULE_FILES_ENABLED name, and
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
"net/http"
"time" "time"
"sneak.berlin/go/smallwebwaf/internal/bans" "sneak.berlin/go/smallwebwaf/internal/bans"
@@ -17,8 +19,9 @@ import (
// ruleFiles takes the rules of the rule files the request matched, which // ruleFiles takes the rules of the rule files the request matched, which
// findBesideLookup found, notes their ids in the log line, adds the tag // findBesideLookup found, notes their ids in the log line, adds the tag
// exploitsignature when it matches any, and refuses the request // exploitsignature when it matches any, and refuses the request
// when the last rule it matches refuses it: with ActionBlockedByBlockRule for a // when the last rule it matches refuses it: with 403 and
// block rule, and for a ban rule with the action for the ban it makes. A ban // ActionBlockedByBlockRule for a block rule, and for a ban rule with
// SWW_WAF_BAN_RESPONSE and the action for the ban it makes. A ban
// rule bans the client's netblock for a clear sign of attack, or in observe // rule bans the client's netblock for a clear sign of attack, or in observe
// mode raises the alert for the ban // mode raises the alert for the ban
// it would have made. Either rule's match is noted as an offence, for the // it would have made. Either rule's match is noted as an offence, for the
@@ -59,6 +62,7 @@ func (r ruleFiles) check(
return &verdict{ return &verdict{
action: requestlog.ActionBlockedByBlockRule, action: requestlog.ActionBlockedByBlockRule,
status: http.StatusForbidden,
figures: figures, figures: figures,
} }
case rules.ActionBan: case rules.ActionBan:
@@ -70,6 +74,7 @@ func (r ruleFiles) check(
now, now,
bans.Notes{RuleID: last.ID, Target: last.Target}, bans.Notes{RuleID: last.ID, Target: last.Target},
), ),
status: r.banMaker.banResponse,
figures: figures, figures: figures,
} }
case rules.ActionLog: case rules.ActionLog:
+6 -4
View File
@@ -1,6 +1,6 @@
package waf package waf
// The heuristic tag_deny. It reads SWW_WAF_TAG_DENY. // The heuristic tag_deny. It reads SWW_WAF_TAG_DENY and SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
@@ -10,10 +10,11 @@ import (
"sneak.berlin/go/smallwebwaf/internal/requestlog" "sneak.berlin/go/smallwebwaf/internal/requestlog"
) )
// tagDeny refuses a request that carries a tag in SWW_WAF_TAG_DENY. Its figure is // tagDeny refuses a request that carries a tag in SWW_WAF_TAG_DENY, with
// the first such tag, in sorted order. // SWW_WAF_BAN_RESPONSE. Its figure is the first such tag, in sorted order.
type tagDeny struct { type tagDeny struct {
tags []string // SWW_WAF_TAG_DENY tags []string // SWW_WAF_TAG_DENY
banResponse int // SWW_WAF_BAN_RESPONSE
} }
func (tagDeny) name() string { return "tag_deny" } func (tagDeny) name() string { return "tag_deny" }
@@ -27,6 +28,7 @@ func (t tagDeny) check(
if slices.Contains(t.tags, tag) { if slices.Contains(t.tags, tag) {
return &verdict{ return &verdict{
action: requestlog.ActionClientDenied, action: requestlog.ActionClientDenied,
status: t.banResponse,
figures: map[string]any{"tag": tag}, figures: map[string]any{"tag": tag},
} }
} }
+7 -5
View File
@@ -1,6 +1,7 @@
package waf package waf
// The heuristic trap_paths. It reads SWW_WAF_TRAP_PATHS. // The heuristic trap_paths. It reads SWW_WAF_TRAP_PATHS and
// SWW_WAF_BAN_RESPONSE.
import ( import (
"context" "context"
@@ -12,10 +13,10 @@ import (
) )
// trapPaths refuses a request for a path in SWW_WAF_TRAP_PATHS, as trapPath // trapPaths refuses a request for a path in SWW_WAF_TRAP_PATHS, as trapPath
// finds it. Such a request is a clear sign of attack, as a ban rule's match is: // finds it, with SWW_WAF_BAN_RESPONSE. Such a request is a clear sign of
// it bans the client's netblock, or in observe mode raises the alert for the // attack, as a ban rule's match is: it bans the client's netblock, or in
// ban it would have made. The ban's notes give the path as sent, and so does // observe mode raises the alert for the ban it would have made. The ban's
// its figure. // notes give the path as sent, and so does its figure.
type trapPaths struct { type trapPaths struct {
paths []string // SWW_WAF_TRAP_PATHS paths []string // SWW_WAF_TRAP_PATHS
banMaker banMaker banMaker banMaker
@@ -41,6 +42,7 @@ func (t trapPaths) check(
now, now,
bans.Notes{TrapPath: path}, bans.Notes{TrapPath: path},
), ),
status: t.banMaker.banResponse,
figures: map[string]any{"path": path}, figures: map[string]any{"path": path},
} }
} }