Die Strelka-Web-UI ist ein browser- und API-basiertes Frontend zur Dateiübermittlung für den Strelka Enterprise File Scanner. Sie ermöglicht es Benutzern, Dateien an einen Strelka-Cluster zu übermitteln und frühere Antwortergebnisse bequem einzusehen. Die Strelka-Web-UI unterstützt LDAP-Authentifizierung und API-Zugriff und bietet so eine sichere und flexible Möglichkeit zur Interaktion mit dem Strelka-Scanner. Dieses Dokument enthält Details zur Einrichtung und Verwendung der Strelka-Web-UI sowie zu ihren Funktionen und verwandten Projekten.

Strelka-UI-Ergebnisseite

Funktionen

Die Dateiübermittlungs-Benutzeroberfläche bietet die folgenden Funktionen:

• Dateien an einen Strelka-Cluster übermitteln und Antworten direkt im Browser prüfen.
• Frühere Übermittlungsergebnisse und -aktivitäten in einer lokalen oder entfernten Datenbank speichern und anzeigen.
• Unterstützung für LDAP-Authentifizierung
• API-Unterstützung

Voraussetzungen

• Erreichbare Strelka-Instanz (siehe: Strelka Quickstart)
• Docker
• Docker-compose
• Python 3.9+

Schnellstart

Standardmäßig ist die Strelka-UI für eine minimale „Quickstart“-Bereitstellung konfiguriert, mit der Benutzer das System testen können. Diese Bereitstellung verwendet eine lokale Strelka-Instanz und startet eine lokale Datenbank. Benutzer können mit einem beliebigen Benutzernamen/Passwort auf dieses System zugreifen. Weitere Informationen zur Verwendung einer entfernten Strelka-Instanz, Datenbank oder zur LDAP-Authentifizierung finden Sie im Abschnitt Zusätzliche Einrichtung:

Schritt 1: Sicherstellen, dass ein Strelka-Cluster bereit ist

Start or ensure Strelka cluster is ready and accessible.
See https://github.com/target/strelka for more information.

Schritt 2: Strelka-UI erstellen und starten (Docker)

# Terminal 1
# From the ./strelka-ui directory
$ docker-compose -f docker-compose.yml up

Schritt 3: Auf die Strelka-UI zugreifen

1) Open A Browser
2) Navigate to 0.0.0.0:8080
3) Login with:
    - Username: strelka
    - Password: strelka

Zusätzliche Schritte

Dieser Abschnitt enthält Details zur Verwendung einer entfernten Strelka-Instanz, einer entfernten Datenbank zur Speicherung und eines LDAP-Servers zur Authentifizierung für eine sicherere Nutzung. Um diese zu aktivieren, können Sie Umgebungsvariablen verwenden, um die Standardwerte zu überschreiben.

Konfiguration über Umgebungsvariablen

Die Backend-Konfiguration erfolgt über Umgebungsvariablen und kann statisch in ./app/config/config.py festgelegt werden.

Bei lokaler Ausführung lautet die Prioritätsreihenfolge der Konfiguration: System environment -> .env -> ./app/config/config.py. Bei Ausführung in Docker lautet die Prioritätsreihenfolge der Konfiguration: Docker environment -> System environment -> ./app/config/config.py.

Bitte beachten Sie ./app/example.env für die Einrichtung der Umgebungsvariablen.

Umgebungsvariablen-Optionen

Im Folgenden werden die Konfigurationselemente in ./app/config/config.py aufgeführt.

Externe Hotlink-Unterstützung

Sie können auch einen Verweis in der Übermittlungstabelle der Benutzeroberfläche festlegen, damit Benutzer anhand der request.id schnell zu einer externen Website wechseln können. Durch Ändern von ./ui/src/config.js und Befolgen des SEARCH_URL-Beispiels in der folgenden Tabelle können Sie Benutzern einen Link zu einer externen Website (z. B. SIEM / Logger) bereitstellen. Stellen Sie sicher, dass Ihr Link die Zeichenfolge <REPLACE> enthält; die Benutzeroberfläche ersetzt diese Zeichenfolge durch die relevante Datei-Request-ID.

