Giters

mikecb / go-cve-dictionary

Build a local copy of CVE (NVD and Japanese JVN). Server mode for easy querying.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

go-cve-dictionary

This is tool to build a local copy of the NVD (National Vulnerabilities Database) [1] and the Japanese JVN [2], which contain security vulnerabilities according to their CVE identifiers [3] including exhaustive information and a risk score. The local copy is generated in sqlite format, and the tool has a server mode for easy querying.

[1] https://en.wikipedia.org/wiki/National_Vulnerability_Database
[2] https://en.wikipedia.org/wiki/Common_Vulnerabilities_and_Exposures
[3] http://jvndb.jvn.jp/apis/termsofuse.html

Install requirements

go-cve-dictionary requires the following packages.

$ ssh ec2-user@52.100.100.100  -i ~/.ssh/private.pem
$ sudo yum -y install sqlite git gcc
$ wget https://storage.googleapis.com/golang/go1.6.linux-amd64.tar.gz
$ sudo tar -C /usr/local -xzf go1.6.linux-amd64.tar.gz
$ mkdir $HOME/go

Put these lines into /etc/profile.d/goenv.sh

export GOROOT=/usr/local/go
export GOPATH=$HOME/go
export PATH=$PATH:$GOROOT/bin:$GOPATH/bin

Set the OS environment variable to current shell

$ source /etc/profile.d/goenv.sh

Deploy go-cve-dictionary

To install, use go get:

go get

$ sudo mkdir /var/log/vuls
$ sudo chown ec2-user /var/log/vuls
$ sudo chmod 700 /var/log/vuls
$ go get github.com/kotakanbe/go-cve-dictionary

Fetch Vulnerability data from NVD.
It takes about 10 minutes (on AWS).

$ for i in {2002..2016}; do ./go-cve-dictionary fetchnvd -years $i; done
... snip ...
$ ls -alh cve.sqlite3
-rw-r--r-- 1 ec2-user ec2-user 7.0M Mar 24 13:20 cve.sqlite3

Now we have vulnerability data.
Start go-cve-dictionary as server mode.

$ go-cve-dictionary server
[Mar 24 15:21:55]  INFO Opening DB. datafile: /home/ec2-user/cve.sqlite3
[Mar 24 15:21:55]  INFO Migrating DB
[Mar 24 15:21:56]  INFO Starting HTTP Sever...
[Mar 24 15:21:56]  INFO Listening on 127.0.0.1:1323

Hello HeartBleed

$ curl http://127.0.0.1:1323/cves/CVE-2014-0160 | jq "." 
{
  "ID": 63949,
  "CreatedAt": "2016-03-23T20:50:52.712279635+09:00",
  "UpdatedAt": "2016-03-23T20:50:52.712279635+09:00",
  "DeletedAt": null,
  "CveInfoID": 0,
  "CveID": "CVE-2014-0160",
  "Nvd": {
    "ID": 63949,
    "CreatedAt": "2016-03-23T20:50:52.712384527+09:00",
    "UpdatedAt": "2016-03-23T20:50:52.712384527+09:00",
    "DeletedAt": null,
    "CveDetailID": 63949,
    "Summary": "The (1) TLS and (2) DTLS implementations in OpenSSL 1.0.1 before 1.0.1g do not properly handle Heartbeat Extension packets, which allows remote attackers to obtain sensitive information from process memory via crafted packets that trigger a buffer over-read, as demonstrated by reading private keys, related to d1_both.c and t1_lib.c, aka the Heartbleed bug.",
    "Score": 5,
    "AccessVector": "NETWORK",
    "AccessComplexity": "LOW",
    "Authentication": "NONE",
    "ConfidentialityImpact": "PARTIAL",
    "IntegrityImpact": "NONE",
    "AvailabilityImpact": "NONE",
    "Cpes": null,
    "References": [
      {
        "ID": 316262,
        "CreatedAt": "2016-03-23T20:50:52.715120529+09:00",
        "UpdatedAt": "2016-03-23T20:50:52.715120529+09:00",
        "DeletedAt": null,
        "JvnID": 0,
        "NvdID": 63949,
        "Source": "CERT",
        "Link": "http://www.us-cert.gov/ncas/alerts/TA14-098A"
      },
      ...snip...
    ],
    "PublishedDate": "2014-04-07T18:55:03.893-04:00",
    "LastModifiedDate": "2015-10-22T10:19:38.453-04:00"
  },
  "Jvn": {
    "ID": 651,
    "CreatedAt": "2016-03-23T20:53:47.711776398+09:00",
    "UpdatedAt": "2016-03-23T20:53:47.711776398+09:00",
    "DeletedAt": null,
    "CveDetailID": 63949,
    "Title": "OpenSSL の heartbeat 拡張に情報漏えいの脆弱性",
    "Summary": "OpenSSL の heartbeat 拡張の実装には、情報漏えいの脆弱性が存在します。TLS や DTLS 通信において OpenSSL のコードを実行しているプロセスのメモリ内容が通信相手に漏えいする可能性があります。",
    "JvnLink": "http://jvndb.jvn.jp/ja/contents/2014/JVNDB-2014-001920.html",
    "JvnID": "JVNDB-2014-001920",
    "Score": 5,
    "Severity": "Medium",
    "Vector": "(AV:N/AC:L/Au:N/C:P/I:N/A:N)",
    "References": [
      {
        "ID": 369475,
        "CreatedAt": "2016-03-23T20:53:47.711885901+09:00",
        "UpdatedAt": "2016-03-23T20:53:47.711885901+09:00",
        "DeletedAt": null,
        "JvnID": 651,
        "NvdID": 0,
        "Source": "AT-POLICE",
        "Link": "http://www.npa.go.jp/cyberpolice/detect/pdf/20140410.pdf"
      },
      ...snip...
    ],
    "Cpes": null,
    "PublishedDate": "2014-04-08T16:13:59+09:00",
    "LastModifiedDate": "2014-04-08T16:13:59+09:00"
  }
}

