docs: add vulnerability report verifier #35
Merged
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
akashsinghal
requested review from
binbin-li,
luisdlp,
susanshi and
toddysm
as code owners
✅ Deploy Preview for ratify-dev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
12 tasks
FeynmanZhou
reviewed
Nov 21, 2023
FeynmanZhou
reviewed
Nov 21, 2023
FeynmanZhou
reviewed
Nov 21, 2023
FeynmanZhou
reviewed
Nov 21, 2023
FeynmanZhou
reviewed
Nov 21, 2023
FeynmanZhou
reviewed
Nov 21, 2023
FeynmanZhou
reviewed
Nov 21, 2023
FeynmanZhou
reviewed
Nov 23, 2023
|
|
||
| ### Recording | ||
|
|
||
| [](https://asciinema.org/a/622368) |
There was a problem hiding this comment.
There is a way to embed the player into the website page. Could you try it as follows?
<script async id="asciicast-622368" src="https://asciinema.org/a/622368.js"></script>
There was a problem hiding this comment.
Seems like this is nontrivial. I tried to change the file to mdx but I still cannot embed the script inside the file.
susanshi
reviewed
Nov 23, 2023
susanshi
reviewed
Dec 5, 2023
| | maximumAge | No | spec.parameters.maximumAge | The string formatted max age of report | "" | | ||
| | disallowedSeverities | No | spec.parameters.disallowedSeverities | String array of disallowed severities. Verification fails if ANY specified severity found. Most common severities: `low`, `medium`, `high`, `critical`, `unknown` | [] | | ||
| | denylistCVEs | No | spec.parameters.denylistCVEs | String array of CVE IDs. Verification fails if ANY specified CVE ID found. Find CVEs [here](https://nvd.nist.gov/vuln/search) | [] | | ||
| | passthrough | No | spec.parameters.passthrough | Bypasses all verification except for `maximumAge`. Report content in `report` field of verifier report | false | |
There was a problem hiding this comment.
Suggestion to mention which scenarios may passthrough be useful.
There was a problem hiding this comment.
@susanshi I've added a section at the bottom called "Passthrough Mode". I feel specifying scenarios in the parameter table is too verbose.
susanshi
previously approved these changes
Dec 5, 2023
susanshi
approved these changes
Dec 6, 2023
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.
No description provided.