Skip to content

Keep the validated request body value by default - #20

Merged
mromaszewicz merged 1 commit into
oapi-codegen:mainfrom
mromaszewicz:feat/keep-validated-value
Oct 23, 2026
Merged

mromaszewicz merged 1 commit into
oapi-codegen:mainfrom
mromaszewicz:feat/keep-validated-value

Conversation

@mromaszewicz

Copy link
Copy Markdown
Member

Summary

Enables kin-openapi's openapi3filter.Options.KeepValidatedValue by default, with an opt-out.

With the flag on, the request body that reaches the handler exposes the value the validator decoded and validated through a ValidatedValue() any method. The body itself stays fully readable. oapi-codegen strict servers are being changed (oapi-codegen/oapi-codegen#2605) to bind that value instead of decoding the body a second time, which closes a validation bypass: encoding/json matches member names case-insensitively, so {"role":"user","ROLE":"admin"} validates as role: user but binds as Role: "admin". Defaulting the flag here makes that fix effective without configuration.

Changes:

  • New Options.DiscardValidatedValue turns the flag back off, for example to limit memory retention for very large bodies. It overrides Options.Options.KeepValidatedValue.
  • The caller's openapi3filter.Options is copied, never mutated; nil options now get {KeepValidatedValue: true}.
  • Tests cover the default, empty options, the opt-out (including overriding an explicit KeepValidatedValue: true), and ExcludeRequestBody, and check the body still reads the original bytes.
  • README documents the default, the opt-out, and that middleware which replaces the request body (decompression, size limiting, logging wrappers) belongs before the validator, since it would otherwise hide the validated value.

Requires kin-openapi v0.151.0 or later; main is on v0.152.0.

🤖 Generated with Claude Code

Enable openapi3filter.Options.KeepValidatedValue by default. With it,
openapi3filter leaves the decoded, validated request body value on
req.Body behind a ValidatedValue() any method, while the body stays
readable with its original bytes.

oapi-codegen strict servers are being changed to bind that value
(oapi-codegen/oapi-codegen#2605) instead of decoding the body a second
time. Decoding twice is a validation bypass: encoding/json matches
object member names case-insensitively, so {"role":"user","ROLE":"admin"}
validates as role: user but binds as Role: "admin". For the fix to
protect users by default, the middleware has to keep the value by
default.

The middleware now passes openapi3filter a copy of Options.Options with
KeepValidatedValue set, leaving the caller's struct untouched; nil
options (OapiRequestValidator, OapiValidatorFromYamlFile, or
ValidateRequestFromContext called with nil) also keep the value. The new
Options.DiscardValidatedValue opts out, for instance to limit memory
retention for very large request bodies, and overrides
Options.Options.KeepValidatedValue.

Any middleware placed after the validator that replaces the request
body (decompression, size limiting, logging wrappers) hides the
validated value from handlers, so such middleware belongs before the
validator. The README documents the default, the opt-out and this
ordering caveat.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mromaszewicz mromaszewicz added the enhancement New feature or request label Oct 23, 2026
@mromaszewicz
mromaszewicz merged commit 12cc7e7 into oapi-codegen:main Oct 23, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant