Skip to content

user security workflows

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

Security Workflows

Siyarix provides end-to-end automation for common security operations workflows — reconnaissance, vulnerability assessment, incident response, threat hunting, and compliance validation.


Network Reconnaissance

# Quick scan for live hosts and open ports
siyarix scan quick 10.0.0.0/24

# Comprehensive scan with service detection
siyarix scan full target.example.com

# Asset and service discovery
siyarix discover example.com

# Natural language equivalent
siyarix run "enumerate all subdomains and live hosts for example.com"

Vulnerability Assessment

# Natural language vulnerability scan
siyarix run "scan target.example.com for common vulnerabilities"

# Multi-tool comprehensive scan
siyarix scan --all 10.0.0.1

# Structured workflow pipeline
siyarix workflow run assessment.yml

# Agent-driven assessment
siyarix agent "find all vulnerabilities on the web server and categorize by severity"

Web Application Testing

# OWASP Top 10 automated scan
siyarix run "scan web application at https://target.com for OWASP Top 10"

# Specialized web scan
siyarix scan web https://target.com

Siyarix chains tools (Nikto, Nuclei, WPScan, ZAP) based on target fingerprinting.


Cloud Infrastructure Security

# Scan cloud providers
siyarix scan --cloud aws
siyarix scan --cloud all

# Natural language
siyarix run "check AWS for misconfigured S3 buckets and security groups"

Checks include: open S3 buckets, permissive security groups, unencrypted storage, disabled logging, and IAM over-privilege.


Infrastructure as Code

# Scan IaC templates for misconfigurations
siyarix run "scan IaC templates for security issues"

# CI/CD pipeline gate
siyarix ci-gate

Supports Terraform, CloudFormation, Helm, and Dockerfile analysis via pattern matching. Enhanced scanning with full AST parsing is planned for a future release.


Incident Response

# Security dashboard overview
siyarix security dashboard

# List active incidents
siyarix security incidents

# Execute containment playbook
siyarix security playbooks run incident-response

# Investigate with AI assistance
siyarix security hunt "find indicators of compromise in the network"

Exploitation and Red Team Campaigns

For authorized engagements, Siyarix supports campaign management and exploitation chains:

# Plan a multi-phase campaign
siyarix run "plan campaign: recon -> scan -> enumerate -> exploit"

# Track campaign progress
# (via /campaign in REPL)

Threat Hunting and Intelligence

# AI-assisted threat hunting
siyarix security hunt "find indicators of compromise in the network"

# MITRE ATT&CK mapping
siyarix security mitre --technique T1078

# Import threat intelligence feeds
siyarix run "import threat intel from stix_feed.json"

Compliance and Governance

# Run SOC 2 compliance checks
siyarix run "check SOC 2 compliance on the infrastructure"

# Via command group
siyarix compliance run --framework soc-2

# Generate compliance report
siyarix report generate --format html --include compliance

Supported frameworks: SOC 2, ISO 27001, NIST 800-53, GDPR, HIPAA, PCI-DSS.


Autonomous Agent Workflows

# Full autonomous multi-step objective
siyarix agent "enumerate all services, find vulnerabilities, generate a report"

# With explicit mode
siyarix agent "scan network" --mode autonomous

The agent decomposes objectives, assigns sub-tasks, executes them, and aggregates results.


Audit Trail Verification

Every command is logged with SHA-256 hash chaining for tamper-evident proof:

# View session audit log
siyarix session-log

# Verify audit chain integrity
siyarix audit verify

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