Installation & Setup

Lightweight Python Package Installation

To install search_vulns, you have to have Python and pip installed beforehand. Then you can install the search_vulns Python package from PyPI like so:

pip install search_vulns

Note that you may have to include --break-system-packages, or use a virtualenv or pipx.

To install the required packages for the optional web server component, you can run:

pip install search_vulns[web]

You can also clone this repository, build the Python package yourself and keep all data editable and in the cloned repository (beneficial for development purposes):

git clone https://github.com/ra1nb0rn/search_vulns
pip install -e .

After installing search_vulns, you need to pull the prebuilt database files from GitHub like so:

search_vulns -u

Lastly, you can run search_vulns or start the search_vulns web server if the web dependencies are installed:

$ search_vulns -q 'jquery 2.1.3'
$ python3 -m search_vulns.web_server

Complete / Full Installation of search_vulns

You can perform a full installation like so (see notes above regarding pip installation):

pip install search_vulns
search_vulns --full-install

Note that this installs some required system packages, as specified in the install.sh files throughout the code.

Thereafter, you can download the database files from GitHub as shown above or build the databases yourself:

search_vulns --full-update

Note, however, that you should supply API keys via a config file, e.g. src/search_vulns/config.json, or as environment variables. All currently used API keys are free and you just need to register with the NVD or VulnCheck, for example.

Dockerfile

There's also a Dockerfile you can use:

docker build -t search_vulns .
docker run -p 127.0.0.1:5000:5000 -it search_vulns bash

The port forwarding is optional, in case you do not intend on using the web server component. If you do, make sure to adjust the listening socket at the end of src/search_vulns/web_server.py accordingly.