Skip to content

Commit 8dec344

Browse files
docs: document data sources and external services (#2457)
## Overview **Issue:** #1433 This PR adds a "Data Sources and Privacy" section to the README documenting the external services OSV-Scanner communicates with during operation. Fixes #1433 ## Details Added documentation for: - **OSV.dev API** (`/v1/querybatch`, `/v1/determineversion`) - Vulnerability queries and vendored C/C++ detection - **deps.dev API** - License scanning, dependency resolution, and package deprecation - **Package Registries** - Maven Central and npm Registry for native resolution The section also clarifies that `--offline` mode disables network requests, and that no source code is transmitted. ## Testing - [x] Manual review of README formatting and content - [x] Verified documentation renders correctly ## Checklist - [x] I have signed the [Contributor License Agreement](https://cla.developers.google.com/). - [x] I have run the linter using [./scripts/run_lints.sh](cci:7://file:///Users/ankitsinghsisodya/osv-scanner/scripts/run_lints.sh:0:0-0:0). (N/A - docs only) - [x] I have run the unit tests using [./scripts/run_tests.sh](cci:7://file:///Users/ankitsinghsisodya/osv-scanner/scripts/run_tests.sh:0:0-0:0). (N/A - docs only) - [x] I have made my commits and PR title follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. --------- Co-authored-by: Xueqin Cui <72771658+cuixq@users.noreply.github.com>
1 parent 5f791d7 commit 8dec344

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,35 @@ $ osv-scanner fix \
140140

141141
<img src="https://google.github.io/osv-scanner/images/guided-remediation-relock-patches.png" alt="Screenshot of the interactive relock results screen with some relaxation patches selected">
142142

143+
## Data Sources and Privacy
144+
145+
OSV-Scanner communicates with the following external services during operation:
146+
147+
### [OSV.dev API](https://osv.dev/)
148+
149+
The primary data source for vulnerability information. OSV-Scanner queries this API to check packages for known vulnerabilities and to identify vendored C/C++ dependencies. Data sent includes package names, versions, ecosystems, and file hashes. Use [`--offline` mode](https://google.github.io/osv-scanner/usage/offline-mode/) to disable network requests and scan against a local database instead.
150+
151+
### [deps.dev API](https://docs.deps.dev/api/)
152+
153+
Used for supplementary package information:
154+
155+
- **Dependency resolution**: Resolves dependency graphs for vulnerability scanning and remediation
156+
- **Container image scanning**: Queries container image metadata for vulnerability detection
157+
- **License scanning** (`--licenses` flag): Retrieves license information for packages
158+
- **Package deprecation**: Checks if packages are deprecated
159+
160+
Data sent includes package names, versions, and ecosystems. No source code is transmitted.
161+
162+
### Package Registries
163+
164+
When using native registry for dependency resolution (instead of deps.dev), OSV-Scanner may query:
165+
166+
| Registry | URL | Used For |
167+
| ------------- | ------------------------------ | ------------------------------------ |
168+
| Maven Central | `repo.maven.apache.org/maven2` | Maven package metadata and POM files |
169+
| npm Registry | `registry.npmjs.org` | npm package metadata |
170+
| PyPI | `pypi.org` | Python package metadata |
171+
143172
## Contribute
144173

145174
### Report Problems

0 commit comments

Comments
 (0)