Kekkan

Kekkan is a parser and ActiveRecord database for NVD CVE and CPE XML files.

The name comes from the Japanese word for 'flaw/defect'.

Version 0.0.1 is the current release.

Requirements

Ruby

Keigan has been tested with ruby-1.9.2-p320, ruby-1.9.3-p125. Please try to use one of these versions if possible. I recommend using RVM to setup your ruby environment you can get it here.

RubyGems

Kekkan relies heavily on RubyGems to install other dependencies I highly recommend using it. RubyGems is included by default in the 1.9.x versions of Ruby.

  • rails
  • yaml
  • nokogiri

Installation

Installation is really easy just gem install!

% gem install kekkan

Database Setup

% kekkan --create-config
% $EDITOR kekkan.cfg
% kekkan --create-tables
  1. Generate the kekkan.cfg file.
  2. Edit the kekkan.cfg file, filling in the variables as needed.
  3. Migrate the database schema.

Parsing NVD CVE XML

% kekkan nvdcve-2.0-2012.xml [nvdcve-2.0-2011.xml ...]
  1. Parse the files by passing their names on the command line.

Viewing Data

The data can be queried with a built in console or with an external database viewer. The data is mostly for consumption from another program.

% kekkan --console

Contributing

If you would like to contribute bug fixes/etc to Kekkan. The easiest way is to fork the project on github and make the changes in your fork and the submit a pull request to the project.

Issues

If you have any problems, bugs or feature requests please use the github issue tracker.

Contact

You can reach the team at kekkan[at]arxopia[dot]com.

You can also contact the team on IRC on irc.freenode.net, #risu