VyOS-Logs erfassen

Unterstützt in:

Google SecOps SIEM

In diesem Dokument wird beschrieben, wie Sie VyOS-Logs mit dem Bindplane-Agent in Google Security Operations aufnehmen.

VyOS ist ein Open-Source-Netzwerkrouter, der Syslog-Nachrichten für Firewallereignisse, Routingänderungen, VPN-Verbindungen und Systemereignisse generiert.

Hinweis

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

• Eine Google SecOps-Instanz
• Windows Server 2016 oder höher oder ein Linux-Host mit systemd
• Netzwerkverbindung zwischen dem Bindplane-Agent und dem VyOS-Router
• Wenn Sie einen Proxy verwenden, müssen die Firewallports gemäß den Anforderungen des Bindplane-Agents geöffnet sein.
• SSH-Zugriff auf den VyOS-Router mit Administratorberechtigungen

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

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

• Neue Bereitstellungen: Verwenden Sie die Chronicle API (Option 1).
• Legacy-Bereitstellungen: Verwenden Sie weiterhin die Authentifizierungsdatei für die Aufnahme (Option 2), bis die Ingestion API am 20. Juli 2027 eingestellt wird.

Option 1: Dienstkonto für die Chronicle API erstellen (empfohlen)

1. Melden Sie sich in der Google Cloud Console an und wählen Sie das Google Cloud Projekt aus, das mit Ihrer Google SecOps-Instanz verknüpft ist.
2. Rufen Sie IAM & 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-Bearbeiter aus.
7. Klicken Sie auf Weiter und dann auf Fertig.
8. Klicken Sie auf das 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, damit der Pfad mit dem Speicherort übereinstimmt.
12. Rufen Sie IAM & Verwaltung > Einstellungen auf und kopieren Sie die Projektnummer. Sie benötigen sie für die Exporterkonfiguration.

Hinweis: Der JSON-Schlüssel ist ein Anmeldedatum. Beschränken Sie den Zugriff auf die Datei auf dem Bindplane-Host und rotieren Sie den Schlüssel gemäß der Richtlinie Ihrer Organisation.

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

1. Melden Sie sich in der Google SecOps-Konsole an.
2. Rufen Sie SIEM-Einstellungen > Erfassungs-Agents auf.
3. Laden Sie die Authentifizierungsdatei für die Aufnahme herunter.
4. Speichern Sie die Datei sicher auf dem System, auf dem der Bindplane-Agent installiert wird.

Hinweis: Mit dieser Datei wird der Agent bei der Legacy Ingestion API (malachiteingestion-pa.googleapis.com) authentifiziert, die Google am 20. Juli 2027 einstellt. Planen Sie, vor diesem Datum zu Option 1 zu wechseln.

Google SecOps-Kundennummer abrufen

1. Melden Sie sich in der Google SecOps-Konsole an.
2. Rufen Sie SIEM-Einstellungen > Profil auf.

3. Kopieren und speichern Sie die Kundennummer aus dem Abschnitt Organisationsdetails.

   **Hinweis**: Die Kundennummer ist für die Konfiguration des Bindplane-Agent-Exporters erforderlich.

Bindplane-Agent installieren

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

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.

Weitere Installationsressourcen

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

Hinweis: Für die Konfiguration des Chronicle API-Exporters ist der Bindplane-Collector v1.106.0 oder höher erforderlich. Mit den vorherigen Befehlen wird die neueste Version installiert. Wenn Sie eine vorhandene Installation aktualisieren, führen Sie ein Upgrade des Collectors durch, bevor Sie die Konfiguration ändern.

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

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/vyos:
      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: VYOS
      raw_log_field: body
  
  service:
    pipelines:
      logs/vyos_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/vyos
  

Konfigurationsparameter

Ersetzen Sie die folgenden Platzhalter:

• Empfängerkonfiguration :

  • listen_address: IP-Adresse und Port, auf die gewartet werden soll:
    • 0.0.0.0, um auf allen Schnittstellen zu warten (empfohlen)
    • Port 514 ist der Standard-Syslog-Port (erfordert Root-Berechtigungen unter Linux; verwenden Sie 1514 für Nicht-Root-Berechtigungen)

