VulnerableCode is a free and open database of open source software package vulnerabilities because open source software vulnerabilities data and tools should be free and open source themselves.
Project description
VulnerableCode is a free and open database of open source software package vulnerabilities because open source software vulnerabilities data and tools should be free and open source themselves:
we are trying to change this and evolve the status quo in a few other areas!
Vulnerability databases have been traditionally proprietary even though they are mostly about free and open source software.
Vulnerability databases also often contain a lot of lesser value data which means a lot of false positive signals that require extensive expert reviews.
Vulnerability databases are also mostly about vulnerabilities first and software package second, making it difficult to find if and when a vulnerability applies to a piece of code. VulnerableCode focus is on software package first where a Package URL is a key and natural identifier for packages; this is making it easier to find a package and whether it is vulnerable.
Package URL themselves were designed first in ScanCode and VulnerableCode and are now a de-facto standard for vulnerability management and package references.
See https://github.com/package-url/purl-spec
The VulnerableCode project is a FOSS community resource to help improve the security of the open source software ecosystem and its users at large.
VulnerableCode consists of a database and the tools to collect, refine and keep the database current.
Read more about VulnerableCode https://vulnerablecode.readthedocs.org/
VulnerableCode is financially supported by NLnet, nexB, Google (through the GSoC) and the active contributions of several volunteers.
VulnerableCode tech stack is Python, Django, PostgreSQL, nginx and Docker and several libraries.
Getting started
Run with Docker
First install docker and docker-compose, then run:
git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode make envfile docker-compose build docker-compose up -d docker-compose run vulnerablecode ./manage.py import --list
Then run an importer for nginx advisories (which is small):
docker-compose exec vulnerablecode ./manage.py import vulnerabilities.importers.nginx.NginxImporter docker-compose exec vulnerablecode ./manage.py improve --all
At this point, the VulnerableCode app and API should be up and running with some data at http://localhost
Populate VulnerableCode database
VulnerableCode data collection works in two steps: importing data from multiple sources and then refining and improving how package and software vulnerabilities are related.
To run all importers and improvers use this:
./manage.py import --all ./manage.py improve --all
Local development installation
On a Debian system, use this:
sudo apt-get install python3-venv python3-dev postgresql libpq-dev build-essential git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode make dev envfile postgres make test ./manage.py import vulnerabilities.importers.nginx.NginxImporter ./manage.py improve --all make run
At this point, the VulnerableCode app and API is up at http://127.0.0.1:8001/
Interface
VulnerableCode comes with a minimal web UI:
And a JSON API and its minimal web documentation:
License
Copyright (c) nexB Inc. and others. All rights reserved.
VulnerableCode is a trademark of nexB Inc.
SPDX-License-Identifier: Apache-2.0 AND CC-BY-SA-4.0
VulnerableCode software is licensed under the Apache License version 2.0.
VulnerableCode data is licensed collectively under CC-BY-SA-4.0.
See https://www.apache.org/licenses/LICENSE-2.0 for the license text.
See https://creativecommons.org/licenses/by-sa/4.0/legalcode for the license text.
See https://github.com/nexB/vulnerablecode for support or download.
See https://aboutcode.org for more information about nexB OSS projects.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file vulnerablecode-31.0.0.tar.gz.
File metadata
- Download URL: vulnerablecode-31.0.0.tar.gz
- Upload date:
- Size: 21.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 07ee55251d66da0789dfcbd68a53a68de20c2736707a9a1a9f89609a81e37033 |
|
| MD5 | ad8c2be870bfea4d98efcae1bba8a4e6 |
|
| BLAKE2b-256 | f5195f865b27ba3efc1069f05b89911d7672fbbe898d99bb0ba42c5a45c3f445 |
Provenance
File details
Details for the file vulnerablecode-31.0.0-py3-none-any.whl.
File metadata
- Download URL: vulnerablecode-31.0.0-py3-none-any.whl
- Upload date:
- Size: 1.9 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c07a044ca687d66963eb13e935aa6079a03731c357cfc4bc0233a3e2fbad0d48 |
|
| MD5 | d4c65dd35d52b93290badd37c8274fc9 |
|
| BLAKE2b-256 | ca36fd0c192e95bff84cc66ff88fc14aa84926c309428207af7f1957c6d647f7 |
