OpenBAS Implant

The following repository is used to store the OpenBAS implant for the platform. For performance and low level access, the agent is written in Rust. Please start your journey with https://doc.rust-lang.org/book.

---

🚀 Installation

There is no direct installation required for the implant.

Instead, it is executed by a neutral orchestrator such as:

• OpenBAS Agent
• Tanium
• Caldera
• Or any other compatible execution engine

Execution is fully managed by the orchestrator via OpenBAS scenarios.

---

🛠 Development

This project is written in Rust. If you're new to Rust, we recommend starting with The Rust Book.

Prerequisites

• Rust
• Cargo
• Linux, macOS, or Windows

Build

To build the implant locally:

cargo build

---

✅ Running Tests

Run all tests:

cargo test

Run a specific test:

cargo test test_name

---

📊 Code Coverage

You can generate coverage reports using cargo-llvm-cov:

cargo install cargo-llvm-cov
cargo llvm-cov --html

---

🧹 Code Quality

🧠 Clippy – Linting

cargo clippy -- -D warnings

Auto-fix warnings:

cargo fix --clippy

Clippy runs in CI and must pass.

---

🎨 Rustfmt – Formatting

Check formatting:

cargo fmt -- --check

Auto-format:

cargo fmt

Rustfmt also runs in CI.

---

🔒 Cargo Audit – Vulnerabilities

Check for known issues in dependencies:

cargo audit

Fix with:

cargo update

---

🐞 Troubleshooting in Development Mode

When running the implant locally (e.g., using cargo run), logs are written to:

target/debug/openbas-implant.log

Check this file to investigate errors or debug behavior during development.

---

🧬 About

OpenBAS is developed by Filigran, a company building open-source security tooling.