caddyhttp: properly sanitize requests for root path#6360
Merged
mholt merged 2 commits intocaddyserver:masterfrom Jun 2, 2024
Merged
caddyhttp: properly sanitize requests for root path#6360mholt merged 2 commits intocaddyserver:masterfrom
mholt merged 2 commits intocaddyserver:masterfrom
Conversation
willnorris
force-pushed
the
will/sanitize
branch
2 times, most recently
from
14d047f to
6b7b155
Compare
SanitizePathJoin protects against directory traversal attacks by checking for requests whose URL path look like they are trying to request something other than a local file, and returns the root directory in those cases. The method is also careful to ensure that requests which contain a trailing slash include a trailing slash in the returned value. However, for requests that contain only a slash (requests for the root path), the IsLocal check returns early before the matching trailing slash is re-added. This change updates SanitizePathJoin to only perform the filepath.IsLocal check if the cleaned request URL path is non-empty. --- This change also updates the existing SanitizePathJoin tests to use filepath.FromSlash rather than filepath.Join. This makes the expected value a little easier to read, but also has the advantage of not being processed by filepath.Clean like filepath.Join is. This means that the exact expect value will be compared, not the result of first cleaning it. Fixes caddyserver#6352
Contributor
Author
|
okay, after a little bit of test cleanup, I think this is ready to go now. |
mholt
approved these changes
Jun 2, 2024
Member
mholt
left a comment
mholt
left a comment
There was a problem hiding this comment.
Thanks, I scanned this a few times and wondered how you handled the Windows cases but I see you didn't change those 👍
This is quite an elegant and simple fix. I appreciate that! Thanks for the patch :)
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.
SanitizePathJoin protects against directory traversal attacks by checking for requests whose URL path look like they are trying to request something other than a local file, and returns the root directory in those cases.
The method is also careful to ensure that requests which contain a trailing slash include a trailing slash in the returned value. However, for requests that contain only a slash (requests for the root path), the IsLocal check returns early before the matching trailing slash is re-added.
This change updates SanitizePathJoin to only perform the filepath.IsLocal check if the cleaned request URL path is non-empty.
This change also updates the existing SanitizePathJoin tests to use filepath.FromSlash rather than filepath.Join. This makes the expected value a little easier to read, but also has the advantage of not being processed by filepath.Clean like filepath.Join is. This means that the exact expect value will be compared, not the result of first cleaning it.
Fixes #6352