GitHub

Getting Started

This guide will help you install and configure the Ilexum forensic tools.

Prerequisites

  • Go 1.25+: All tools are written in Go and require the Go toolchain
  • The Sleuth Kit (TSK): Required for Bitex disk analysis
    • Ubuntu/Debian: sudo apt install sleuthkit
    • macOS: brew install sleuthkit
    • Windows: Download from sleuthkit.org

Installation

From Source

Clone each repository and build:

# Bitex
git clone https://github.com/ilexum-group/Bitex.git
cd Bitex && go build -o bitex ./cmd/bitex

# Tracium
git clone https://github.com/ilexum-group/Tracium.git
cd Tracium && go build -o tracium ./cmd/tracium

# Evidex
git clone https://github.com/ilexum-group/Evidex.git
cd Evidex && go build -o evidex ./cmd/evidex

Pre-built Binaries

Download pre-built binaries from the GitHub releases page for your platform.

Cross-Platform Builds

Use the provided Makefiles to build for multiple platforms:

make build-all   # Builds for all platforms
make build-linux # Linux only

Configuration

All three tools share common command-line flags:

FlagDescriptionRequired
--serverRemote server URLYes
--tokenAuthentication tokenYes
--case-idCase identifierYes

Example Configuration

# Bitex - Analyze a disk image
./bitex --disk /dev/sdb --case-id CASE-2024-001 \
  --server https://forensics.example.com \
  --token YOUR_AUTH_TOKEN

# Tracium - Collect system forensics
./tracium --case-id CASE-2024-001 \
  --server https://forensics.example.com \
  --token YOUR_AUTH_TOKEN

# Evidex - Acquire evidence files
./evidex --case-id CASE-2024-001 \
  --server https://forensics.example.com \
  --token YOUR_AUTH_TOKEN \
  -r /evidence/*

Quick Start

1. Start with Bitex

Analyze a disk image to understand the partition structure:

./bitex --disk disk-image.aff --case-id MYCASE-001 \
  --server http://localhost:8080 --token mytoken

2. Collect Files with Evidex

Acquire specific files of interest:

./evidex --case-id MYCASE-001 \
  --server http://localhost:8080 --token mytoken \
  -r /mount/evidence/documents/

3. Gather System Data with Tracium

Collect comprehensive system artifacts:

./tracium --case-id MYCASE-001 \
  --server http://localhost:8080 --token mytoken

Verifying Installation

Run the built-in validation:

# Bitex validation
./bitex --version

# Tracium validation
./tracium --version

# Evidex validation
./evidex --version

Next Steps

  • Read the Architecture documentation
  • Explore each tool's detailed documentation
  • Review Examples for common workflows