MCPcopy Index your code
hub / github.com/WhiteBeamSec/WhiteBeam

github.com/WhiteBeamSec/WhiteBeam @v0.2.6

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.2.6 ↗ · + Follow
211 symbols 399 edges 63 files 10 documented · 5%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

WhiteBeam Logo

WhiteBeam

Transparent endpoint security

Latest Release Bounty $5,000 Chat


Features

  • Block and detect advanced attacks
  • Modern audited cryptography: RustCrypto for hashing and encryption
  • Highly compatible: Development focused on all platforms (incl. legacy) and architectures
  • Source available: Audits welcome
  • Reviewed by security researchers with combined 100+ years of experience

In Action

Installation

From Packages (Linux)

Distro-specific packages have not been released yet for WhiteBeam, check again soon!

From Releases (Linux)

  1. Download the latest release
  2. Ensure the release file hash matches the official hashes (How-to)
  3. Install:
    • ./whitebeam-installer install

From Source (Linux)

  1. Run tests (Optional):
    • cargo run test
  2. Compile:
    • cargo run build
  3. Install WhiteBeam:
    • cargo run install

Quick start

  1. Become root (sudo -s/su root)
  2. Set a recovery secret. You'll be able to use this with whitebeam --auth to make changes to the system: whitebeam --setting RecoverySecret mask

How to Detect Attacks with WhiteBeam

Multiple guides are provided depending on your preference. Contact us so we can help you integrate WhiteBeam with your environment. 1. Serverless guide, for passive review 2. osquery Fleet setup guide, for passive review 3. WhiteBeam Server setup guide, for active response

How to Prevent Attacks with WhiteBeam

:information_source: WhiteBeam is experimental software. Contact us for assistance safely implementing it.

  1. Become root (sudo -s/su root)
  2. Download default whitelists for your platform:
    • whitebeam --load Base
  3. Review the baseline after a minimum of 24 hours:
    • whitebeam --baseline
  4. Add trusted behavior to the whitelist, following the whitelisting guide
  5. Enable WhiteBeam prevention:
    • whitebeam --setting Prevention true

Core symbols most depended-on inside this repo

db_open
called by 14
src/application/common/db.rs
valid_auth
called by 7
src/application/main.rs
get_setting
called by 7
src/application/common/db.rs
is_superuser
called by 7
src/application/platforms/macos/mod.rs
get_setting
called by 6
src/library/common/db.rs
search_path
called by 6
src/installer/platforms/linux/mod.rs
osstr_to_cstring
called by 5
src/library/common/convert.rs
get_client_public_private_key
called by 4
src/application/common/crypto.rs

Shape

Function 191
Class 17
Method 3

Languages

Rust100%

Modules by API surface

src/library/tests/platforms/linux/mod.rs33 symbols
src/library/platforms/linux/mod.rs20 symbols
src/library/common/db.rs20 symbols
src/application/main.rs19 symbols
src/application/common/db.rs18 symbols
src/application/common/crypto.rs16 symbols
src/application/platforms/linux/mod.rs11 symbols
src/library/common/convert.rs8 symbols
src/installer/platforms/linux/mod.rs7 symbols
src/installer/main.rs7 symbols
src/application/platforms/windows/mod.rs6 symbols
src/application/platforms/macos/mod.rs6 symbols

For agents

$ claude mcp add WhiteBeam \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page