ForgeRock OpenAM-Logs erfassen

Parserversion:4.0

Unterstützt in:

Google SecOps SIEM

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

ForgeRock OpenAM ist eine Lösung zur Zugriffsverwaltung, die Syslog-Meldungen für Authentifizierungsereignisse, Entscheidungen zur Zugriffssteuerung, Sitzungsaktivitäten und Konfigurationsänderungen generiert. Der Parser extrahiert Felder aus JSON-formatierten Audit-Logs 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 dem ForgeRock OpenAM-Server
• 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 AM-Konsole (z. B. amAdmin)

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

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

• Neue Deployments: 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.

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

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 & 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 erstellte Dienstkonto und rufen Sie dann 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 & Verwaltung > Einstellungen auf und kopieren Sie die Projektnummer. Sie benötigen sie für die Konfiguration des Exporters.

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

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

1. Melden Sie sich in der Google SecOps-Konsole an.
2. Rufen Sie die 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 werden soll.

Hinweis: Mit dieser Datei wird der Agent bei der Legacy Ingestion API (malachiteingestion-pa.googleapis.com) authentifiziert, die Google am 20. Juli 2027 einstellen wird. 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 die SIEM-Einstellungen > Profil auf.

3. Kopieren und speichern Sie die Kundennummer aus dem Bereich Organization Details (Organisationsdetails).

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

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. Warte, 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. Warte, 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-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 der neueste Release installiert. Wenn Sie eine vorhandene Installation aktualisieren, führen Sie ein Upgrade des Collectors durch, bevor Sie die Konfiguration ändern.

Bindplane-Agent 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/openam:
      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: OPENAM
      raw_log_field: body
  
  service:
    pipelines:
      logs/openam_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/openam
  

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 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 unter 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 creds_file_path auf den Pfad zur Datei für die Authentifizierung bei der 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/openam:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: OPENAM
      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. Logs auf Fehler prüfen:

     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-Handler für ForgeRock OpenAM konfigurieren

1. Melden Sie sich als Administrator in der AM-Konsole an (z. B. amAdmin).
2. Um den Event-Handler in der globalen Konfiguration zu erstellen, rufen Sie Konfigurieren > Globale Dienste > Audit-Logging auf.
   • Wenn Sie den Event Handler in einem Realm erstellen möchten, rufen Sie Realms > Realm-Name > Dienste > Audit-Logging auf.
3. Klicken Sie auf Sekundäre Konfiguration hinzufügen > Syslog.
4. Geben Sie die folgenden Konfigurationsdetails an:
   • Name: Geben Sie einen Namen für den Event Handler ein (z. B. Syslog Event Handler).
   • Hostname des Servers: Geben Sie die IP-Adresse des Bindplane-Agents ein.
   • Serverport: Geben Sie die Portnummer des Bindplane-Agents ein (z. B. 514 für UDP).
   • Transport Protocol: Wählen Sie UDP aus.
   • Zeitlimit für Verbindung: Geben Sie die Anzahl der Sekunden für die Verbindung ein (z. B. 120).
   • Optional: Aktivieren Sie die Option Zwischenspeichern.
5. Klicken Sie auf Erstellen.
6. Wählen Sie auf dem Tab Allgemeine Handler-Konfiguration die Option Aktiviert aus, um den Ereignishandler zu aktivieren.
7. Wählen Sie die Themen für Audit-Logs aus:
   • Zugriff
   • Aktivität
   • Authentifizierung
   • Konfiguration
8. Klicken Sie auf Speichern.
9. Geben Sie auf dem Tab Syslog-Konfiguration die folgenden Konfigurationsdetails an:
   • Hostname des Servers: Geben Sie die Bindplane-IP-Adresse ein.
   • Serverport: Geben Sie die Bindplane-Portnummer ein.
   • Zeitlimit für Verbindung: Geben Sie die Anzahl der Sekunden ein, die für die Verbindung verwendet werden sollen (z. B. 120).
   • Transport Protocol: Wählen Sie UDP aus.
   • Facility: Wählen Sie Local0 aus.
   • Bei allen Themen wird der Schweregrad auf INFORMATIONELL festgelegt.
10. Klicken Sie auf Speichern.
11. Wählen Sie auf dem Tab Pufferung die Option Pufferung aktiviert aus, um die Pufferung zu aktivieren.
12. Klicken Sie auf Speichern.

UDM-Zuordnungstabelle

