Collecter les journaux VMware vSphere

Compatible avec :

Google SecOps SIEM

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

VMware vSphere est une plate-forme de virtualisation qui génère des messages syslog pour les événements d'hôte ESXi, les opérations de VM, l'authentification et la surveillance de l'état du système.

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 l'hôte VMware vSphere ESXi
• 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 privilégié au client Web VMware vSphere ou à ESXi Shell

Obtenir des 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).
• Déploiements existants : continuez à utiliser le fichier d'authentification pour l'ingestion (option 2) jusqu'à l'arrêt de l'API Ingestion le 20 juillet 2027.

Option 1 : Créer un compte de service pour l'API Chronicle (recommandé)

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.

Remarque : La clé JSON est un identifiant. Limitez l'accès au fichier sur l'hôte BindPlane et effectuez une rotation de la clé conformément aux règles de votre organisation.

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é.

Remarque : Ce fichier authentifie l'agent auprès de l'ancienne API Ingestion (malachiteingestion-pa.googleapis.com), dont Google a prévu la fin de vie le 20 juillet 2027. Prévoyez de passer à l'option 1 avant cette date.

Obtenir l'ID client Google SecOps

1. Connectez-vous à la console Google SecOps.
2. Accédez à Paramètres du SIEM > Profil.

3. Copiez et enregistrez le numéro client dans la section Informations sur l'organisation.

   Remarque : L'ID client est requis pour configurer l'exportateur de l'agent Bindplane.

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 s'afficher comme actif (en cours d'exécution).

Ressources d'installation supplémentaires

Pour en savoir plus sur les options d'installation et le dépannage, consultez le guide d'installation de l'agent Bindplane.

Remarque : La configuration de l'exportateur de l'API Chronicle nécessite la version 1.106.0 ou ultérieure du collecteur Bindplane. Les commandes précédentes installent la dernière version. Si vous mettez à jour une installation existante, mettez à niveau le collecteur avant de modifier la configuration.

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/vmware_vsphere:
      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: VMWARE_VSPHERE
      raw_log_field: body
  
  service:
    pipelines:
      logs/vmware_vsphere_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/vmware_vsphere
  

Paramètres de configuration

Remplacez les espaces réservés suivants :

• Configuration du récepteur :

  • listen_address : adresse IP et port d'écoute :
    • 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 préfixe chronicle.googleapis.com avec cette valeur. 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 ce qui suit. Définissez creds_file_path sur le chemin d'accès au fichier d'authentification d'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/vmware_vsphere:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: VMWARE_VSPHERE
      raw_log_field: body
  

Remarque : Cet exportateur cessera de fonctionner lorsque l'API Ingestion sera abandonnée le 20 juillet 2027.

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 et 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 syslog dans VMware vSphere

Option 1 : client Web vSphere

1. Connectez-vous au client Web vSphere.
2. Sélectionnez l'hôte ESXi.
3. Accédez à Configurer > Système > Paramètres système avancés.
4. Cliquez sur Modifier.
5. Définissez le paramètre Syslog.global.logHost sur udp://<bindplane-ip>:514 (remplacez <bindplane-ip> par l'adresse IP de votre agent BindPlane).
6. Cliquez sur OK.

Option 2 : ESXi Shell

1. Connectez-vous en SSH à l'hôte ESXi.

2. Exécutez les commandes suivantes :

   esxcli system syslog config set --loghost=udp://<bindplane-ip>:514
   esxcli system syslog reload
   

   • Remplacez <bindplane-ip> par l'adresse IP de votre agent BindPlane.

Table de mappage UDM

Champ du journal	Mappage UDM	Logique
Originator_label	additional.fields	Fusionné
activityType_label	additional.fields	Fusionné
certVerificationStatus_label	additional.fields	Fusionné
cls_simple_activity_label	additional.fields	Fusionné
itemType_label	additional.fields	Fusionné
logtype_label	additional.fields	Fusionné
opID_label	additional.fields	Fusionné
progress_label	additional.fields	Fusionné
securityCompliance_label	additional.fields	Fusionné
sub_label	additional.fields	Fusionné
vpxd_label	additional.fields	Fusionné
column9	extensions.auth.type	Mappé : logged out → AUTHTYPE_UNSPECIFIED
column9	metadata.description	Mappé directement
msg	metadata.description	Mappage direct
response_Message	metadata.description	Mappage direct
column3	metadata.event_timestamp	Analysé en tant que ISO8601
column9	metadata.event_type	Mappé : logged out → USER_LOGOUT
has_principal	metadata.event_type	Mapped: true → NETWOK_CONNECTION, true → STATUS_UPDATE
column4	metadata.product_event_type	Mappage direct
column1	metadata.product_log_id	Mappage direct
uuid	metadata.product_log_id	Mappage direct
user_agent	network.http.parsed_user_agent	Renommé/Mappé
user_agent	network.http.user_agent	Mappage direct
sessionId	network.session_id	Mappage direct
Hostname	principal.asset.hostname	Mappage direct
hostname	principal.asset.hostname	Mappage direct
srcip	principal.asset.ip	Fusionné
Hostname	principal.hostname	Mappage direct
hostname	principal.hostname	Mappage direct
srcip	principal.ip	Fusionné
column5	security_result.severity	Mappé : INFO → INFORMATIONAL
severity	security_result.severity_details	Mappé directement
pid	target.process.pid	Mappage direct
column7	target.resource.name	Mappage direct
column6	target.user.userid	Mappage direct
N/A	extensions.auth.type	Constante : AUTHTYPE_UNSPECIFIED
N/A	metadata.event_type	Constante : NETWOK_CONNECTION
N/A	metadata.product_name	Constante : VMWARE_VSPHERE
N/A	metadata.vendor_name	Constante : VMWARE_VSPHERE
N/A	security_result.severity	Constante : INFORMATIONAL
timestamp	event.idm.read_only_udm.metadata.event_timestamp	Mappé à partir du journal des modifications
file_path	event.idm.read_only_udm.target.process.file.full_path	Mappé à partir du journal des modifications
api_invocations	event.idm.read_only_udm.security_result.detection_fields	Mappé à partir du journal des modifications
column2	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
login time	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
syslog_priority	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
user_level	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
session_id	event.idm.read_only_udm.network.session_id	Mappé à partir du journal des modifications
uuid	event.idm.read_only_udm.metadata.product_log_id	Mappé à partir du journal des modifications
Hostname	event.idm.read_only_udm.principal.hostname	Mappé à partir du journal des modifications
Hostname	event.idm.read_only_udm.principal.asset.hostname	Mappé à partir du journal des modifications
msg	event.idm.read_only_udm.metadata.description	Mappé à partir du journal des modifications
Originator	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
sub	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
opID	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
progress	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
cls_simple_activity	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
certVerificationStatus	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
itemType	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
vpxd	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
securityCompliance	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
logtype	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
severity	event.idm.read_only_udm.security_result.severity_details	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.