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.

Sign up for GitHub

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

Jump to bottom

OpenAPI upstream request/response validation #21

Closed

2 tasks done

johakoch opened this issue Sep 17, 2020 · 8 comments · Fixed by #22 or #81

Closed

2 tasks done

OpenAPI upstream request/response validation #21

johakoch opened this issue Sep 17, 2020 · 8 comments · Fixed by #22 or #81

Assignees

Labels

enhancement spec theme/config

Milestone

Collaborator

johakoch commented Sep 17, 2020 •

edited by malud

Loading

We want to prevent invalid upstream request and responses which does not match the requirements from a given openAPI yaml file.

implementation
documentation

johakoch pushed a commit that referenced this issue


          add library for swagger (#21)

c921f0c

johakoch pushed a commit that referenced this issue


          upstream validation: implementation, first try (#21)

edbf070

johakoch pushed a commit that referenced this issue


          add upstream swagger file, referenced in couper.hcl (#21)

a72008e

Collaborator Author

johakoch commented Sep 17, 2020 •

edited

Loading

This feature is currently configured by

swagger_definition = "path/to/swagger.yaml"
validate_request = true
validate_response = true

in a backend() block

johakoch added the enhancement label

johakoch self-assigned this

johakoch linked a pull request

that will close this issue

Add upstream request/response validation with openapi (#21) #22

Merged

2 tasks

johakoch changed the title ~~Add upstream request/response validation with swagger~~ Add upstream request/response validation with swagger/openapi

Collaborator Author

johakoch commented Sep 17, 2020

The github.com/getkin/kin-openapi library is very handy for OpenAPI version 3. If you have a version 2 (Swagger) definition it's a lot more work. Do we need version 2 for the MVP?

Collaborator

malud commented Sep 17, 2020 •

edited

Loading

[...]. Do we need version 2 for the MVP?

We don't need v2 support for now.

johakoch changed the title ~~Add upstream request/response validation with swagger/openapi~~ [POC] Add upstream request/response validation with swagger/openapi

Collaborator

malud commented Sep 18, 2020

This feature is currently configured by
swagger_definition = "path/to/swagger.yaml"
validate_request = true
validate_response = true
in a backend() block

We should name it swagger_file since all couper file references has a file suffix.

Collaborator Author

johakoch commented Sep 18, 2020

Or openapi_file, if swagger_file sounds too v2-ish?

Collaborator

malud commented Sep 18, 2020

Or openapi_file, if swagger_file sounds too v2-ish?

sounds good.

johakoch pushed a commit that referenced this issue


          rename swagger_definition -> openapi_file (#21)

2752a3d

johakoch pushed a commit that referenced this issue


          rename swagger_definition -> openapi_file (#21)

11d4d8b

johakoch pushed a commit that referenced this issue


          add library for swagger (#21)

6e60603

johakoch pushed a commit that referenced this issue


          upstream validation: implementation, first try (#21)

1ded850

johakoch pushed a commit that referenced this issue


          add upstream swagger file, referenced in couper.hcl (#21)

64878e8

johakoch pushed a commit that referenced this issue


          rename swagger_definition -> openapi_file (#21)

52e79b0

johakoch pushed a commit that referenced this issue


          openapi block with properties instead of properties only; request/res…

4f388c5

…ponse are always validated if openapi block is present; request is rejected if invalid and ignore_request_violations is not true; response is rejected if invalid and ignore_response_violations is not true (#21)

johakoch pushed a commit that referenced this issue


          invalid upstream request gets 400 - Bad Request; invalid upstream res…

eea5d41

…ponse gets 502 - Bad Gateway (#21)

johakoch pushed a commit that referenced this issue


          add library for swagger (#21)

7b829c3

johakoch pushed a commit that referenced this issue


          upstream validation: implementation, first try (#21)

60764c7

johakoch pushed a commit that referenced this issue


          add upstream swagger file, referenced in couper.hcl (#21)

ed65bdf

johakoch pushed a commit that referenced this issue


          rename swagger_definition -> openapi_file (#21)

6a1e7c3

johakoch pushed a commit that referenced this issue


          openapi block with properties instead of properties only; request/res…

fb2ecdb

…ponse are always validated if openapi block is present; request is rejected if invalid and ignore_request_violations is not true; response is rejected if invalid and ignore_response_violations is not true (#21)

johakoch pushed a commit that referenced this issue


          invalid upstream request gets 400 - Bad Request; invalid upstream res…

c036380

…ponse gets 502 - Bad Gateway (#21)

johakoch pushed a commit that referenced this issue


          openapi block with properties instead of properties only; request/res…

384bdd0

…ponse are always validated if openapi block is present; request is rejected if invalid and ignore_request_violations is not true; response is rejected if invalid and ignore_response_violations is not true (#21)

johakoch pushed a commit that referenced this issue


          invalid upstream request gets 400 - Bad Request; invalid upstream res…

9e66f29

…ponse gets 502 - Bad Gateway (#21)

malud pushed a commit that referenced this issue


          openapi block with properties instead of properties only; request/res…

…ponse are always validated if openapi block is present; request is rejected if invalid and ignore_request_violations is not true; response is rejected if invalid and ignore_response_violations is not true (#21)

malud pushed a commit that referenced this issue


          invalid upstream request gets 400 - Bad Request; invalid upstream res…

4a50819

…ponse gets 502 - Bad Gateway (#21)

malud pushed a commit that referenced this issue


          keep backend status code in log even in case of response validation e…

…rror (#21)

malud pushed a commit that referenced this issue


          validation message in backend log's message field (#21)

ca36705

malud pushed a commit that referenced this issue


          tests for validation (#21)

95767fc

malud pushed a commit that referenced this issue


          extracted OpenAPI validator (#21)

810e9ed

malud pushed a commit that referenced this issue


          Fixed validation errors in openapi file to be logged as errors instea…

…d of panic (#21)

malud pushed a commit that referenced this issue


          upstream validation: implementation, first try (#21)

e8f64ef

malud pushed a commit that referenced this issue


          add upstream swagger file, referenced in couper.hcl (#21)

fa9303a

malud pushed a commit that referenced this issue


          rename swagger_definition -> openapi_file (#21)

a5a73d6

malud pushed a commit that referenced this issue


          openapi block with properties instead of properties only; request/res…

…ponse are always validated if openapi block is present; request is rejected if invalid and ignore_request_violations is not true; response is rejected if invalid and ignore_response_violations is not true (#21)

malud pushed a commit that referenced this issue


          invalid upstream request gets 400 - Bad Request; invalid upstream res…

da841a7

…ponse gets 502 - Bad Gateway (#21)

malud pushed a commit that referenced this issue


          keep backend status code in log even in case of response validation e…

796a3f3

…rror (#21)

malud pushed a commit that referenced this issue


          validation message in backend log's message field (#21)

d979688

malud pushed a commit that referenced this issue


          tests for validation (#21)

50f21e5

malud pushed a commit that referenced this issue


          extracted OpenAPI validator (#21)

8829ad4

malud pushed a commit that referenced this issue


          Fixed validation errors in openapi file to be logged as errors instea…

d93ac33

…d of panic (#21)

malud pushed a commit that referenced this issue


          upstream validation: implementation, first try (#21)

malud pushed a commit that referenced this issue


          add upstream swagger file, referenced in couper.hcl (#21)

062a9e4

malud pushed a commit that referenced this issue


          rename swagger_definition -> openapi_file (#21)

a16854c

malud pushed a commit that referenced this issue


          openapi block with properties instead of properties only; request/res…

0e9bc88

…ponse are always validated if openapi block is present; request is rejected if invalid and ignore_request_violations is not true; response is rejected if invalid and ignore_response_violations is not true (#21)

malud pushed a commit that referenced this issue


          invalid upstream request gets 400 - Bad Request; invalid upstream res…

5e5c373

…ponse gets 502 - Bad Gateway (#21)

malud pushed a commit that referenced this issue


          keep backend status code in log even in case of response validation e…

…rror (#21)

malud pushed a commit that referenced this issue


          validation message in backend log's message field (#21)

f46c641

malud pushed a commit that referenced this issue


          tests for validation (#21)

f8839d6

malud pushed a commit that referenced this issue


          extracted OpenAPI validator (#21)

627fa8c

malud pushed a commit that referenced this issue


          Fixed validation errors in openapi file to be logged as errors instea…

d1a762d

…d of panic (#21)

malud closed this as completed in #22

malud pushed a commit that referenced this issue


          Add upstream request/response validation with openapi (#21) (#22)

8feffb2

* upstream validation: implementation, first try (#21)

* add upstream swagger file, referenced in couper.hcl (#21)

* rename swagger_definition -> openapi_file (#21)

* openapi block with properties instead of properties only; request/response are always validated if openapi block is present; request is rejected if invalid and ignore_request_violations is not true; response is rejected if invalid and ignore_response_violations is not true (#21)

* invalid upstream request gets 400 - Bad Request; invalid upstream response gets 502 - Bad Gateway (#21)

* keep backend status code in log even in case of response validation error (#21)

* validation message in backend log's message field (#21)

* tests for validation (#21)

* extracted OpenAPI validator (#21)

* Fixed validation errors in openapi file to be logged as errors instead of panic (#21)

* Fixup openAPI validation test

* Handle body rewind

Refactor openAPI error handling

* Fix set getBody method first #72

Leads to getAttribute errors for recently added dynamic evals for origin, path and hostname

* Add buffer stringer implementation

Add stringer tool to generate for const

* Add test for bufferOption interaction

* rm httpbin.yaml

* Fix documentation hcl format

* Remove loose punctuation mark from documentation

Fix couper version to latest release

* Add openapi documentation and example link

* Fixup obsolete conditions

* Add validation exclude options

Fix passing the query param

* Fixup validation tests

e.g. query 404 -> 404= due to our set query feature

* Update validation documentation

* Use req context

* Fix merge openAPI and use partialContent for deprecated log

* Upgrade kin-openapi dependency to latest v0.33.0

* Add documentation note about openapi3

* Add additional openapi test

Remove own getBody set since openapi3 does this already (too)

* Revert configurable validation exclude options

* Add additonal openapi link

Co-authored-by: Marcel Ludwig <marcel.ludwig@avenga.com>

malud linked a pull request

that will close this issue

Fix openapi block handling for inline backends #81

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment