开源项目 `osv.dev` 使用教程

开源项目 osv.dev 使用教程

osv.devOpen source vulnerability DB and triage service.项目地址:https://gitcode.com/gh_mirrors/os/osv.dev

1. 项目的目录结构及介绍

osv.dev 项目的目录结构如下：

osv.dev/
├── deployment/
│   ├── Terraform Cloud Deploy & App Engine config files
│   ├── Cloud Build config yamls
│   ├── api-staging and api-test Cloud Run configs
├── docker/
│   ├── CI docker files (ci, deployment, terraform)
├── workers/
│   ├── bisection and impact analysis (worker, importer, exporter, alias, worker-base)
├── cron/
│   ├── jobs for database backups and processing oss-fuzz records
├── docs/
│   ├── Jekyll files for https://google.github.io/osv.dev/
├── build_swagger.py
├── tools/
├── go/
├── gcp/
│   ├── api/
│   │   ├── OSV API server files (including files for the local ESP server)
│   │   ├── protobuf files in /v1
│   ├── appengine/
│   │   ├── backend of the osv.dev web interface with the frontend in frontend3
├── blog/
│   ├── Blog posts
├── datastore/
│   ├── indexes file (index.yaml)
├── functions/
│   ├── Cloud Function for publishing PyPI vulnerabilities
├── osv/
│   ├── core OSV Python library used in basically all Python services

目录结构介绍

• deployment/: 包含 Terraform 和 App Engine 的配置文件，以及 Cloud Build 的配置文件。
• docker/: 包含 CI 和部署所需的 Docker 文件。
• workers/: 包含用于二分法和影响分析的工作进程。
• cron/: 包含数据库备份和处理 oss-fuzz 记录的定时任务。
• docs/: 包含用于生成文档的 Jekyll 文件。
• gcp/: 包含 API 服务器文件和 App Engine 后端文件。
• blog/: 包含博客文章。
• datastore/: 包含数据存储索引文件。
• functions/: 包含用于发布 PyPI 漏洞的云函数。
• osv/: 包含核心的 OSV Python 库。

2. 项目的启动文件介绍

项目的启动文件主要位于 gcp/api 和 gcp/appengine 目录下。

gcp/api 目录

• main.py: 这是 API 服务器的主启动文件，负责启动和配置 API 服务。

gcp/appengine 目录

• main.py: 这是 App Engine 后端的主启动文件，负责启动和配置 Web 界面。

3. 项目的配置文件介绍

项目的配置文件主要位于 deployment/ 和 gcp/ 目录下。

deployment/ 目录

• app.yaml: 这是 App Engine 的配置文件，定义了应用的运行环境和资源配置。
• cloudbuild.yaml: 这是 Cloud Build 的配置文件，定义了构建和部署的步骤。

gcp/api 目录

• config.yaml: 这是 API 服务器的配置文件，定义了 API 的各种配置参数。

gcp/appengine 目录

• config.yaml: 这是 App Engine 后端的配置文件，定义了 Web 界面的各种配置参数。

以上是 osv.dev 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

osv.devOpen source vulnerability DB and triage service.项目地址:https://gitcode.com/gh_mirrors/os/osv.dev