Welcome to VulnerableCode!

VulnerableCode provides an open database of software packages that are affected by known security vulnerabilities aka. “vulnerable packages”.

VulnerableCode is also a free and open source software (FOSS) project that provides the tools to build this open database. The tools handle collecting, aggregating and correlating these vulnerabilities and relating them to a correct package version. Our project also supports a public cloud instance of this database - VulnerableCode.io.

In this documentation you will find information on:

• An overview of VulnerableCode and what you can do with it

• Installation instructions

• How to make technical contributions to the project and the community

Getting Started

• VulnerableCode Overview
  • What can I do with VulnerableCode?
  • Why VulnerableCode?
  • How does it work?
  • How can I contribute to VulnerableCode?
• Installation
  • Run with Docker
  • Local development installation
  • Using Nix
• Contributing to VulnerableCode
  • Do Your Homework
  • Ways to Contribute
  • Helpful Resources
• FAQ
  • During development, how do I quickly empty my database and start afresh ?
• Miscellaneous
  • Continuous periodic Data import
  • Environment variables configuration
  • Throttling rate configuration

Tutorial

• Add a new importer
  • TL;DR
  • Prerequisites
  • Writing an importer
• Add a new improver
  • TL;DR
  • Prerequisites
  • Writing an improver

Reference Documentation

• Importer Overview
• Improver Overview
• Framework Overview
• Command Line Interface
  • $ ./manage.py --help
  • $ ./manage.py <subcommand> --help
  • $ ./manage.py import <importer-name>
  • $ ./manage.py improve <improver-name>
  • $ ./manage.py purl2cpe --destination <directory
• Importers
• API overview
  • Browse the Open API documentation
  • Enable the API key authentication
  • Create an API key-only user
  • Access the API using curl
  • API endpoints

Summer of Codes

• Google Summer of Code 2021 Final Report

Indices and tables

• Index

• Module Index

• Search Page