vulnogram v0.1.0-rc1

Vulnogram

Making the world safer one CVE ID at a time, since 2017.

Introduction

Vulnogram is a tool for creating and editing CVE information in CVE JSON format, and for generating advisories.

The name Vulnogram is inspired from Greek origin suffix '-gram' which is used for denoting something written or recorded especially in a certain way. Vulnerability related information when recorded in a standard format can help in aggregation, curation, dissemination, analysis and remediation. This enables automation and efficiency in response activities.

Vulnogram project aims to make it easier for vendors and security researchers to accurately record vulnerability information for inclusion in the CVE List.

Getting started

Vulnogram can be deployed in two modes:

Server mode deployment

Step 1. Install required Node.js modules

$ cd vulnogram
$ npm install
... this should install required dependencies, (except process monitors) ...

Step 2. Setup monogodb to be used for persistent storage of CVE JSON and users

See https://www.mongodb.com/.

Important: Ensure mongodb authentication is enabled. It is recommended to run mongodb bound to loopback/localhost and not expose it to network.

Step 3. Edit the config parameters in conf.js to suit your requirements

See config/conf-default.js comments for hints.

Step 4 (Optional). Add custom templates, schemas, or routes

Copy the "default" directory as "custom" and modify relevant pug templates, schemas or routes. Files or fields from "custom" override "default".

Step 5. Configure a user on the CLI for logging in

$ node useradd.js tester tester@example.com Tester sirt@example.com 1
Enter Password: ********************************************
Enter Password again: ********************************************
Success New user is now registered and can log in: tester

Step 6 (Optional). Configure the .env file

Copy the example.env file to .env and configure the environment variables to values you prefer. The values in .env will automatically be loaded as environment variables when Vulnogram starts. See dotenv for more details.

Step 7. Start the node application

$ node app.js

Step 8. Run the application as a daemon server

Use a process monitor like pm2 (preferred) or forever to run vulnogram as a service:

8.a Example using pm2

First install pm2 using instruction at pm2 documentation

$ pm2 start app.js
[PM2] Spawning PM2 daemon with pm2_home=/home/vulnogram/.pm2
[PM2] PM2 Successfully daemonized
[PM2] Starting /home/vulnogram/app.js in fork_mode (1 instance)
[PM2] Done.

8.b Example using forever

$ npm start
> Vulnogram@0.0.6 start /home/vulnogram/
> forever start --id 'vulnogram' --spinSleepTime 5000 --minUptime 2000 app.js

info:    Forever processing file: app.js
info:    Forever processes running
data:        uid  command                      script forever pid   id        logfile                      uptime
data:    [0] v3wE /usr/bin/node app.js 11208   11210 vulnogram /home/vulnogram/.forever/v3wE.log 0:0:0:0.23

Step 9. Finish

Web application should be now accessible at one of the following addresses, depending on configuration:

• http://localhost:3555/
• https://localhost:3555/

Browser mode deployment

Configure defaults

• Install required nodejs modules. See step 1 above.
• Configure Vulnogram following step 3 to 5 above.

Generate files needed for a front-end only static website (browser mode)

$ make min

This creates standalone /index.html with minimized javascript and stylesheets can be hosted independently on websites serving static files. This does not require the backend mongodb server or the nodejs server application to be running.

Note: Opening the index.html as a file URL may not work since some browsers (including Chrome) will not run async requests on file:// URLs. It is recommended to serve these files from a webserver. See https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server for examples on how to run a simple testing webserver.

Docker deployment

To run Vulnogram in a container alongside MongoDB, run the following command:

$ docker compose up

To modify the configuration options available, make a copy of the example.env file and make relevant modifications. Then launch Vulnogram by using the ENV_VAR_PATH environment variable. Replace example.env with the path to your file:

$ ENV_VAR_PATH=example.env docker compose up

To change the ports that Vulnogram or MongoDB are running on, use the MONGO_PORT and VULNOGRAM_PORT environment variables. When doing this, make sure to make the appropriate modifications within the environment variables file as well, so that the ports used inside the container match those being passed to docker compose:

$ cat my-env-vars.env | grep PORT
MONGO_PORT=12345
VULNOGRAM_PORT=54321
$ MONGO_PORT=12345 VULNOGRAM_PORT=54321 ENV_VAR_PATH=my-env-vars.env docker compose up

Dependencies

This project uses or depends on software from:

• NodeJS https://nodejs.org/
• Express https://github.com/expressjs
• Mongodb
• Passportjs http://passportjs.org/
• Pug https://pugjs.org/
• ACE editor https://ace.c9.io/
• JSON Schema based editor https://github.com/jdorn/json-editor
• tablesort v5.0.1 https://github.com/tristen/tablesort
• cvssjs https://github.com/cvssjs
• json-patch-extended
• querymen
• linkifyjs
• pptxGenJS

Copyright (c) 2017-2022 Chandan B N.

SPDX-License-Identifier: MIT