Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AppThreat/vulnerability-db
Vulnerability database and package search for sources such as Linux, OSV, NVD, GitHub and npm. Powered by sqlite, CVE 5.0, purl, and vers.
https://github.com/AppThreat/vulnerability-db
advisories cli cve database nvd purl sca vers vulnerability-database vulnerability-detection
Last synced: about 15 hours ago
JSON representation
Vulnerability database and package search for sources such as Linux, OSV, NVD, GitHub and npm. Powered by sqlite, CVE 5.0, purl, and vers.
- Host: GitHub
- URL: https://github.com/AppThreat/vulnerability-db
- Owner: AppThreat
- License: mit
- Created: 2020-01-20T10:16:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T09:36:30.000Z (6 months ago)
- Last Synced: 2024-05-23T09:51:15.621Z (6 months ago)
- Topics: advisories, cli, cve, database, nvd, purl, sca, vers, vulnerability-database, vulnerability-detection
- Language: Python
- Homepage:
- Size: 3.18 MB
- Stars: 72
- Watchers: 6
- Forks: 20
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-software-supply-chain-security - AppThreat/vulnerability-db: Vulnerability database and package search for sources such as OSV, NVD, GitHub and npm.
README
# Introduction
This repo is a vulnerability database and package search for sources such as AppThreat vuln-list, OSV, NVD, and GitHub. Vulnerability data are downloaded from the sources and stored in a sqlite based storage with indexes to allow offline access and efficient searches.
## Why vulnerability db?
A good vulnerability database must have the following properties:
- Accuracy
- Easy to [download](#download-pre-built-database-recommended), [integrate](./INTEGRATION.md), and use
- Performance
Multiple upstream sources are used by vdb to improve accuracy and reduce false negatives. SQLite database containing data in CVE 5.1 schema format is precompiled and distributed as files via ghcr to simplify download. With automatic purl prefix generation even for git repos, searches on the database can be performed with purl, cpe, or even http git url string. Every row in the database uses an open specification such as CVE 5.0 or Package URL (purl and vers) thus preventing the possibility of vendor lock-in.
## Vulnerability Data sources
- Linux [vuln-list](https://github.com/appthreat/vuln-list) (Forked from AquaSecurity)
- OSV (1)
- NVD
- GitHub
1 - We exclude Linux and oss-fuzz feeds by default. Set the environment variable `OSV_INCLUDE_FUZZ=true` to include them.
2 - Malware feeds are included by default, thus increasing the db size slightly. Set the environment variable `OSV_EXCLUDE_MALWARE=true` to exclude them.
## Linux distros
- AlmaLinux
- Debian
- Alpine
- Amazon Linux
- Arch Linux
- RHEL/CentOS
- Rocky Linux
- Ubuntu
- OpenSUSE
- Photon
- Chainguard
- Wolfi OS
## Installation
```shell
pip install appthreat-vulnerability-db>=6.2.0
```
To install vdb with optional dependencies such as `oras` use the `[oras]` or `[all]` dependency group.
```shell
pip install appthreat-vulnerability-db[all]
```
**NOTE:** VDB v6 is a major rewrite to use SQLite database. Current users of depscan v5 must continue using version 5.8.x
```shell
pip install appthreat-vulnerability-db==5.8.0
```
## Usage
This package is ideal as a library for managing vulnerabilities. This is used by [owasp-dep-scan](http://github.com/owasp-dep-scan/dep-scan), a free open-source dependency audit tool. However, there is a limited cli capability available with few features to test this tool directly.
### Option 1: Download pre-built database (Recommended)
To download a pre-built SQLite database ([refreshed](https://github.com/AppThreat/vdb/actions) every 6 hours) containing all application vulnerabilities (~ 700MB). This step is recommended for all users.
```shell
# pip install appthreat-vulnerability-db[all]
vdb --download-image
```
You can execute this command daily or when a fresh database is required.
To perform containers and OS scans, download the full image (~ 7.5GB) which includes all application and OS vulnerabilities.
```
vdb --download-full-image
```
### Option 2: Download pre-built database (ORAS)
Using [ORAS cli](https://oras.land/) might be slightly faster.
```
export VDB_HOME=$HOME/vdb
oras pull ghcr.io/appthreat/vdbxz:v6 -o $VDB_HOME
tar -xvf *.tar.xz
rm *.tar.xz
```
Use any sqlite browser or cli tools to load and query the two databases.
**data.index.vdb6** - index db with purl prefix and vers
**data.vdb6** - Contains source data in CVE 5.1 format stored as a jsonb blob.
### Option 3: Manually create the vulnerability database (ADVANCED users)
Cache application vulnerabilities
```shell
vdb --cache
```
The typical size of this database is over 700 MB.
Cache from just [OSV](https://osv.dev)
```shell
vdb --cache --only-osv
```
It is possible to customize the cache behavior by increasing the historic data period to cache by setting the following environment variables.
- NVD_START_YEAR - Default: 2018. Supports up to 2002
- GITHUB_PAGE_COUNT - Default: 2. Supports up to 20
Cache application and OS vulnerabilities
```shell
vdb --cache-os
```
Note the size of the database with OS vulnerabilities is over 7.5 GB. It is possible to ignore/exlude specific OS distros using environment variables.
Example to ignore almalinux and ubuntu data from getting included, set the below environment variables:
```shell
export VDB_IGNORE_ALMALINUX=true
export VDB_IGNORE_UBUNTU=true
```
Refer to the variable `LINUX_DISTRO_VULN_LIST_PATHS` in [config.py](./vdb/lib/config.py) for the full list of distro strings supported.
## CLI Usage
```shell
usage: vdb [-h] [--clean] [--cache] [--cache-os] [--only-osv] [--only-aqua] [--only-ghsa] [--search SEARCH] [--list-malware] [--bom BOM_FILE]
AppThreat's vulnerability database and package search library with a built-in sqlite based storage.
options:
-h, --help show this help message and exit
--clean Clear the vulnerability database cache from platform specific user_data_dir.
--cache Cache vulnerability information in platform specific user_data_dir.
--cache-os Cache OS vulnerability information in platform specific user_data_dir.
--only-osv Use only OSV as the source. Use with --cache.
--only-aqua Use only Aqua vuln-list as the source. Use with --cache.
--only-ghsa Use only recent ghsa as the source. Use with --cache.
--search SEARCH Search for the package or CVE ID in the database. Use purl, cpe, or git http url.
--list-malware List latest malwares with CVE ID beginning with MAL-.
--bom BOM_FILE Search for packages in the CycloneDX BOM file.
--download-image Downloaded pre-created vdb image to platform specific user_data_dir. Application vulnerabilities only.
--download-full-image
Downloaded pre-created vdb image to platform specific user_data_dir. All vulnerabilities including OS.
--print-vdb-metadata Display metadata about the current vdb in user_data_dir.
```
### CLI search
It is possible to perform a range of searches using the cli.
```shell
vdb --search pkg:pypi/[email protected]
# Search based on a purl prefix
vdb --search pkg:pypi/xml2dict
# Full url and short form for swift
vdb --search "pkg:swift/github.com/vapor/[email protected]"
vdb --search "pkg:swift/vapor/[email protected]"
# Search by cpe
vdb --search "cpe:2.3:a:npm:gitblame:*:*:*:*:*:*:*:*"
# Search by colon separated values
vdb --search "npm:gitblame:0.0.1"
# Search by vulnerability id (CVE, GHSA, ALSA, DSA, etc.)
vdb --search CVE-2024-25169
# Search with wildcard for CVE
vdb --search CVE-2024-%
# Search by git url
vdb --search "https://github.com/electron/electron"
# Search by CycloneDX SBOM
vdb --bom bom.json
```
### List recent malware
To list malware entries with the `MAL-` prefix, use the following command.
```shell
vdb --list-malware
```
## Library usage
Refer to [cli.py](./vdb/cli.py) for usage. Below is a sample code snippet.
```python
from vdb.lib import config, db6 as db_lib, search
from vdb.lib.cve_model import CVE
# Perform search
results = search.search_by_any("purl or cpe or url", with_data=True)
# Download prebuilt database
from vdb.lib.orasclient import download_image
download_image(config.VDB_DATABASE_URL, config.DATA_DIR)
# Check if database needs updating
if db_lib.needs_update():
print("Database needs to be updated")
download_image(...)
```
## License
MIT