feat(rulesets): validate API security in oas-operation-security-defined #2046
Conversation
This file contains 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
mkistler
force-pushed
the
security-schemes
branch
from
11b4420
to
e792e63
Compare
P0lip
reviewed
Feb 21, 2022
| @@ -50,6 +53,31 @@ export default createRulesetFunction<{ paths: Record<string, unknown> }, Options | |||
| const schemes = _get(targetVal, schemesPath); | |||
| const allDefs = isObject(schemes) ? Object.keys(schemes) : []; | |||
|
|
|||
| // Check global security requirements | |||
|
|
|||
| { | |||
There was a problem hiding this comment.
do we need this block? It doesn't seem like security is redeclared within the current scope. It is a later on at
There was a problem hiding this comment.
Amended PR to remove unnecessary block.
mkistler
force-pushed
the
security-schemes
branch
from
e792e63
to
536800a
Compare
stoplight-bot
pushed a commit
that referenced
this pull request
Mar 3, 2022
# [@stoplight/spectral-rulesets-v1.6.0](https://github.com/stoplightio/spectral/compare/@stoplight/spectral-rulesets-v1.5.2...@stoplight/spectral-rulesets-v1.6.0) (2022-03-03) ### Features * **rulesets:** validate API security in oas-operation-security-defined ([#2046](#2046)) ([5540250](5540250))
|
🎉 This PR is included in version @stoplight/spectral-rulesets-v1.6.0 🎉 The release is available on npm package (@latest dist-tag) Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds checking in the function for oas[23]-operation-security-defined to also check the API-level security requirement to ensure it also only references defined security schemes.
I admit that it is stretching the intent of these rules a bit, to check the API-level definition in a rule that by its name would only work on the operation-level security requirement. But it seemed like overkill to define an entirely new rule to perform the same checking as this one, just at the global level. And in some sense the API level security is the operation-level security for any operation that does not override it, so it didn't seem too unreasonable to include these checks here.
UPDATE: I've updated this PR to add checking for all the fields in a security requirements object -- not just the first one.
Checklist
Does this PR introduce a breaking change?