Collecter les journaux ForgeRock OpenAM

Version de l'analyseur : 4.0

Compatible avec :

Ce document explique comment ingérer des journaux ForgeRock OpenAM dans Google Security Operations à l'aide de l'agent Bindplane.

ForgeRock OpenAM est une solution de gestion des accès qui génère des messages syslog pour les événements d'authentification, les décisions de contrôle des accès, l'activité des sessions et les modifications de configuration. L'analyseur extrait les champs des journaux d'audit au format JSON et les mappe sur le modèle de données unifié (UDM).

Avant de commencer

Assurez-vous de remplir les conditions suivantes :

  • Une instance Google SecOps
  • Windows Server 2016 ou version ultérieure, ou hôte Linux avec systemd
  • Connectivité réseau entre l'agent Bindplane et le serveur ForgeRock OpenAM
  • Si vous exécutez l'agent derrière un proxy, assurez-vous que les ports du pare-feu sont ouverts conformément aux exigences de l'agent BindPlane.
  • Accès administrateur à la console AM (par exemple, amAdmin)

Obtenir les identifiants Google SecOps pour l'agent Bindplane

Pour authentifier l'agent Bindplane auprès de Google SecOps, choisissez l'une des méthodes suivantes :

  • Nouveaux déploiements : utilisez l'API Chronicle (option 1).
  • Anciens déploiements : continuez à utiliser le fichier d'authentification d'ingestion (option 2) jusqu'à l'arrêt de l'API Ingestion le 20 juillet 2027.
  1. Connectez-vous à la consoleGoogle Cloud et sélectionnez le projet Google Cloud associé à votre instance Google SecOps.
  2. Accédez à IAM et administration > Comptes de service.
  3. Cliquez sur Créer un compte de service.
  4. Fournissez les informations de configuration suivantes :
    • Nom du compte de service : saisissez un nom pour le compte (par exemple, bindplane-ingest).
    • Description du compte de service : saisissez une description (par exemple, Bindplane agent log ingestion).
  5. Cliquez sur Créer et continuer.
  6. Dans la section Autoriser ce compte de service à accéder au projet, cliquez sur Sélectionner un rôle, puis sélectionnez Éditeur Chronicle.
  7. Cliquez sur Continue (Continuer), puis sur Done (OK).
  8. Cliquez sur le compte de service que vous avez créé, puis accédez à l'onglet Clés.
  9. Cliquez sur Ajouter une clé > Créer une clé.
  10. Sélectionnez JSON, puis cliquez sur Créer. Le fichier de clé est téléchargé sur votre ordinateur.
  11. Enregistrez le fichier de clé sous le nom ingestion-auth.json dans le répertoire du collecteur BindPlane (/opt/observiq-otel-collector/ingestion-auth.json sous Linux ou C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json sous Windows), ou mettez à jour creds_file_path dans config.yaml pour qu'il corresponde au chemin d'accès où vous l'enregistrez.
  12. Accédez à IAM et administration > Paramètres, puis copiez le numéro du projet. Vous en aurez besoin pour la configuration de l'exportateur.

Option 2 : Télécharger le fichier d'authentification d'ingestion (ancienne méthode)

  1. Connectez-vous à la console Google SecOps.
  2. Accédez à Paramètres SIEM> Agents de collecte.
  3. Téléchargez le fichier d'authentification d'ingestion.
  4. Enregistrez le fichier de manière sécurisée sur le système sur lequel l'agent Bindplane sera installé.

Obtenir l'ID client Google SecOps

  1. Connectez-vous à la console Google SecOps.
  2. Accédez à Paramètres SIEM > Profil.
  3. Copiez et enregistrez le numéro client dans la section Détails de l'organisation.

Installer l'agent Bindplane

Installez l'agent Bindplane sur votre système d'exploitation Windows ou Linux en suivant les instructions ci-dessous.

Installation de Windows

  1. Ouvrez l'invite de commande ou PowerShell en tant qu'administrateur.
  2. Exécutez la commande suivante :

    msiexec /i "https://github.com/observIQ/bindplane-agent/releases/latest/download/observiq-otel-collector.msi" /quiet
    
  3. Attendez que l'installation se termine.

  4. Vérifiez l'installation en exécutant la commande suivante :

    sc query observiq-otel-collector
    

    Le service doit s'afficher comme étant EN COURS D'EXÉCUTION.

