Skip to content

ra1nb0rn/search_vulns

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

search_vulns logo

Search for known vulnerabilities in software using software titles or a CPE 2.3 string.

search_vulns release License PyPI downloads search-vulns.com up search_vulns contributors Python version

About · Quick Links · Modules · Installation · Usage · Wiki · License


About

search_vulns can be used to search for known vulnerabilities in software. To achieve this, it utilizes a locally built database containing various data sources about products, vulnerabilities, exploits, software recency and more. Since search_vulns is designed in a modular fashion, new data sources and extensions can be integrated easily. A complete list of all current modules and included data sources is provided in the Modules section.

You can either provide product titles like Apache 2.4.39 or a CPE 2.3 string like cpe:2.3:a:sudo_project:sudo:1.8.2:*:*:*:*:*:*:* as input. In addition, you can directly search for vulnerabilities like CVE-2023-1234 or GHSA-xx68-jfcg-xmmf by using a comma-separated list of IDs.

search_vulns can either be used as a CLI tool or via a web server. It is recommended to use the CLI tool for automated workflows that might be resource-constrained. Otherwise, using the web server is recommended, because it offers more features and flexibility. A public instance of the web server is available at https://search-vulns.com.

Quick Links

Modules

search_vulns' search engine is designed in a modular fashion. Therefore, new data sources can be integrated easily. The currently available modules and data sources are the following:

Module ID Description
nvd.search_vulns_nvd Integrates CVE information and exploits from the National Vulnerability (NVD) database
vulncheck.search_vulns_nvdpp Integrates additional enrichment of the CVE/NVD data via VulnCheck's NVD++
ghsa.search_vulns_ghsa Integrates CVE and non-CVE vulnerabilties from the GitHub Security Advisory (GHSA) database
exploit_db.search_vulns_edb Integrates publicly available exploits from the Exploit-DB
poc_in_github.search_vulns_poc_in_github Integrates exploit information from PoC-in-GitHub
msf_exploits.search_vulns_msf_exploits Integrates information about exploits in the Metasploit Framework
end_of_life_date.search_vulns_eold Integrates software recency information from endoflife.date
epss.search_vulns_epss Integrates FIRST's EPSS scores for CVEs
cpe_search.search_vulns_cpe_search Matches a users natural language query to a CPE string via cpe_search and the NVD's official dictionary
linux_distro_backpatches.debian.
search_vulns_debian
Integrates backpatch information from the Debian Security Bug Tracker
linux_distro_backpatches.ubuntu.
search_vulns_ubuntu
Integrates backpatch information from the Ubuntu Security API via aquasecurity's repository
linux_distro_backpatches.redhat.
search_vulns_redhat
Integrates backpatch information from the Red Hat Security Data API via aquasecurity's repository

As this overview shows, modules can help in finding product IDs, vulnerabilities, extra information about vulnerabilities and extra information about the queried product. Examples of the latter two are exploits, CVSS or EPSS scores, or software recency information. Furthermore, modules can classify identified vulnerabilities as patched if they store and utilize special information related to the query, for example.

Have a look at the template module to get started with writing your own modules: src/search_vulns/modules/template/search_vulns_template.py.

Installation

The core of search_vulns can be installed as a lightweight Python package, optionally with a web server component. An extended installation can be performed, which enables you to build the local databases yourself instead of pulling them from the latest release on GitHub and to use MariaDB as database backend. As of now, there are no other functional differences.

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.

Usage

search_vulns's usage information is shown in the following:

usage: search_vulns [-h] [-u] [--full-update] [--full-update-module MODULE_ID [MODULE_ID ...]]
                    [--full-install] [-a] [-f {txt,json}] [-o OUTPUT] [-q QUERY] [-c CONFIG]
                    [-V] [--cpe-search-threshold CPE_SEARCH_THRESHOLD]
                    [--ignore-general-product-vulns] [--include-single-version-vulns]
                    [--use-created-product-ids] [--include-patched]

Search for known vulnerabilities in software -- Created by Dustin Born (ra1nb0rn)

