Collecter les journaux Ansible AWX

Version de l'analyseur : 1.0

Compatible avec :

Ce document explique comment ingérer des journaux Ansible AWX dans Google Security Operations à l'aide de Bindplane. Ansible AWX est une application Web Open Source qui fournit une interface utilisateur, une API REST et un moteur de tâches pour Ansible. Il permet aux équipes de gérer de manière centralisée les playbooks d'automatisation, les inventaires, les identifiants et les jobs planifiés dans l'ensemble de l'organisation. L'analyseur extrait les champs des journaux Ansible AWX au format JSON et mappe ces valeurs au 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.
  • Si vous exécutez l'agent derrière un proxy, assurez-vous que les ports de pare-feu sont ouverts conformément aux exigences de l'agent BindPlane.
  • Accès privilégié à la console de gestion Ansible AWX avec des autorisations d'administrateur.

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).
  • 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 configurer l'exportateur.

Option 2 : Télécharger le fichier d'authentification d'ingestion (ancien)

  1. Connectez-vous à la console Google SecOps.
  2. Accédez à Paramètres > Gestion des données > Agents de collecte. Si vous utilisez une plate-forme SIEM uniquement, accédez à Paramètres > 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 où l'agent BindPlane sera installé.

Obtenir le numéro client Google SecOps

  1. Connectez-vous à la console Google SecOps.
  2. Accédez à Paramètres > Administration > Profil. Si vous utilisez une plate-forme SIEM uniquement, accédez à Paramètres > Profil.
  3. Copiez et enregistrez le numéro client de 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
    

Installation sous 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
    

Ressources d'installation supplémentaires

Pour découvrir d'autres options d'installation, consultez ce guide d'installation.

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

  1. Accédez au fichier de configuration :

    • Trouvez le fichier config.yaml. Il se trouve généralement dans le répertoire /observiq-otel-collector/ sous Linux ou dans le répertoire d'installation sous Windows.
    • Ouvrez le fichier à l'aide d'un éditeur de texte (par exemple, nano, vi ou Notepad).
  2. Modifiez le fichier config.yaml comme suit :

    receivers:
      udplog:
        # Replace the port and IP address as required
        listen_address: "0.0.0.0:514"
    
    exporters:
      chronicle/ansible_awx:
        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
        # Adjust the path to the credentials file you downloaded in Step 1
        creds_file_path: '/path/to/ingestion-authentication-file.json'
        # Replace with your actual customer ID from Step 2
        customer_id: '<customer_id>'
        endpoint: chronicle.googleapis.com
        log_type: 'ANSIBLE_AWX'
        raw_log_field: body
    
    service:
      pipelines:
        logs/ansible_awx:
          receivers:
            - udplog
          exporters:
            - chronicle/ansible_awx
    
  • Remplacez le port et l'adresse IP selon les besoins de votre infrastructure.
  • 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.
  • Remplacez <PROJECT_NUMBER> par le numéro de projet indiqué dans IAM et administration > Paramètres.
  • Remplacez <customer_id> par le numéro client réel.
  • Remplacez /path/to/ingestion-authentication-file.json par le chemin d'accès au fichier de clé du compte de service (option 1) enregistré dans la section "Obtenir les identifiants Google SecOps pour l'agent BindPlane".

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 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/ansible_awx:
        compression: gzip
        # Adjust the path to the credentials file you downloaded in Step 1
        creds_file_path: '/path/to/ingestion-authentication-file.json'
        # Replace with your actual customer ID from Step 2
        customer_id: '<customer_id>'
        endpoint: malachiteingestion-pa.googleapis.com
        log_type: 'ANSIBLE_AWX'
        raw_log_field: body
    

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

Pour redémarrer l'agent BindPlane sous Linux :

  1. Exécutez la commande suivante :

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

    sudo systemctl status observiq-otel-collector
    
  3. Vérifiez les journaux pour détecter d'éventuelles erreurs :

    sudo journalctl -u observiq-otel-collector -f
    