Unterstützte Änderungsfelder in ./ui/src/config.js:

Bereitstellung von CA-Zertifikaten

Falls Ihre Netzwerkumgebung ein benutzerdefiniertes CA-Bundle erfordert (z. B. einen Unternehmens-TLS-Inspektionsproxy), können Sie es sowohl zur Build-Zeit als auch zur Laufzeit bereitstellen, ohne Zertifikatsdateien in das Repository zu committen.

Build-Zeit – Übergeben Sie den Pfad zu Ihrem CA-Bundle über CUSTOM_CA_CERT, bevor Sie docker compose build ausführen. Das Zertifikat wird mithilfe eines BuildKit-Secrets temporär eingebunden und niemals in einer Image-Ebene gespeichert:

CUSTOM_CA_CERT=/path/to/your/ca-bundle.crt docker compose build
# or, combined with up:
CUSTOM_CA_CERT=/path/to/your/ca-bundle.crt docker compose up --build

In offenen Netzwerken, in denen kein benutzerdefiniertes CA erforderlich ist, lassen Sie die Variable einfach weg – der Build funktioniert auch ohne sie:

docker compose up --build

Laufzeit – Das Verzeichnis certs im Projektstamm wird in den laufenden Container unter /certs eingebunden. Platzieren Sie Ihr CA-Bundle dort und setzen Sie REQUESTS_CA_BUNDLE (und optional SSL_CERT_FILE) in ./app/strelka_ui/.env oder als Docker-Umgebungsvariable:

# ./app/strelka_ui/.env
REQUESTS_CA_BUNDLE=/certs/ca-bundle.crt
SSL_CERT_FILE=/certs/ca-bundle.crt

API

Die Strelka-UI bietet außerdem API-Routen für den Zugriff über Benutzerskripte. Details finden Sie in den folgenden Routen:

Authentifizierungsrouten

• [Basis-URL]/api/auth/login (POST)
• [Basis-URL]/api/auth/logout (GET)

Strelka-Routen

• [Basis-URL]/api/strelka/scans/stats (GET)
• [Basis-URL]/api/strelka/scans/upload (POST, form-encoded)
• [Basis-URL]/api/strelka/scans?page=?&per_page=? (GET)
• [Basis-URL]/api/strelka/scans/Scan-ID

Beispiel

Beispiele für die Authentifizierung an der Strelka-UI-API, das Abrufen von Scan-Statistiken und das Übermitteln einer Datei mit Python requests finden Sie in ./misc/examples/api_examples.py.

Datenbank

Die Datenbank verwendet https://www.sqlalchemy.org/ als ORM. Flask-Migrate wird verwendet, um Datenbankmigrationen über Alembic bereitzustellen. Eine Hilfsskriptdatei manage.py wird zur Unterstützung allgemeiner Datenbankaufgaben bereitgestellt.

Wenn Sie eine neue Datenbank erstellen oder die aktuelle ändern, müssen Sie die folgenden Schritte ausführen – diese Befehle werden beim Starten des Clusters für Sie ausgeführt:

Neue Migration aus Modelländerungen erstellen:

• python manage.py db migrate

Datenbank mit der aktuellen Datenbankkonfiguration aktualisieren

• python manage.py db upgrade

Anwendungsdetails

Die Backend-Anwendung besteht überwiegend aus den folgenden Technologien:

• https://flask.palletsprojects.com/en/1.1.x/
• https://www.sqlalchemy.org/
• https://www.postgresql.org/

Die Frontend-Benutzeroberfläche ist eine React-JS-Anwendung, die mit React erstellt und von Flask bereitgestellt wird. Die Benutzeroberfläche verwendet die Bibliothek Antd und Antd ProComponents; das Routing wird von React Router übernommen.

• create-react-app
• Ant Financial UI
• Antd ProComponents
• React Router

Strelka-UI-Dashboardseite

Verwandte Projekte

• Strelka

Lizenz

Die Strelka-UI und der zugehörige Code werden unter den Bedingungen der Apache-2.0-Lizenz veröffentlicht.