fix(standard-validator): arktype leaking headers (#1282)

* fix(standard-validator): arktype strip headers from error output

* chore(standard-validator): fix formatting

* feat(changeset): add changeset

* fix: change header schema to lowercase and cleanup tests

* fix: strip out sensitive fields for valibot

* chore: refactor, cleanup and add jsdoc
pull/1323/head
Andrei 2025-07-20 01:30:09 +02:00 committed by GitHub
parent 28601b311b
commit 2a46bfbba0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 221 additions and 1 deletions

View File

@ -0,0 +1,5 @@
---
'@hono/standard-validator': patch
---
Fix cookies output for arktype in standard schema validator

View File

@ -26,7 +26,12 @@ const querySortSchema = type({
order: "'asc'|'desc'", order: "'asc'|'desc'",
}) })
const headerSchema = type({
'user-agent': 'string',
})
export { export {
headerSchema,
idJSONSchema, idJSONSchema,
personJSONSchema, personJSONSchema,
postJSONSchema, postJSONSchema,

View File

@ -28,7 +28,12 @@ const querySortSchema = object({
order: picklist(['asc', 'desc']), order: picklist(['asc', 'desc']),
}) })
const headerSchema = object({
'user-agent': string(),
})
export { export {
headerSchema,
idJSONSchema, idJSONSchema,
personJSONSchema, personJSONSchema,
postJSONSchema, postJSONSchema,

View File

@ -28,7 +28,12 @@ const querySortSchema = z.object({
order: z.enum(['asc', 'desc']), order: z.enum(['asc', 'desc']),
}) })
const headerSchema = z.object({
'user-agent': z.string(),
})
export { export {
headerSchema,
idJSONSchema, idJSONSchema,
personJSONSchema, personJSONSchema,
postJSONSchema, postJSONSchema,

View File

@ -352,6 +352,47 @@ describe('Standard Schema Validation', () => {
> >
}) })
}) })
describe('Sensitive Data Removal', () => {
it("doesn't return cookies after headers validation", async () => {
const app = new Hono()
const schema = schemas.headerSchema
app.get('/headers', sValidator('header', schema), (c) =>
c.json({ success: true, userAgent: c.req.header('User-Agent') })
)
const req = new Request('http://localhost/headers', {
headers: {
// Not passing the User-Agent header to trigger the validation error
Cookie: 'SECRET=123',
},
})
const res = await app.request(req)
expect(res.status).toBe(400)
const data = (await res.json()) as { success: false; error: unknown[] }
expect(data.success).toBe(false)
expect(data.error).toBeDefined()
if (lib === 'arktype') {
expect(
(data.error as { data: Record<string, unknown> }[]).some(
(error) => error.data && error.data.cookie
)
).toBe(false)
}
if (lib === 'valibot') {
expect(
(data.error as { path: { input: Record<string, unknown> }[] }[]).some((error) =>
error.path.some((path) => path.input.cookie)
)
).toBe(false)
}
})
})
}) })
}) })
}) })

View File