Logfeld	UDM-Zuordnung	Logik
client.ip	principal.ip	Die IP-Adresse des Clients, der die Anfrage stellt.
client.ip	principal.asset.ip	Die IP-Adresse des Client-Assets, das die Anfrage stellt.
client.port	principal.port	Der Port, der vom Client verwendet wird, der die Anfrage stellt.
entries[0].info.authLevel	principal.resource.resource_subtype	Die mit dem Ereignis verknüpfte Authentifizierungsebene. Präfix „authLevel:“
entries[0].info.displayName	security_result.description	Ein beschreibender Name für den Knoten im Authentifizierungsbaum.
entries[0].info.ipAddress	principal.asset.ip	Die IP-Adresse, die dem Hauptkonto im Ereignis zugeordnet ist.
entries[0].info.ipAddress	principal.ip	Die IP-Adresse, die dem Hauptkonto im Ereignis zugeordnet ist.
entries[0].info.nodeId	principal.resource.id	Die eindeutige Kennung des Knotens im Authentifizierungsbaum. Präfix „nodeId:“
entries[0].info.nodeOutcome	principal.resource.attribute.labels.value	Das Ergebnis des Knotens im Authentifizierungsbaum.
entries[0].info.nodeType	principal.resource.type	Der Typ des Knotens im Authentifizierungsbaum. Präfix „nodeType:“.
entries[0].info.treeName	principal.resource.name	Der Name des Authentifizierungsbaums. Präfix „treeName:“
eventName	metadata.product_event_type	Der Rohereignisname aus den OpenAM-Protokollen.
http.request.headers.host[0]	target.asset.hostname	Der Hostname des Zielservers, der aus dem host-Header extrahiert wird.
http.request.headers.host[0]	target.hostname	Der Hostname des Zielservers, der aus dem host-Header extrahiert wurde.
http.request.headers.user-agent[0]	network.http.user_agent	Der User-Agent der HTTP-Anfrage.
http.request.method	network.http.method	Die in der Anfrage verwendete HTTP-Methode.
http.request.path	target.url	Der Pfad der HTTP-Anfrage-URL.
info.failureReason	security_result.summary	Der Grund für einen Authentifizierungsfehler. Hartcodiert auf „SSO“. Wird durch Logik basierend auf eventName und anderen Feldern bestimmt. Kann GENERIC_EVENT, USER_LOGIN, USER_LOGOUT, NETWORK_HTTP oder STATUS_UPDATE sein. Hartcodiert auf „OPENAM“. Fest codiert auf „OpenAM“. Hartcodiert auf „ForgeRock“.
principal	target.user.userid	Die am Ereignis beteiligte Nutzer-ID, die aus den Feldern userId, principal oder runAs extrahiert wurde.
result	security_result.action_details	Das Ergebnis des Ereignisses (z.B. „SUCCESSFUL“, „FAILED“).
response.detail.reason	security_result.summary	Der Grund für einen Fehler bei einem Zugriffsereignis.
response.status	security_result.action_details	Der Status der Antwort in einem Zugriffsereignis.
runAs	target.user.userid	Die User-ID, die am Ereignis beteiligt ist. Sie wird aus den Feldern userId, principal oder runAs extrahiert.
security_result.action	security_result.action	Die Aktion, die aufgrund des Sicherheitsereignisses ausgeführt wurde (z.B. „ALLOW“, „BLOCK“).
server.ip	target.asset.ip	Die IP-Adresse des Zielservers.
server.ip	target.ip	Die IP-Adresse des Zielservers.
server.port	target.port	Der Port des Zielservers.
timestamp	metadata.event_timestamp	Der Zeitstempel des Ereignisses.
trackingIds	metadata.product_log_id	Die mit dem Ereignis verknüpfte Tracking-ID.
transactionId	metadata.product_deployment_id	Die mit dem Ereignis verknüpfte Transaktions-ID.
userId	target.user.userid	Die am Ereignis beteiligte Nutzer-ID, die aus den Feldern userId, principal oder runAs extrahiert wurde.
userId	target.user.group_identifiers	Die mit dem Nutzer verknüpften Gruppenkennungen.
am_group	target.user.group_identifiers	Die mit dem Nutzer verknüpften Gruppenkennungen.
am_user	target.user.email_addresses	Die E-Mail-Adresse des Nutzers, falls im Feld am_user vorhanden.
loginID[0]	target.user.userid	Die im Ereignis verwendete Anmelde-ID.
loginID[0]	target.user.email_addresses	Die für die Anmeldung verwendete E‑Mail-Adresse, falls im Feld loginID vorhanden.
hostip	intermediary.hostname	Der Hostname eines Vermittlungsgeräts.
hostip	intermediary.ip	Die IP-Adresse eines Zwischengeräts.
src_ip	principal.asset.ip	Die Quell-IP-Adresse.
src_ip	principal.ip	Die Quell-IP-Adresse.
desc	metadata.description	Die Beschreibung des Ereignisses.
payload	metadata.description	Die Nutzlast des Ereignisses.
http.request.headers.host.0	tatget.hostname	Aus Änderungsprotokoll zugeordnet
http.request.headers.user-agent.0	network.http.user_agent	Aus Änderungsprotokoll zugeordnet
extensions.auth.type	SSO	Aus Änderungsprotokoll zugeordnet

Änderungsprotokoll

Änderungsprotokoll für diesen Parser ansehen

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