Data-driven Security Game (DdSG) Server

Currently hosted at: https://ddsg-server.herokuapp.com/. Contact me at dagerikhl@gmail.com for questions about this deployed server.

Introduction

Working title: "STIX and Stones"

Master Thesis of spring 2018, attending study programme of Computer Science at NTNU.

Server repository.

Getting Started

1. Install Node and NPM (Node.js).
2. Run npm install to install dependencies.

Use Locally

Note! Requires some enviroment variables to be set. See section Configuration.

Production

1. Run npm start.

Development

1. Run npm run dev to start Nodemon to restart server on file-changes.

Test

Run tests

1. Run npm test or npm run test to run all tests.
   • Run npm run test-unit to only run the unit tests.

Watch / Continuously run tests

1. Run npm run test:w to watch all test, running them again on file-changes.
   • Run npm run test-unit:w to only watch the unit tests.

Run test coverage

1. Run npm run coverage to check test coverage for the entire application.
   • This logs the result to the console. It also generates a HTML coverage report in the folder coverage which you can view in your web browser.
   • Note! This also performs a normal run of the tests before generating coverage report.

Deployment

• To deploy, use these environment variables (explained below):

  NODE_ENV=production
  
  LOCAL_JSON_STORE=false
  LOCAL_JSON_USE=false
  USE_FILE_SYSTEM=false
  

• The server can be deployed anywhere that can run a Node.js application.
• For simple deployment, I recommend setting up a free Heroku server and deploy to that.
  1. To set up a Heroku remote, follow this guide: https://devcenter.heroku.com/articles/deploying-nodejs.
  2. Run npm run deploy to simply deploy to a Heroku remote after you have set one up and added its remote.

Technologies

• The server is written in Node using JavaScript (ES5).
• The server is built as an express server application.

Configuration

• The server uses cross-env to easily set environment variables for all platforms (Windows, Linux, ++).
• The server uses dotenv for configuration.
  • All environment variables are accessed through process.env.<variable>.
  • Note! For local development, a local configuration-file, .env, with all environment variables is required.
    • Note! This file should not be commited and used in production. The production server should have different values from local development.
    • Note! If environment variables are set through other means, such as npm scripts or server configuration, these are used over the configuration-file.
    • Note! HOST is not required, and should not be used in production.
• Layout of configuration-file:

  NODE_ENV=<one of: { production, development, test }>
  
  HOST=<url>
  PORT=<number>
  
  LOCAL_JSON_STORE=<one of: { true, false }>
  LOCAL_JSON_USE=<one of: { true, false }>
  USE_FILE_SYSTEM=<one of: { true, false }>

Logging

• The server usese winston for logging.
  • The logger logs to both console and the local log-files combined.log and error.log.
  • Note! This means you use logger.debug(<...>) instead of console.log(<...>) to log.
  • Note! Currently using winston@3.0.0-rc5 for additional new features, but this is not a stable version.

Testing

• The server uses mocha, sinon, and chai to perform unit tests.
• The server usese nyc to perform coverage tests and generate coverage reports.

HTTP requests

• The server uses axios for HTTP requests.

Production specific dependecies

• In production, the server uses node-schedule to schedule and perform an update of data from data sources at 00:30 every night.

Notes

CWE removed as data source

On 2018-04-25 CWE was removed as a data source. This included all the logic for fetching data from that source. This was done to avoid cluttering the code with no-longer used code.

However, should this code become relevant at a later date, the code was removed in isolated commits so it can easily be added back in. The commits are 49c43ba628b8cfe6cea7a3a147ab23a220fc813b, 1a2112bcafdb129a8d77dc931d1f725e91a2efce, and 9d98df16f1b4998ac444146aee2ecd315a5387e8.