@ -1,6 +1,7 @@
import type { StandardSchemaV1 } from '@standard-schema/spec' import type { StandardSchemaV1 } from '@standard-schema/spec'
import type { Context, Env, Input, MiddlewareHandler, TypedResponse, ValidationTargets } from 'hono' import type { Context, Env, Input, MiddlewareHandler, TypedResponse, ValidationTargets } from 'hono'
import { validator } from 'hono/validator' import { validator } from 'hono/validator'
import { sanitizeIssues } from './sanitize-issues'
type HasUndefined<T> = undefined extends T ? true : false type HasUndefined<T> = undefined extends T ? true : false
type TOrPromiseOfT<T> = T | Promise<T> type TOrPromiseOfT<T> = T | Promise<T>
@ -21,6 +22,67 @@ type Hook<
c: Context<E, P> c: Context<E, P>
) => TOrPromiseOfT<Response | void | TypedResponse<O>> ) => TOrPromiseOfT<Response | void | TypedResponse<O>>
/**
* Validation middleware for libraries that support [Standard Schema](https://standardschema.dev/) specification.
*
* This middleware validates incoming request data against a provided schema
* that conforms to the Standard Schema specification. It supports validation
* of JSON bodies, headers, queries, forms, and other request targets.
*
* @param target - The request target to validate ('json', 'header', 'query', 'form', etc.)
* @param schema - A schema object conforming to Standard Schema specification
* @param hook - Optional hook function called with validation results for custom error handling
* @returns A Hono middleware handler that validates requests and makes validated data available via `c.req.valid()`
*
* @example Basic JSON validation
* ```ts
* import { z } from 'zod'
* import { sValidator } from '@hono/standard-validator'
*
* const schema = z.object({
* name: z.string(),
* age: z.number(),
* })
*
* app.post('/author', sValidator('json', schema), (c) => {
* const data = c.req.valid('json')
* return c.json({
* success: true,
* message: `${data.name} is ${data.age}`,
* })
* })
* ```
*
* @example With custom error handling hook
* ```ts
* app.post(
* '/post',
* sValidator('json', schema, (result, c) => {
* if (!result.success) {
* return c.text('Invalid!', 400)
* }
* }),
* (c) => {
* // Handler code
* }
* )
* ```
*
* @example Header validation
* ```ts
* import { object, string } from 'valibot'
*
* const schema = object({
* 'content-type': string(),
* 'user-agent': string(),
* })
*
* app.post('/author', sValidator('header', schema), (c) => {
* const headers = c.req.valid('header')
* // do something with headers
* })
* ```
*/
const sValidator = < const sValidator = <
Schema extends StandardSchemaV1, Schema extends StandardSchemaV1,
Target extends keyof ValidationTargets, Target extends keyof ValidationTargets,
@ -71,7 +133,9 @@ const sValidator = <
} }
if (result.issues) { if (result.issues) {
return c.json({ data: value, error: result.issues, success: false }, 400) const processedIssues = sanitizeIssues(result.issues, schema['~standard'].vendor, target)
return c.json({ data: value, error: processedIssues, success: false }, 400)
} }
return result.value as StandardSchemaV1.InferOutput<Schema> return result.value as StandardSchemaV1.InferOutput<Schema>

View File

@ -0,0 +1,95 @@
import type { StandardSchemaV1 } from '@standard-schema/spec'
import type { ValidationTargets } from 'hono'
const RESTRICTED_DATA_FIELDS = {
header: ['cookie'],
}
/**
* Sanitizes validation issues by removing sensitive data fields from error messages.
*
* This function removes potentially sensitive information (like cookies) from validation
* error messages before they are returned to the client. It handles different validation
* library formats based on the vendor string.
*
* @param issues - Array of validation issues from Standard Schema validation
* @param vendor - The validation library vendor identifier (e.g., 'arktype', 'valibot')
* @param target - The validation target being processed ('header', 'json', etc.)
* @returns Sanitized array of validation issues with sensitive data removed
*
* @example
* ```ts
* const issues = [{ message: 'Invalid header', data: { cookie: 'secret' } }]
* const sanitized = sanitizeIssues(issues, 'arktype', 'header')
* // Returns issues with cookie field removed from data
* ```
*/
export function sanitizeIssues(
issues: readonly StandardSchemaV1.Issue[],
vendor: string,
target: keyof ValidationTargets
): readonly StandardSchemaV1.Issue[] {
if (!(target in RESTRICTED_DATA_FIELDS)) {
return issues
}
const restrictedFields =
RESTRICTED_DATA_FIELDS[target as keyof typeof RESTRICTED_DATA_FIELDS] || []
if (vendor === 'arktype') {
return sanitizeArktypeIssues(issues, restrictedFields)
}
if (vendor === 'valibot') {
return sanitizeValibotIssues(issues, restrictedFields)
}
return issues
}
function sanitizeArktypeIssues(
issues: readonly StandardSchemaV1.Issue[],
restrictedFields: string[]
): readonly StandardSchemaV1.Issue[] {
return issues.map((issue) => {
if (
issue &&
typeof issue === 'object' &&
'data' in issue &&
typeof issue.data === 'object' &&
issue.data !== null &&
!Array.isArray(issue.data)
) {
const dataCopy = { ...(issue.data as Record<string, unknown>) }
for (const field of restrictedFields) {
delete dataCopy[field]
}
return { ...issue, data: dataCopy }
}
return issue
}) as readonly StandardSchemaV1.Issue[]
}
function sanitizeValibotIssues(
issues: readonly StandardSchemaV1.Issue[],
restrictedFields: string[]
): readonly StandardSchemaV1.Issue[] {
return issues.map((issue) => {
if (issue && typeof issue === 'object' && 'path' in issue && Array.isArray(issue.path)) {
for (const path of issue.path) {
if (
typeof path === 'object' &&
'input' in path &&
typeof path.input === 'object' &&
path.input !== null &&
!Array.isArray(path.input)
) {
for (const field of restrictedFields) {
delete path.input[field]
}
}
}
}
return issue
}) as readonly StandardSchemaV1.Issue[]
}