Hello Ruby on Rails 4.0.2

$ curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"name": "cpe:/a:rubyonrails:ruby_on_rails:4.0.2:-"}' http://localhost:1323/cpes | jq "."
[
  {
    "ID": 345,
    "CreatedAt": "2016-04-10T10:52:26.196610454+09:00",
    "UpdatedAt": "2016-04-10T10:52:26.196610454+09:00",
    "DeletedAt": null,
    "CveInfoID": 0,
    "CveID": "CVE-2016-0751",
    "Nvd": {
      "ID": 345,
      "CreatedAt": "2016-04-10T10:52:26.196853826+09:00",
      "UpdatedAt": "2016-04-10T10:52:26.196853826+09:00",
      "DeletedAt": null,
      "CveDetailID": 345,
      "Summary": "actionpack/lib/action_dispatch/http/mime_type.rb in Action Pack in Ruby on Rails before 3.2.22.1, 4.0.x and 4.1.x before 4.1.14.1, 4.2.x before 4.2.5.1, and 5.x before 5.0.0.beta1.1 does not properly restrict use of the MIME type cache, which allows remote attackers to cause a denial of service (memory consumption) via a crafted HTTP Accept header.",
      "Score": 5,
      "AccessVector": "NETWORK",
      "AccessComplexity": "LOW",
      "Authentication": "NONE",
      "ConfidentialityImpact": "NONE",
      "IntegrityImpact": "NONE",
      "AvailabilityImpact": "PARTIAL",
      "Cpes": null,
      "References": [
        {
          "ID": 486,
          "CreatedAt": "2016-04-10T10:52:26.217958168+09:00",
          "UpdatedAt": "2016-04-10T10:52:26.217958168+09:00",
          "DeletedAt": null,
          "JvnID": 0,
          "NvdID": 345,
          "Source": "MLIST",
          "Link": "https://groups.google.com/forum/message/raw?msg=ruby-security-ann/9oLY_FCzvoc/5CDXbvpYEgAJ"
        },
        {
          "ID": 487,
          "CreatedAt": "2016-04-10T10:52:26.218175571+09:00",
          "UpdatedAt": "2016-04-10T10:52:26.218175571+09:00",
          "DeletedAt": null,
          "JvnID": 0,
          "NvdID": 345,
          "Source": "MLIST",
          "Link": "http://www.openwall.com/lists/oss-security/2016/01/25/9"
        }
      ],
      "PublishedDate": "2016-02-15T21:59:05.877-05:00",
      "LastModifiedDate": "2016-03-18T21:02:43.817-04:00"
    },
    "Jvn": {
      "ID": 0,
      "CreatedAt": "0001-01-01T00:00:00Z",
      "UpdatedAt": "0001-01-01T00:00:00Z",
      "DeletedAt": null,
      "CveDetailID": 0,
      "Title": "",
      "Summary": "",
      "JvnLink": "",
      "JvnID": "",
      "Score": 0,
      "Severity": "",
      "Vector": "",
      "References": null,
      "Cpes": null,
      "PublishedDate": "0001-01-01T00:00:00Z",
      "LastModifiedDate": "0001-01-01T00:00:00Z"
    }
  },
  ... snip ...
]

Usage:

$ go-cve-dictionary -help
Usage: go-cve-dictionary <flags> <subcommand> <subcommand args>

Subcommands:
        commands         list all command names
        flags            describe all known top-level flags
        help             describe subcommands and their syntax

Subcommands for fetchjvn:
        fetchjvn         Fetch Vulnerability dictionary from JVN

