OPNsense-Firewall-Logs erfassen

Unterstützt in:

In diesem Dokument wird beschrieben, wie Sie OPNsense-Firewall-Logs mit dem Bindplane-Agenten in Google Security Operations aufnehmen.

OPNsense ist eine Open-Source-Firewall- und Routing-Plattform, die Syslog-Nachrichten für Firewallregel-Übereinstimmungen, Netzwerkverbindungen und Systemereignisse generiert. Der Parser extrahiert Felder aus CSV-formatierten Filterlog-Nachrichten mithilfe von Grok- und CSV-Parsing und ordnet sie dem Unified Data Model (UDM) zu.

Hinweis

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

  • Eine Google SecOps-Instanz
  • Windows Server 2016 oder höher oder Linux-Host mit systemd
  • Netzwerkverbindung zwischen dem Bindplane-Agent und der OPNsense-Firewall
  • Wenn der Agent hinter einem Proxy ausgeführt wird, müssen die Firewallports gemäß den Anforderungen des Bindplane-Agents geöffnet sein.
  • Administratorzugriff auf die OPNsense-Weboberflä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
    
  3. Warten Sie, bis die Installation abgeschlossen ist.

  4. Überprüfen Sie die Installation mit folgendem Befehl:

    sc query observiq-otel-collector
    

    Der Dienst sollte als RUNNING angezeigt werden.

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
    
  3. Warten Sie, bis die Installation abgeschlossen ist.

  4. Überprüfen Sie die Installation mit folgendem Befehl:

    sudo systemctl status observiq-otel-collector
    

    Der Dienst sollte als active (running) angezeigt werden.

Zusätzliche Installationsressourcen

Weitere Installationsoptionen und Informationen zur Fehlerbehebung finden Sie in der Installationsanleitung für den Bindplane-Agenten.

Bindplane-Agenten so konfigurieren, dass Syslog-Daten aufgenommen und an Google SecOps gesendet werden

Konfigurationsdatei suchen

  • Linux:

    sudo nano /opt/observiq-otel-collector/config.yaml
    
  • Windows:

    notepad "C:\Program Files\observIQ OpenTelemetry Collector\config.yaml"
    

Konfigurationsdatei bearbeiten

  • Ersetzen Sie den gesamten Inhalt von config.yaml durch die folgende Konfiguration:

    receivers:
      udplog:
        listen_address: "0.0.0.0:514"
    
    exporters:
      chronicle/opnsense:
        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
        creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: chronicle.googleapis.com
        log_type: OPNSENSE
        raw_log_field: body
    
    service:
      pipelines:
        logs/opnsense_to_chronicle:
          receivers:
            - udplog
          exporters:
            - chronicle/opnsense
    

Konfigurationsparameter

Ersetzen Sie die folgenden Platzhalter:

  • Empfängerkonfiguration:

    • listen_address: IP-Adresse und Port, auf dem gelauscht werden soll:
      • 0.0.0.0, um auf allen Schnittstellen zu lauschen (empfohlen)
      • Port 514 ist der Standard-Syslog-Port (erfordert Root unter Linux; verwenden Sie 1514 für Nicht-Root).
  • Exporter-Konfiguration:

    • creds_file_path: Vollständiger Pfad zur JSON-Schlüsseldatei des Dienstkontos (Option 1):
      • Linux: /opt/observiq-otel-collector/ingestion-auth.json
      • Windows: C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
    • customer_id: Kundennummer, die aus der Google SecOps-Konsole kopiert wurde
    • location: 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. Eine vollständige Liste finden Sie unter Regionale Endpunkte.
    • project: Ersetzen Sie <PROJECT_NUMBER> durch die Projektnummer aus IAM & Verwaltung > Einstellungen.
    • endpoint: Behalten Sie die Einstellung chronicle.googleapis.com bei.

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/opnsense:
        compression: gzip
        creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: OPNSENSE
        raw_log_field: body
    

Konfigurationsdatei speichern

  • Speichern Sie die Datei nach der Bearbeitung:
    • Linux: Drücken Sie Ctrl+O, dann Enter und dann Ctrl+X.
    • Windows: Klicken Sie auf Datei > Speichern.

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
    
    1. Prüfen Sie, ob der Dienst ausgeführt wird:

      sudo systemctl status observiq-otel-collector
      
    2. Prüfen Sie die Logs auf Fehler:

      sudo journalctl -u observiq-otel-collector -f
      
  • Wählen Sie eine der folgenden Optionen aus, um den Bindplane-Agenten unter Windows neu zu starten:

    • Eingabeaufforderung oder PowerShell als Administrator:

      net stop observiq-otel-collector && net start observiq-otel-collector
      
    • Dienstkonsole:

      1. Drücken Sie Win+R, geben Sie services.msc ein und drücken Sie die Eingabetaste.
      2. Suchen Sie nach observIQ OpenTelemetry Collector.
      3. Rechtsklicken Sie und wählen Sie Neu starten aus.
      4. Prüfen Sie, ob der Dienst ausgeführt wird:

        sc query observiq-otel-collector
        
      5. Prüfen Sie die Logs auf Fehler:

        type "C:\Program Files\observIQ OpenTelemetry Collector\log\collector.log"
        

