-
-
Notifications
You must be signed in to change notification settings - Fork 498
Enable stateless headers/cookies-based CSRF protection #1337
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
// register any custom, 3rd party controllers here | ||
// app.register('some_controller_name', SomeImportedController); |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"controllers": [], | ||
"entrypoints": [] | ||
} |
60 changes: 60 additions & 0 deletions
60
symfony/stimulus-bundle/2.20/assets/controllers/csrf_protection_controller.js
nicolas-grekas marked this conversation as resolved.
Show resolved
Hide resolved
nicolas-grekas marked this conversation as resolved.
Show resolved
Hide resolved
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
var nameCheck = /^[-_a-zA-Z0-9]{4,22}$/; | ||
var tokenCheck = /^[-_/+a-zA-Z0-9]{24,}$/; | ||
|
||
// Generate and double-submit a CSRF token in a form field and a cookie, as defined by Symfony's SameOriginCsrfTokenManager | ||
document.addEventListener('submit', function (event) { | ||
var csrfField = event.target.querySelector('input[data-controller="csrf-protection"]'); | ||
|
||
if (!csrfField) { | ||
return; | ||
} | ||
|
||
var csrfCookie = csrfField.getAttribute('data-csrf-protection-cookie-value'); | ||
var csrfToken = csrfField.value; | ||
|
||
if (!csrfCookie && nameCheck.test(csrfToken)) { | ||
csrfField.setAttribute('data-csrf-protection-cookie-value', csrfCookie = csrfToken); | ||
csrfField.value = csrfToken = btoa(String.fromCharCode.apply(null, (window.crypto || window.msCrypto).getRandomValues(new Uint8Array(18)))); | ||
} | ||
|
||
if (csrfCookie && tokenCheck.test(csrfToken)) { | ||
var cookie = csrfCookie + '_' + csrfToken + '=' + csrfCookie + '; path=/; samesite=strict'; | ||
document.cookie = window.location.protocol === 'https:' ? '__Host-' + cookie + '; secure' : cookie; | ||
} | ||
}); | ||
|
||
// When @hotwired/turbo handles form submissions, send the CSRF token in a header in addition to a cookie | ||
// The `framework.csrf_protection.check_header` config option needs to be enabled for the header to be checked | ||
document.addEventListener('turbo:submit-start', function (event) { | ||
var csrfField = event.detail.formSubmission.formElement.querySelector('input[data-controller="csrf-protection"]'); | ||
|
||
if (!csrfField) { | ||
return; | ||
} | ||
|
||
var csrfCookie = csrfField.getAttribute('data-csrf-protection-cookie-value'); | ||
|
||
if (tokenCheck.test(csrfField.value) && nameCheck.test(csrfCookie)) { | ||
event.detail.formSubmission.fetchRequest.headers[csrfCookie] = csrfField.value; | ||
} | ||
}); | ||
|
||
// When @hotwired/turbo handles form submissions, remove the CSRF cookie once a form has been submitted | ||
document.addEventListener('turbo:submit-end', function (event) { | ||
var csrfField = event.detail.formSubmission.formElement.querySelector('input[data-controller="csrf-protection"]'); | ||
|
||
if (!csrfField) { | ||
return; | ||
} | ||
|
||
var csrfCookie = csrfField.getAttribute('data-csrf-protection-cookie-value'); | ||
|
||
if (tokenCheck.test(csrfField.value) && nameCheck.test(csrfCookie)) { | ||
var cookie = csrfCookie + '_' + csrfField.value + '=0; path=/; samesite=strict; max-age=0'; | ||
|
||
document.cookie = window.location.protocol === 'https:' ? '__Host-' + cookie + '; secure' : cookie; | ||
} | ||
}); | ||
|
||
/* stimulusFetch: 'lazy' */ | ||
export default 'csrf-protection-controller'; |
16 changes: 16 additions & 0 deletions
16
symfony/stimulus-bundle/2.20/assets/controllers/hello_controller.js
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
import { Controller } from '@hotwired/stimulus'; | ||
|
||
/* | ||
* This is an example Stimulus controller! | ||
* | ||
* Any element with a data-controller="hello" attribute will cause | ||
* this controller to be executed. The name "hello" comes from the filename: | ||
* hello_controller.js -> "hello" | ||
* | ||
* Delete this file or adapt it for your use! | ||
*/ | ||
export default class extends Controller { | ||
connect() { | ||
this.element.textContent = 'Hello Stimulus! Edit me in assets/controllers/hello_controller.js'; | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
{ | ||
"bundles": { | ||
"Symfony\\UX\\StimulusBundle\\StimulusBundle": ["all"] | ||
}, | ||
"copy-from-recipe": { | ||
"assets/": "assets/" | ||
}, | ||
"aliases": ["stimulus", "stimulus-bundle"], | ||
"conflict": { | ||
"symfony/framework-bundle": "<7.2", | ||
"symfony/security-csrf": "<7.2", | ||
"symfony/webpack-encore-bundle": "<2.0", | ||
"symfony/flex": "<1.20.0 || >=2.0.0,<2.3.0" | ||
}, | ||
"add-lines": [ | ||
{ | ||
"file": "webpack.config.js", | ||
"content": "\n // enables the Symfony UX Stimulus bridge (used in assets/bootstrap.js)\n .enableStimulusBridge('./assets/controllers.json')", | ||
"position": "after_target", | ||
"target": ".splitEntryChunks()" | ||
}, | ||
{ | ||
"file": "assets/app.js", | ||
"content": "import './bootstrap.js';", | ||
"position": "top", | ||
"warn_if_missing": true | ||
}, | ||
{ | ||
"file": "assets/bootstrap.js", | ||
"content": "import { startStimulusApp } from '@symfony/stimulus-bridge';\n\n// Registers Stimulus controllers from controllers.json and in the controllers/ directory\nexport const app = startStimulusApp(require.context(\n '@symfony/stimulus-bridge/lazy-controller-loader!./controllers',\n true,\n /\\.[jt]sx?$/\n));", | ||
"position": "top", | ||
"requires": "symfony/webpack-encore-bundle" | ||
}, | ||
{ | ||
"file": "assets/bootstrap.js", | ||
"content": "import { startStimulusApp } from '@symfony/stimulus-bundle';\n\nconst app = startStimulusApp();", | ||
"position": "top", | ||
"requires": "symfony/asset-mapper" | ||
} | ||
] | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
{ | ||
"conflict": { | ||
"symfony/framework-bundle": "<7.2", | ||
"symfony/security-csrf": "<7.2" | ||
}, | ||
"add-lines": [ | ||
{ | ||
"file": "config/packages/framework.yaml", | ||
"position": "after_target", | ||
"target": " csrf_protection:", | ||
"content": " check_header: true" | ||
} | ||
] | ||
} |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.