Ubiquiti Unifi-Switch-Logs erfassen

Unterstützt in:

In diesem Dokument wird beschrieben, wie Sie Ubiquiti Unifi-Switch-Logs mit Bindplane in Google Security Operations aufnehmen. Der Parser extrahiert Felder aus den Syslog-Nachrichten mithilfe von Grok-Mustern und konvertiert die Logrohdaten in ein strukturiertes Format, das dem Unified Data Model (UDM) entspricht. Er verarbeitet verschiedene Protokollformate, extrahiert wichtige Informationen wie Zeitstempel, Hostnamen, Beschreibungen und Netzwerkdetails und reichert die Daten mit zusätzlichem Kontext an, bevor sie in das endgültige UDM-Ereignis zusammengeführt werden.

Hinweis

Prüfen Sie, ob folgende Voraussetzungen erfüllt sind:

  • Eine Google SecOps-Instanz
  • Ein Windows 2016- oder höherer oder Linux-Host mit systemd
  • Wenn der Agent hinter einem Proxy ausgeführt wird, müssen die Firewallports gemäß den Anforderungen des BindPlane-Agents geöffnet sein.
  • Privilegierter Zugriff auf die Ubiquiti Controller-Benutzeroberfläche

Google SecOps-Anmeldedaten für den Bindplane-Agenten abrufen

Wählen Sie eine der folgenden Methoden aus, um den Bindplane-Agenten bei Google SecOps zu authentifizieren:

  • Neue Bereitstellungen: Verwenden Sie die Chronicle API (Option 1).
  • Legacy-Bereitstellungen: Verwenden Sie die Authentifizierungsdatei für die Datenaufnahme (Option 2) weiter, bis die Ingestion API am 20. Juli 2027 eingestellt wird.
  1. Melden Sie sich in der Google Cloud -Konsole an und wählen Sie das Google Cloud -Projekt aus, das mit Ihrer Google SecOps-Instanz verknüpft ist.
  2. Rufen Sie IAM und Verwaltung > Dienstkonten auf.
  3. Klicken Sie auf Dienstkonto erstellen.
  4. Geben Sie die folgenden Konfigurationsdetails an:
    • Name des Dienstkontos: Geben Sie einen Namen für das Konto ein (z. B. bindplane-ingest).
    • Dienstkontobeschreibung: Geben Sie eine Beschreibung ein (z. B. Bindplane agent log ingestion).
  5. Klicken Sie auf Erstellen und fortfahren.
  6. Klicken Sie im Abschnitt Diesem Dienstkonto Zugriff auf das Projekt erteilen auf Rolle auswählen und wählen Sie Chronicle Editor aus.
  7. Klicken Sie auf Weiter und dann auf Fertig.
  8. Klicken Sie auf das von Ihnen erstellte Dienstkonto und rufen Sie den Tab Schlüssel auf.
  9. Klicken Sie auf Schlüssel hinzufügen > Neuen Schlüssel erstellen.
  10. Wählen Sie JSON aus und klicken Sie auf Erstellen. Die Schlüsseldatei wird auf Ihren Computer heruntergeladen.
  11. Speichern Sie die Schlüsseldatei als ingestion-auth.json im Bindplane-Collector-Verzeichnis (/opt/observiq-otel-collector/ingestion-auth.json unter Linux oder C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json unter Windows) oder aktualisieren Sie creds_file_path in config.yaml, sodass der Pfad mit dem Pfad übereinstimmt, unter dem Sie die Datei speichern.
  12. Rufen Sie IAM und Verwaltung > Einstellungen auf und kopieren Sie die Projektnummer. Sie benötigen sie für die Exporter-Konfiguration.

Option 2: Authentifizierungsdatei für die Datenaufnahme herunterladen (Legacy)

  1. Melden Sie sich in der Google SecOps-Konsole an.
  2. Rufen Sie Einstellungen > Datenverwaltung > Erfassungs-Agents auf. Wenn Sie eine reine SIEM-Plattform verwenden, rufen Sie die Einstellungen > Erfassungs-Agents auf.
  3. Laden Sie die Authentifizierungsdatei für die Datenaufnahme herunter.
  4. Speichern Sie die Datei sicher auf dem System, auf dem der Bindplane-Agent installiert werden soll.