options:
  -h, --help            show this help message and exit
  -u, --update          Download the latest version of the the local vulnerability and
                        software database from GitHub repo
  --full-update         Fully (re)build the local vulnerability and software database
  --full-update-module MODULE_ID [MODULE_ID ...]
                        Fully (re)build the local database for the given module(s) in-place
  --full-install        Fully install search_vulns, including all dependencies (python
                        packages, system packages etc.)
  -a, --artifacts       Print JSON list of artifacts created during full update
  -f {txt,json}, --format {txt,json}
                        Output format, either 'txt' or 'json' (default: 'txt')
  -o OUTPUT, --output OUTPUT
                        File to write found vulnerabilities to
  -q QUERY, --query QUERY
                        A query, either a software title like 'Apache 2.4.39', a product ID
                        string (e.g. CPE 2.3) or a list of vuln IDs
  -c CONFIG, --config CONFIG
                        A config file to use (default: config.json)
  -V, --version         Print the version of search_vulns
  --cpe-search-threshold CPE_SEARCH_THRESHOLD
                        Similarity threshold used for retrieving a CPE via the cpe_search tool
  --ignore-general-product-vulns
                        Ignore vulnerabilities that only affect a general product (i.e.
                        without version)
  --include-single-version-vulns
                        Include vulnerabilities that only affect one specific version of a
                        product when querying a lower version
  --use-created-product-ids
                        If no matching product ID exists in the software database,
                        automatically use matching ones created by search_vulns
  --include-patched     Include vulnerabilities reported as (back)patched, e.g. by Debian
                        Security Tracker, in results

Note that when querying software with -q you have to put the software information in quotes if it contains any spaces. Also, you can use -q multiple times to make multiple queries at once. For one, a query can be a software name / title like 'Apache 2.4.39' or 'Wordpress 5.7.2'. Furthermore, a query can also be a CPE 2.3 string.

Here are some examples:

  • Query Sudo 1.8.2 for known vulnerabilities:
    $ search_vulns -q 'Sudo 1.8.2'
    [+] Sudo 1.8.2 (cpe:2.3:a:sudo_project:sudo:1.8.2:*:*:*:*:*:*:*/cpe:2.3:a:todd_miller:sudo:1.8.2:*:*:*:*:*:*:*)
    CVE-2019-14287 (CVSSv3.1/8.8): In Sudo before 1.8.28, an attacker with access to a Runas ALL sudoer account can bypass certain policy blacklists and session PAM modules, and can cause incorrect logging, by invoking sudo with a crafted user ID. For example, this allows bypass of !root configuration, and USER= logging, for a "sudo -u \#$((0xffffffff))" command.
    Exploits:  https://www.exploit-db.com/exploits/47502
               [...]
    Reference: https://nvd.nist.gov/vuln/detail/CVE-2019-14287, 2019-10-17
    CVE-2017-1000368 (CVSSv3.0/8.2): Todd Miller's sudo version 1.8.20p1 and earlier is vulnerable to an input validation (embedded newlines) in the get_process_ttyname() function resulting in information disclosure and command execution.
    Reference: https://nvd.nist.gov/vuln/detail/CVE-2017-1000368, 2017-06-05
    [...]
  • Query Moodle 3.4.0 for known vulnerabilities:
    $ search_vulns -q 'Moodle 3.4.0'
    [+] Moodle 3.4.0 (cpe:2.3:a:moodle:moodle:3.4.0:*:*:*:*:*:*:*)
    CVE-2018-14630 (CVSSv3.0/8.8): moodle before versions 3.5.2, 3.4.5, 3.3.8, 3.1.14 is vulnerable to an XML import of ddwtos could lead to intentional remote code execution. When importing legacy 'drag and drop into text' (ddwtos) type quiz questions, it was possible to inject and execute PHP code from within the imported questions, either intentionally or by importing questions from an untrusted source.
    Reference: https://nvd.nist.gov/vuln/detail/CVE-2018-14630, 2018-09-17
    CVE-2018-1133 (CVSSv3.0/8.8): An issue was discovered in Moodle 3.x. A Teacher creating a Calculated question can intentionally cause remote code execution on the server, aka eval injection.
    Exploits:  https://www.exploit-db.com/exploits/46551
    Reference: https://nvd.nist.gov/vuln/detail/CVE-2018-1133, 2018-05-25
    [...]
  • Explicitly retrieve information about CVE-2024-24824 and GHSA-q9q2-3ppx-mwqf:
    $ search_vulns -q 'CVE-2024-24824 GHSA-q9q2-3ppx-mwqf'
    [+] CVE-2024-24824 GHSA-q9q2-3ppx-mwqf ()
    CVE-2024-24824 (CVSSv3.1/8.8): Graylog is a free and open log management platform. Starting in version 2.0.0 and prior to versions 5.1.11 and 5.2.4, arbitrary classes can be loaded and instantiated using a HTTP PUT request to the `/api/system/cluster_config/` endpoint. Graylog's cluster config system uses fully qualified class names as config keys. To validate the existence of the requested class before using them, Graylog loads the class using the class loader. [...]
    Exploits:  https://github.com/Graylog2/graylog2-server/security/advisories/GHSA-p6gg-5hf4-4rgj
    Reference: https://nvd.nist.gov/vuln/detail/CVE-2024-24824, 2024-02-07
    GHSA-q9q2-3ppx-mwqf (CVSSv3.1/7.3): Graylog Allows Stored Cross-Site Scripting via Files Plugin and API Browser
    Reference: https://github.com/advisories/GHSA-q9q2-3ppx-mwqf, 2025-05-07
  • Retrieve open vulnerabilities for Squid 5.7-2 on Debian 12:
    $ search_vulns -q 'Squid 5.7-2 Debian 12'
    [...]
  • Retrieve open vulnerabilities for Apache Tomcat 9.0.70-2 on Ubuntu Plucky
    $ search_vulns -q 'Apache Tomcat 9.0.70-2 Ubuntu Plucky'
    [...]
  • Retrieve vulnerabilities, including backpatched ones, for Nginx 1.20.1-22 on RHEL 9.2 in JSON format:
    $ search_vulns -q 'Nginx 1.20.1-22 RHEL 9.2' -f json --include-patched
    [...]

