Getting Started

Requirements

For the machines running the CaTracer

• For CatBpf:
  • Kernel 5.4+
  • Go 1.14+
  • BCC tools (#e41f7a3)
• For CatStrace:
  • Python 3.8 (with pip support)
  • Strace

For the machines running the remaining pipeline components

• For Falcon-Solver:
  • Z3 Theorem Prover (make sure that the z3 binary is in the environment PATH /usr/bin or /usr/local/bin)
  • Maven
• For CaSolver:
  • Python 3.8 (with pip support) / Go 1.14+
• Falcon-Visualizer:
  • npm

Clone CaT Repository

Run the following command to clone CaT's repository with its submodules:

git clone --recursive https://github.com/dsrhaslab/cat.git

Install CaT's components

CaT's components are independent and, therefore, can be leveraged by different projects. To set up the full pipeline, install each particular component according to the following instructions:

Install the CaTracer component

Install CatBpf

1. Go to CatBpf folder: cd cat/catracer/catbpf/
2. Run go build . or go install to build the catbpf binary. (When using the latter, the binary is placed at $GOPATH/bin).

Install CatStrace

1. Go to CatStrace folder: cd cat/catracer/catstrace/
2. Run sudo pip install -e . to install it locally and to make catstrace available globally.

Install the Falcon-Solver component

1. Install falcon-taz:

   i. Go to falcon-taz folder: cd cat/falcon-taz

   ii. Run mvn package install

2. Install falcon-solver:

   i. Go to falcon-solver folder: cd cat/falcon-solver

   ii. Run mvn package

Install the CaSolver component

Install casolver-go

1. Go to casolver-go folder: cd cat/casolver/casolver-go/
2. Run go build . or go install to build the casolver-go binary. (When using the latter, the binary is placed at $GOPATH/bin).

Install casolver-py

1. Go to casolver-py folder: cd cat/casolver/casolver-py/
2. Run sudo pip install -e . to install it locally and make casolver-py available globally.

Install the Falcon-Visualizer component

1. Go to falcon-visualizer folder: cd cat/falcon-visualizer/
2. Run npm install