[9.x] Allow VerifyCsrfToken's CSRF cookie to be extended#41342
Merged
taylorotwell merged 4 commits intoMar 4, 2022
Conversation
VerifyCsrfToken's CSRF cookie to be extended much easier VerifyCsrfToken's CSRF cookie to be extended
X-Coder264
reviewed
Mar 4, 2022
thugic
reviewed
Mar 4, 2022
Comment on lines
+205
to
+211
| protected function newCookie($request, $config) | ||
| { | ||
| return new Cookie( | ||
| 'XSRF-TOKEN', $request->session()->token(), $this->availableAt(60 * $config['lifetime']), | ||
| $config['path'], $config['domain'], $config['secure'], false, false, $config['same_site'] ?? null | ||
| ); | ||
| } |
There was a problem hiding this comment.
Why not just passing the request, since the only usage of the method is this one, you could just get the config in there, if missing? (Then you could remove src/Illuminate/Foundation/Http/Middleware/VerifyCsrfToken.php:185)
Suggested change
| protected function newCookie($request, $config) | |
| { | |
| return new Cookie( | |
| 'XSRF-TOKEN', $request->session()->token(), $this->availableAt(60 * $config['lifetime']), | |
| $config['path'], $config['domain'], $config['secure'], false, false, $config['same_site'] ?? null | |
| ); | |
| } | |
| protected function newCookie($request, $config = null) | |
| { | |
| $config = $config ?: config('session'); | |
| return new Cookie( | |
| 'XSRF-TOKEN', $request->session()->token(), $this->availableAt(60 * $config['lifetime']), | |
| $config['path'], $config['domain'], $config['secure'], false, false, $config['same_site'] ?? null | |
| ); | |
| } |
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
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.
This PR moves how the CSRF token is created to its own method.
Why?
There are some cases in multi-tenant systems that the user might want to change the CSRF token name to prevent 419 errors. Multiple Auth providers make this happen as well mainly in XHR requests. This also allows multi-tenant systems to update the token's domain (ie, pull the current tenant's custom domain) from the middleware layer.
I think this is going to help a lot with people using Inertia to allow customization in how
XSRF-TOKENis named by adding the tenant ID, or even the user type.By allowing the cookie to be extended in user-land, the user can create 2 different
VerifyCsrfTokenclasses and allow it to be modified without having to extend the wholeaddCookieToResponsemethod.