Google SecOps-Kundennummer abrufen

  1. Melden Sie sich in der Google SecOps-Konsole an.
  2. Gehen Sie zu Einstellungen > Verwaltung > Profil. Wenn Sie eine reine SIEM-Plattform verwenden, rufen Sie die Einstellungen > Profil auf.
  3. Kopieren und speichern Sie die Kundennummer aus dem Bereich Organisationsdetails.

Bindplane-Agent installieren

Installieren Sie den Bindplane-Agenten gemäß der folgenden Anleitung auf Ihrem Windows- oder Linux-Betriebssystem.

Windows-Installation

  1. Öffnen Sie die Eingabeaufforderung oder PowerShell als Administrator.
  2. Führen Sie dazu diesen Befehl aus:

    msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
    

Linux-Installation

  1. Öffnen Sie ein Terminal mit Root- oder sudo-Berechtigungen.
  2. Führen Sie dazu diesen Befehl aus:

    sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
    

Zusätzliche Installationsressourcen

Bindplane-Agent für die Aufnahme von Syslog und das Senden an Google SecOps konfigurieren

  1. Greifen Sie auf die Konfigurationsdatei zu:

    1. Suchen Sie die Datei config.yaml. In der Regel befindet sie sich unter Linux im Verzeichnis /opt/observiq-otel-collector/ oder unter Windows im Installationsverzeichnis.
    2. Öffnen Sie die Datei mit einem Texteditor (z. B. nano, vi oder Notepad).
  2. Bearbeiten Sie die Datei config.yamlso:

    receivers:
      udplog:
        # Replace the port and IP address as required
        listen_address: "0.0.0.0:514"
    
    exporters:
      chronicle/chronicle_w_labels:
        protocol: https
        # Region of your instance, for example us, europe, asia-southeast1
        location: <LOCATION>
        # Project number of the Google Cloud project linked to the instance
        project: '<PROJECT_NUMBER>'
        compression: gzip
        # Adjust the path to the credentials file you downloaded in Step 1
        creds_file_path: '/path/to/ingestion-authentication-file.json'
        # Replace with your actual customer ID from Step 2
        customer_id: <CUSTOMER_ID>
        endpoint: chronicle.googleapis.com
        # Add optional ingestion labels for better organization
        log_type: 'UBIQUITI_SWITCH'
        raw_log_field: body
        ingestion_labels:
    
    service:
      pipelines:
        logs/source0__chronicle_w_labels-0:
          receivers:
            - udplog
          exporters:
            - chronicle/chronicle_w_labels
    
    • Ersetzen Sie den Port und die IP-Adresse nach Bedarf in Ihrer Infrastruktur.
    • Ersetzen Sie <LOCATION> durch die Region Ihrer Google SecOps-Instanz (z. B. us, europe oder asia-southeast1). Der Exporter stellt diesem Wert chronicle.googleapis.com voran.
    • Ersetzen Sie <PROJECT_NUMBER> durch die Projektnummer aus IAM und Verwaltung > Einstellungen.
    • Ersetzen Sie <CUSTOMER_ID> durch die tatsächliche Kundennummer.
    • Aktualisieren Sie /path/to/ingestion-authentication-file.json auf den Pfad, unter dem die Dienstkontoschlüsseldatei (Option 1) im Abschnitt Google SecOps-Anmeldedaten für den Bindplane-Agenten abrufen gespeichert wurde.

Legacy-Ingestion-API-Exporter

  • Wenn Sie die Authentifizierungsdatei für die Datenaufnahme aus Option 2 verwenden, ersetzen Sie den Block exporters durch Folgendes. Legen Sie für creds_file_path den Pfad zur Authentifizierungsdatei für die Datenaufnahme fest. Wenn sich Ihre Instanz außerhalb der USA befindet, ersetzen Sie malachiteingestion-pa.googleapis.com durch Ihren regionalen Endpunkt (z. B. europe-malachiteingestion-pa.googleapis.com).

    exporters:
      chronicle/chronicle_w_labels:
        compression: gzip
        # Adjust the path to the credentials file you downloaded in Step 1
        creds_file_path: '/path/to/ingestion-authentication-file.json'
        # Replace with your actual customer ID from Step 2
        customer_id: <CUSTOMER_ID>
        endpoint: malachiteingestion-pa.googleapis.com
        # Add optional ingestion labels for better organization
        log_type: 'UBIQUITI_SWITCH'
        raw_log_field: body
        ingestion_labels:
    

