Go to file
CyberMind-FR 0706317d25 feat(core): SSO-lite session cookie + /auth/verify for nginx auth_request (ref #400)
Foundation to replace Authelia with SecuBox's own users (reuses the argon2
user_store; those hashes can't feed nginx Basic auth, but a verify endpoint
can validate them). Source-only — no live cutover yet.

- auth.py: /login now also sets an HttpOnly, parent-domain-scoped session
  cookie (secubox_session = the JWT). New GET /auth/verify validates the
  cookie (or Bearer) via the same checks as require_jwt and echoes
  Remote-User/Remote-Groups for the proxied app (200 allow / 401 deny).
  New POST /auth/logout clears the cookie.
- secubox.conf.example: api.sso_cookie_domain (parent domain, e.g.
  ".gk2.secubox.in"; empty = host-only).

Remaining for #400 (follow-up, careful + board-specific): confirm which
socket serves /auth/verify given secubox-auth overrides /login; ship the
nginx auth_request snippet with the real SecuBox login-page redirect; live
cutover one vhost first (lyrion/zigbee) then all; stop+disable Authelia.
2026-05-28 10:09:49 +02:00
.claude docs(history,wip,todo): 2026-05-27 evening — peertube + photoprism + WAF unblocking 2026-05-27 16:47:17 +02:00
.gitea/workflows ci: mirror .github/workflows -> .gitea/workflows (closes #177) (#178) 2026-05-17 10:56:49 +02:00
.github/workflows fix(kernel-build): install build-essential so dpkg-checkbuilddeps passes (#336) 2026-05-22 08:02:01 +02:00
.superpowers/brainstorm/1465198-1777214258 fix(eye-remote): Fix route parameter naming and logic issues 2026-04-26 17:39:56 +02:00
.vscode fix(eye-remote): Prevent duplicate IP on USB composite gadget 2026-05-07 04:54:38 +02:00
apt feat(secubox): complete meta-script generator Tasks 14-17 2026-05-11 05:32:29 +02:00
board fix(boot): MOCHAbin extlinux auto-boots mpcie-fix kernel after 3s instead of waiting forever 2026-05-23 21:38:17 +02:00
cache/repo docs: Add modules architecture documentation 2026-04-10 10:47:35 +02:00
cmd/secubox fix(apt): Use binary keyring URL so apt accepts the signed-by= source (ref #89) 2026-05-12 12:23:02 +02:00
common feat(core): SSO-lite session cookie + /auth/verify for nginx auth_request (ref #400) 2026-05-28 10:09:49 +02:00
config feat(config): Add metablogizer flat config (165 sites) 2026-05-06 17:42:30 +02:00
daemon Add c3box mesh dashboard theme variables to sidebar.js 2026-03-26 06:50:43 +01:00
docs docs(audit): mesh cluster inspection — master-link is dead code, mirror is miscategorized 2026-05-27 08:31:36 +02:00
doctrine/opad docs(opad): add doctrine documents (OPAD.md, CSPN.matrix.md, OPAD-OPERATIONS.md) 2026-05-12 09:30:16 +02:00
hardware feat(eye-remote): Add display state machine with splash and fallback modes 2026-04-28 14:48:00 +02:00
image fix(soc): move nft cache into secubox-hub + realtime fallback 2026-05-26 12:43:55 +02:00
kernel-build feat(kernel-build): add CONFIG_ZRAM=m with zstd default (closes #295) (#296) 2026-05-21 08:37:09 +02:00
packages Merge docs/387-docs-final-naming-clarity-sweep-on-8-sta 2026-05-27 10:17:52 +02:00
profiles feat(secubox): complete meta-script generator Tasks 14-17 2026-05-11 05:32:29 +02:00
prototypes feat(ui): Universal hybrid-skin theme with global status/menu bars 2026-05-08 16:42:51 +02:00
redroid Add ReDroid (Android in Container) LXC setup scripts 2026-03-26 16:05:11 +01:00
remote-ui fix(eye-square): relocate firstboot.sh out of /usr/local/sbin/ (closes #207) (#208) 2026-05-19 06:53:31 +02:00
repo fix(repo): Dearmor GPG key on import in install.sh (ref #80) 2026-05-12 10:09:09 +02:00
schemas feat(opad): add JSON Schema for 3-prong profile 2026-05-12 08:58:10 +02:00
scripts fix(build): scripts/build-packages.sh — auto-discover packages instead of hardcoded list 2026-05-27 10:24:16 +02:00
templates docs: Add VirtualBox quick start guide and VM creation script 2026-04-04 10:31:21 +02:00
tests Mail Phase 2 — Rspamd migration (closes #153) (#160) 2026-05-18 08:21:23 +02:00
tools feat(tow-boot): Add Tow-Boot with eMMC boot support for MOCHAbin 2026-05-03 16:58:25 +02:00
vm feat(eye-remote): Add display state machine with splash and fallback modes 2026-04-28 14:48:00 +02:00
wiki docs: codify dual-vhost MUST for modules with a real web UI 2026-05-24 10:06:56 +02:00
.cache-lint-allowlist.toml feat(scripts): add check-dashboard-cache.py lint + CI (closes #147) (#148) 2026-05-18 08:21:20 +02:00
.gitignore docs(audit): Phase 1 consolidation audit — script + findings (ref #378) 2026-05-27 07:14:48 +02:00
build-eye-remote-full.sh feat(eye-remote): v2.3.0 - Auto-fallback dashboard with splash 2026-04-28 16:39:59 +02:00
CLAUDE.md docs: add multi-agent worktree workflow doctrine to CLAUDE.md (ref #83) 2026-05-12 10:05:09 +02:00
HOWTO-grammar.md docs: codify the SecuBox CTL grammar (closes #216) (#217) 2026-05-19 08:01:08 +02:00
LICENCE-CMSD-1.0.md license: Add CMSD-1.0 (CyberMind Source-Disclosed) license 2026-05-06 09:49:17 +02:00
LICENSE-CMSD-1.0.en.md license: Add CMSD-1.0 (CyberMind Source-Disclosed) license 2026-05-06 09:49:17 +02:00
LICENSING.md license: Add CMSD-1.0 (CyberMind Source-Disclosed) license 2026-05-06 09:49:17 +02:00
PROMPT_SYSTEM.md feat: Add 15 new SecuBox-Deb modules and VM configuration 2026-03-27 10:08:05 +01:00
pytest.ini fix(auth): consolidate sessions/audit file constants, harden _DATA_DIR.mkdir, fix pytest.ini footgun (ref #120) 2026-05-13 09:25:08 +02:00
README.md docs: codify the SecuBox CTL grammar (closes #216) (#217) 2026-05-19 08:01:08 +02:00
REPORT-2026-04-10.md fix(ui): Add sidebar navigation to 11 modules 2026-04-10 13:20:24 +02:00
secubox.conf.example feat(core): SSO-lite session cookie + /auth/verify for nginx auth_request (ref #400) 2026-05-28 10:09:49 +02:00
setup-dev.sh Initial commit: SecuBox-DEB migration from OpenWrt to Debian 2026-03-21 09:41:06 +01:00
TOOLS.md feat(console): Standalone mode + tools documentation 2026-04-01 07:22:30 +02:00

SecuBox

SecuBox OS - Network Security Appliance

Your Network Security Appliance — Plug, Protect, Peace of Mind

Release Packages Live USB Installer License: CMSD-1.0


License — CyberMind Source-Disclosed (CMSD-1.0)

Source disclosed, rights reserved.

This software is released under the CyberMind Source-Disclosed License v1.0 — a source-available license designed for transparency and security auditability while preserving all commercial rights.

What you CAN do What you CANNOT do
Read and study the source code Use in production (any environment)
Compile for isolated testing/audit Redistribute or create derivatives
Publish security research results Integrate into other products
Quote in academic/journalistic contexts Provide as hosted service (SaaS)

ANSSI CSPN Ready: The license explicitly authorizes audits by accredited security labs (CESTI, CC equivalents) without prior authorization.

See LICENCE-CMSD-1.0.md (French, authoritative) or LICENSE-CMSD-1.0.en.md (English, informative).

Metric Value
Packages 132 .deb packages
Migration 124/132 modules migrated
APIs FastAPI + JWT auth
![Arch](https://img.shields.io/badge/Architecture-amd64_ _arm64-orange)

SecuBox transforms any compatible device into a complete network security appliance with VPN, firewall, intrusion detection, and web dashboard — all preconfigured and ready to use.


Latest Releases

Latest stable All releases Downloads

v2.9.0 — Main system (2026-05-17)

Full SecuBox-DEB platform: 132 .deb packages, system images for four boards, Live USB for amd64. See release notes.

Target Download
VirtualBox / QEMU / KVM (amd64) secubox-vm-x64-bookworm.img.gz · bundle with verifier + VDI
Live USB / amd64 PC secubox-live-amd64-bookworm.img.gz
MOCHAbin (Marvell Armada 7040) secubox-mochabin-bookworm.img.gz
Raspberry Pi 400 secubox-rpi400-bookworm.img.gz
ESPRESSObin v7 (Marvell Armada 3720) secubox-espressobin-v7-bookworm.img.gz
Installer ISO (any amd64 host) secubox-installer-amd64-bookworm.iso.gz
All .deb packages attached to the v2.9.0 release page
APT repository https://apt.secubox.in/ (install script)
SHA256SUMS SHA256SUMS — verify every download

v2.2.1-eye-remote — Round display (2026-05-11)

Side-line image for the Pi Zero W round-display dashboard. Not part of the main v2.x.y line — refreshed independently when the kiosk stack moves.

Target Download
Pi Zero W + HyperPixel 2.1 Round secubox-eye-remote-2.2.1.img.xz

Verifying downloads

Every release attaches a SHA256SUMS file alongside the artifacts. Verify before flashing:

sha256sum -c SHA256SUMS 2>&1 | grep -v 'OK$' || echo "all hashes match"

For the amd64 VirtualBox target there's a turn-key tester bundle under output/ci-vm-x64-25983593168/ — drop-in verify.sh + raw_to_vdi.py (no qemu-img/VBoxManage needed) + step-by-step README.md. Boot in 4 commands; see output/ci-vm-x64-25983593168/FIX-PXE.md if the VBox EFI ever lands on the PXE screen.

→ See all releases on GitHub


What You Get

  • VPN Server — WireGuard with QR codes for mobile devices
  • Intrusion Detection — CrowdSec IDS/IPS with automatic threat blocking
  • Network Monitoring — Real-time traffic analysis and bandwidth control
  • Web Dashboard — Modern dark-themed interface accessible from any browser
  • Automatic Updates — Security patches applied automatically

Quick Start

Option 1: VirtualBox (Try It Now)

Download and run in VirtualBox — no hardware required:

# Download the image
wget https://github.com/CyberMind-FR/secubox-deb/releases/latest/download/secubox-live-amd64-bookworm.img.gz

# Extract
gunzip secubox-live-amd64-bookworm.img.gz

# Create VM (requires VBoxManage)
./scripts/create-secubox-vm.sh secubox-live-amd64-bookworm.img

Access: Open https://localhost:9443 in your browser Login: admin / secubox

Option 2: Live USB (Any PC)

Boot from USB on any x86_64 computer:

# Download
wget https://github.com/CyberMind-FR/secubox-deb/releases/latest/download/secubox-live-amd64-bookworm.img.gz

# Flash to USB (replace /dev/sdX with your USB device)
zcat secubox-live-amd64-bookworm.img.gz | sudo dd of=/dev/sdX bs=4M status=progress

Boot from USB, then access the dashboard at https://<device-ip>/

Option 3: Dedicated Hardware

For 24/7 operation, flash to dedicated hardware:

Device Best For Image
Raspberry Pi 4/5 Home use secubox-rpi-arm64-*.img.gz
ESPRESSObin Small office secubox-espressobin-v7-*.img.gz
MOCHAbin Enterprise secubox-mochabin-*.img.gz
Any x86_64 PC Repurposed hardware secubox-live-amd64-*.img.gz

Features

Security Dashboard

Central control panel showing system health, active threats, and quick actions.

VPN (WireGuard)

Create VPN connections with one click. Scan QR codes on mobile devices.

Intrusion Detection (CrowdSec)

Automatic threat detection and IP blocking with community threat intelligence.

Network Control

  • Bandwidth management (QoS)
  • Device access control
  • Deep packet inspection
  • Virtual hosts with SSL

System Management

  • Service control
  • Log viewer
  • Automatic backups
  • Easy updates

CTL Grammar — modular tools box

Copyright spiritual concept · Gérald Kerma · 1991

Each SecuBox module exposes its capability through three surfaces — a web UI, a FastAPI API, and a CTL command (/usr/sbin/<module>ctl). The CTL is the grammar of the system: each verb is a sentence addressed to a specific layer of the operator's expressive control over their own infrastructure.

Layer Verb
ROUTING haproxyctl vhost add/remove
INTERCEPTION mitmproxyctl route add/remove/list
REPLICATION giteactl repo mirror add/remove
IDENTITY giteactl user add/remove
CI EXECUTION giteactl runner add/remove/list
PUBLISHING publishctl post / dropletctl publish / metablogizerctl site
EMANCIPATE metablogizerctl tor expose/revoke
HOSTING streamlitctl app deploy/.../info
DEV WORKBENCH streamforgectl project create/.../templates
OPS MONITORING healthctl check/list/status/alert

Composing the verbs expresses end-to-end workflows in three lines of shell. See docs/grammar.md for the conceptual frame and the layered architecture map.

To add a 9th verb, follow HOWTO-grammar.md — the six-step recipe takes about an hour for a Bash CTL.


Eye Remote — External Dashboard

SecuBox Eye Remote

A standalone round display that connects to SecuBox via USB OTG, showing real-time metrics with a cyberpunk 3D visualization.

Feature Description
Hardware Raspberry Pi Zero W + HyperPixel 2.1 Round (480×480)
Connection USB OTG composite gadget (network + serial)
Display 3D rotating cube + rainbow ring metrics
Metrics CPU, Memory, Disk, Temperature, WiFi RSSI

Quick Start

# Download Eye Remote image
wget https://github.com/CyberMind-FR/secubox-deb/releases/download/v2.2.1-eye-remote/secubox-eye-remote-2.2.1.img.xz

# Flash to SD card
xzcat secubox-eye-remote-2.2.1.img.xz | sudo dd of=/dev/sdX bs=4M status=progress
  1. Insert SD in Pi Zero W with HyperPixel display
  2. Connect USB DATA port (middle) to SecuBox
  3. Dashboard appears automatically (~60s boot)

SSH: pi@10.55.0.2 (password: raspberry)

📖 Full documentation: remote-ui/round/README.md


Default Credentials

Service Username Password
Web Dashboard admin secubox
SSH root secubox

Change these immediately after first login!


Support


License

CMSD-1.0 (CyberMind Source-Disclosed License) © 2026 CyberMind · Gérald Kerma See LICENCE-CMSD-1.0.md for terms.


Technical Reference (Click to Expand)

Architecture

OpenWrt / LuCI                   →    Debian bookworm
─────────────────────────────────────────────────────────
RPCD shell backend               →    FastAPI + Uvicorn (Unix socket)
UCI config /etc/config/          →    TOML /etc/secubox/secubox.conf
luci-app-*/htdocs/ (JS/CSS/HTML) →    Conservé + XHR réécrits
OpenWrt packages (.ipk)          →    Paquets Debian (.deb)
opkg                             →    apt + repo apt.secubox.in

Supported Hardware

Board SoC RAM Network Profile
MOCHAbin Armada 7040 Quad 1.8GHz 4 GB 2× SFP+ 10GbE + 4× GbE Pro
ESPRESSObin v7 Armada 3720 Dual 1.2GHz 12 GB WAN + 2× LAN DSA Lite
ESPRESSObin Ultra Armada 3720 Dual 1.2GHz 2 GB WAN PoE + 4× LAN + Wi-Fi Lite+
Raspberry Pi 4/400 BCM2711 Quad 1.5-1.8GHz 2-8 GB GbE + USB Lite
Raspberry Pi 5 BCM2712 Quad 2.4GHz 4-8 GB GbE + USB Full
VM x86_64 Any 2+ GB Virtio/NAT Full

Packages (126 modules)

Core: secubox-core, secubox-hub, secubox-portal, secubox-system

Security: secubox-crowdsec, secubox-wireguard, secubox-auth, secubox-nac, secubox-waf, secubox-users

Network: secubox-netmodes, secubox-dpi, secubox-qos, secubox-vhost, secubox-haproxy

Monitoring: secubox-netdata, secubox-mediaflow, secubox-cdn

DNS/Email: secubox-dns, secubox-mail, secubox-webmail

Publishing: secubox-droplet, secubox-streamlit, secubox-metablogizer, secubox-publish

API Reference

All modules expose REST APIs at /api/v1/<module>/

# Login
curl -X POST https://localhost/api/v1/portal/login \
  -H 'Content-Type: application/json' \
  -d '{"username":"admin","password":"secubox"}'

# Use token
curl https://localhost/api/v1/hub/status \
  -H 'Authorization: Bearer <token>'

Key Endpoints:

  • GET /api/v1/hub/dashboard — Dashboard data
  • GET /api/v1/crowdsec/decisions — Active bans
  • POST /api/v1/crowdsec/ban — Ban IP
  • GET /api/v1/wireguard/peers — VPN peers
  • GET /api/v1/wireguard/qrcode/{peer} — Peer QR code

Configuration

Main config: /etc/secubox/secubox.conf (TOML)

[general]
hostname = "secubox"
timezone = "Europe/Paris"

[auth]
jwt_secret = "your-secret-key"
session_timeout = 86400

[network]
wan_interface = "eth0"
lan_interface = "eth1"

Development

# Setup
bash setup-dev.sh && source .venv/bin/activate

# Run module API
cd packages/secubox-crowdsec
uvicorn api.main:app --reload --port 8001

# Build package
dpkg-buildpackage -us -uc -b

# Build image
sudo bash image/build-image.sh --board vm-x64 --vdi

UI Design Guidelines

Color Palette (Cyberpunk/Hermetic):

Variable Color Usage
--cosmos-black #0a0a0f Background
--gold-hermetic #c9a84c Accents, titles
--cinnabar #e63946 Alerts, errors
--matrix-green #00ff41 Success
--void-purple #6e40c9 Links
--cyber-cyan #00d4ff Info, hover
--text-primary #e8e6d9 Main text

Typography: Cinzel (titles), IM Fell English (body), JetBrains Mono (code)

Documentation