Syslog-Serverkonfiguration zu OPNsense hinzufügen

  1. Melden Sie sich in der Weboberfläche von OPNsense an.
  2. Gehen Sie zu System > Einstellungen > Logging.
  3. Aktivieren Sie im Bereich Remote Logging die Option Send logs to remote syslog server (Logs an Remote-Syslog-Server senden), indem Sie das Kästchen anklicken.
  4. Geben Sie im Feld Remote-Syslog-Server die IP-Adresse des Syslog-Servers einschließlich des Ports ein (z. B. 10.10.10.10:514).
  5. Wählen Sie Local0 als Syslog-Einrichtung aus.
  6. Legen Sie die Syslog-Stufe auf Alert fest.
  7. Klicken Sie auf Speichern, um die Änderungen zu übernehmen.

UDM-Zuordnungstabelle

Logfeld UDM-Zuordnung Logik
column1 security_result.rule_id Direkt von column1 zugeordnet.
column10 additional.fields[].key: „tos“
additional.fields[].value.string_value: Wert von column10
Direkt aus column10 zugeordnet, verschachtelt unter additional.fields mit dem Schlüssel „tos“.
column12 additional.fields[].key: „ttl“
additional.fields[].value.string_value: Wert von column12
Direkt aus column12 zugeordnet, verschachtelt unter additional.fields mit dem Schlüssel „ttl“.
column13 additional.fields[].key: „Id“
additional.fields[].value.string_value: Wert von column13
Direkt aus column13 zugeordnet, verschachtelt unter additional.fields mit dem Schlüssel „Id“.
column14 additional.fields[].key: „offset“
additional.fields[].value.string_value: Wert von column14
Direkt aus column14 zugeordnet, verschachtelt unter additional.fields mit dem Schlüssel „offset“.
column15 additional.fields[].key: „flags“
additional.fields[].value.string_value: Wert von column15
Direkt aus column15 zugeordnet, verschachtelt unter additional.fields mit dem Schlüssel „flags“.
column17 network.ip_protocol Direkt aus column17 zugeordnet, nachdem in Großbuchstaben umgewandelt wurde.
column18 network.received_bytes Wird nach der Konvertierung in eine vorzeichenlose Ganzzahl direkt aus column18 zugeordnet.
column19 principal.ip Direkt von column19 zugeordnet.
column20 target.ip Direkt von column20 zugeordnet.
column21 principal.port (wenn column17 TCP oder UDP ist)
additional.fields[].key: „data_length“
additional.fields[].value.string_value: Extrahierter Wert (wenn column17 ICMP, GRE, ESP oder IGMP ist)
Wenn column17 TCP/UDP ist, wird es direkt von column21 zugeordnet und in eine Ganzzahl konvertiert. Andernfalls wird der Wert „datalength“ mit grok extrahiert und in additional.fields mit dem Schlüssel „data_length“ platziert.
column22 target.port Wird direkt von column22 zugeordnet, wenn column17 TCP oder UDP ist, und in eine Ganzzahl konvertiert.
column24 additional.fields[].key: „tcp_flags“
additional.fields[].value.string_value: Wert von column24
Direkt von column24 zugeordnet, wenn column17 TCP ist, verschachtelt unter additional.fields mit dem Schlüssel „tcp_flags“.
column29 additional.fields[].key: „tcp_options“
additional.fields[].value.string_value: Wert von column29
Direkt von column29 zugeordnet, wenn column17 TCP ist, verschachtelt unter additional.fields mit dem Schlüssel „tcp_options“.
column4 additional.fields[].key: „tracker“
additional.fields[].value.string_value: Wert von column4
Direkt aus column4 zugeordnet, verschachtelt unter additional.fields mit dem Schlüssel „tracker“.
column5 additional.fields[].key: „interface“
additional.fields[].value.string_value: Wert von column5
Direkt von column5 zugeordnet, verschachtelt unter additional.fields mit dem Schlüssel „interface“.
column6 security_result.rule_type Direkt von column6 zugeordnet.
column7 security_result.action Aus column7 zugeordnet. Wenn „block“, wird es in Großbuchstaben „BLOCK“ umgewandelt. Wenn „pass“, auf „ALLOW“ festlegen.
column8 network.direction Aus column8 zugeordnet. Wenn „in“, legen Sie „INBOUND“ fest. Wenn „out“, auf „OUTBOUND“ festlegen.
domain principal.administrative_domain Direkt aus dem mit Grok extrahierten domain zugeordnet. Wird auf „NETWORK_CONNECTION“ gesetzt, wenn sowohl die IP-Adresse des Hauptkontos als auch die des Ziels vorhanden sind, andernfalls auf „GENERIC_EVENT“. Hartcodiert auf „OPNSENSE“. Hartcodiert auf „OPNSENSE“.
message Verschiedene Felder Wird mit Grok- und CSV-Filtern geparst, um verschiedene Felder zu extrahieren. Spezifische Zuordnungen finden Sie in den anderen Zeilen.
ts metadata.event_timestamp.seconds, timestamp.seconds Wird mit Grok aus dem Nachrichtenfeld geparst und dann in einen Zeitstempel konvertiert. Der Sekundenwert wird verwendet, um sowohl metadata.event_timestamp.seconds als auch timestamp.seconds zu füllen.
application principal.application Direkt aus dem mit Grok extrahierten application zugeordnet.
column27 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet
column2 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet
column3 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet
column11 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet
column26 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet
column28 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet
column25 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet
column16 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet
column9 event.idm.read_only_udm.additional.fields Aus Änderungsprotokoll zugeordnet

Änderungsprotokoll

Änderungsprotokoll für diesen Parser ansehen

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