Starten Sie den Bindplane-Agent neu, um die Änderungen zu übernehmen.

  • Führen Sie den folgenden Befehl aus, um den Bindplane-Agenten unter Linux neu zu starten:

    sudo systemctl restart observiq-otel-collector
    
  • Wenn Sie den Bindplane-Agent unter Windows neu starten möchten, können Sie entweder die Konsole Dienste verwenden oder den folgenden Befehl eingeben:

    net stop observiq-otel-collector && net start observiq-otel-collector
    

Ubquiti-Switch so konfigurieren, dass Syslog-Daten der Steuerungsebene gesendet werden

  1. Melden Sie sich in der Unifi Controller-Benutzeroberfläche an.
  2. Öffne Unifi Network.
  3. Gehen Sie zu Einstellungen > Steuerungsebene > Tab „Integrationen“.
  4. Suchen Sie den Abschnitt Aktivitätsprotokollierung (Syslog).
  5. Aktivieren Sie die Option SIEM-Server.
  6. Geben Sie die folgenden Konfigurationsdetails an:
    • Klicken Sie auf Kategorien bearbeiten und fügen Sie die erforderlichen Protokollkategorien hinzu.
    • Serveradresse: Geben Sie die IP-Adresse des Bindplane-Agents ein.
    • Port: Geben Sie die Portnummer des Bindplane-Agents ein (UDP ist erforderlich).
  7. Klicken Sie auf Änderungen übernehmen.

Ubquiti-Switch so konfigurieren, dass CyberSecure-Syslog gesendet wird

  1. Melden Sie sich in der Unifi Controller-Benutzeroberfläche an.
  2. Öffne Unifi Network.
  3. Gehen Sie zu Einstellungen > CyberSecure > Tab „Traffic Logging“.
  4. Suchen Sie den Abschnitt Aktivitätsprotokollierung (Syslog).
  5. Aktivieren Sie die Option SIEM-Server.
  6. Geben Sie die folgenden Konfigurationsdetails an:
    • Klicken Sie auf Kategorien bearbeiten und fügen Sie die erforderlichen Protokollkategorien hinzu.
    • Serveradresse: Geben Sie die IP-Adresse des Bindplane-Agents ein.
    • Port: Geben Sie die Portnummer des Bindplane-Agents ein (UDP ist erforderlich).
    • Deaktivieren Sie Debugging-Logs.
  7. Klicken Sie auf Änderungen übernehmen.

UDM-Zuordnungstabelle

