Give ban causes, limit kinds, alert events, actions and dispositions named types (closes #428) #464
Open
clawbot
wants to merge 1 commits from
issue-428-named-value-types into next
pull from: issue-428-named-value-types
merge into: sneak:next
sneak:main
sneak:issue-447-config-above-the-parts
sneak:next
sneak:issue-448-config-setting-name-constants
sneak:issue-438-metrics-params
sneak:issue-426-chi-routes
sneak:issue-440-cobra-commands
sneak:issue-441-heuristic-structs
sneak:issue-425-wafprotocol-package
sneak:issue-439-stop-asks-at-stop
sneak:issue-429-dirwatch
sneak:issue-436-server-exports-no-parts
sneak:issue-434-core-rule-set-in-sww
sneak:issue-430-app-fixes-directory
sneak:issue-431-body-wrapper-fields
sneak:issue-433-report-goroutines
sneak:issue-427-typed-fixed-value-settings
sneak:issue-411-abuseipdb-blacklist
sneak:issue-414-fx-wiring
sneak:issue-420-tests-under-load
sneak:issue-381-compose-waf-settings
sneak:issue-412-anomaly-alert-only
sneak:issue-418-test-time-limits
sneak:issue-415-header-limit-test
sneak:issue-406-parallel-tests
sneak:issue-405-decide-beside-lookup
sneak:issue-404-geojs-package
sneak:issue-401-one-cookie-line
sneak:issue-400-coreruleset-timing-ref
sneak:issue-398-breaker-test-without-questions
sneak:issue-400-coreruleset-timing
sneak:issue-396-no-own-hosts
sneak:issue-394-decide-in-time
sneak:issue-392-rproxy-circuit-breaker
sneak:issue-388-any-tls-proxy
sneak:issue-386-readme-rproxy-alone
sneak:issue-387-readme-scraper-policy
sneak:issue-339-long-line-limits
sneak:issue-379-lookup-headers-by-default
sneak:issue-315-remove-crowdsec
sneak:issue-354-package-registry-searches
sneak:issue-353-api-searches
sneak:issue-234-rename-settings
sneak:issue-359-ghost-remaining-fields
sneak:issue-373-read-rest-after-connection-close
sneak:issue-374-ghost-canonical-url
sneak:issue-371-body-over-limit-test-reset
sneak:issue-358-ghost-scripts
sneak:issue-211-viper-config
sneak:issue-357-ghost
sneak:issue-346-names-in-bodies
sneak:issue-365-adopt-form-repository-names
sneak:issue-220-apps-by-hostname
sneak:issue-352-shared-searches
sneak:issue-215-golines
sneak:issue-227-settings-file-per-daemon
sneak:issue-350-forgejo-searches
sneak:issue-349-gitea-user-page-ls
sneak:issue-287-crs-test-cpu
sneak:issue-284-wordpress-recorded-both-ways
sneak:readme-rewrite-155
No Reviewers
Labels
Clear labels
critical
merge-ready
needs-checks
needs-decision
needs-decision
needs-decision
needs-rebase
needs-review
needs-rework
not-one-pr
post-1.0
red-next
Extremely important: data loss, a security hole, production down, or basic use impossible
Reviewed and ready for the owner to merge
Checks must be fixed before review
Waits on an owner decision
Waiting on a decision by the owner
Conflicts with next; rebase required
Review not yet done
Review found issues to fix
No labels
needs-review
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: sneak/smallwebwaf#464
Reference in new issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Closes #428.
Each fixed set of string constants is now a named string type in the package that owns it. Fields, parameters and comparisons use it. Every value keeps its string, so the logs, state files, alerts and metrics are unchanged.
New types:
bans.Cause: why a ban was made.ratelimit.LimitKind: what a limit counts (requests, bytes or refusals).bans.Notes.Kinduses it, sobansnow importsratelimit.alerts.Event: what an alert is for.config.WAF.AlertEventsis[]alerts.Event.alerts.Destination: where alerts are sent.rules.Action: what a rule does when it matches.requestlog.Action: what waf did with a request, as its log line names it.requestlog.Offence: what a request was held as.requestlog.WAFLine: which of waf's two lines a request line is.waf.Disposition: what waf tells rproxy to do with a request.What the diff does not show:
WAFBackendNoAnswerDispositionandrequestlog.Line.Dispositionstaystring.wafimportsconfigandrequestlog, so neither can importwaf.Disposition. They can take the type once #425 moves the dispositions to a package below both.string(cause)andstring(kind), so a detail in memory equals one read back fromalerts.json.anyholding a named type never equals a plain string. Tests that compare decoded JSON with a constant therefore convert it withstring(...).exhaustiveasked for cases in seven switches. Where adefaultreturned a value, the listed cases now fall through to that same return after the switch.Model: opus-5-5
Verdict: FAIL
Head:
58dafa1876string:WAFBackendNoAnswerDispositionininternal/config/rproxy.goandDispositiononrequestlog.Lineininternal/requestlog/requestlog.go.WAFBackendNoAnswerDispositionexplicitly.env.dispositionstill checks the literals"allow"and"deny", andinternal/rproxyconverts withwaf.Disposition(...)andstring(...).wafimports bothconfigandrequestlog, so neither field can usewaf.Disposition. The type belongs in a package below both, and thewafprotocolpackage from #461 is that package.next, rebase onto it and declareDispositionwith its three constants ininternal/wafprotocol. Give both fields, andwafprotocol.Answer.Disposition, that type. Haveenv.dispositioncompare against the constants and return the type. Remove the conversions ininternal/rproxy.Sequencing: this finding can only be acted on after #461 is merged.
Model: opus-5-5
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.