openapi3filter: don't consume request body in AuthenticatorFunc
#1064
+263
−0
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.
As noted in #743, some users of the
openapi3filter, largely viaoapi-codegenandopenapi.tanna.dev/go/validator0 are seeing thatwhen using an
AuthenticationFunc, this can lead to errors such as:Or:
This turns out to be down to the fact that a call to the
AuthenticationFuncmay read the request body, but due to the way thatGo's
io.Readers can only be read once, this then means the body cannotbe read by anyone else further in the request chain.
To resolve this, we can make sure that each iteration of the
AuthenticationFuncgets a fresh copy of the request body (in its ownio.Reader).This follows logic that exists within the
ValidateRequestBodymethod,with an additional layer of caching the raw bytes from the body.
We also add tests to validate:
ValidateRequestbody function with anAuthenticationFuncthat reads the request bodyindicating that the HTTP handler can then read the request body itself
Closes #743.