-
Notifications
You must be signed in to change notification settings - Fork 9.1k
Added security considerations document #3488
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
Merged
Merged
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
9996d4f
Added security considerations document
darrelmiller cb85ba0
Update SECURITY_CONSIDERATIONS.md
darrelmiller 621fc7b
Update SECURITY_CONSIDERATIONS.md
darrelmiller f30283d
Add note about external references being potentially on untrusted dom…
darrelmiller a95e1ba
Update SECURITY_CONSIDERATIONS.md
darrelmiller f9fc722
Update SECURITY_CONSIDERATIONS.md
darrelmiller fa1c65e
Added note about security schemes
darrelmiller e4bf4cf
Merge branch 'security-considerations' of https://github.com/OAI/Open…
darrelmiller File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Security Considerations | ||
|
||
OpenAPI documents use JSON, YAML, and JSON Schema, and therefore share their security considerations: | ||
- [JSON](https://datatracker.ietf.org/doc/html/rfc8259) | ||
- [YAML](https://datatracker.ietf.org/doc/html/rfc9512) | ||
- [JSON Schema Core](https://json-schema.org/draft/2020-12/json-schema-core#section-13) | ||
- [JSON Schema Validation](https://json-schema.org/draft/2020-12/json-schema-validation#name-security-considerations) | ||
In additional, OpenAPI documents are processed by a wide variety of tooling for numerous different purposes, such as client code generation, documentation generation, server side routing, and API testing. OpenAPI document authors must consider the risks of the scenarios where the OpenAPI document may be used. | ||
OpenAPI documents may contain references to external resources that may be dereferenced automatically by consuming tools. External resources may be hosted on different domains that may be untrusted. References in an OpenAPI document, or across OpenAPI documents may cause a cycle. Tooling must detect and handle cycles to prevent resource exhaustion. | ||
darrelmiller marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Certain properties allow the use of Markdown which can contain HTML including script. It is the responsibility of tooling to appropriately sanitize the Markdown. |
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.
Uh oh!
There was an error while loading. Please reload this page.