Running a Web Server

It is also possible to run a web server that provides this tool's functionality to clients over the network. src/search_vulns/web_server.py contains a working example using Flask. Depending on your environment, you may want to modify the server IP and port at the end of this file. To run a simple Flask web server, just run:

python3 -m search_vulns.web_server

Furthermore, you can use gunicorn to make the web server more scalable; for example by running:

gunicorn --worker-class=gevent --worker-connections=50 --workers=3 --bind '0.0.0.0:8000' search_vulns.wsgi:app

You can read more about choosing good gunicorn settings for your system here. Note, however, that this tool is quite CPU intensive, meaning that scalability is somewhat limited.

Finally, you can also use Nginx as a reverse proxy. A sample configuration file is provided in web_server_files/nginx.conf.sample. Again, you may have to adjust this to your needs. When using Nginx, make sure you have the app running at the configured endpoint(s). For the sample configuration file, for example, you would have to run something similar to the following:

gunicorn --worker-class=gevent --worker-connections=50 --workers=3 --bind 'unix:/tmp/gunicorn.sock' search_vulns.wsgi:app

MariaDB as Alternative Database Option

search_vulns can be configured to use MariaDB as an alternative to the preconfigured SQLite mechanism. A sample configuration file for MariaDB is provided in src/search_vulns/config_mariadb.json.

Make sure that you adjust the values for MariaDB in the configuration file to your MariaDB deployment (user, password, host and port).

To use MariaDB instead of SQLite for the webserver, simply change the CONFIG_FILE variable in web_server.py to your config file (e.g. src/search_vulns/config_mariadb.json).

To improve the performance of search_vulns with MariaDB, it is recommend to add the following settings to your MariaDB configuration file (e.g. /etc/mysql/my.cnf):

[mariadb]
query_cache_type = 1
query_cache_size = 192M
innodb_buffer_pool_size = 8G
thread_handling = pool-of-threads

innodb_buffer_pool_size should be set to approximately 80% of available memory (see MariaDB's official documentation).

License

search_vulns is licensed under the MIT license, see here.

View the licenses of the included data sources here.