Sirius Scan

Sirius ist ein Open-Source-Schwachstellenscanner mit automatischer Erkennung, CVE-basierter Analyse und einer modernen Weboberfläche. Repository klonen, vier Befehle ausführen, mit dem Scannen beginnen.

Schnellstart

git clone https://github.com/SiriusScan/Sirius.git
cd Sirius
docker compose -f docker-compose.installer.yaml run --rm sirius-installer
docker compose up -d

Öffnen Sie http://localhost:3000 und melden Sie sich an:

Das war's. Alle sechs Dienste starten automatisch. Der Installer generiert beim ersten Start sichere Zugangsdaten und kann bedenkenlos erneut ausgeführt werden.

Standardmäßig setzt der Installer IMAGE_TAG nicht, sodass Compose latest von GHCR zieht. Um eine bestimmte Version festzulegen (z. B. v1.0.0 in .env), tun Sie dies nur, nachdem dieser Tag für alle sechs Container-Images vorhanden ist. Überprüfen Sie dies mit bash scripts/verify-ghcr-public-access.sh v1.0.0 in einer Shell, die nicht bei ghcr.io angemeldet ist.

Voraussetzungen: Docker Engine 20.10+ mit Compose V2, 4 GB RAM, 10 GB Festplattenspeicher. Funktioniert unter Linux, macOS und Windows (WSL2).

Was Sirius tut

• Netzwerkerkennung – automatische Host- und Dienstaufzählung mittels Nmap
• Schwachstellenerkennung – CVE-basierte Scans mit CVSS-Bewertung
• Risiko-Dashboards – Echtzeit-Scanfortschritt, Schweregradtrends und Anleitungen zur Behebung
• Entfernte Agenten – verteilte Scans in mehreren Umgebungen via gRPC
• Interaktives Terminal – PowerShell-Konsole für erweiterte Skripterstellung und Automatisierung
• REST-API – Integration in bestehende Sicherheits-Workflows (X-API-Key-Authentifizierung auf Port 9001)

Bereitstellungsoptionen

Der Installer-Schritt ist immer derselbe. Nur der docker compose up-Befehl ändert sich.

Nicht-interaktives Setup (CI / Terraform / Automatisierung)

docker compose -f docker-compose.installer.yaml run --rm sirius-installer --non-interactive --no-print-secrets
docker compose up -d

Zugangsdaten rotieren

docker compose -f docker-compose.installer.yaml run --rm sirius-installer --force
docker compose up -d --force-recreate

Installation überprüfen

docker compose ps                    # alle 6 Dienste sollten "healthy" oder "running" anzeigen
curl http://localhost:3000            # UI antwortet
curl http://localhost:9001/health     # API antwortet

Erwartete Dienste: sirius-ui (3000), sirius-api (9001), sirius-engine (5174, 50051), sirius-postgres (5432), sirius-rabbitmq (5672, 15672), sirius-valkey (6379).

Architektur

graph TD
    subgraph clients [Clients]
        UI["Sirius UI (Next.js)"]
        CLI["Terminal and Agent Runtime"]
    end

    subgraph core [Core Services]
        API["Sirius API (Go/Gin)"]
        Engine["Sirius Engine"]
    end

    subgraph infra [Infrastructure]
        MQ["RabbitMQ"]
        DB["PostgreSQL"]
        Cache["Valkey"]
    end

    UI -->|"HTTP/WebSocket"| API
    CLI -->|"gRPC"| Engine
    API -->|"AMQP publish"| MQ
    MQ -->|"Queue consume"| Engine
    API -->|"SQL read/write"| DB
    Engine -->|"SQL read/write"| DB
    API -->|"Session/cache ops"| Cache
    Engine -->|"Scan state cache ops"| Cache

Oberfläche

Dashboard	Scanner	Schwachstellennavigator

Umgebung	Host-Details	Terminal

API

Sirius stellt REST-Endpunkte auf Port 9001 bereit, geschützt durch den internen Service-API-Key. Bevorzugen Sie die Docker Secret-Datei (SIRIUS_API_KEY_FILE, Standard /run/secrets/sirius_api_key); SIRIUS_API_KEY bleibt als unterstützte Umgebungsvariable für den Fallback erhalten. Der Installer schreibt ./secrets/sirius_api_key.txt (Modus 0644, sodass Nicht-Root-App-UIDs das bind-gemountete Secret lesen können) und konfiguriert beides.

curl http://localhost:9001/health -H "X-API-Key: $SIRIUS_API_KEY"
curl http://localhost:9001/api/v1/scan/get/all -H "X-API-Key: $SIRIUS_API_KEY"

Vollständige API-Dokumentation: REST-API-Referenz

Sicherheitsempfehlungen

Für Produktionsbereitstellungen:

1. Zugangsdaten rotieren – den Installer mit --force ausführen, um alle Berechtigungen neu zu generieren
2. Ports einschränken – nur Port 3000 (UI) freigeben; 5432, 6379, 5672 intern halten
3. Reverse Proxy verwenden – nginx oder Traefik mit TLS vorschalten
4. Images aktuell halten – docker compose pull && docker compose up -d

Fehlerbehebung

Schnellhilfen für häufige Probleme:

Ausführliche Betriebsrunbooks, Verifikationsverfahren und Notfallwiederherstellung finden Sie unter Betrieb & Fehlerbehebung.

Mitwirken

Siehe CONTRIBUTING.md für Entwicklungseinrichtung, Codierungsstandards und PR-Richtlinien.

Schnelllinks: Issues | Diskussionen | Discord

Weiterführende Informationen

• Installationsanleitung
• Oberflächentour
• Scananleitung
• Docker-Architektur
• Systemarchitektur
• CI/CD-Anleitung
• Betrieb & Fehlerbehebung

Lizenz

MIT