Welcome to CVE Binary Tool’s documentation!

The CVE Binary Tool helps you determine if your system includes known vulnerabilities. You can scan binaries for a number of common, vulnerable components (openssl, libpng, libxml2, expat and others), or if you know the components used, you can get a list of known vulnerabilities associated with a list of components and versions.

Contents:

• CVE Binary Tool quick start / README
  • Installing CVE Binary Tool
  • Setting up an NVD_API_KEY
  • Most popular usage options
  • Output Options
  • Full option list
  • Configuration
  • Using CVE Binary Tool in GitHub Actions
  • Data Sources
  • Binary checker list
  • Language Specific checkers
  • SBOM Generation
  • Limitations
  • Additional Requirements
  • Supported Archive Formats
  • Feedback & Contributions
  • Security Issues
• CVE Binary Tool User Manual
  • How it works
  • Installing
  • Fixing Known Issues / What should I do if it finds something?
  • Limitations
  • Optional Arguments
  • CVE Data Download Arguments
  • Checkers Arguments
  • Input Arguments
  • Output Arguments
  • Merge Report Arguments
  • Database Management
  • Deprecated Arguments
  • SBOM
  • Feedback & Contributions
  • Security Issues
• CSV2CVE
  • Running the tool:
  • Additional Options:
  • Example .csv file:
  • Example output:
• How To Guides
  • How do I create a custom theme for the HTML Report?
  • How to scan a docker image?
  • How do I use CVE Binary Tool in an offline environment?
  • Best practices for running multiple scans at once
  • NVD CVE Retrieval API
  • How to use intermediate reports
  • Filter Intermediate Reports
• CVE Binary Tool Release Notes
  • CVE Binary Tool 3.2
  • CVE Bin Tool pre-release 3.2rc0
  • CVE Binary Tool 3.1.2
  • CVE Binary Tool 3.1.1
  • CVE Binary Tool 3.1
  • CVE Binary Tool 3.1rc3
  • CVE Binary Tool 3.1rc2
  • CVE Binary Tool 3.1.pre1
  • CVE Binary Tool 3.1.pre0
  • CVE Binary Tool 3.0
  • CVE Binary Tool 2.2.1
  • CVE Binary Tool 2.2
  • CVE Binary Tool 2.1.post1
  • CVE Binary Tool 2.1
  • CVE Binary Tool 2.0
  • CVE Binary Tool 1.1.1
  • CVE Binary Tool 2.0 alpha release
  • CVE Binary Tool 1.1
  • CVE Binary Tool 1.0
  • CVE Binary Tool 0.3.1
  • CVE Binary Tool 0.3.0
  • CVE Binary Tool 0.2.0
• CVE Binary Tool Contributor Guide
  • Imposter syndrome disclaimer
  • Code of Conduct
  • Development Environment
  • Getting and maintaining a local copy of the source code
  • Choosing a version of python
  • Setting up a virtualenv
  • Installing dependencies
  • Running your local copy of CVE Binary Tool
  • Help, my checkers aren’t loading
  • Running tests
  • Running linters
  • Making a new branch & pull request
  • Code Review
  • Style Guide for cve-bin-tool
  • Making documentation
  • Where should I start?
• Adding a new checker to the cve-bin-tool
  • Requirements
  • Hints for finding the right data to use
  • Helper-Script
  • Adding tests
  • Running tests
  • How it works
  • Updating checker table
  • Pull Request Template
• SBOMs For Humans

Indices and tables

• Index

• Module Index

• Search Page