Logfeld UDM-Zuordnung Logik
anomalies security_result.detection_fields[].key: „anomalies“
security_result.detection_fields[].value: anomalies-Wert aus dem Log
Wird direkt aus dem Feld anomalies im Rohlog zugeordnet.
application observer.application Wird direkt aus dem Feld application im Rohlog zugeordnet.
assoc_status security_result.detection_fields[].key: „assoc_status“
security_result.detection_fields[].value: assoc_status-Wert aus dem Protokoll
Wird direkt aus dem Feld assoc_status im Rohlog zugeordnet.
asset_details observer.asset.product_object_id: Mit dem Grok-Muster %{GREEDYDATA:asset_id},%{GREEDYDATA:asset_version} extrahiert
asset_software.version: Mit dem Grok-Muster %{GREEDYDATA:asset_id},%{GREEDYDATA:asset_version} extrahiert
Das Feld asset_details wird mit einem Grok-Muster geparst, um asset_id und asset_version zu extrahieren.
asset_id observer.asset.product_object_id Direkt aus dem extrahierten Feld asset_id aus asset_details zugeordnet.
asset_version observer.asset.software.version Direkt aus dem extrahierten Feld asset_version aus asset_details zugeordnet.
bssid principal.mac Wird direkt aus dem Feld bssid im Rohlog zugeordnet.
description metadata.description Wird direkt aus dem Feld description im Rohlog zugeordnet.
device metadata.product_name Wird direkt aus dem Feld device im Rohlog zugeordnet. Wenn device nicht vorhanden ist, wird der Wert „UBIQUITI_SWITCH“ verwendet.
dns_resp_seen security_result.detection_fields[].key: „dns_resp_seen“
security_result.detection_fields[].value: dns_resp_seen-Wert aus dem Log
Wird direkt aus dem Feld dns_resp_seen im Rohlog zugeordnet.
DST target.ip Wird direkt aus dem Feld DST im Rohlog zugeordnet.
DPT principal.port Wird direkt aus dem Feld DPT im Rohlog zugeordnet, nachdem es in eine Ganzzahl umgewandelt wurde.
event_type security_result.detection_fields[].key: „event_type“
security_result.detection_fields[].value: event_type-Wert aus dem Protokoll
Wird direkt aus dem Feld event_type im Rohlog zugeordnet.
host principal.hostname Wird direkt aus dem Feld host im Rohlog zugeordnet.
ID additional.fields[].key: „ID“
additional.fields[].value.string_value: ID-Wert aus dem Protokoll
Wird direkt aus dem Feld ID im Rohlog zugeordnet.
IN additional.fields[].key: „IN“
additional.fields[].value.string_value: IN-Wert aus dem Log
Wird direkt aus dem Feld IN im Rohlog zugeordnet.
interface additional.fields[].key: „interface“
additional.fields[].value.string_value: interface-Wert aus dem Log
Wird direkt aus dem Feld interface im Rohlog zugeordnet.
LEN additional.fields[].key: „LEN“
additional.fields[].value.string_value: LEN-Wert aus dem Protokoll
Wird direkt aus dem Feld LEN im Rohlog zugeordnet.
mac principal.mac Wird direkt aus dem Feld mac im Rohlog zugeordnet.
metadata.event_type metadata.event_type Abgeleitet von der Parserlogik. Wird auf „STATUS_SHUTDOWN“ gesetzt, wenn state „Down“ ist, auf „STATUS_STARTUP“, wenn state „Up“ ist, auf „STATUS_UPDATE“, wenn kv_msg und DST vorhanden sind oder principal_present „true“ ist, und andernfalls auf „GENERIC_EVENT“.
metadata.log_type metadata.log_type: „UBIQUITI_SWITCH“ Konstanter Wert, der vom Parser festgelegt wird.
metadata.vendor_name metadata.vendor_name: „UBIQUITI“ Konstanter Wert, der vom Parser festgelegt wird.
principal_ip principal.ip Wird direkt aus dem Feld principal_ip im Rohlog zugeordnet.
process_id observer.process.pid Wird direkt aus dem Feld process_id im Rohlog zugeordnet.
product_event_type metadata.product_event_type Wird direkt aus dem Feld product_event_type im Rohlog zugeordnet.
PROTO network.ip_protocol Wird direkt aus dem Feld PROTO im Rohlog zugeordnet. Wenn PROTO „ICMPv6“ ist, wird der Wert in „ICMP“ geändert.
query_1 target.administrative_domain Wird direkt aus dem Feld query_1 im Rohlog zugeordnet.
query_server_1 target.ip Wird direkt aus dem Feld query_server_1 im Rohlog zugeordnet.
radio security_result.detection_fields[].key: „radio“
security_result.detection_fields[].value: radio-Wert aus dem Protokoll
Wird direkt aus dem Feld radio im Rohlog zugeordnet.
satisfaction_now security_result.detection_fields[].key: „satisfaction_now“
security_result.detection_fields[].value: satisfaction_now-Wert aus dem Protokoll
Wird direkt aus dem Feld satisfaction_now im Rohlog zugeordnet.
source_port principal.port Wird direkt aus dem Feld source_port im Rohlog zugeordnet, nachdem es in eine Ganzzahl umgewandelt wurde.
SPT target.port Wird direkt aus dem Feld SPT im Rohlog zugeordnet, nachdem es in eine Ganzzahl umgewandelt wurde.
SRC principal.ip, principal.hostname Wird direkt aus dem Feld SRC im Rohlog zugeordnet.
sta principal.mac Wird direkt aus dem Feld sta im Rohlog zugeordnet.
state additional.fields[].key: „state“
additional.fields[].value.string_value: state-Wert aus dem Log
Wird direkt aus dem Feld state im Rohlog zugeordnet.
timestamp metadata.event_timestamp Wird direkt aus dem Feld timestamp im Rohlog zugeordnet, nachdem es vom Datumsfilter geparst wurde.
TTL additional.fields[].key: „TTL“
additional.fields[].value.string_value: TTL-Wert aus dem Log
Wird direkt aus dem Feld TTL im Rohlog zugeordnet.
vap metadata.ingestion_labels[].key: „Vap“
metadata.ingestion_labels[].value: vap-Wert aus dem Protokoll
Wird direkt aus dem Feld vap im Rohlog zugeordnet.
version metadata.product_version Wird direkt aus dem Feld version im Rohlog zugeordnet.

Änderungsprotokoll

Änderungsprotokoll für diesen Parser ansehen

Benötigen Sie weitere Hilfe? Antworten von Community-Mitgliedern und Google SecOps-Experten erhalten