CVEServer

Simple REST-style web service for the CVE searching.

Requirements

• Ruby Version Manager
• Ruby 2.4.x or later version
• Bundler
• Mongo DB

Getting Started

Install the CVE Server

You must have running ruby, git, mongodb and nginx in your local machine.

curl --ssl -s https://raw.githubusercontent.com/SpiderLabs/cve_server/master/scripts/install.sh | bash -

Using the API

• Search for an specific CVE using its ID

  • http://localhost:port/v1/cve/CVE-2015-3900

• Search for several CVEs

  • http://localhost:port/v1/cves/CVE-2019-14407,CVE-2018-18656

• Search for CVEs related to a CPE without versions

  • http://localhost:port/v1/cpe/apache:spark

  • http://localhost:port/v1/cpe/apache:spark,apache:http_server

• List all the available CPEs with versions

  • http://localhost:port/v1/cpe

• Search for CVEs related to a CPE with versions

  • http://localhost:port/v1/cpe_with_version/samba:samba:4.0.0
  • http://localhost:port/v1/cpe_with_version/samba:samba:4.0.0,apache:http_server:2.4.4
  • Don't forget to encode the URI if that has special characters, example:
    • URI::encode('/v1/cpe_with_version/cisco:ios:15.4%282%29t1')

• List all the available CPEs with versions

  • http://localhost:port/v1/cpe_with_versions

Additional Information

• Deploying the CVE Server with Capistrano and Ngnix

Other installation method

1. Clone our repository.

git clone https://github.com/SpiderLabs/cve_server.git

2. Install the ruby dependencies.

bundle install

3. Download the raw data from the National Vulnerability Database. The supported NVD reports are XML 2.0 (by default) and JSON 1.0 files.

./bin/nvd_downloader

or

./bin/nvd_downloader -f json

4. Configure your database.

vi config/database.yml

5. Create and populate the database for you environment.

RACK_ENV=development ./bin/seed

or

RACK_ENV=development ./bin/seed -f json

The -f flag with the json option will populate the database using the experimental JSON reports from NVD and it renames the score key to base_score in the cvss (v2) field, it also includes the cvssv3 information and some changes for the links in the references field.

6. Start the server.

RACK_ENV=development puma

License

CVEServer is released under the MIT License