Installation

CVE Scan has been tested and is supported on Ubuntu, Debian, Kali and Arch Linux, but should work on any standard Linux distribution running on Intel x64.

You can either use the provided installer, or install CVE Scan manually.

Use the installer (recommended)

The simplest way to install CVE Scan is to invoke the install.sh script located in the root directory, which will guide you through all installation steps:

  • installation of the required dependencies,
  • installation of CVE Scan command.

You will have the choice of installing CVE Scan in a Python virtual environment (refer to the Python documentation for details about how to use a virtual environment). We recommend doing this, so that CVE Scan does not interfere with existing Python packages you may use on your system.

Optionnally you can use the -d option if you want to be able to modify CVE Scan, which is only adviced for advanced users that would want to tamper with CVE Scan behaviour.

Warning

For compatibility with microprocessors not supporting Advanced Vector Extensions (AVX), use the install.sh --lts-cpu option.

Install manually

If you prefer to install CVE Scan manually the following dependencies are needed on your system:

  • git
  • libgit2-dev
  • python3-venv

After installing these set $cvescan_top to point to the CVE Scan root directory. From the top-level directory of your project run the following commands:

pip install wheel
pip install $cvescan_top[all]

Warning

For compatibility with microprocessors not supporting Advanced Vector Extensions (AVX), use pip install $cvescan_top[all-lts-cpu] instead.

Note on virtual environment

If you wish so, cvescan can be installed in a virtual environment. Run this steps before cvescan install, they will get you through the creation and activation of such an environment. 

mkdir .venv
python3 -m venv .venv
source .venv/bin/activate
Here is the official documentation on how to create a virtual environment.