Repository navigation
feat(tools/osv): query OSV.dev for vulnerability cross-references during security triage (#311) #1297
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
feat(tools/osv): query OSV.dev for vulnerability cross-references during security triage (#311) #1297
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
52faca7
feat(tools/osv): query OSV.dev for vulnerability cross-references dur…
Kaap10 a108f80
fix(tools/osv): update TOC and fix link anchor to PRINCIPLES.md (#311)
Kaap10 83aee57
fix(tools/osv): address review feedback on template config, framing, …
Kaap10 5380908
fix(tools/osv): apply semantic line breaks, commit wording precision,…
Kaap10 1c34373
fixup! fix(tools/osv): apply semantic line breaks, commit wording pre…
potiuk 4f07268
fixup! fix(tools/osv): apply semantic line breaks, commit wording pre…
potiuk 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
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
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
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
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
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
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
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,38 @@ | ||
| <!-- SPDX-License-Identifier: Apache-2.0 | ||
| https://www.apache.org/licenses/LICENSE-2.0 --> | ||
|
|
||
| <!-- START doctoc generated TOC please keep comment here to allow auto update --> | ||
| <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> | ||
| **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* | ||
|
|
||
| - [`tools/osv/`](#toolsosv) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Configuration](#configuration) | ||
|
|
||
| <!-- END doctoc generated TOC please keep comment here to allow auto update --> | ||
|
|
||
| # `tools/osv/` | ||
|
|
||
| **Capability:** contract:security-cross-ref | ||
|
|
||
| **Kind:** implementation | ||
|
|
||
| **Vendor:** OSV.dev | ||
|
|
||
| OSV.dev vulnerability cross-reference client. | ||
| Queries the [OSV.dev REST API v1](https://api.osv.dev/v1/) for vulnerability records, aliases (CVE ↔ GHSA ↔ OSV IDs), affected package versions, and vulnerabilities associated with a public upstream commit. | ||
| Complements [`tools/cve-org/`](../cve-org/) and [`tools/cve-tool-vulnogram/`](../cve-tool-vulnogram/) by providing cross-ecosystem vulnerability records for intended triage consumers (`security-issue-triage`, `security-issue-deduplicate`, `security-cve-allocate`, and `dependency-audit` — not yet wired). | ||
| See [`tool.md`](tool.md) for endpoint recipes, payload structures, and confidentiality boundaries. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - **Runtime:** None of its own — this directory documents a read-only adapter; queries are `curl` + `jq` recipes (see `tool.md`). | ||
| - **CLIs:** `curl` and `jq`. | ||
| - **Credentials / auth:** None — OSV.dev is a public vulnerability database with an open, unauthenticated REST API. | ||
| - **Network:** `api.osv.dev` (OSV.dev REST API v1) and `osv.dev` (public web UI). | ||
|
potiuk marked this conversation as resolved.
Resolved
|
||
|
|
||
| ## Configuration | ||
|
|
||
| Adopters select this backend with `<project-config>/project.md` → `security_cross_ref.tool: osv` when performing automated vulnerability cross-referencing. | ||
| The default ecosystem (e.g. `PyPI`, `Maven`, `npm`, `Go`, `crates.io`, `NuGet`, `RubyGems`, `Packagist`) can be configured via `security_cross_ref.ecosystem`. | ||
| The adopter-facing configuration block is declared in [`projects/_template/project.md`](../../projects/_template/project.md#security-cross-reference). | ||
Oops, something went wrong.
Oops, something went wrong.
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.