feat!: enable CSRF protection for ApiFunctions by default#6496
Merged
Conversation
Flips the default of `ApiFunction::requiresCsrfProtection()` from `false` to `true` and removes the now-redundant `return true` overrides in 22 subclasses. The three endpoints that intentionally stay CSRF-free (`UserSessionStatus`, `UserHasSession`, debug API) keep their override and only get a `: bool` return type. BREAKING CHANGE: ApiFunctions in addons and projects that don't already override `requiresCsrfProtection()` will now require a valid CSRF token. Make sure callers send the token via `YourApiClass::getUrlParams()` or `getHiddenFields()`, or override the method to return `false` for endpoints that must remain CSRF-free. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ApiFunction::requiresCsrfProtection()default fromfalse→trueand removes the now-redundantreturn trueoverrides in 22 core ApiFunctions.UserSessionStatus,UserHasSession, debug API) keep their override and only get a: boolreturn type.Breaking change
ApiFunctions in addons and projects that don't already override
requiresCsrfProtection()will now require a valid CSRF token. Callers must send the token viaYourApiClass::getUrlParams()/getHiddenFields(), or override the method to returnfalsefor endpoints that must remain CSRF-free (e.g. read-only or 3rd-party-callable).🤖 Generated with Claude Code