Installation de Linux

  1. Ouvrez un terminal avec des droits d'accès racine ou sudo.
  2. Exécutez la commande suivante :

    sudo sh -c "$(curl -fsSlL https://github.com/observiq/bindplane-agent/releases/latest/download/install_unix.sh)" install_unix.sh
    
  3. Attendez que l'installation se termine.

  4. Vérifiez l'installation en exécutant la commande suivante :

    sudo systemctl status observiq-otel-collector
    

    Le service doit être indiqué comme actif (en cours d'exécution).

Ressources d'installation supplémentaires

Pour obtenir d'autres options d'installation et de dépannage, consultez le guide d'installation de l'agent Bindplane.

Configurer l'agent Bindplane pour ingérer les journaux Syslog et les envoyer à Google SecOps

Localiser le fichier de configuration

  • Linux :

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

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

Modifiez le fichier de configuration

  • Remplacez l'intégralité du contenu de config.yaml par la configuration suivante :

    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
    

Paramètres de configuration

Remplacez les espaces réservés suivants :

  • Configuration du récepteur :

    • listen_address : adresse IP et port à écouter :
      • 0.0.0.0 pour écouter sur toutes les interfaces (recommandé)
      • Le port 514 est le port syslog standard (nécessite un accès racine sous Linux ; utilisez 1514 pour un accès non racine).
  • Configuration de l'exportateur :

    • creds_file_path : chemin d'accès complet au fichier de clé JSON du compte de service (option 1) :
      • Linux : /opt/observiq-otel-collector/ingestion-auth.json
      • Windows : C:\Program Files\observIQ OpenTelemetry Collector\ingestion-auth.json
    • customer_id : ID client copié depuis la console Google SecOps
    • location : remplacez <LOCATION> par la région de votre instance Google SecOps (par exemple, us, europe ou asia-southeast1). L'exportateur ajoute cette valeur en préfixe à chronicle.googleapis.com. Pour obtenir la liste complète, consultez Points de terminaison régionaux.
    • project : remplacez <PROJECT_NUMBER> par le numéro de projet dans IAM et administration > Paramètres.
    • endpoint : laissez la valeur définie sur chronicle.googleapis.com.

Ancien exportateur d'API d'ingestion

  • Si vous utilisez le fichier d'authentification d'ingestion de l'option 2, remplacez le bloc exporters par le code suivant. Définissez creds_file_path sur le chemin d'accès au fichier d'authentification de l'ingestion. Si votre instance se trouve en dehors des États-Unis, remplacez malachiteingestion-pa.googleapis.com par votre point de terminaison régional (par exemple, 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
    

Enregistrez le fichier de configuration.

  • Après avoir modifié le fichier, enregistrez-le :
    • Linux : appuyez sur Ctrl+O, puis sur Enter, puis sur Ctrl+X.
    • Windows : cliquez sur Fichier > Enregistrer.

Redémarrez l'agent Bindplane pour appliquer les modifications.

  • Pour redémarrer l'agent BindPlane sous Linux, exécutez la commande suivante :

    sudo systemctl restart observiq-otel-collector
    
    1. Vérifiez que le service est en cours d'exécution :

      sudo systemctl status observiq-otel-collector
      
    2. Recherchez les erreurs dans les journaux :

      sudo journalctl -u observiq-otel-collector -f
      
  • Pour redémarrer l'agent Bindplane dans Windows, choisissez l'une des options suivantes :

    • Invite de commande ou PowerShell en tant qu'administrateur :

      net stop observiq-otel-collector && net start observiq-otel-collector
      
    • Console Services :

      1. Appuyez sur Win+R, saisissez services.msc, puis appuyez sur Entrée.
      2. Localisez observIQ OpenTelemetry Collector.
      3. Effectuez un clic droit, puis sélectionnez Redémarrer.
      4. Vérifiez que le service est en cours d'exécution :

        sc query observiq-otel-collector
        
      5. Recherchez les erreurs dans les journaux :

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

Configurer les gestionnaires syslog pour ForgeRock OpenAM

  1. Connectez-vous à la console AM en tant qu'administrateur (par exemple, amAdmin).
  2. Pour créer le gestionnaire d'événements dans la configuration globale, accédez à Configurer > Services globaux > Journalisation des audits.
    • Pour créer le gestionnaire d'événements dans un domaine, accédez à Domaines > Nom du domaine > Services > Journalisation des audits.
  3. Cliquez sur Ajouter une configuration secondaire > Syslog.
  4. Fournissez les informations de configuration suivantes :
    • Nom : saisissez un nom pour le gestionnaire d'événements (par exemple, Syslog Event Handler).
    • Nom d'hôte du serveur : saisissez l'adresse IP de l'agent Bindplane.
    • Port du serveur : saisissez le numéro de port de l'agent BindPlane (par exemple, 514 pour UDP).
    • Protocole de transport : sélectionnez UDP.
    • Délai avant expiration de la connexion : saisissez le nombre de secondes avant la connexion (par exemple, 120).
    • Facultatif : Activez l'option Mise en mémoire tampon.
  5. Cliquez sur Créer.
  6. Dans l'onglet General Handler Configuration (Configuration du gestionnaire général), sélectionnez Enabled (Activé) pour activer le gestionnaire d'événements.
  7. Sélectionnez les sujets des journaux d'audit :
    • Accès
    • Activité
    • Authentification
    • Configuration
  8. Cliquez sur Enregistrer.
  9. Dans l'onglet Configuration Syslog, fournissez les informations de configuration suivantes :
    • Nom d'hôte du serveur : saisissez l'adresse IP de BindPlane.
    • Port du serveur : saisissez le numéro de port Bindplane.
    • Délai avant expiration de la connexion : saisissez le nombre de secondes avant la connexion (par exemple, 120).
    • Protocole de transport : sélectionnez UDP.
    • Établissement : sélectionnez Local0.
    • Tous les sujets définissent la gravité sur INFORMATIONAL.
  10. Cliquez sur Enregistrer.
  11. Dans l'onglet Mise en mémoire tampon, sélectionnez Mise en mémoire tampon activée pour l'activer.
  12. Cliquez sur Enregistrer.

Table de mappage UDM

Champ du journal Mappage UDM Logique
client.ip principal.ip Adresse IP du client à l'origine de la requête.
client.ip principal.asset.ip Adresse IP de l'élément client à l'origine de la requête.
client.port principal.port Port utilisé par le client à l'origine de la requête.
entries[0].info.authLevel principal.resource.resource_subtype Niveau d'authentification associé à l'événement. Préfixé par "authLevel:".
entries[0].info.displayName security_result.description Nom descriptif du nœud dans l'arborescence d'authentification.
entries[0].info.ipAddress principal.asset.ip Adresse IP associée au compte principal dans l'événement.
entries[0].info.ipAddress principal.ip Adresse IP associée au compte principal dans l'événement.
entries[0].info.nodeId principal.resource.id Identifiant unique du nœud dans l'arborescence d'authentification. Préfixé par "nodeId:".
entries[0].info.nodeOutcome principal.resource.attribute.labels.value Résultat du nœud dans l'arbre d'authentification.
entries[0].info.nodeType principal.resource.type Type du nœud dans l'arborescence d'authentification. Préfixé par "nodeType:".
entries[0].info.treeName principal.resource.name Nom de l'arborescence d'authentification. Préfixé par "treeName:".
eventName metadata.product_event_type Nom de l'événement brut issu des journaux OpenAM.
http.request.headers.host[0] target.asset.hostname Nom d'hôte du serveur cible, extrait de l'en-tête host.
http.request.headers.host[0] target.hostname Nom d'hôte du serveur cible, extrait de l'en-tête host.
http.request.headers.user-agent[0] network.http.user_agent User-agent de la requête HTTP.
http.request.method network.http.method Méthode HTTP utilisée dans la requête.
http.request.path target.url Chemin d'URL de la requête HTTP.
info.failureReason security_result.summary Raison de l'échec de l'authentification. Codé en dur sur "SSO". Déterminé par une logique basée sur eventName et d'autres champs. Il peut s'agir de GENERIC_EVENT, USER_LOGIN, USER_LOGOUT, NETWORK_HTTP ou STATUS_UPDATE. Codé en dur sur "OPENAM". Codé en dur sur "OpenAM". Codé en dur sur "ForgeRock".
principal target.user.userid ID utilisateur impliqué dans l'événement, extrait des champs userId, principal ou runAs.
result security_result.action_details Résultat de l'événement (par exemple, "SUCCESSFUL", "FAILED").
response.detail.reason security_result.summary Raison de l'échec d'un événement de résultat d'accès.
response.status security_result.action_details État de la réponse dans un événement de résultat d'accès.
runAs target.user.userid ID utilisateur impliqué dans l'événement, extrait des champs userId, principal ou runAs.
security_result.action security_result.action Action effectuée à la suite de l'événement de sécurité (par exemple, "ALLOW", "BLOCK").
server.ip target.asset.ip Adresse IP du serveur cible.
server.ip target.ip Adresse IP du serveur cible.
server.port target.port Port du serveur cible.
timestamp metadata.event_timestamp Horodatage de l'événement.
trackingIds metadata.product_log_id ID de suivi associé à l'événement.
transactionId metadata.product_deployment_id ID de transaction associé à l'événement.
userId target.user.userid ID utilisateur impliqué dans l'événement, extrait des champs userId, principal ou runAs.
userId target.user.group_identifiers Identifiants de groupe associés à l'utilisateur.
am_group target.user.group_identifiers Identifiants de groupe associés à l'utilisateur.
am_user target.user.email_addresses Adresse e-mail de l'utilisateur, si elle est présente dans le champ am_user.
loginID[0] target.user.userid ID de connexion utilisé dans l'événement.
loginID[0] target.user.email_addresses L'adresse e-mail utilisée pour la connexion, si elle est présente dans le champ loginID.
hostip intermediary.hostname Nom d'hôte d'un appareil intermédiaire.
hostip intermediary.ip Adresse IP d'un appareil intermédiaire.
src_ip principal.asset.ip Adresse IP source.
src_ip principal.ip Adresse IP source.
desc metadata.description Description de l'événement.
payload metadata.description Charge utile de l'événement.
http.request.headers.host.0 tatget.hostname Mappé à partir du journal des modifications
http.request.headers.user-agent.0 network.http.user_agent Mappé à partir du journal des modifications
extensions.auth.type SSO Mappé à partir du journal des modifications

Journal des modifications

Afficher le journal des modifications de cet analyseur

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.