Subcommands for fetchnvd:
        fetchnvd         Fetch Vulnerability dictionary from NVD

Subcommands for loadjvn:
        loadjvn          Start CVE dictionary HTTP server

Subcommands for server:
        server           Start CVE dictionary HTTP server


Use "go-cve-dictionary flags" for a list of top-level flags

go-cve-dictionary has four subcommands

  • fetchnvd
    Fetch vulnerbility data from NVD(English)

  • fetchjvn Fetch vulnerbility data from JVN(Japanese)

  • loadjvn Load vulnerbility data from local json file(Japanese)

  • server Start HTTP server

Usage: Fetch NVD Data.

$ ./go-cve-dictionary fetchnvd -help
fetchnvd:
        fetchnvd
                [-last2y]
                [-years] 2015 2016 ...
                [-dbpath=/path/to/cve.sqlite3]
                [-http-proxy=http://192.168.0.1:8080]
                [-debug]
                [-debug-sql]

For the first time, run the blow command to fetch data for entire period. (It takes about 10 minutes)
   $ for i in {2002..2016}; do go-cve-dictionary fetchnvd -years $i ; done

  -dbpath string
        /path/to/sqlite3 (default "$PWD/cve.sqlite3")
  -debug
        debug mode
  -debug-sql
        SQL debug mode
  -http-proxy string
        http://proxy-url:port (default: empty)
  -last2y
        Refresh NVD data in the last two years.
  -years
        Refresh NVD data of specific years.
  • Fetch data in the last two years
$ go-cve-dictionary fetchnvd -last2y
  • Fetch data of specific years
$ go-cve-dictionary fetchnvd -years 2002 2003 2016
  • Fetch NVD data for entire period.
for i in {2002..2016}; do ./go-cve-dictionary fetchnvd -years $i; done

Usage: Fetch JVN Data.

$ go-cve-dictionary fetchjvn -h
fetchjvn:
        fetchjvn
                [-dump-path=/path/to/cve.json]
                [-dbpath=$PWD/cve.sqlite3]
                [-week]
                [-month]
                [-entire]
                [-http-proxy=http://192.168.0.1:8080]
                [-debug]
                [-debug-sql]

  -dbpath string
        /path/to/sqlite3 (default "$PWD/cve.sqlite3")
  -debug
        debug mode
  -debug-sql
        SQL debug mode
  -dump-path string
        /path/to/cve.json (default: empty(nodump))
  -entire
        Fetch data for entire period.(This operation is time-consuming) (default: false)
  -http-proxy string
        http://proxy-url:port (default: empty)
  -month
        Fetch data in the last month
  -week
        Fetch data in the last week
  • Fetch data for entire period
$ go-cve-dictionary fetchjvn --entire
  • Fetch data in the last month
$ go-cve-dictionary fetchnjvn -month
  • Fetch data in the last week
$ go-cve-dictionary fetchjvn -week

Usage: Run HTTP Server.

$ go-cve-dictionary server -h
server:
        server
                [-bind=127.0.0.1]
                [-port=8000]
                [-dbpath=$PWD/cve.sqlite3]
                [-debug]
                [-debug-sql]

  -bind string
        HTTP server bind to IP address (default: loop back interface) (default "127.0.0.1")
  -dbpath string
        /path/to/sqlite3 (default : $PWD/cve.sqlite3) 
  -debug
        debug mode (default: false)
  -debug-sql
        SQL debug mode (default: false)
  -port string
        HTTP server port number (default: 1323) (default "1323")

Misc

  • HTTP Proxy Support
    If your system is behind HTTP proxy, you have to specify --http-proxy option.

  • How to Daemonize go-cve-dictionary
    Use Systemd, Upstart or supervisord, daemontools...

  • How to update vulnerbility data automatically.
    Use job scheduler like Cron (with -last2y option).

  • How to cross compile

    $ cd /path/to/your/local-git-reporsitory/go-cve-dictionary
$ GOOS=linux GOARCH=amd64 go build -o cvedict.amd64

  • Logging
    Log wrote to under /var/log/vuls/

  • Debug
    Run with --debug, --sql-debug option.

Data Source

Authors

kotakanbe (@kotakanbe) created go-cve-dictionary and these fine people have contributed.

Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Change Log

Please see CHANGELOG.

Licence

Please see LICENSE.

Additional License

How can my organization use the NVD data within our own products and services?
All NVD data is freely available from our XML Data Feeds. There are no fees, licensing restrictions, or even a requirement to register. All NIST publications are available in the public domain according to Title 17 of the United States Code. Acknowledgment of the NVD when using our information is appreciated. In addition, please email nvd@nist.gov to let us know how the information is being used.

About

Build a local copy of CVE (NVD and Japanese JVN). Server mode for easy querying.

License:Apache License 2.0

Languages

Language:Go 98.4%Language:Makefile 1.6%