fix(req): correct c.req.param decodes invalid percent strings
#3573
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3573 +/- ##
==========================================
- Coverage 94.71% 94.71% -0.01%
==========================================
Files 157 158 +1
Lines 9539 9537 -2
Branches 2774 2794 +20
==========================================
- Hits 9035 9033 -2
Misses 504 504 ☔ View full report in Codecov by Sentry. |
|
Hi @usualoma ! Can you review this? |
usualoma
reviewed
Oct 28, 2024
There was a problem hiding this comment.
@yusukebe Thank you! I agree with this approach.
tryDecodeURIComponent
This is a pure function that does not require 'this', so I think it is better to make it an independent function rather than an object property. I think that would also improve performance.
Also, even if we merge this pull request, I think the minified result will be smaller if we use decodeURIComponent_. However, it's only a few characters, so it may not matter.
diff --git a/src/request.ts b/src/request.ts
index 92ebc771..6239ebac 100644
--- a/src/request.ts
+++ b/src/request.ts
@@ -12,7 +12,7 @@ import type {
import { parseBody } from './utils/body'
import type { BodyData, ParseBodyOptions } from './utils/body'
import type { Simplify, UnionToIntersection } from './utils/types'
-import { getQueryParam, getQueryParams, tryDecode } from './utils/url'
+import { decodeURIComponent_, getQueryParam, getQueryParams, tryDecode } from './utils/url'
type Body = {
json: any
@@ -23,6 +23,8 @@ type Body = {
}
type BodyCache = Partial<Body & { parsedBody: BodyData }>
+const tryDecodeURIComponent = (str: string) => tryDecode(str, decodeURIComponent_)
+
export class HonoRequest<P extends string = '/', I extends Input['out'] = {}> {
/**
* `.raw` can get the raw Request object.
@@ -91,12 +93,10 @@ export class HonoRequest<P extends string = '/', I extends Input['out'] = {}> {
return key ? this.getDecodedParam(key) : this.getAllDecodedParams()
}
- #tryDecodeURIComponent = (str: string) => tryDecode(str, decodeURIComponent)
-
private getDecodedParam(key: string): string | undefined {
const paramKey = this.#matchResult[0][this.routeIndex][1][key]
const param = this.getParamValue(paramKey)
- return param ? this.#tryDecodeURIComponent(param) : undefined
+ return param ? tryDecodeURIComponent(param) : undefined
}
private getAllDecodedParams(): Record<string, string> {
@@ -106,7 +106,7 @@ export class HonoRequest<P extends string = '/', I extends Input['out'] = {}> {
for (const key of keys) {
const value = this.getParamValue(this.#matchResult[0][this.routeIndex][1][key])
if (value && typeof value === 'string') {
- decoded[key] = this.#tryDecodeURIComponent(value)
+ decoded[key] = tryDecodeURIComponent(value)
}
}
|
@usualoma Thanks! Agree all. Can you review this again? |
usualoma
approved these changes
Oct 29, 2024
|
Thanks! Merging now. |
yusukebe
deleted the
fix/request-dont-throw-error-with-percent-strings
branch
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.
Fixes #3550
In the current behavior, the
c.req.param()will throw the error when decoding invalid percent encoding or invalid UTF-8 sequence.These behaviors are expected in the current version implementation; they are tested:
https://github.com/honojs/hono/compare/fix/request-dont-throw-error-with-percent-strings?expand=1#diff-8ac13809c9886e994d1db33943de82df4d6c5d88b73fd0270c0189804ff565c2L772-L814
However, according to #3550, throwing the error will stop the application procedure, and it can accept malicious requests. I think it should not throw the error. This should be fixed, though we should rewrite the test code.
The correct behavior
How to handle the invalid path parameter strings. One way is throwing
400 Bad Request, but as I commented, it should follow the decode method of thegetPath()to resolve the URL path:hono/src/utils/url.ts
Line 112 in 0a99bd3
So, the result will be like the following:
In this PR, I used the same logic of
tryDecodeURIfortryDecodeURIComponent.The author should do the following, if applicable
bun run format:fix && bun run lint:fixto format the code