README.rst

Authors

• Aaron Tuor ([email protected])
• Ryan Baerwolf ([email protected])
• Robin Cosbey ([email protected])
• Nick Knowles ([email protected])
• Elliot Skomski ([email protected])
• Sam Kaplan ([email protected])
• Brian Hutchinson ([email protected])
• Nicole Nichols ([email protected])
• Sean Robinson ([email protected])
• Rob Jasper ([email protected])

About Safekit

Safekit is a python software package for anomaly detection from multivariate streams, developed for the AIMSAFE (Analysis in Motion Stream Adaptive Foraging for Evidence) project at Pacific Northwest National Laboratory. An exposition of the models in this package can be found in the papers:

• Deep Learning for Unsupervised Insider Threat Detection in Structured Cybersecurity Data Streams
• Recurrent Neural Network Language Models for Open Vocabulary Event-Level Cyber Anomaly Detection

The code of the toolkit is written in python using the tensorflow deep learning toolkit and numpy.

Dependencies

Dependencies required for installation:

• Tensorflow 1.0 or above
• Numpy
• Scipy
• Sklearn
• Matplotlib

Python Distribution

Safekit is written in python 2. Most functionality should be forwards compatible.

Installation

A virtual environment is recommended for installation. Make sure that tensorflow 1.0+ is installed in your virtual environment.

Install tensorflow

From the terminal in your activated virtual environment: Follow instructions to install TF: https://github.com/tensorflow/tensorflow/blob/r0.12/tensorflow/g3doc/get_started/os_setup.md

conda env

$ conda create -n safekit python=2.7
$ (safekit) source activate safekit
# CPU
(safekit) $ export TF_BINARY_URL=https://storage.googleapis.com/tensorflow/linux/cpu/tensorflow-1.12.0-cp27-none-linux_x86_64.whl
# GPU
(safekit) $ export TF_BINARY_URL=https://storage.googleapis.com/tensorflow/linux/gpu/tensorflow_gpu-1.12.0-cp27-none-linux_x86_64.whl
(safekit) $ pip install --ignore-installed --upgrade $TF_BINARY_URL
(safekit) $ git clone https:/github.com/pnnl/safekit.git
(safekit)) $ cd safekit/
(safekit) $ python setup.py develop

To test your installation, from the top level directory run:

$ tar -xjvf data_examples.tar.bz2
$ python test/agg_tests.py data_examples/lanl/agg_feats data_examples/cert/agg_feats test.log
$ python test/lanl_lm_tests.py data_examples/lanl/lm_feats/ test.log

These two tests should take about 10 to 15 minutes each depending on the processing capability of your system. The tests range over many different model configurations and can be used as a somewhat comprehensive tutorial on the functionality of the code base.

Documentation

Github hosted documentation

Docs can be read locally from the cloned repo by opening safekit/docs/_build/html/index.html with a browser.