synos-public-docs/GRIMOIRE.md
diablo 53f100bd2d
docs: hard kernel numbers, refreshed game data, faction creed
- ARCHITECTURE: the kernel section now carries the real Rust-vs-C numbers —
  22 Rust modules / 29,269 Rust LOC at ring 0 / 492 lines of hand-written C
  (nine FFI shims; the rest kbuild-generated). char-device/ioctl ABI, Ed25519
  module signing, Linux 6.19, QEMU-boot-validated.
- GRIMOIRE "by the numbers": 113 labs (was 108), 13 plugins (was 8), 84-module
  / ~105K-LOC gamification engine (was ~110/~53K), 7 playable factions, live
  systems (XP curve, perk synergies, morality consequences, faction wars).
- README: ChurchOfMalware creed updated to the current faction liturgy —
  "code is scripture · exploitation is sermon · INFECTION is salvation".

All measured from the live tree; boundary-clean (no sealed-symbol usage).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-10 21:03:17 -04:00

204 lines
14 KiB
Markdown

# GRIMOIRE
### *the gamified cybersecurity training platform that ships as the public face of Syn_OS.*
---
## the premise
Most cybersecurity training looks like this: read a chapter, watch a video, do a sandbox exercise, take a quiz, repeat. Linear. Disconnected. Optimized for completion, not for fluency.
GRIMOIRE rejects all of that.
GRIMOIRE is a **world**, not a curriculum. You enter as a novice. You leave as someone who's lived through scenarios that actually happened to people, with consequences that actually mattered, in factions whose loyalties you actually felt.
It's the platform we ship to the community. It's the closest thing we know how to build to *learning by doing it for real, with everything that implies.*
---
## by the numbers
| | |
|---|---|
| Hand-authored labs | **113** (GRIMOIRE catalog **1.0**), exact (enforced by integrity manifest) |
| Lab categories | **13** (beginner, intermediate, advanced, nightmare, crypto, forensics, privesc, defense, ai-red-team, mesh, homelab, raids, quests) |
| Playable factions | **7** (DarkArmy, AzureWatch, GraySyndicate, Warden, Crimson Spire, ChurchOfMalware, + neutrals) |
| Certification paths mapped | **11** (CompTIA Security+ / CySA+ / PenTest+, OSCP, OSWE, CRTP, CRTO, CEH, CISSP foundations, GIAC GPEN/GCIH, eJPT) |
| Game engine plugins | **13** (cutscene, mindmap, retro filter, cyberspace, skill tree, faction HQ, rehoboam, twin, multiplayer, lab launcher, playbook editor, receipt overlay, + more) |
| Gamification engine | **84 modules, ~105,000 lines of code** |
| Live systems | XP curve (`100·N^1.73`), perk synergies, morality-with-consequence, seasonal faction wars, credit economy with real sinks |
| First-boot onboarding | **Wizard-driven**, faction selection, calibration, opening lab seed |
---
## the world
### factions
You pick a faction at the first-boot wizard. Each faction has a distinct relationship to power, secrecy, and what counts as ethical engagement. **Crimson Spire**, **Ashen Veil**, and the third house each shape what missions are on offer, who you can trust, what equipment opens up, and how cohorts measure each other's worth across server walls.
There are no "good guys" and "bad guys." There are people with different philosophies, and you've chosen one. Faction reputation gates content. Allegiance shifts have costs. Inter-faction wars are a recurring narrative beat.
### labs
The atom of progression is the **lab** — a hand-authored challenge built around a specific technique, vulnerability, or defensive posture. The 108-lab corpus (catalog 1.0) spans 13 categories — a representative cut:
- **Beginner** (14 labs) — first-contact for users with no prior background.
- **Advanced** (14 labs) — hard multi-stage exploitation, real-world complexity.
- **Crypto** (6 labs) — classical and modern crypto attacks and misuses.
- **Web** — full-spectrum web application security, from XSS to deserialization to cache-deception.
- **Network** — protocol abuse, lateral movement, segmentation analysis.
- **Forensics** — disk, memory, network, timeline reconstruction.
- **Reversing** — static and dynamic analysis, anti-debugging, packers.
- **AI red team** (6 labs) — attacks on ML/AI systems and prompt-driven agents.
- **Active Directory** — kerberoasting, golden tickets, ACL abuse, BloodHound recipes.
- **Cloud** — AWS/Azure/GCP misconfiguration paths, IAM privilege escalation.
- **Mobile** — Android and iOS reverse engineering, runtime instrumentation.
- **Hardware** — embedded, firmware, side channel.
- **OSINT** — open-source intelligence and adversary attribution.
Every lab is real. Every solution is verifiable. Every credit is earned.
### boss contracts
Some scenarios are too big for a single lab. **Boss contracts** chain multiple labs into a single multi-stage arc — a piece of multi-week storytelling where you earn your way through stages, where partial progress matters, and where the final clear means something.
Boss contracts live in two tiers:
- **Raids** — multi-lab arcs designed for cohorts. The engine tracks party composition, role assignment, and shared progress.
- **Nightmare** — solo-tier endgame contracts. Brutal. Long. The kind of work that earns its own page on your operator résumé.
Each contract is described by a `contract.toml` declaring the ordered constituent labs, the narrative beats inserted between them, branch conditions (the engine reads what *kind* of solution you produced and routes you accordingly), and the final reward. The engine treats a boss contract as a **state machine**: progress is persisted to your save file, you can step away and return without losing place, and **branches don't just change which lab is next — they change which faction owes you a favor afterward.**
Boss contracts are the tests the system pulls out when it thinks you're ready.
### the economy
Earning is more than XP. GRIMOIRE has a **loot and crafting economy**. Solve labs, you earn artifacts. Combine artifacts, you craft equipment. Equipment opens doors. Better gear unlocks harder labs. Harder labs feed deeper missions.
It's not pay-to-win. It's *earn-to-play.*
Loot tables are tied to lab tiers — beginner labs drop common components, advanced labs drop rare ones, raids drop legendary blueprints. Crafted gear modifies your in-game stats: detection radius, lab attempt limits, hint-cost reductions, faction reputation multipliers. Some pieces unlock *only* at certain prestige levels — meaning the operator who's ground through a hundred labs has gear the new arrival can't even see in the catalog.
### the XP engine
The gamification crate is the largest single Rust crate in the platform — close to **a hundred thousand lines** of game systems code, with over a thousand tests holding the math in place. The level curve is a modified logarithmic ramp with prestige boundaries; XP doesn't merely pile up, it transforms.
XP sources the engine recognizes:
- **Lab completion** — base XP from each lab's manifest.
- **Speed runs** — beat a lab's timer threshold and a multiplier kicks in.
- **Achievements** — one-time grants from a static table; some require lateral thinking the engine notices on its own.
- **Daily and weekly challenges** — rotating objectives that ask you to do *something specific* with what you already know.
- **Upstream contributions** — XP grants keyed off **signed commit attestations**. You can't forge it by editing a local file. The signature is checked against the project's keyring.
- **Boss contract clears** — the prize pools that move you up tiers.
Multipliers stack **multiplicatively**, not additively, up to a hard cap (enforced by a property test — the math doesn't get to drift). Faction affinity, first-time completion, active event modifiers — the cap is real.
### the arsenal
GRIMOIRE doesn't ship "a list of tools." It ships a **multi-distro arsenal** stitched together with a curated catalog and faction-flavored access.
**Three distrobox-based operator environments** ride alongside the host system, each a fully isolated Linux distribution available at your fingertips:
| Container | What's in it | When to reach for it |
|---|---|---|
| **Kali** | The classic offensive-security toolkit — Burp, Metasploit, Nmap, sqlmap, Wireshark, Aircrack-ng, hashcat, John, the lot | Web app testing, network reconnaissance, password attacks, the standard pentest workflow |
| **BlackArch** | The largest offensive-security tool collection in any Linux ecosystem — well over 2,800 packages spanning every category from binary analysis to wireless | Niche tools, exotic protocols, specialist research, anything Kali doesn't ship |
| **Parrot** | Security + privacy + forensics, with Anonsurf and the privacy-tooling stack | OPSEC-conscious engagements, anonymization workflows, forensic recovery |
The host distribution layers in **600+ tools natively** through the Arch + AUR ecosystem, plus the project's own tooling (memory-safe replacements, ALFRED-aware integrations, custom ATT&CK-tagged utilities). Total cross-distrobox surface: **3,400+ tools** at your reach, without juggling separate VMs.
The arsenal isn't dumped on you at first boot. **Tools unlock progressively** through GRIMOIRE's certification arcs — beginning users see a curated starter set; the wider catalog opens as your skill bracket rises. This is not artificial difficulty: it's the difference between handing a novice every weapon in the armory and walking them through what each tool actually does, on a live target, in context.
### narrative quests
Threading through everything is a **branching narrative**. Quests with multiple paths. Choices that close some doors and open others. NPCs whose names you'll remember. Cutscenes that hit. A world with its own history before you arrived. You're not the protagonist — you're a new player in a world already in motion.
### cohorts and competition
GRIMOIRE plays best with peers. **Cohort mode** lets a class, a club, or a team compete on the same content. **Five competition modes** ship in the engine: leaderboard climbs, squad missions, faction wars, head-to-head challenge runs, and asymmetric red-vs-blue scenarios.
Some of the best labs can only be solved as a group.
---
### the certification arcs
GRIMOIRE doesn't replace certifications. It makes the practice that earns them feel like a story you're inside, not a syllabus you're slogging through. Lab progression is mapped against the major industry tracks:
- **Offensive Security** — OSCP, OSEP, OSWE, OSCE³
- **GIAC / SANS** — every active GIAC track with at least one mapped lab arc
- **(ISC)²** — CISSP, CCSP, CSSLP foundations
- **EC-Council** — CEH, CHFI, CCISO
- **INE** — eJPT, eCPPT, eWPTXv2
- **Defensive operations** — Splunk, Sentinel, Elastic certifications
- **Cloud security** — AZ-500, SC-100, AWS Security Specialty
Each cert track is materialized as a progression arc with labs mapped to actual exam objectives. You don't just *prepare* for the exam. You *live the curriculum*, in faction-colored scenarios, with real adversaries (some of them ALFRED-driven) and real loot to show for it.
### blue. red. purple. all of it.
GRIMOIRE refuses the false choice between offensive and defensive. The lab corpus spans:
- **Blue team** — SOC workflows, SIEM queries, incident response, log analysis, threat hunting, forensics, detection engineering, malware analysis
- **Red team** — reconnaissance, exploitation, privilege escalation, lateral movement, persistence, OPSEC, sandboxed adversary tradecraft
- **Purple team** — collaborative detect-validate loops, ATT&CK-driven assessments, detection-as-code authoring, shared telemetry analysis
- **War games** — live seasonal scenarios with rotating threats, ALFRED-driven adversary simulation, player-vs-player head-to-heads, team-vs-team campaigns, King-of-the-Hill persistence contests
Pick one lane. Pick all of them. The platform doesn't care. The platform *records* — and the leaderboards remember who turned up for which fights.
## the path
GRIMOIRE is structured around a long arc: from **novice** to **operator**.
The early game is exploration. The middle game is mastery. The endgame is the **Sovereign Operator Path** — a curated sequence of challenges that graduates a player from "I can solve labs" to "I can run my own infrastructure, defend my own mesh, mentor others through the same arc."
Along the way, the system maps your progress against **11 established cybersecurity certification paths**. We don't replace certs. We make the practice that earns them feel like a story you're inside, not a syllabus you're slogging through.
---
## the first-boot wizard
The first time you boot Syn_OS, GRIMOIRE meets you with a wizard. It asks you what you're here for. What you already know. What scares you. What thrills you. It chooses a starting faction (you can override). It seeds a few opening labs. It puts you on a path that fits.
The wizard is not a personality test. It's a **calibration**. It tunes the early experience so the first hour doesn't waste you.
---
## lab integrity
Every lab in the 108-lab corpus is hashed and signed. The `INTEGRITY_MANIFEST.toml` at the root of the lab tree enforces: exact lab count, per-lab SHA-256, per-category counts. The build system refuses to publish an ISO whose lab corpus doesn't match.
This matters because GRIMOIRE is a training platform — the integrity of what you're being asked to learn is load-bearing. We don't ship if we can't verify.
---
## who it's for
- **Students** working through certification paths who want the practice to feel like something more than rote.
- **Self-taught practitioners** who want a structure without it feeling like one.
- **Cohorts and clubs** running their own programs and looking for a platform that scales with them.
- **Operators** who already know the craft and want a place to push apprentices through.
- **Security teams** running internal training cycles who want a real platform under the curriculum.
---
## what's coming
- **GRIMOIRE Public ISO release** — the platform, signed, downloadable, with the full first-boot experience.
- **Cohort program at scale** — multi-tenant deployments for clubs, classes, and corporate training programs.
- **Continual content waves** — new labs, new boss contracts, new narrative arcs, new factions over time.
- **Public Rekor-anchored releases** — verifiable signatures on every ISO.
- **Curriculum integrations** — partnerships with academic and industry training programs that map GRIMOIRE progression onto formal coursework.
The platform is the long game. Every release deepens the world.
---
<div align="center">
*every lab is a small death. every boss contract is a small rebirth.*
</div>