- README.md: Complete project overview with features, download, quick start - ARCHITECTURE.md: System design, components, security architecture - Includes technology stack, deployment models, performance specs - All non-sensitive IP suitable for public consumption
277 lines
9.9 KiB
Markdown
277 lines
9.9 KiB
Markdown
<div align="center">
|
|
|
|
# Syn_OS v10.3.2 - "GRIMOIRE Hardened"
|
|
|
|
<img src="https://raw.githubusercontent.com/TLimoges33/Syn_OS/main/assets/branding/logos/phoenix/phoenix-512.png" width="300" alt="Syn_OS Phoenix Logo">
|
|
|
|
## 🛡️ The World's First AI-Conscious Cybersecurity Operating System
|
|
|
|
**Production-Grade Security Platform with Integrated AI Training Environment**
|
|
|
|
[](https://github.com/TLimoges33/Syn_OS)
|
|
[](https://github.com/TLimoges33/synos-public-docs/blob/main/ROADMAP.md)
|
|
[](LICENSE)
|
|
[](https://github.com/TLimoges33/synos-public-docs/blob/main/FEATURES.md#grimoire-labs)
|
|
[](https://github.com/TLimoges33/synos-public-docs/blob/main/FEATURES.md#security-tools)
|
|
|
|
[📥 Download](#download) | [✨ Features](#features) | [🚀 Quick Start](#quick-start) | [📖 Documentation](#documentation) | [💬 Community](#community)
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## 🎯 What is Syn_OS?
|
|
|
|
**Syn_OS** (Synaptic Operating System) is a **production-grade cybersecurity platform** built on Debian 13 Trixie that bridges the gap between cutting-edge security research and practical penetration testing.
|
|
|
|
### Why "Syn_OS"?
|
|
|
|
The underscore "_" represents the **synaptic gap** — the space between neurons where signals jump. Syn_OS bridges the gap between:
|
|
- **Traditional Security** ↔ **AI-Enhanced Defense**
|
|
- **Theory** ↔ **Practice**
|
|
- **Learning** ↔ **Execution**
|
|
|
|
> *"Own Your Infrastructure. Own Your Intelligence. Own Your Future."*
|
|
|
|
---
|
|
|
|
## ✨ Features
|
|
|
|
### 🛡️ Core Security Platform
|
|
|
|
- **600+ Security Tools** — Unified collection from ParrotOS, Kali Linux, and BlackArch
|
|
- **Dual Kernel Architecture** — Production (6.12.57) + Experimental (6.18.2) with Rust support
|
|
- **11 Custom AI Syscalls** — Direct kernel-to-AI communication (syscalls 480-491)
|
|
- **eBPF Security Monitoring** — 5 kernel-level monitors with ML integration
|
|
- **Zero-Trust Architecture** — PKI-based authentication with behavioral analytics
|
|
- **Post-Quantum Cryptography** — NIST PQC standards (ML-KEM, ML-DSA, SLH-DSA)
|
|
|
|
### 🤖 ALFRED v5.0 — AI Security Assistant
|
|
|
|
- **LLM Integration** — Support for OpenAI, Anthropic, Mistral, local models
|
|
- **RAG Capabilities** — Vector database with ChromaDB for context-aware responses
|
|
- **STIX 2.1 Threat Intel** — MITRE ATT&CK integration with real-time updates
|
|
- **Security Automation** — Automated reconnaissance, vulnerability scanning, reporting
|
|
- **Voice Control** — Hands-free operation for OPSEC scenarios
|
|
|
|
### 🎓 GRIMOIRE Labs — Cybersecurity Training
|
|
|
|
- **50+ Hands-On Labs** — From beginner (Capture the Flag) to advanced (APT simulation)
|
|
- **Progress Tracking** — XP system with skill trees and achievements
|
|
- **Industry Certifications** — OSCP, GPEN, CEH, CompTIA Security+ aligned content
|
|
- **Real-World Scenarios** — Based on actual CVEs and threat intelligence
|
|
- **Docker Integration** — Isolated lab environments with automatic provisioning
|
|
|
|
### 🚀 Developer-Friendly
|
|
|
|
- **1.9M+ Lines of Code** — 107 Rust crates, comprehensive Python/C integration
|
|
- **Modular Architecture** — Clean separation between core, services, and applications
|
|
- **Full Documentation** — Architecture guides, API references, development tutorials
|
|
- **CI/CD Pipeline** — Automated testing, security scanning, ISO building
|
|
- **Open Development** — Transparent roadmap, community contributions welcome
|
|
|
|
---
|
|
|
|
## 📥 Download
|
|
|
|
### Latest Release: v10.3.2 "GRIMOIRE Hardened" (January 2026)
|
|
|
|
**System Requirements:**
|
|
- **RAM:** 8GB minimum, 16GB recommended
|
|
- **Storage:** 50GB minimum, 100GB recommended
|
|
- **CPU:** x86_64, 4 cores minimum
|
|
- **Boot:** UEFI + Legacy BIOS support
|
|
|
|
**Download Options:**
|
|
|
|
| Edition | Size | Use Case | Link |
|
|
|---------|------|----------|------|
|
|
| **Full ISO** | ~4.5GB | Complete platform with all tools | [Download](https://github.com/TLimoges33/Syn_OS/releases) |
|
|
| **Minimal ISO** | ~2.0GB | Core system, download tools as needed | [Download](https://github.com/TLimoges33/Syn_OS/releases) |
|
|
| **VM Image** | ~6.0GB | Pre-configured VMware/VirtualBox | [Download](https://github.com/TLimoges33/Syn_OS/releases) |
|
|
|
|
**Verification:**
|
|
```bash
|
|
# Download checksums
|
|
wget https://github.com/TLimoges33/Syn_OS/releases/download/v10.3.2/SHA256SUMS
|
|
wget https://github.com/TLimoges33/Syn_OS/releases/download/v10.3.2/SHA256SUMS.sig
|
|
|
|
# Verify integrity
|
|
sha256sum -c SHA256SUMS 2>&1 | grep OK
|
|
|
|
# Verify signature (optional)
|
|
gpg --verify SHA256SUMS.sig SHA256SUMS
|
|
```
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### 1. Boot from ISO
|
|
|
|
```bash
|
|
# Write ISO to USB (Linux)
|
|
sudo dd if=synos-v10.3.2.iso of=/dev/sdX bs=4M status=progress oflag=sync
|
|
|
|
# Or use Etcher/Rufus on Windows
|
|
```
|
|
|
|
### 2. Installation
|
|
|
|
1. Boot from USB/DVD
|
|
2. Select "Install Syn_OS" from boot menu
|
|
3. Follow Calamares installer (supports 10 desktop environments)
|
|
4. Choose security profile: Beginner | Professional | Hardened
|
|
5. Wait ~15 minutes for installation
|
|
6. Reboot and enjoy!
|
|
|
|
### 3. First Steps
|
|
|
|
```bash
|
|
# Initialize ALFRED AI assistant
|
|
alfred-setup --profile security
|
|
|
|
# Run system diagnostic
|
|
synos-diagnostic --full
|
|
|
|
# Start GRIMOIRE lab environment
|
|
grimoire-ctl start
|
|
|
|
# Launch first lab
|
|
grimoire-lab start 001-intro-recon
|
|
```
|
|
|
|
---
|
|
|
|
## 📖 Documentation
|
|
|
|
### User Guides
|
|
- [Installation Guide](articles/installation-guide.md) — Detailed installation instructions
|
|
- [Getting Started](articles/getting-started.md) — First steps with Syn_OS
|
|
- [ALFRED Tutorial](articles/alfred-tutorial.md) — Using the AI assistant
|
|
- [GRIMOIRE Labs Guide](articles/grimoire-guide.md) — Hands-on training platform
|
|
|
|
### Technical Documentation
|
|
- [Architecture Overview](ARCHITECTURE.md) — System design and components
|
|
- [Feature Reference](FEATURES.md) — Comprehensive feature list
|
|
- [Security Features](SECURITY.md) — Security architecture and hardening
|
|
- [API Reference](API.md) — Developer APIs and integration
|
|
|
|
### Development
|
|
- [Contributing Guidelines](CONTRIBUTING.md) — How to contribute
|
|
- [Development Setup](articles/dev-setup.md) — Build environment configuration
|
|
- [Roadmap](ROADMAP.md) — Future plans and milestones
|
|
|
|
---
|
|
|
|
## 🎯 Use Cases
|
|
|
|
### 🎓 **Learning & Certification**
|
|
Perfect for students preparing for OSCP, CEH, GPEN, or CompTIA Security+. GRIMOIRE labs provide hands-on practice with real-world scenarios.
|
|
|
|
### 🔍 **Penetration Testing**
|
|
Professional-grade toolkit with 600+ tools, automated workflows, and AI-assisted reconnaissance. ALFRED helps automate repetitive tasks.
|
|
|
|
### 🔬 **Security Research**
|
|
Custom kernel with AI integration enables novel research in ML-based threat detection and autonomous defense systems.
|
|
|
|
### 🏢 **Enterprise Security**
|
|
Zero-trust architecture, post-quantum cryptography, and SIEM integration make Syn_OS suitable for corporate security operations.
|
|
|
|
### 🎮 **CTF Competitions**
|
|
Optimized for Capture the Flag events with quick tool access, automated note-taking, and collaborative features.
|
|
|
|
---
|
|
|
|
## 🏆 Why Choose Syn_OS?
|
|
|
|
| Feature | Kali Linux | ParrotOS | Syn_OS |
|
|
|---------|-----------|----------|--------|
|
|
| **Security Tools** | 600+ | 700+ | **600+** (curated) |
|
|
| **AI Integration** | ❌ | ❌ | ✅ **ALFRED v5.0** |
|
|
| **Training Labs** | ❌ | Limited | ✅ **50+ GRIMOIRE Labs** |
|
|
| **Custom Kernel** | ❌ | ❌ | ✅ **AI Syscalls + Rust** |
|
|
| **Post-Quantum Crypto** | ❌ | ❌ | ✅ **NIST PQC** |
|
|
| **Gamification** | ❌ | ❌ | ✅ **XP + Skill Trees** |
|
|
| **Desktop Environments** | 5 | 6 | ✅ **10 Options** |
|
|
|
|
---
|
|
|
|
## 💬 Community
|
|
|
|
### Get Involved
|
|
|
|
- 🐛 **Report Bugs:** [GitHub Issues](https://github.com/TLimoges33/Syn_OS/issues)
|
|
- 💡 **Feature Requests:** [GitHub Discussions](https://github.com/TLimoges33/Syn_OS/discussions)
|
|
- 📧 **Contact:** synos@tlimoges.dev
|
|
- 🐦 **Twitter:** [@TLimoges33](https://twitter.com/TLimoges33)
|
|
- 📝 **Blog:** [Substack](https://synos.substack.com)
|
|
|
|
### Contributing
|
|
|
|
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
|
|
**Ways to Contribute:**
|
|
- 🐛 Bug fixes and testing
|
|
- 📝 Documentation improvements
|
|
- 🎨 UI/UX enhancements
|
|
- 🧪 New GRIMOIRE labs
|
|
- 🔧 Tool integration
|
|
- 🌍 Translations
|
|
|
|
---
|
|
|
|
## 📊 Project Stats
|
|
|
|
**Codebase (January 2026):**
|
|
- **1.9M+ Lines of Code** across 453,717 files
|
|
- **107 Rust Crates** — Modern, memory-safe components
|
|
- **165K+ Lines of Tests** — 14:1 test-to-code ratio
|
|
- **50+ Labs** — Comprehensive training curriculum
|
|
- **600+ Tools** — Industry-standard security arsenal
|
|
|
|
**Active Development:**
|
|
- ✅ Production-ready v10.3.2 release
|
|
- 🚀 Monthly security updates
|
|
- 📈 Growing community
|
|
- 🎯 OSCP/CEH-aligned training content
|
|
|
|
---
|
|
|
|
## 📜 License
|
|
|
|
Syn_OS is released under the **MIT License**. See [LICENSE](LICENSE) for details.
|
|
|
|
**Third-Party Components:**
|
|
- Security tools retain their original licenses (GPLv2, GPLv3, MIT, etc.)
|
|
- Debian base: [Debian Free Software Guidelines](https://www.debian.org/social_contract#guidelines)
|
|
- Kernel patches: GPLv2
|
|
|
|
---
|
|
|
|
## 🙏 Acknowledgments
|
|
|
|
Syn_OS builds upon the incredible work of:
|
|
- **Debian Project** — Rock-solid foundation
|
|
- **Parrot Security** — Tool curation and UI inspiration
|
|
- **Kali Linux** — Penetration testing standards
|
|
- **BlackArch** — Comprehensive tool collection
|
|
- **Rust Community** — Memory-safe systems programming
|
|
- **Open Source Community** — Thousands of security tools and libraries
|
|
|
|
---
|
|
|
|
## ⚠️ Disclaimer
|
|
|
|
Syn_OS is designed for **authorized security testing and education only**. Users are responsible for ensuring compliance with all applicable laws and regulations. Unauthorized access to computer systems is illegal.
|
|
|
|
---
|
|
|
|
<div align="center">
|
|
|
|
**[⭐ Star this repo](https://github.com/TLimoges33/synos-public-docs)** if you find Syn_OS valuable!
|
|
|
|
Made with ❤️ by the Syn_OS Team
|
|
|
|
</div>
|