Add logging to CsrfTokenRequestHandler implementations #16994
Conversation
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
Add trace-level logging to show the logical path of CSRF token processing - Log token source (header or parameter) in resolveCsrfTokenValue - Log request attribute names in handle methods - Log failures in XorCsrfTokenRequestAttributeHandler (especially Base64 decoding) - Add similar logging to XorServerCsrfTokenRequestAttributeHandler Improves debugging capabilities without changing functionality. Signed-off-by: yybmion <yunyubin54@gmail.com>
spring-projects-issues
added
the
status: waiting-for-triage
jzheaux
requested changes
Apr 29, 2025
There was a problem hiding this comment.
Hi, @yybmion, thanks for the PR! I've left some feedback inline for the servlet code. Will you please apply the same to the reactive code?
Also, I don't see changes to ServerCsrfTokenRequestHandler. Can you add logging changes equivalent to CsrfTokenRequestHandler?
web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestHandler.java
Outdated
Show resolved
Hide resolved
web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestHandler.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/springframework/security/web/csrf/XorCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/springframework/security/web/csrf/XorCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/springframework/security/web/csrf/XorCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/springframework/security/web/csrf/XorCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
web/src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/springframework/security/web/csrf/XorCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/springframework/security/web/csrf/XorCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
Improve CSRF logging: consistent formatting, reduced nesting, proper encapsulation, and removal of redundant messages Signed-off-by: yybmion <yunyubin54@gmail.com>
|
Thank you @jzheaux for thorough review and detailed guidance! |
jzheaux
requested changes
May 1, 2025
...src/main/java/org/springframework/security/web/csrf/CsrfTokenRequestHandlerLoggerHolder.java
Outdated
Show resolved
Hide resolved
...src/main/java/org/springframework/security/web/csrf/XorCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
.../org/springframework/security/web/server/csrf/XorServerCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
.../org/springframework/security/web/server/csrf/XorServerCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
...ava/org/springframework/security/web/server/csrf/ServerCsrfTokenRequestAttributeHandler.java
Outdated
Show resolved
Hide resolved
.../org/springframework/security/web/server/csrf/ServerCsrfTokenRequestHandlerLoggerHolder.java
Outdated
Show resolved
Hide resolved
|
Thanks for additional feedback @jzheaux! I updated feedback. |
jzheaux
added
in: cas
|
Thanks, @yybmion, this is taking shape nicely. When I run the build ( |
Align log messages between servlet and reactive implementations Signed-off-by: yybmion <yunyubin54@gmail.com>
|
@jzheaux I ran "./gradlew :spring-security-web:check" and the build completed successfully. Sorry for the small issues that extended the review process. I've learned a lot from this contribution opportunity and appreciate your patience!" |
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.
Issue
This PR adds trace-level logging to CSRF token handlers to improve debugging capabilities.
Changes
resolveCsrfTokenValuehandlemethodsXorCsrfTokenRequestAttributeHandlerwhen token processing fails (as specifically requested in the issue)XorServerCsrfTokenRequestAttributeHandlerfor consistencyFixes #13626