osv.dev - Open source vulnerability DB and triage service.

项目说明

<picture>
<source srcset="docs/images/os.svg" media="(prefers-color-scheme: dark)">
<!-- markdown-link-check-disable-next-line -->
<img src="docs/images/os.svg">
</picture>

---

![OpenSSF Scorecard]()

Documentation

Comprehensi is a here.
API documentation is a here.

Data Dump

We have data dumps a from a GCS bucket at gs://os. For more information check out our documentation.

the web UI

An instance of OSV's web UI is deployed at <

Using the scanner

We provide a Go based tool that will scan your dependencies, and check them against the OS for known via the OSV API.

Currently it is able to scan lockfiles, debian docker containers, SPDX and CycloneDB SBOMs, and git repositories.

The scanner is located in its own repository.

This repository

This repository contains all the code for running on GCP. This
consists of:

| directory | what |
|-----------------|------|
| bindings/ | Language bindings for the OSV API (currently Go only) |
| deployment/ | Terraform & Cloud Deploy config files <br /> A few Cloud Build config yamls |
| docker/ | CI docker files (ci, deployment, terraform, esp) <br /> worker-base docker image for gcp/workers/worker |
| docs/ | Jekyll files for <br /> build_swagger.sh and tools.go |
| gcp/datastore | The datastore index file (index.yaml) |
| gcp/functions | The Cloud Function for publishing PyPI (maintained, but not de) |
| gcp/indexer | The determine indexer |
| gcp/workers/ | Legacy Python workers (i.e. oss_fuzz_worker) |
| go/ | Go module for shared libraries and commands (cmd/api, cmd/website, cmd/importer, cmd/worker, cmd/exporter, cmd/recoverer, cmd/relations, etc.) |
| osv/ | The core OS library, used in basically all Python services <br /> OS package helpers in ecosystems/ <br /> Datastore model definitions in models.py |
| tools/ | Misc scripts/tools, mostly intended for de (datastore stuff, linting) <br /> The indexer-api-caller for indexer calling |
| / | Go module for (mostly) the NVD C <br /> The Alpine feed con (cmd/alpine) <br /> The Debian feed con (tools/debian, which is written in Python) |
| website/ | Frontend assets for the osv.de (in frontend3) and blog posts (in blog) |

You'll need to check out submodules as well for many local building steps to
work:

Contributing

Contributions are welcome!

Learn more about code, data, and documentation contributions.
We also have a mailing list.

Do you have a question or a suggestion? Please open an issue.

Third party tools and integrations

There are also community tools that use OSV. Note that these are community built
tools and as such are not supported or endorsed by the core OS. You may wish
to consult the OpenSSF's Concise Guide for E Open Source Software
to determine suitability for your use. Some popular third party tools are:

项目信息

开发语言：Go

Star 数：2960

技术要点

该项目属于漏洞知识库方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕Open source vulnerability DB and triage service.展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。