Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

openapi3filter: validation of x-www-form-urlencoded with arbitrary nested allOf #1046

Merged
merged 2 commits into from
Dec 24, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
improper validation of x-www-form-urlencoded with arbitrary nested a…
…llOf (#1045)
mikhailovavexmocom committed Dec 23, 2024
commit f04b5e8cef2dbea52f34125ebdd569a83eb201eb
128 changes: 128 additions & 0 deletions openapi3filter/issue1045_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
package openapi3filter

import (
"net/http"
"strings"
"testing"

"github.com/stretchr/testify/require"

"github.com/getkin/kin-openapi/openapi3"
"github.com/getkin/kin-openapi/routers/gorillamux"
)

func TestIssue1045(t *testing.T) {
spec := `
openapi: 3.0.3
info:
version: 1.0.0
title: sample api
description: api service paths to test the issue
paths:
/api/path:
post:
summary: path
tags:
- api
requestBody:
required: true
content:
application/json:
schema: { $ref: '#/components/schemas/PathRequest' }
application/x-www-form-urlencoded:
schema: { $ref: '#/components/schemas/PathRequest' }
responses:
'200':
description: Ok
content:
application/json:
schema: { $ref: '#/components/schemas/PathResponse' }
components:
schemas:
Msg_Opt:
properties:
msg: { type: string }
Msg:
allOf:
- $ref: '#/components/schemas/Msg_Opt'
- required: [ msg ]
Name:
properties:
name: { type: string }
required: [ name ]
Id:
properties:
id:
type: string
format: uint64
required: [ id ]
PathRequest:
type: object
allOf:
- $ref: '#/components/schemas/Msg'
- $ref: '#/components/schemas/Name'
PathResponse:
type: object
allOf:
- $ref: '#/components/schemas/PathRequest'
- $ref: '#/components/schemas/Id'
`[1:]

loader := openapi3.NewLoader()

doc, err := loader.LoadFromData([]byte(spec))
require.NoError(t, err)

err = doc.Validate(loader.Context)
require.NoError(t, err)

router, err := gorillamux.NewRouter(doc)
require.NoError(t, err)

for _, testcase := range []struct {
name string
endpoint string
ct string
data string
shouldFail bool
}{
{
name: "json",
endpoint: "/api/path",
ct: "application/json",
data: `{"msg":"message", "name":"some+name"}`,
shouldFail: false,
},

// application/x-www-form-urlencoded
{
name: "form",
endpoint: "/api/path",
ct: "application/x-www-form-urlencoded",
data: "msg=message&name=some+name",
shouldFail: false,
},
} {
t.Run(testcase.ct, func(t *testing.T) {
data := strings.NewReader(testcase.data)
req, err := http.NewRequest("POST", testcase.endpoint, data)
require.NoError(t, err)
req.Header.Add("Content-Type", testcase.ct)

route, pathParams, err := router.FindRoute(req)
require.NoError(t, err)

validationInput := &RequestValidationInput{
Request: req,
PathParams: pathParams,
Route: route,
}
err = ValidateRequest(loader.Context, validationInput)
if testcase.shouldFail {
require.Error(t, err, "This test case should fail "+testcase.data)
} else {
require.NoError(t, err, "This test case should pass "+testcase.data)
}
})
}
}
24 changes: 12 additions & 12 deletions openapi3filter/req_resp_decoder.go
Original file line number Diff line number Diff line change
@@ -1340,18 +1340,6 @@ func urlencodedBodyDecoder(body io.Reader, header http.Header, schema *openapi3.
obj := make(map[string]any)
dec := &urlValuesDecoder{values: values}

// Decode schema constructs (allOf, anyOf, oneOf)
if err := decodeSchemaConstructs(dec, schema.Value.AllOf, obj, encFn); err != nil {
return nil, err
}
if err := decodeSchemaConstructs(dec, schema.Value.AnyOf, obj, encFn); err != nil {
return nil, err
}
if err := decodeSchemaConstructs(dec, schema.Value.OneOf, obj, encFn); err != nil {
return nil, err
}

// Decode properties from the main schema
if err := decodeSchemaConstructs(dec, []*openapi3.SchemaRef{schema}, obj, encFn); err != nil {
return nil, err
}
@@ -1363,6 +1351,18 @@ func urlencodedBodyDecoder(body io.Reader, header http.Header, schema *openapi3.
// This function is for decoding purposes only and not for validation.
func decodeSchemaConstructs(dec *urlValuesDecoder, schemas []*openapi3.SchemaRef, obj map[string]any, encFn EncodingFn) error {
for _, schemaRef := range schemas {

// Decode schema constructs (allOf, anyOf, oneOf)
if err := decodeSchemaConstructs(dec, schemaRef.Value.AllOf, obj, encFn); err != nil {
return err
}
if err := decodeSchemaConstructs(dec, schemaRef.Value.AnyOf, obj, encFn); err != nil {
return err
}
if err := decodeSchemaConstructs(dec, schemaRef.Value.OneOf, obj, encFn); err != nil {
return err
}

for name, prop := range schemaRef.Value.Properties {
value, _, err := decodeProperty(dec, name, prop, encFn)
if err != nil {