nvd-cli

nvd-cli

NOTE: This project is currently in BETA.. please stand by...

This project is designed to assist with searching the National Vulnerability Database (NVD) and getting vulnerability info for the products that matter to you

If there's errors or anything like that, feel free to put up and issue or contact me personally. This is a personal project of sorts but I know how useful it can be

Please be patient since this will be the first npm cli-type project I've worked on. I'll be testing as I can

Installation

You can install this cli program via npm:

npm install -g nvd-cli

Usage

$ nvd-cli --help

Usage: nvd-cli <primary flag> <primary flag arg> [optional flags]

-f, --full            Conduct a full search against the default or provided 
                      checklist for a given <year> arg

-r, --recent          Search for vulnerabilaties in the NVD recent category using default 
                      or provided checklist

-s, --search          Specifically search for an NVD vulnerability matching the providded 
                      <product> or <vendor> string and optional <year> arg

- OPTIONAL PARAMETERS -

-o, --output          Change the nvd-cli output file name and/or location

-c, --checklist       Change the nvd-cli checklist file name and/or location

-t, --type            Change the output type for the NVD report (.pdf or .txt)

- MISC PARAMETERS -

-h, --help, help      Display this help text or try -h <command>

-v, --version         Get the version of nvd-cli you are currently running


For more help on a specific command/arg type help <command> without the '-' or '--'

Configuring

TODO: Add configuration info

Checklist Schema

NOTE: The default checklist.json is just used for testing!!

When providing a checklist, the .json file should look something like this:

[
    {
        "manufacturerName": "nodejs",
        "softwareName": "node.js"
    },
    {
        "manufacturerName": "microsoft",
        "softwareName": "windows_xp"
    },
    {
        "manufacturerName": "redhat",
        "softwareName": "enterprise_linux"
    }
]

History

• 0.4.1

  • Fixed the npm install issue

• 0.4.0

  • Added the help <command> functionality. There's likely typos/errors. If you find any let me know
  • Updated the -h (--help) information
  • Project is now up on npm

• 0.3.5

  • Added the -t (--type) optional flag for changing the output type
  • Changed the arg validations slightly, reducing the number of pre-run checks

• 0.3.2

  • Updated help info to be actually useful

• 0.3.1

  • -s now requires at least 3 characters to search by
  • fixed HUGE issue where -s flag wasn't actually searching the passed year

• 0.3.0

  • -s functionality has been (mostly) implimented
  • -v flag will now show the version of nvd-cli installed
  • Major improvment to code layout
  • Much more validation has been put in place

• 0.2.0

  • A new (better) argument handler is now in place
  • -f and -r args work as before if not better than before
  • -c and -o commands for setting a custom checklist and output location have been added

• 0.1.2

  • Added help command/arg handler. help <command> not yet working

• 0.1.0

  • -r and -f functionality are partially implimented

• 0.0.1

  • Initial minimum viable product

License