waf: list its own endpoints on a chi router in routes.go (closes #426) #459
Open
clawbot
wants to merge 2 commits from
issue-426-chi-routes into next
pull from: issue-426-chi-routes
merge into: sneak:next
sneak:main
sneak:next
sneak:issue-440-cobra-commands
sneak:issue-441-heuristic-structs
sneak:issue-425-wafprotocol-package
sneak:issue-428-named-value-types
sneak:issue-439-stop-asks-at-stop
sneak:issue-429-dirwatch
sneak:issue-438-metrics-params
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#459
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.
internal/waf/routes.gonow lists every one ofwaf's own endpoints on achirouter. One middleware checks a token, and a second writes each request's log line.answerOwnEndpoint,answerAdminandendpoint()are gone, and the endpoint handlers are no longer methods onrequest. A question never reaches the router:ServeHTTPstill answers it first.closes #426
New names:
routes.go: the router ofwaf's own endpoints and its middleware.routes: returns that router.matchDecodedPath: has the router match the decoded path.chimatches the path as sent when it is encoded unusually, so/_sww/%68ealthzwould otherwise answer 404. The new testTestHealthEndpointIsFoundAtItsPathPercentEncodedcovers it.logOwnEndpoint: writes the log line with the actionown_endpoint.countedBody: a request body that counts the bytes read of it, forrequest_bytes.requireToken: lets a request through only with the token. It answers 404 while the token is unset, and 401 without it.answerNotFound: the 404 for a path with no endpoint, and for a method the path has none for. It replaceschi's 405.handleHealth,handleListBans,handleAddBan,handleLiftBans,handleShowClient,handleReport: each answers its endpoint.handler.ownEndpoints: the router, built once innewHandler.Things the diff does not show:
chiwraps in the group's middleware, so an unknown path still writes its line.request_bytes4097, the bytes actually read, where it logged 4096.http.MaxBytesReaderreads one byte past its limit.Model: opus-5-5
Verdict: PASS
Head:
e84156ef04routes.golists every one ofwaf's own endpoints on achirouter behind one token middleware, keeps each answer, token check and log line as before, and meets the definition of done of #426.request_bytes4097 where it logged 4096. I accepted this, since 4097 is the bytes read, which is howdocs/request-log.mddefines the field.Model: opus-5-5
Verdict: PASS
Head:
b7e7557047routes.golists every one ofwaf's own endpoints on achirouter behind one token middleware and one log middleware, keeps every answer and log line as before but for the case below, and meets the definition of done of #426.request_bytes4097 where it logged 4096. I accepted this, sincedocs/request-log.mddefines the field as the bytes read.Model: opus-5-5
View command line instructions
Checkout
From your project repository, check out a new branch and test the changes.