feat(pdk) normalize kong.request.get_path #8823
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
jschmid1
reviewed
May 20, 2022
flrgh
force-pushed
the
feat/pdk-get-normalized-path
branch
from
ad537b6 to
ce9be8e
Compare
mayocream
reviewed
May 27, 2022
| -- | ||
| -- kong.request.get_path() -- "/t/Abc 123ø%2F/test/" | ||
| function _REQUEST.get_path() | ||
| return normalize(_REQUEST.get_raw_path(), true) |
There was a problem hiding this comment.
This would change the default behavior of this API, any possibility to add another API like get_normalized_path?
There was a problem hiding this comment.
That was actually the original idea, but after some discussion it was decided that we want get_path() to be normalized so that it's secure by default when used for string comparison. Sorry I didn't make this more apparent in the description! This reminds me to add a breaking change entry for the changelog though.
There was a problem hiding this comment.
It is a security fix, so the change is expected.
This changes the behavior of kong.request.get_path() by performing path normalization on the value before returning it to the caller. The new PDK function kong.request.get_raw_path() performs no normalization.
flrgh
force-pushed
the
feat/pdk-get-normalized-path
branch
from
ce9be8e to
bf6b15a
Compare
dndx
reviewed
May 29, 2022
Co-authored-by: Datong Sun <datong.sun@konghq.com>
dndx
approved these changes
May 30, 2022
locao
pushed a commit
that referenced
this pull request
Jun 21, 2024
…n roles (`admin` and `workspace-admin`) (#8823)
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 changes the behavior of
kong.request.get_path()such that it performs path normalization on the value before returning it to the caller. The new PDK functionkong.request.get_raw_path()performs no normalization and contains a notice about its potential security pitfalls when used unwisely.Note: there has been much discussion on the underlying implementation/methodology of our normalization strategy (see #8140). This pull request does not attempt to resolve that discussion and only focuses on the PDK interface. The assumption here is that the implementation of
kong.tools.uri.normalizecan be updated/finalized at a later date if we wish (though some test cases and LuaDoc annotations may need to be updated depending on what changes are made).