Skip to content

Latest commit

 

History

History
128 lines (89 loc) · 3.73 KB

README.md

File metadata and controls

128 lines (89 loc) · 3.73 KB
Raw

Database system for Linux Data Log Analysis

A database system for the efficient storage and querying of Linux audit logs.

Read more about the purpose of this system and its design here.

By Deven Bansod, Raghav Bhat, and Jitin George.

Installation (Debian/Ubuntu)

This assumes python2.7 is installed.

Install Libraries and dependency

sudo apt-get install python-audit auditd
pip install -r requirements.txt

Install Neo4j server

This requires Java to be installed. See this for installing Java 8 on newer versions of Ubuntu.

wget -O - https://debian.neo4j.org/neotechnology.gpg.key | sudo apt-key add -
echo 'deb https://debian.neo4j.org/repo stable/' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
sudo apt-get update
sudo apt install neo4j

Setup Neo4j server

sudo neo4j start

Install when-changed to watch the incoming logs

git clone https://github.com/joh/when-changed
cd when-changed
sudo python setup.py install

Demo

Download Data

Download some sample Linux Audit Log files from this OneDrive folder to your data/ directory

https://gtvault-my.sharepoint.com/:f:/g/personal/dbansod3_gatech_edu/Ek_MxbalghtHk4Gr5T7uyGQBFCGxjQtsfjyu_EYdkosWnA?e=bTUJbf

Initial setup

Set password variable

export PASS=<neo4j-password>

Check initial size of graph.db

du -h /var/lib/neo4j/data/databases/graph.db/

Upload initial data

sudo bash upload.sh neo4j $PASS data/1.log

Note: Running this automatically creates the Indexes that are used while querying.

Check size of graph.db

du -h /var/lib/neo4j/data/databases/graph.db/

Online Data ingestion

Start watching being-watched.log

when-changed being-watched.log "sudo -E bash watcher.sh"

Add 10 lines from data/2.log to being-watched.log

The process should run partially but halt since new lines is less than specified number.

Add remaining lines from data/2.log to being-watched.log

The process should run completely.

Check size of graph.db

du -h /var/lib/neo4j/data/databases/graph.db/

CLI usage

Now that the demo data has been ingested by the system, we can run queries on the data. The CLI is designed to be interactive.

python main.py 127.0.0.1:7687 neo4j $PASS

Code References

Code Components Slightly Modified By Us:

reducer/ folder in 1:

  • Folder contains the Causality Preserving Reduction (CPR) algorithm we use to reduce shrink the logs
  • We modified the original source code to make it compatible with our log-ingestion pipeline

Code Components Substantially Modified By Us:

parser/ folder in 1:

  • Folder contains the log parser, which takes in raw system call logs, strips out irrelevant fields (e.g. register values), and deletes irrelevant system-calls (e.g. execve).
  • We modified the set of parameters that is returned and made the code compatible with our pipeline

Code Components Written By Us:

cli/ and root directories, which include:

  • Script to ingest data into Neo4j (upload.sh)
  • Neo4j Queries - ~20 Queries that are relevant to system call log analysis (cli/query_functions.py)
  • Command-line interface (cli/*)
  • Git diff-based system to ingest only new logs into the database (watcher.sh)