-
Notifications
You must be signed in to change notification settings - Fork 187
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
Document the properties of a high quality OSV record #2193
Document the properties of a high quality OSV record #2193
Conversation
e64bb03
to
12cd78b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great doc! I left some very soft suggestions and nits along with a few grammatical fixes
Co-authored-by: Jon <[email protected]>
Feedback was that it was possible to perceive this as known unfixed vulnerabilities as being of lower quality than ones with known/available fixes, and that is not the case, as such known unfixed vulnerabilities can and do legitimately exist (as is the case when the vulnerable package is orphaned). These are a legitimate true positive with no available fixed version.
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Reviewer feedback.
…ev into document_quality_bar
"Managing the Perishability of OSV Records" is in the early ideation phase.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me 👍
Co-authored-by: Jon <[email protected]>
Feedback was that it was possible to perceive this as known unfixed vulnerabilities as being of lower quality than ones with known/available fixes, and that is not the case, as such known unfixed vulnerabilities can and do legitimately exist (as is the case when the vulnerable package is orphaned). These are a legitimate true positive with no available fixed version.
Reviewer feedback.
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
Co-authored-by: Chris Bloom <[email protected]>
"Managing the Perishability of OSV Records" is in the early ideation phase.
I realised I'd omitted the `events[]` array in the JSON path when talking about `introduced` and `fixed`/`last_affected`. Explicitly refer to commits *and* versions when discussing temporal ordering of `introduced` and `fixed`/`last_affected`.
…ev into document_quality_bar
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the clarification in the documentation. I think this will be very useful to the OSV community & downstream consumers.
Based on feedback from Duy Truong about Android's patching approach.
|
||
## Rationale | ||
|
||
OSV.dev seeks to be a comprehensive, accurate and timely database of known vulnerabilities that is highly automation friendly. In order to meet this accuracy goal, a quality bar needs to be both defined and sustainably enforced. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'll have to cross that bridge when we get to it, I think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. As far as I understand it should be addressed in #2188 one way or another. Until then it would maybe make sense to mention that the quality bar isn't enforced yet. It should hopefully help to prevent treating all OSV entries as vulnerabilities. I'm 99% sure that bogus CVEs based on OSV data popped up because the OSV database was (and still is) advertised in a way that doesn't (always) match reality.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this discussion is separate to the intention of this document here.
This document is meant to serve as a reference for how to properly structure and format an OSV record. It doesn't go into whether or not a record is worthy of being considered a vulnerability. That would be a separate discussion :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It doesn't go into whether or not a record is worthy of being considered a vulnerability
Currently the documentation says "It is also assumed that the vulnerability discussed in the OSV record is valid and affects the software described" and looking at #2193 (comment) I think it implies that OSV records are vulnerabilities.
Either way I agree that this discussion can be moved elsewhere. Just to clarify I think OSS-Fuzz is great and OSV is great. It's just that they don't interact well with each other yet and get misused from time to time by some organizations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with some minor nits.
|
||
## Rationale | ||
|
||
OSV.dev seeks to be a comprehensive, accurate and timely database of known vulnerabilities that is highly automation friendly. In order to meet this accuracy goal, a quality bar needs to be both defined and sustainably enforced. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this discussion is separate to the intention of this document here.
This document is meant to serve as a reference for how to properly structure and format an OSV record. It doesn't go into whether or not a record is worthy of being considered a vulnerability. That would be a separate discussion :)
https://github.com/google/osv.dev/actions/runs/9933115405/job/27435624106 causes a modification to go.work.sum which then breaks the workflow. Revert modification to go.work.sum
Reference from existing documentation on data.
Part of #2186