Skip to content

user cloud scanning

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! 🚀

☁️ Cloud Security Scanning

Securing your cloud environments doesn't have to be a headache. Siyarix comes packed with multi-cloud security scanning capabilities right out of the box, covering AWS, Azure, GCP, Kubernetes, and Docker.

Note

Siyarix is smart! It only queries a provider's SDK if it detects that the respective cloud credentials are available on your system.


🏢 Supported Providers

Here is a quick look at the platforms we currently support and what you need to get started:

Provider Number of Checks What You Need
AWS 5 boto3 installed, AWS credentials configured
Azure 3 azure-identity installed, Azure credentials
GCP 3 google-cloud-resource-manager installed, GCP credentials
Kubernetes 3 kubernetes Python package, valid kubeconfig
Docker 3 docker Python package, running Docker daemon

🔍 How to Scan

Starting a scan is incredibly simple. You can scan everything at once, target specific providers, or just use natural language!

# 🌍 Scan ALL configured cloud providers
siyarix scan --cloud all

# 🎯 Target specific providers
siyarix scan --cloud aws
siyarix scan --cloud azure
siyarix scan --cloud gcp
siyarix scan --cloud kubernetes
siyarix scan --cloud docker

# 🗣️ Use natural language!
siyarix run "check AWS for security misconfigurations"

📋 Security Checks by Provider

Curious about what we're looking for? Here are the specific misconfigurations Siyarix hunts down:

🟠 AWS Checks

Check ID What We Look For Severity
S3_PUBLIC_ACCESS Are your S3 buckets wide open to the public? HIGH
IAM_OVERLY_PERMISSIVE Do your IAM policies grant *:* (everything to everyone)? CRITICAL
SECURITY_GROUP_OPEN Are security groups allowing SSH from anywhere (0.0.0.0/0)? HIGH
UNENCRYPTED_EBS Are your EBS volumes missing encryption? MEDIUM
CLOUDTRAIL_DISABLED Is AWS CloudTrail turned off? (You need those logs!) HIGH

🔵 Azure Checks

Check ID What We Look For Severity
NSG_OPEN Do Network Security Groups allow RDP/SSH from any source? HIGH
BLOB_PUBLIC_ACCESS Can anyone access your Blob storage containers anonymously? HIGH
RBAC_OVERPRIVILEGED Are RBAC role assignments giving away too much power? MEDIUM

🟢 GCP Checks

Check ID What We Look For Severity
BUCKET_PUBLIC_ACCESS Are GCS buckets publicly accessible? HIGH
FIREWALL_OPEN Do firewall rules allow 0.0.0.0/0 on management ports? HIGH
IAM_PRIMITIVE_ROLE Are primitive roles (owner/editor/viewer) actively assigned? MEDIUM

☸️ Kubernetes Checks

Check ID What We Look For Severity
POD_ROOT_USER Are your containers running as root? HIGH
PRIVILEGE_ESCALATION Is privilege escalation allowed on pods? HIGH
HOST_NETWORK Are pods tying into the host network namespace? MEDIUM

🐳 Docker Checks

Check ID What We Look For Severity
ROOT_USER Are your Docker containers running as root? HIGH
SENSITIVE_ENV Do environment variables expose sensitive secrets? MEDIUM
NO_HEALTHCHECK Are containers missing standard health checks? LOW

🔑 Credential Configuration

You don't need to jump through hoops to configure credentials. Siyarix automatically looks for them in this order:

  1. Environment Variables: Like AWS_ACCESS_KEY_ID, AZURE_CLIENT_ID, etc.
  2. Default Chains: Standard locations (like ~/.aws/credentials).
  3. Siyarix Store: Credentials saved via siyarix auth set-key <provider>.

📈 Understanding the Output

When a scan finishes, you'll get detailed results including the Check ID, Severity, Description, and most importantly: Remediation Guidance (how to fix it!).

Tip

Need to pipe the output to another tool? Use the --output flag for clean JSON!

siyarix scan --cloud aws --output json

🚀 What's Next? (Planned Enhancements)

We're constantly improving! While our current scanner is great for quick, provider-specific checks, we are actively building a comprehensive CloudScanner.

Future updates will include:

  • Deep multi-account support
  • Cross-provider correlation (spotting complex attack paths)
  • Automated, click-to-fix remediation!

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