• Exporterkonfiguration :

  • 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 chronicle.googleapis.com diesen Wert voran. Die vollständige Liste finden Sie unter Regionale Endpunkte.
  • project: Ersetzen Sie <PROJECT_NUMBER> durch die Projektnummer unter IAM & Verwaltung > Einstellungen.
  • endpoint: Behalten Sie die Einstellung chronicle.googleapis.com bei.

Exporter für die Legacy Ingestion API

• Wenn Sie die Authentifizierungsdatei für die Aufnahme aus Option 2 verwenden, ersetzen Sie den Block exporters durch Folgendes. Legen Sie creds_file_path auf den Pfad zur Authentifizierungsdatei für die Aufnahme 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/vyos:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: VYOS
      raw_log_field: body
  

Hinweis: Dieser Exporter funktioniert nicht mehr, wenn die Ingestion API am 20. Juli 2027 eingestellt wird.

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

Bindplane-Agent neu starten, um die Änderungen zu übernehmen

• Führen Sie den folgenden Befehl aus, um den Bindplane-Agent 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-Agent 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 in VyOS konfigurieren

1. Stellen Sie eine SSH-Verbindung zum VyOS-Router her.

2. Rufen Sie den Konfigurationsmodus auf:

   configure
   

3. Konfigurieren Sie den Remote-Syslog-Host. Ersetzen Sie <bindplane-ip> durch die IP-Adresse Ihres Bindplane-Agents:

   set system syslog host <bindplane-ip> facility all level info
   set system syslog host <bindplane-ip> port 514
   set system syslog host <bindplane-ip> protocol udp
   

4. Übernehmen und speichern Sie die Konfiguration:

   commit
   save
   

UDM-Zuordnungstabelle

Logfeld	UDM-Zuordnung	Logik
clientIp	principal.ip	Client-IP-Adresse, die aus der DHCP-Nachricht extrahiert wurde.
clientMac	principal.mac	Client-MAC-Adresse, die aus der DHCP-Nachricht extrahiert wurde.
datetime	metadata.event_timestamp	Der Zeitstempel, der aus dem Logeintrag extrahiert wurde.
dst_ipaddress	target.ip	Ziel-IP-Adresse, die aus dem Logeintrag extrahiert wurde.
hostname	observer.hostname	Hostname, der aus dem Logeintrag extrahiert wurde. Wird vom Parser anhand des process-Felds und anderer Felder bestimmt. Kann GENERIC_EVENT, NETWORK_CONNECTION, NETWORK_DHCP oder STATUS_UPDATE sein. Fest auf „VYOS“ codiert.
msg	metadata.description	Die ursprüngliche Nachricht aus dem Log oder ein Teil davon, je nach Parsinglogik. Wird auf „DHCP Event“ festgelegt, wenn process „dhcpd“ ist. Fest auf „VYOS DHCP“ codiert. Fest auf „VYOS“ codiert.
network.dhcp.chaddr	network.dhcp.chaddr	Client-MAC-Adresse, die aus DHCP-Nachrichten extrahiert wurde.
network.dhcp.ciaddr	network.dhcp.ciaddr	Client-IP-Adresse in einer DHCPREQUEST-Nachricht. DHCP-Nachrichtencode. Wird für DHCPREQUEST und DHCPINFORM auf „BOOTREQUEST“ und für DHCPACK und DHCPNAK auf „BOOTREPLY“ festgelegt. DHCP-Nachrichtentyp. Wird aus eventType abgeleitet und kann REQUEST, ACK, INFORM, NAK oder OFFER sein.
network.dhcp.yiaddr	network.dhcp.yiaddr	Ihre (Client-)IP-Adresse in einer DHCPACK- oder DHCPOFFER-Nachricht. Wird auf „DHCP“ festgelegt, wenn process „dhcpd“ ist.
pri_host	principal.hostname	Hostname, der in DHCP-Nachrichten mit einem Client verknüpft ist.
rem_msg	metadata.description	Verbleibender Teil der Nachricht nach dem ersten Parsing, der in einigen Fällen für die Beschreibung verwendet wird.
src_ipaddress	principal.ip	Quell-IP-Adresse, die aus dem Logeintrag extrahiert wurde.
timestamp	event.timestamp	Der Zeitstempel des Logeintrags.

Änderungsprotokoll

Änderungsprotokoll für diesen Parser ansehen

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