Pour redémarrer l'agent BindPlane sous Windows :

  1. 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. Recherchez observIQ OpenTelemetry Collector.
      3. Effectuez un clic droit et sélectionnez Redémarrer.
  2. Vérifiez que le service est en cours d'exécution :

    sc query observiq-otel-collector
    
  3. Vérifiez les journaux pour détecter d'éventuelles erreurs :

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

Configurer la journalisation externe sur Ansible AWX

  1. Connectez-vous à l'interface Web Ansible AWX.
  2. Accédez à Paramètres dans la barre de navigation de gauche.
  3. Sélectionnez Paramètres de journalisation dans la section Système.
  4. Cliquez sur Modifier en bas de la page des paramètres de journalisation.
  5. Fournissez les informations de configuration suivantes :
    • Agrégateur de journaux : saisissez l'adresse IP de l'hôte de l'agent BindPlane (par exemple, 192.168.1.100).
    • Port de l'agrégateur de journaux : saisissez le numéro de port de l'agent Bindplane (par exemple, 514).
    • Type d'agrégateur de journaux : sélectionnez Autre dans le menu déroulant.
    • Nom d'utilisateur de l'agrégateur de journaux : laissez ce champ vide (non requis pour syslog).
    • Mot de passe/Jeton de l'agrégateur de journaux : laissez ce champ vide (non requis pour syslog).
    • Protocole de l'agrégateur de journaux : sélectionnez UDP.
    • Seuil de niveau de l'agrégateur de journalisation : sélectionnez INFO ou le niveau de journalisation de votre choix.
    • Activer la journalisation externe : activez cette option.
    • Loggers to Send Data to the Log Aggregator Form (Enregistreurs pour envoyer des données au formulaire de l'agrégateur de journaux) : sélectionnez les types de journaux pertinents :
      • awx : journaux de serveur génériques
      • activity_stream : enregistrement des modifications apportées aux objets AWX
      • job_events : données du module de rappel Ansible
      • system_tracking : faits système et données de configuration
    • Enregistrer les faits de suivi du système individuellement : désactivez cette option (par défaut).
  6. Cliquez sur Enregistrer pour appliquer les paramètres.
  7. Cliquez sur Tester pour vérifier la connexion à l'agent BindPlane.

Table de mappage UDM

Champ du journal Mappage UDM Logique
logger_name intermediary.application Mappage direct
RenderedMessage metadata.description Mappage direct
description metadata.description Mappage direct
event1 metadata.description Mappage direct
message metadata.description Mappage direct
timestamp metadata.event_timestamp Analysé en tant que yyyy-MM-ddTHH:mm:ss.SSSZ
principal_present metadata.event_type Mappé : true → STATUS_UPDATE
target_present metadata.event_type Mappé : true → NETWORK_CONNECTION
user_present metadata.event_type Mappé : true → USER_UNCATEGORIZED
event1_data.uuid metadata.product_log_id Mappage direct
Properties.Method network.http.method Mappage direct
agent.type observer.application Mappage direct
agent.id observer.asset_id Mappage direct
agent.type observer.asset_id Mappage direct
agent.hostname observer.hostname Mappage direct
ephemeral_id_label observer.labels Fusionné
agent.version observer.platform_version Mappage direct
agent.name observer.user.userid Mappage direct
Properties.applicationName principal.application Mappage direct
Properties.MachineName principal.asset.asset_id Mappage direct
Properties.Host principal.asset.hostname Mappage direct
event1_data.remote_addr principal.asset.hostname Mappage direct
principal_device principal.asset.hostname Mappage direct
principal_hostname principal.asset.hostname Mappage direct
Properties.ClientIP principal.asset.ip Fusionné
ip_address principal.asset.ip Fusionné
principal_ip principal.asset.ip Fusionné
src_ip principal.asset.ip Fusionné
Properties.Host principal.hostname Mappage direct
event1_data.remote_addr principal.hostname Mappage direct
principal_device principal.hostname Mappage direct
principal_hostname principal.hostname Mappage direct
Properties.ClientIP principal.ip Fusionné
ip_address principal.ip Fusionné
principal_ip principal.ip Fusionné
src_ip principal.ip Fusionné
src_port principal.port Mappage direct
event1_data.task_path principal.process.file.full_path Mappage direct
process_pid principal.process.pid Mappage direct
availability_zone principal.resource.attribute.labels Fusionné
connectionid_label principal.resource.attribute.labels Fusionné
endpointname_label principal.resource.attribute.labels Fusionné
machine_type principal.resource.attribute.labels Fusionné
provider principal.resource.attribute.labels Fusionné
cloud.instance.name principal.resource.name Mappage direct
cloud.instance.id principal.resource.product_object_id Mappage direct
Properties.UserName principal.user.userid Mappage direct
user_name principal.user.userid Mappage direct
event1_display security_result.description Mappage direct
ca_id_label security_result.detection_fields Fusionné
cf_component_label security_result.detection_fields Fusionné
container_hash_label security_result.detection_fields Fusionné
container_image_label security_result.detection_fields Fusionné
container_name_label security_result.detection_fields Fusionné
messagetemplate_label security_result.detection_fields Fusionné
parent_uuid_label security_result.detection_fields Fusionné
requestid_label security_result.detection_fields Fusionné
requestpath_label security_result.detection_fields Fusionné
serviceNowId_label security_result.detection_fields Fusionné
sourcecontext_label security_result.detection_fields Fusionné
stream_label security_result.detection_fields Fusionné
task_label security_result.detection_fields Fusionné
task_uuid_label security_result.detection_fields Fusionné
threadid_label security_result.detection_fields Fusionné
wf_env_label security_result.detection_fields Fusionné
wf_id_label security_result.detection_fields Fusionné
level security_result.severity Mappé : "DEBUG", "INFO", "AUDIT" → INFORMATIONAL, WARNING → MEDIUM
level security_result.severity_details Mappage direct
log security_result.summary Mappage direct
host.fqdn target.administrative_domain Mappage direct
host.id target.asset.asset_id Mappage direct
codename_label target.asset.attribute.labels Fusionné
json_data target.asset.attribute.labels Mappé : host.*os.*platform → codename_label, host.*os.*platform → os_name_label
os_name_label target.asset.attribute.labels Fusionné
hardware target.asset.hardware Fusionné
json_data target.asset.hardware Mappé : host.*os.*platform → hardware
host.hostname target.asset.hostname Mappage direct
kubernetes.host target.asset.hostname Mappage direct
target_device target.asset.hostname Mappage direct
ips target.asset.ip Fusionné
json_data target.asset.ip Mappé : host.*os.*platform → ips
target_ip target.asset.ip Fusionné
kubernetes.docker_id target.asset_id Mappage direct
host.hostname target.hostname Mappage direct
kubernetes.host target.hostname Mappage direct
target_device target.hostname Mappage direct
target_ip target.ip Fusionné
json_data target.mac Mappé : host.*os.*platform → macs
macs target.mac Fusionné
kubernetes.namespace_name target.namespace Mappage direct
json_data target.platform Mappé : host.*os.*platform → LINUX
host.os.kernel target.platform_patch_level Mappage direct
host.os.version target.platform_version Mappage direct
io_instance_label target.resource.attribute.labels Fusionné
io_name_label target.resource.attribute.labels Fusionné
pod_id_label target.resource.attribute.labels Fusionné
pod_template_hash_label target.resource.attribute.labels Fusionné
cluster_name target.resource.name Mappage direct
N/A metadata.event_type Constante : NETWORK_CONNECTION
N/A metadata.product_name Constante : ANSIBLE_AWX
N/A metadata.vendor_name Constante : ANSIBLE_AWX
N/A network.ip_protocol Constante : TCP
N/A principal.resource.resource_type Constante : VIRTUAL_MACHINE
N/A security_result.severity Constante : INFORMATIONAL
N/A target.platform Constante : LINUX

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.