Collecter les journaux de pare-feu OPNsense

Compatible avec :

Google SecOps SIEM

Ce document explique comment ingérer les journaux de pare-feu OPNsense dans Google Security Operations à l'aide de l'agent Bindplane.

OPNsense est une plate-forme de pare-feu et de routage Open Source qui génère des messages syslog pour les correspondances de règles de pare-feu, les connexions réseau et les événements système. L'analyseur extrait les champs des messages filterlog au format CSV à l'aide de l'analyse grok et CSV, puis les mappe 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
• Connectivité réseau entre l'agent BindPlane et le pare-feu OPNsense
• 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 à l'interface Web OPNsense

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 SIEM > Profil.

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

   Remarque : Le numéro 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 être indiqué comme RUNNING (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 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/opnsense:
      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: OPNSENSE
      raw_log_field: body
  
  service:
    pipelines:
      logs/opnsense_to_chronicle:
        receivers:
          - udplog
        exporters:
          - chronicle/opnsense
  

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 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 indiqué 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 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/opnsense:
      compression: gzip
      creds_file_path: '/opt/observiq-otel-collector/ingestion-auth.json'
      customer_id: '<customer_id>'
      endpoint: malachiteingestion-pa.googleapis.com
      log_type: OPNSENSE
      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 sous 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. Recherchez 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"
       

Ajouter la configuration du serveur syslog à OPNsense

1. Connectez-vous à l'interface Web OPNsense.
2. Accédez à Système> Paramètres> Journalisation.
3. Dans la section Journalisation à distance, cochez la case Envoyer les journaux au serveur Syslog distant pour activer cette option.
4. Dans le champ Serveurs Syslog distants, saisissez l'adresse IP du serveur Syslog, y compris le port (par exemple, 10.10.10.10:514).
5. Sélectionnez Local0 comme fonctionnalité syslog.
6. Définissez le niveau de syslog sur Alerte.
7. Cliquez sur Enregistrer pour appliquer les modifications.

Table de mappage UDM

Champ de journal	Mappage UDM	Logique
column1	security_result.rule_id	Mappé directement à partir de column1.
column10	additional.fields[].key: "tos" additional.fields[].value.string_value: valeur de column10	Mappé directement à partir de column10, imbriqué sous additional.fields avec la clé "tos".
column12	additional.fields[].key: "ttl" additional.fields[].value.string_value: valeur de column12	Mappé directement à partir de column12, imbriqué sous additional.fields avec la clé "ttl".
column13	additional.fields[].key : "Id" additional.fields[].value.string_value : valeur de column13	Mappé directement à partir de column13, imbriqué sous additional.fields avec la clé "Id".
column14	additional.fields[].key : "offset" additional.fields[].value.string_value : valeur de column14	Mappé directement à partir de column14, imbriqué sous additional.fields avec la clé "offset".
column15	additional.fields[].key : "flags" additional.fields[].value.string_value : valeur de column15	Mappé directement à partir de column15, imbriqué sous additional.fields avec la clé "flags".
column17	network.ip_protocol	Mappé directement à partir de column17 après conversion en majuscules.
column18	network.received_bytes	Mappé directement à partir de column18 après conversion en entier non signé.
column19	principal.ip	Mappé directement à partir de column19.
column20	target.ip	Mappé directement à partir de column20.
column21	principal.port (si column17 est TCP ou UDP) additional.fields[].key : "data_length" additional.fields[].value.string_value : valeur extraite (si column17 est ICMP, GRE, ESP ou IGMP)	Si column17 est TCP/UDP, directement mappé à partir de column21 et converti en entier. Sinon, la valeur "datalength" est extraite à l'aide de grok et placée dans additional.fields avec la clé "data_length".
column22	target.port	Directement mappé à partir de column22 si column17 est TCP ou UDP, et converti en entier.
column24	additional.fields[].key: "tcp_flags" additional.fields[].value.string_value: valeur de column24	Mappé directement à partir de column24 si column17 est TCP, imbriqué sous additional.fields avec la clé "tcp_flags".
column29	additional.fields[].key : "tcp_options" additional.fields[].value.string_value : valeur de column29	Mappé directement à partir de column29 si column17 est TCP, imbriqué sous additional.fields avec la clé "tcp_options".
column4	additional.fields[].key : "tracker" additional.fields[].value.string_value : valeur de column4	Mappé directement à partir de column4, imbriqué sous additional.fields avec la clé "tracker".
column5	additional.fields[].key : "interface" additional.fields[].value.string_value : valeur de column5	Mappé directement à partir de column5, imbriqué sous additional.fields avec la clé "interface".
column6	security_result.rule_type	Mappé directement à partir de column6.
column7	security_result.action	Mappé à partir de column7. Si "block", converti en majuscules "BLOCK". Si la valeur est "pass", définissez-la sur "ALLOW".
column8	network.direction	Mappé à partir de column8. Si "in", définissez sur "INBOUND". Si "out", définissez sur "OUTBOUND".
domain	principal.administrative_domain	Mappé directement à partir de domain extrait par Grok. Définissez la valeur sur "NETWORK_CONNECTION" si les adresses IP principales et cibles sont présentes, sinon sur "GENERIC_EVENT". Codé en dur sur "OPNSENSE". Codé en dur sur "OPNSENSE".
message	Divers champs	Analyse à l'aide des filtres grok et csv pour extraire différents champs. Consultez les autres lignes pour connaître les mappages spécifiques.
ts	metadata.event_timestamp.seconds, timestamp.seconds	Analysé à partir du champ de message à l'aide de grok, puis converti en code temporel. La valeur en secondes est utilisée pour renseigner metadata.event_timestamp.seconds et timestamp.seconds.
application	principal.application	Mappé directement à partir de application extrait par Grok.
column27	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
column2	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
column3	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
column11	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
column26	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
column28	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
column25	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
column16	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications
column9	event.idm.read_only_udm.additional.fields	Mappé à partir du journal des modifications

Journal des modifications

Afficher le journal des modifications de ce parseur

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