Skip to content
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

Enhance discussion of affected[].version formats #238

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Enhance discussion of affected[].version formats #238

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c49efc
Enhance discussion of affected[].version formats
andrewpollock Apr 30, 2024
7bcda4b
Reviewer suggested reword to remove assumption
andrewpollock May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/schema.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -678,6 +678,15 @@ The `affected` object's `versions` field is a JSON array of strings. Each string
is a single affected version in whatever version syntax is used by the given
package ecosystem.

When there is no well-defined packaging ecosystem specified (for
example, general C/C++ libraries), GIT commit ranges are typically the best way
to define vulnerable version ranges. In this case, versions specified in this
array cannot be relied upon to conform to any particular syntax (e.g. they
could be the upstream Git version tags derived from these GIT commit ranges,
which is what [OSV.dev](https://osv.dev/) populates this field with). In this
situation, the GIT commit ranges in [`affected[].ranges`](#affectedranges-field)
should be used to match vulnerabilities by Git commit hashes.

### affected[].ranges[] field

The `affected` object's `ranges` field is a JSON array of objects describing the
Expand Down