Skip to content

user compliance frameworks

MD MUFTHAKHERUL ISLAM MIRAZ edited this page Jun 24, 2026 · 2 revisions

Note

👋 Hey there! Siyarix is a personal passion project built by a single developer that is growing and under active development. The feature described on this page is currently Planned / Under Development and may not be fully functional in the codebase yet. Stay tuned for updates! 🚀

📋 Compliance Frameworks

Navigating compliance audits can be overwhelming, but Siyarix is here to help simplify the process. We are actively building out automated probes and evidence collection to assess your systems against six major industry compliance frameworks!

Warning

Active Development Notice: The compliance assessment engine is currently a work in progress! At the moment, running compliance checks will return a NOT_EVALUATED status because we are carefully building out the underlying evaluation logic.


🏛️ Supported Frameworks

Once fully implemented, Siyarix will help you assess your posture against:

Framework Full Name Planned Controls
PCI-DSS Payment Card Industry Data Security Standard 3
ISO 27001 Information Security Management Standard 3
NIST 800-53 Security and Privacy Controls 3
SOC 2 Service Organization Control 2 3
GDPR General Data Protection Regulation 2
HIPAA Health Insurance Portability and Accountability Act 2

🏃 Running Compliance Checks

It's designed to be incredibly simple to run a check against any target:

# Check a specific framework against your target infrastructure
siyarix compliance run SOC2 10.0.0.1
siyarix compliance run PCI-DSS webapp.example.com
siyarix compliance run GDPR customer-db.internal

Note

The compliance run command requires two things: the Framework Name and the Target.

Current Engine Status

Right now, calling ComplianceCheck.run() acts as a placeholder and returns NOT_EVALUATED. Behind the scenes, we are actively writing the assessment probes and evidence collection modules. Currently, evidence data and target metadata are being captured and stored for future evaluation.


🔎 Control Examples by Framework

Here is a sneak peek at the types of controls Siyarix will automatically verify for you:

💳 PCI-DSS

Control ID What We Check For
Req-1.1 Strict firewall configuration standards
Req-6.1 Robust security patching processes
Req-10.1 Comprehensive audit trail implementation

🏢 SOC 2

Control ID What We Check For
cc1.1 Sound control environment practices
cc6.1 Logical and physical access restrictions
cc6.2 Secure access provisioning and deprovisioning

🌍 GDPR

Control ID What We Check For
Art. 32 Overall security of processing
Art. 33 Proper breach notification mechanisms

🕵️ Automated Evidence Collection

Audits require proof! Siyarix doesn't just say "pass" or "fail"; it collects the receipts. Our automated probes gather structured evidence for your auditors, including:

  • Tool Detection: Proving required security tools (like AV or EDR) are actively running.
  • Process Verification: Ensuring logging, monitoring, and response mechanisms are configured.
  • Configuration Checks: Verifying encryption standards, access controls, and audit settings.
  • Documentation Scans: Checking if required policy and procedure documents actually exist.

📄 Understanding the Output

Every control we assess provides clear, structured feedback:

Field What It Means
check_id The specific identifier for the framework (e.g., cc1.1)
status Did you pass? (Currently defaults to NOT_EVALUATED)
evidence_data The hard proof we collected to support the status
message A human-readable description of what we found

Example Output

{
  "framework": "SOC2",
  "target": "10.0.0.1",
  "results": [
    {
      "check_id": "cc1.1",
      "status": "NOT_EVALUATED",
      "message": "Stub check — not yet evaluated against live controls."
    }
  ]
}

📊 Report Generation

When audit time comes, you need beautiful, easy-to-read reports. Siyarix makes it a breeze!

# 📄 Generate a stunning HTML compliance report
siyarix report generate --format html --output compliance-report.html

# 💻 Export raw JSON data for your CI/CD pipelines
siyarix report generate --format json

Note

👋 Welcome to Siyarix! This is a personal passion project built by a single developer. It's currently under active development and growing fast. Expect rough edges, but lots of love! ❤️

🗺️ Siyarix Documentation Map

Welcome to the Siyarix Documentation Map! This page serves as your master compass for navigating the extensive documentation we have built for the platform.

Whether you are a brand new user, a seasoned security operator, or a developer looking to contribute to the core engine, you can find exactly what you need here.


🧭 Quick Navigation

Not sure where to start? Pick the path that best describes you:

🌱 For New Users

Just getting started? We highly recommend following these guides in order:

  1. Installation Guide — Get Siyarix running on your machine.
  2. Onboarding Wizard — Let our interactive wizard help you set up your API keys and environment.
  3. Setup & Configuration — A deeper dive into customizing your setup.
  4. Your First Run — A gentle walkthrough of your very first Siyarix command.

🛡️ For Security Operators

Ready to put Siyarix to work? Dive into our operational guides:

💻 For Developers & Contributors

Looking under the hood or wanting to write some code? Start here:


📂 The Complete Documentation Tree

