Fix AdminGroupSchema CSRF protection
#9333
Merged
Conversation
This file contains 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
Doing `super().__init__(validator=username_validator)` overrides the Colander schema's global validator function, with the result that the base `CSRFSchema` class's `validator()` method never gets called and there is no CSRF protection. Replace this with a subclass `validator()` method that calls the superclass's method first.
seanh
changed the title
AdminGroupSchema CSRF protection
seanh
commented
Feb 7, 2025
| @@ -139,7 +139,7 @@ def group_organization_select_widget(_node, kwargs): | |||
|
|
|||
| class AdminGroupSchema(CSRFSchema): | |||
| def __init__(self, *args): | |||
| super().__init__(validator=username_validator, *args) # noqa: B026 | |||
| super().__init__(*args) | |||
There was a problem hiding this comment.
The *args looks like it's unused: we never instantiate AdminGroupSchema() with any arguments. But in fact Colander itself does instantiate further AdminGroupSchema instances for us, with arguments.
seanh
commented
Feb 7, 2025
Comment on lines
+21
to
+31
| def test_it_raises_if_csrf_token_missing(self, group_data, bound_schema): | ||
| del bound_schema.bindings["request"].headers["X-CSRF-Token"] | ||
|
|
||
| with pytest.raises(BadCSRFToken): | ||
| bound_schema.deserialize(group_data) | ||
|
|
||
| def test_it_raises_if_csrf_token_wrong(self, group_data, bound_schema): | ||
| bound_schema.bindings["request"].headers["X-CSRF-Token"] = "foobar" | ||
|
|
||
| with pytest.raises(BadCSRFToken): | ||
| bound_schema.deserialize(group_data) |
There was a problem hiding this comment.
By default Pyramid will read the CSRF token from either a csrf_token form field or an X-CSRF-Token header. In practice our pages use the form field. But our tests use the header (via the pyramid_csrf_request fixture).
There was a problem hiding this comment.
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
tests/unit/h/schemas/forms/admin/group_test.py:27
- Add a test case to ensure that the
username_validatoris called in thevalidatormethod.
def test_it_raises_if_csrf_token_wrong(self, group_data, bound_schema):
robertknight
approved these changes
Feb 11, 2025
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.
Doing
super().__init__(validator=username_validator)overrides the Colander schema's global validator function, with the result that the baseCSRFSchemaclass'svalidator()method never gets called and there is no CSRF protection.Replace this with a subclass
validator()method that calls the superclass's method first.This is the same way as it's done in several other
CSRFSchemasubclasses throughout the code.Testing
"csrf_token"form fieldOn
mainthe form submission will succeed with no CSRF token. On this branch it'll fail.