Give ban causes, limit kinds, alert events, actions and dispositions named types (closes #428)
check / check (push) Failing after 2m7s

Each fixed set of string constants becomes a named string type in the
package that owns it, and the fields and parameters that carry it use
the type: bans.Cause, ratelimit.LimitKind, alerts.Event,
alerts.Destination, rules.Action, requestlog.Action, requestlog.Offence,
requestlog.WAFLine and waf.Disposition. Every value keeps its string,
so the logs, state files, alerts and metrics do not change.

The switches exhaustive now checks list their missing cases.

Model: opus-5-5
This commit is contained in:
sneak committed 2026-11-19 18:46:07 +00:00
1 parent 98d7432077
commit fde205af50
41 files changed
+347 -239

No files matched your search

+11 -6
View File
@@ -17,7 +17,7 @@ import (
// banResponse is a refusal answered with SWW_WAF_BAN_RESPONSE, and logged
// with action.
func (rq *request) banResponse(action string) *refusal {
func (rq *request) banResponse(action requestlog.Action) *refusal {
return &refusal{status: rq.h.config.BanResponse, action: action}
}
@@ -63,7 +63,7 @@ func (activeBan) check(
// banAction is the action of a request refused under a ban or for making one:
// permanent says the ban never runs out.
func banAction(permanent bool) string {
func banAction(permanent bool) requestlog.Action {
if permanent {
return requestlog.ActionPermanentlyBanned
}
@@ -116,7 +116,7 @@ func (rq *request) banForLimit(
rq.line.LimitHit = hit.Window + "_bytes" // as counts names the byte totals
case ratelimit.KindRefusals:
rq.line.LimitHit = requestlog.LimitHitMinuteRefusals
default:
case ratelimit.KindRequests:
rq.line.LimitHit = hit.Window
}
@@ -147,6 +147,7 @@ func (rq *request) banForLimit(
notes.LimitPercent, notes.LimitPercentSetting = rq.rateLimitPercent.logged()
case ratelimit.KindBytes:
notes.LimitPercent, notes.LimitPercentSetting = rq.bytesLimitPercent.logged()
case ratelimit.KindRefusals: // the refusal limit is not lowered
}
if rq.h.config.Observe {
@@ -172,7 +173,9 @@ func (rq *request) banForLimit(
// asked for. It fills in the rest of the notes. In observe mode it makes
// no ban, and raises the alert for the ban it would have made, if that
// alert would be sent. It returns the action for that ban.
func (rq *request) banForAttack(now time.Time, notes bans.Notes) string {
func (rq *request) banForAttack(
now time.Time, notes bans.Notes,
) requestlog.Action {
netblock := banNetblock(rq.h.config, rq.client)
if rq.h.config.Observe &&
!rq.wouldAlertBan(netblock, now, bans.CauseAttack) {
@@ -213,7 +216,7 @@ func (rq *request) banForAttack(now time.Time, notes bans.Notes) string {
// SWW_WAF_ALERT_COOLDOWN and never with no webhook set: its notes count the
// netblock's requests, which can mean going through every client.
func (rq *request) wouldAlertBan(
netblock netip.Prefix, now time.Time, cause string,
netblock netip.Prefix, now time.Time, cause bans.Cause,
) bool {
event := alerts.EventBan
if rq.h.ledger.WouldBePermanent(netblock, now, cause) {
@@ -235,7 +238,9 @@ func (rq *request) alertBan(ban bans.Ban) {
}
detail := map[string]any{
"cause": ban.Cause, "ban_expires": banExpires(ban), "notes": ban.Notes,
"cause": string(ban.Cause),
"ban_expires": banExpires(ban),
"notes": ban.Notes,
}
if rq.h.config.Observe {
detail["mode"] = "observe"