If you prefer to browse the raw structure, here is a complete layout of the docs/ folder:

docs/
├── 🚀 getting-started/       # Installation, onboarding, and configuration
│   ├── installation.md       # Multi-platform install (pip, brew, winget, docker)
│   ├── onboarding.md         # The interactive 11-step setup wizard
│   ├── setup.md              # Managing API keys, credentials, and settings
│   ├── first-run.md          # A walkthrough of your first session
│   ├── configuration.md      # A deep-dive into advanced settings
│   └── troubleshooting.md    # Common issues and how to fix them instantly
│
├── 📖 user/                  # Daily operations and workflows
│   ├── cli-commands.md       # Reference for 50+ CLI commands across 12 groups
│   ├── interactive-chat.md   # Mastering the AI REPL and 54+ slash commands
│   ├── security-workflows.md # Recon, vulnerability assessment, incident response
│   ├── cloud-scanning.md     # Multi-cloud security scanning (under development)
│   ├── compliance.md         # Framework mapping (SOC 2, NIST, GDPR, PCI-DSS)
│   ├── threat-intelligence.md# Integrations with OTX, NVD, and MITRE ATT&CK
│   ├── playbooks.md          # Building automated YAML-based IR playbooks
│   ├── workflow-files.md     # DAG workflow reference (programmatic API)
│   ├── reporting.md          # Multi-format report generation
│   ├── offline-registry.md   # Running without AI (Offline/Registry execution mode)
│   └── ai-workflows.md       # Advanced AI-driven autonomous operations
│
├── 💻 developer/             # Building, testing, and extending Siyarix
│   ├── codebase-overview.md  # Full module structure mapping
│   ├── contribution-guide.md # How to submit PRs and our coding standards
│   ├── module-architecture.md# Component design and responsibilities
│   ├── testing.md            # Writing tests (pytest), coverage, and CI/CD
│   └── building.md           # Packaging, distribution, and Docker builds
│
├── 🏗️ architecture/          # System design and core internals
│   ├── overview.md           # High-level data flow and layered orchestration
│   ├── ai-agent-pipeline.md  # The AgentCore reasoning and execution pipeline
│   ├── provider-abstraction.md# How we unify 26 different AI providers
│   ├── execution-engine.md   # Plan-based step orchestration
│   ├── memory-and-state.md   # Knowledge graph, session persistence, and learning
│   ├── security-model.md     # The Permission Gate, DLP, audit logging, and OPSEC
│   └── intent-routing.md     # Semantic intent classification and routing
│
├── 🧠 ai/                    # Deep dive into the AI provider & agent systems
│   ├── routing.md            # Managing 26 providers, failovers, and circuit breakers
│   ├── persona-system.md     # Overview of our 10 security personas
│   ├── agent-reasoning.md    # The Observe-Reason-Act loop and tool call repair
│   ├── tool-execution.md     # The tool registry, capability graph, and parsers
│   ├── ensemble.md           # Parallel LLM voting strategies
│   ├── multi-wave.md         # Iterative goal execution with context carry-over
│   ├── prompt-architecture.md# System prompt design and management
│   └── safety.md             # Our rigorous 8-layer hallucination mitigation system
│
├── 🛡️ security/              # Safety, ethics, and threat models
│   ├── reporting.md          # How to safely report vulnerabilities to us
│   ├── threat-model.md       # System threat model and our mitigations
│   ├── operational-security.md# TOR routing, stealth modes, and OPSEC controls
│   ├── ethical-policy.md     # Mandatory rules of engagement for all users
│   └── abuse-prevention.md   # How we prevent misuse of the AI engine
│
└── ⚖️ legal/                 # Licensing and governance
    ├── agpl-guide.md         # A plain-English overview of the AGPL-3.0-or-later license
    ├── why-agpl.md           # The philosophy behind our license choice
    ├── trademark-policy.md   # Branding and trademark guidelines
    ├── responsible-ai.md     # Our framework for ethical AI usage
    ├── disclaimer.md         # Important legal disclaimers
    └── plugin-exception.md   # The license exception for building custom plugins

📖 Key Terminology

As you read through the documentation, you might encounter some specific terms. Here is a quick cheat sheet:

Term What It Means
Provider The backend AI engine powering Siyarix (e.g., OpenAI, Anthropic, Ollama).
Tool A traditional security executable installed on your system (e.g., nmap, nuclei).
Plan A step-by-step sequence of tool commands intelligently generated by the AI.
Workflow A hardcoded, predefined execution path (usually defined in YAML/JSON) that doesn't require AI generation.
Persona A specialized behavioral profile given to the AI (e.g., instructing it to act specifically as a "Network Recon Specialist").
Knowledge Graph Siyarix's internal memory where it stores findings (like IP addresses, open ports) to contextually inform future steps.

Need help finding something specific? Feel free to use the search bar at the top of the documentation site, or open a discussion on our GitHub!

Clone this wiki locally