Skip to main content

eBPF-based System Inspector and Forensic Tool (Multi-Agent/Web)

Project description

sys-inspector - eBPF-based System Inspector and Audit Tool

OBS Build Status PyPI version License: GPL v3 Python 3.6+ Platform: Linux GitHub Stars GitHub Forks GitHub Release Build Status Issues Code Size Last Commit Code Quality

Sys-Inspector is an advanced observability and forensic tool powered by eBPF (Extended Berkeley Packet Filter).

Unlike traditional tools that poll /proc periodically, Sys-Inspector hooks directly into the Linux Kernel to capture events (process execution, file I/O, network connections) in real-time.

Features (v0.90.00)

  • Fleet View Dashboard: Monitor multiple infrastructure nodes from a single centralized web interface.
  • Forensic Time Machine: Pause live execution and travel back in time to inspect historical snapshots stored in SQLite.
  • Kernel-Level Visibility: Uses eBPF kprobes/tracepoints for zero-blindspot monitoring.
  • Deep Forensics:
    • Real-time MD5 Hashes: Calculates hashes of executed binaries instantly.
    • Context Awareness: Detects SSH origin IPs, Sudo users, and Tmux sessions.
    • Recursive Alert Bubbling: Child process anomalies (e.g., Unsafe Libs, Net Errors) propagate warnings up to the parent process in the tree view.
  • Topology & Infrastructure:
    • Storage Topology: Hierarchical view of Disks -> Partitions -> LVM -> Mount Points with HCTL info.
    • Network Topology: Auto-detection of Gateway, DNS servers, and Interfaces.
  • Enterprise Reporting:
    • Generates self-contained, interactive HTML Dashboards.
    • Custom Logo Support: Embeds your organization's logo automatically.
    • Visual Badges: Instant identification of [SSH], [SUDO], [UNSAFE], [NET ERR].

Requirements

  • Linux Kernel 4.15+ (5.x+ recommended for BTF support).
  • Root privileges (sudo).
  • Python 3.6+.
  • BCC Tools (python3-bcc).
  • iproute2 (for tc command, required only for Chaos Maker).
  • Additional Python libs: flask, cryptography, pyyaml.

Installation (PyPI)

Works on any Linux distribution with Python 3.6+.

    pip install sys-inspector

Installation (RPM / openSUSE)

You can install Sys-Inspector directly via zypper using the openSUSE Build Service repository.

  1. Add the Repository:
    zypper addrepo https://download.opensuse.org/repositories/home:mariosergiosl:sys-inspector/15.6/home:mariosergiosl:sys-inspector.repo
  1. Refresh and Accept GPG Key: During the refresh, you will be asked to trust the repository GPG key.

Fingerprint: 7CF0 5795 053C F397 8E00 948E 9F8D 1AC9 E2BE EABC

    zypper refresh
    # Type 'a' to trust always when prompted.
  1. Install the Package:
    zypper install sys-inspector
  1. Run: Once installed, the command is available globally:
    sys-inspector

Usage

Sys-Inspector is orchestrated via the main.py entry point (or globally as sys-inspector). It supports multiple execution modes.

1. Local Live Mode (Recommended)

Starts the background collector daemon and the Fleet Web Dashboard simultaneously.

    sudo sys-inspector --mode local-live
    # Access the dashboard at http://localhost:8080

2. Snapshot Mode (Static Report)

Captures activity for a specific duration and generates a standalone HTML report.

    sudo sys-inspector --mode snapshot --interval 20
    # Output Example: report/sys-inspector_hostname_20260316_100000.html

3. Custom Logo

To include your company logo in the report header, simply place a PNG file at the following path:

    /etc/sys-inspector/logo.png

The application will automatically detect, resize (max-height: 40px), encode it to Base64, and embed it in the HTML.

Chaos Engineering (Testing Tool)

Included in scripts/chaos_maker.sh is a stress testing tool designed to validate the inspector's detection capabilities.

⚠️ WARNING: DO NOT RUN ON PRODUCTION SYSTEMS. This script uses tc (Traffic Control) to purposefully degrade network quality (packet loss/latency) and consumes CPU/Disk resources.

Capabilities

  • Network Degradation: Injects 100ms latency and 20% packet loss to trigger [NET ERR] alerts in the report.
  • Process Anomalies: Hides processes in /dev/shm to trigger [WARN] alerts.
  • Unsafe Library Loading: Forces loading of dynamic libraries from /tmp via a Python script to trigger [UNSAFE] alerts.
  • Disk Stress: Generates high I/O throughput to test IO accounting.

How to Run

    sudo ./scripts/chaos_maker.sh

To Stop: Press Ctrl+C. The script traps the signal and automatically cleans up the network rules (tc qdisc del) and temporary files.

Project Structure

    ├── conf/                  # Configuration and Cryptographic Keys
    ├── data/                  # SQLite Persistence and Agent IDs
    ├── doc/                   # Documentation and Requirements
    ├── report/                # Standalone HTML Reports Output
    ├── scripts/               # Chaos Engineering & Setup Scripts
    ├── src/
       ├── collectors/        # eBPF Engine and Process Tree Builders
       ├── controllers/       # Execution Modes (Daemon, Web, Snapshot)
       ├── core/              # Database and Crypto Logic
       ├── exporters/         # HTML and Web Assets
       ├── probes/            # C eBPF source code
       ├── storage/           # Storage interface and handlers
       └── utils/             # Configuration loaders
    ├── tools/                 # Utility scripts (e.g., Key Generation)
    └── main.py                # Unified Entry Point

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sys_inspector-0.90.14.tar.gz (95.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sys_inspector-0.90.14-py3-none-any.whl (104.6 kB view details)

Uploaded Python 3

File details

Details for the file sys_inspector-0.90.14.tar.gz.

File metadata

  • Download URL: sys_inspector-0.90.14.tar.gz
  • Upload date:
  • Size: 95.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.25.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for sys_inspector-0.90.14.tar.gz
Algorithm Hash digest
SHA256 7aa4d311c188c2e29815dc14ac2a20f5aeccbe75fdafb3728c6b0fafbf6faed5
MD5 4695637a92aca17487004d5f905744c6
BLAKE2b-256 bd7d7da9ddb67dd9d9fb70466f54e075e48495f8da968bccd53be3be1045c2cb

See more details on using hashes here.

File details

Details for the file sys_inspector-0.90.14-py3-none-any.whl.

File metadata

  • Download URL: sys_inspector-0.90.14-py3-none-any.whl
  • Upload date:
  • Size: 104.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.10.0 readme-renderer/34.0 requests/2.25.1 requests-toolbelt/1.0.0 urllib3/1.26.20 tqdm/4.64.1 importlib-metadata/4.2.0 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.5 CPython/3.6.15

File hashes

Hashes for sys_inspector-0.90.14-py3-none-any.whl
Algorithm Hash digest
SHA256 83b010032bfef3ce1a785ae52042630c79f172882c3495de8a0e9e2eecd32311
MD5 fe9b65f7bc9c08718962cd1194cd0566
BLAKE2b-256 8e54a6454e12fe442b00d8348e580b2eae14810eafceffb9829e6da5a79218fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page