How mr-r3b00t/soc_chef works
Project Type and Purpose
• soc_chef is a static-site “Security Operations Chef” comprising a suite of proof-of-concept HTML/JS tools, JSON data files, and markdown templates.
• There is no traditional backend service; all HTML pages, data JSON, and interactive logic live in the repository and are served as static assets (e.g., via GitHub Pages + CDN).
• Its purpose is to deliver policy generators, risk and threat models, incident response wizards, planning checklists, and other security-ops utilities directly in the browser.
High-Level Architecture Components
A. Development & Deployment
• Git Repository (README, file tree)
• CI/CD Pipeline (GitHub Actions or equivalent to publish to GitHub Pages)
• Hosting / CDN (GitHub Pages + global cache)
B. Static Asset Store
• HTML files (tools, policy, processes, planning, models, assessments, resources)
• JSON data files (e.g., planning/project_plan_schema.json, process IR wizards)
• Markdown / templates (templates/html/playbook_template.html)
C. Client-Side Runtime
• Browser loads HTML/JS/CSS
• In-page JavaScript fetches JSON, renders dynamic content, wires user interactions
• Minimal third-party dependencies (vanilla JS or lightweight libs)
Relationships & Data Flows
1. Developer edits files → commits to GitHub
2. CI/CD builds (if needed) → publishes to GitHub Pages & CDN
3. End user’s browser requests HTML page
4. CDN serves static HTML/JS/CSS → browser renders UI
5. JS modules fetch associated JSON data or templates (e.g., planning JSON, process wizards)
6. JS dynamically injects content into the DOM → interactive tool
Architectural Patterns & Design Principles
• Static-First Architecture: All logic and data shipped as static files, no backend runtime.
• Modular & Categorized Content: Directories group functionality by domain (assessments, policy, processes, tools).
• Client-Side Rendering: JSON data + HTML templates → processed in browser.
• Reusable Templates: Playbook templates in templates/html drive consistent look and feel across tools.