Gestion des traps SNMP

Contexte

Simple Network Management Protocol  (abrégé SNMP ), est un protocole de communication qui permet aux administrateurs réseau de gérer les équipements du réseau, de superviser et de diagnostiquer des problèmes réseaux et matériels à distance.

Une requête SNMP est un datagramme UDP envoyé par le manager à destination du port 161 de l'agent. L'agent répond alors au manager avec la valeur demandée.

Les traps SNMP sont émises depuis les agents SNMP vers une destination ( un serveur de supervision par exemple ), qui récupérera ces requêtes. Pour les comprendre, ce serveur devra disposer de bases de données avec l'ensemble des informations ( OID et Descripteurs ) des constructeurs, ces bases sont appelées MIB. Les valeurs pourront alors être interprétées par le serveur de supervision. Ce procédé est souvent utilisé dans les routeurs pour, par exemple, avertir qu’un lien vient de tomber sur l’une de ses interfaces. L’intérêt des traps SNMP est donc d'envoyer des « alertes » dès qu’une panne apparaît sans attendre que le serveur de supervision le détecte de lui-même pendant une vérification dans le cadre d’un monitoring actif.

Pour récupérer et interpréter ces traps dans Shinken, il existe deux moyens, via le module receiver-module-webservice, ou via le module Named Pipe ( aussi utilisé de manière historique dans Nagios avec le fichier nagios.cmd, utilisable via un fichier shinken.cmd ).

Recevoir des Statuts au Format Shinken de l'extérieur

Recevoir des statuts de l’extérieur se fait par l'intermédiaire du Receiver. Il faut accrocher l'un des 2 modules suivants sur le Receiver :

• receiver-module-webservice ( réception des statuts via une API REST ) :
  
  • Permet de recevoir les statuts de n'importe quel outil de transformation de trap SNMP situé n'importe où.
  • Mise en place du module ( voir la page Module receiver-module-webservice).
  • Mise en place d'un script qui interprète les traps ( voir la page Script d'interprétation des traps avec le module receiver-module-webservice ).

• named-pipe ( réception via un fichier "passe plat" FIFO (shinken.cmd) ) :
  
  • Son mode de fonctionnement impose que les outils de réception des traps soient sur l'ordinateur hébergeant le Receiver.
  • Mise en place du module ( voir la page Module named-pipe ).
  • Mise en place d'un script qui interprète les traps, ( voir la page Script d'interprétation des traps avec le module named-pipe ).

Réception des TRAPS SNMP

Pour traiter les traps SNMP venant des équipements à superviser, il faut un serveur SNMP capable de capturer les traps, ainsi que traducteur de trap vers Shinken

Installation

Mise en place des démons SNMPD et SNMPTRAPD

RHEL / CentOS 7 ou RHEL / Alma / Rocky 8 ou RHEL / Alma / Rocky 9

Voici les étapes à suivre :

• Installation des paquets et dépendances :
  
  

yum install net-snmp net-snmp-utils net-snmp-perl perl-Sys-Syslog

Pour activer les services SNMP au démarrage du serveur, il faut exécuter la commande suivante :
 

chkconfig --level 3 snmpd on
chkconfig --level 3 snmptrapd on

Démarrer les services snmpd et snmptrapd :

service snmpd start
service snmptrapd start

Debian 13

Pour installer les démons, exécuter la commande suivante :

apt install snmpd snmptrapd

Optionnellement, il est possible d'installer les MIBs sur le serveur, afin de diagnostiquer plus rapidement des problèmes SNMP, par exemple. Ce n'est pas obligatoire sur le serveur à superviser.

apt install snmp-mibs-downloader

Puis configurer les applications SNMP pour utiliser ces MIBs en commentant la ligne "mibs:" dans le fichier /etc/snmp/snmp.conf

#mibs :

Test des flux SNMP

Sur le serveur pour vérifier la bonne communication SNMP, utiliser la commande :

snmpwalk -v 1 -c public -O e 127.0.0.1

La commande doit retourner une réponse de la même forme que celle-ci :

SNMPv2-MIB::sysDescr.0 = STRING: Linux Shinken 2.6.32-504.16.2.el6.x86_64 #1 SMP Wed Apr 22 06:48:29 UTC 2015 x86_64
SNMPv2-MIB::sysObjectID.0 = OID: NET-SNMP-MIB::netSnmpAgentOIDs.10
DISMAN-EVENT-MIB::sysUpTimeInstance = Timeticks: (31359) 0:05:13.59
SNMPv2-MIB::sysContact.0 = STRING: Root <root@localhost> (configure /etc/snmp/snmp.local.conf)
SNMPv2-MIB::sysName.0 = STRING: shinken
SNMPv2-MIB::sysLocation.0 = STRING: Unknown (edit /etc/snmp/snmpd.conf)
SNMPv2-MIB::sysORLastChange.0 = Timeticks: (64) 0:00:00.64
SNMPv2-MIB::sysORID.1 = OID: SNMP-MPD-MIB::snmpMPDMIBObjects.3.1.1
SNMPv2-MIB::sysORID.2 = OID: SNMP-USER-BASED-SM-MIB::usmMIBCompliance
SNMPv2-MIB::sysORID.3 = OID: SNMP-FRAMEWORK-MIB::snmpFrameworkMIBCompliance
SNMPv2-MIB::sysORID.4 = OID: SNMPv2-MIB::snmpMIB
SNMPv2-MIB::sysORID.5 = OID: TCP-MIB::tcpMIB
SNMPv2-MIB::sysORID.6 = OID: IP-MIB::ip
SNMPv2-MIB::sysORID.7 = OID: UDP-MIB::udpMIB
SNMPv2-MIB::sysORID.8 = OID: SNMP-VIEW-BASED-ACM-MIB::vacmBasicGroup
(...)

Mise en place de SNMPTT

RHEL / CentOS 7 ou RHEL / Alma / Rocky 8 ou RHEL / Alma / Rocky 9

• Le téléchargement du programme se fait directement avec yum :

yum install snmptt

Debian 13

• L'installation du programme se fait directement avec apt :

apt install snmptt libnet-ip-perl

• Pour autoriser snmtrapd à écrire des données pour snmptt, modifier les droits et le groupe du dossier /var/spool/snmptt/

chown :Debian-snmp /var/spool/snmptt/
chmod g+w /var/spool/snmptt/

Configuration

• Mettre en commentaire le paramètre daemon_uid du fichier /etc/snmp/snmptt.ini :

#daemon_uid = snmptt

Pour interpréter les traps et envoyer des statuts à Shinken :

• Éditer le fichier de configuration /etc/snmp/snmptt.ini :
  • Activer le niveau de log debug afin de voir les traps reçues mais non interprétées. S'il y a une erreur dans la configuration, les traps non interprétées seront écrites dans le fichier : /var/log/snmptt/snmpttunknown.log :

unknown_trap_log_enable = 1

• • Activer le module Perl net-snmp permettant l'interprétation des OIDs : 

net_snmp_perl_enable = 1

• Ajouter ensuite les lignes suivantes à la fin du fichier /etc/snmp/snmptrapd.conf :

disableAuthorization yes
traphandle default /usr/sbin/snmptthandler 

• • Ce qui signifie :
    • disableAuthorization : on accepte toutes les interruptions ( traps ),
    • traphandle default /usr/sbin/snmptthandler : les traps sont transmises au démon snmptt.

• Si SELinux est actif, pour avoir le droit d'exécuter un script à la réception d'une trap SNMP, il faut ajouter une permission à SNMP dans SELinux :
  
  

semanage permissive -a snmpd_t

• Relancer les deux services pour prendre en compte les modifications :
  
  

service snmptrapd restart
service snmptt restart

Compilation de MIB

SNMPTT a besoin de compiler les MIBs du format TXT vers un fichier de configuration. Cette compilation effectue l’association OID/action à effectuer ( information inscrite dans le fichier MIB ).

• Les MIBs se trouvent par défaut dans le dossier /usr/share/snmp/mibs/.
• Pour travailler avec une MIB particulière ( routeur CISCO ou autre équipement ), il faudra l’importer sur le système afin de la compiler.

Pour chaque MIB, il faut compiler à l'aide d'une des syntaxes suivantes :

• Cette syntaxe permet simplement de compiler une seule MIB :

snmpttconvertmib --in=<fichier MIB> \
--out=/etc/snmp/snmptt.conf.<equipement> \
--exec='/var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2'

• Cette syntaxe permet de compiler toutes les MIBs d'un répertoire :

for i in *; do snmpttconvertmib --in=$i --out=snmptt.conf.test --exec='/var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2'; done

• Il est aussi possible de reprendre cette syntaxe, et mettre par exemple CISCO juste devant l'étoile, comme ceci :

for i in CISCO*; do snmpttconvertmib --in=$i --out=snmptt.conf.test --exec='/var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2'; done

Ici, toutes les MIBs du répertoire courant dont le nom commence par CISCO seront compilées.

Problème récurrent

Attention, lors de la compilation de la MIB, un problème similaire à celui-ci peut survenir :

$ snmpttconvertmib --in=/usr/share/snmp/mibs/CISCO-OSCP-MIB.mib --out=/etc/snmp/test.txt --exec='/var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2'
exec: /var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2


*****  Processing MIB file *****

snmptranslate version: NET-SNMP version: 5.7.2
severity: Normal

File to load is:        /usr/share/snmp/mibs/CISCO-OSCP-MIB.mib
File to APPEND TO:      /etc/snmp/test.txt

MIBS environment var:   /usr/share/snmp/mibs/CISCO-OSCP-MIB.mib
mib name: CISCO-OSCP-MIB


Processing MIB:         CISCO-OSCP-MIB
#
skipping a TRAP-TYPE / NOTIFICATION-TYPE line - probably an import line.
#
Line: 677
NOTIFICATION-TYPE: coscpNotifyTransDown
Variables: coscpLinkTransDown
Enterprise: ciscoOscpNotificationsPrefix
Looking up via snmptranslate: CISCO-OSCP-MIB::coscpNotifyTransDown
MIB search path: /root/.snmp/mibs:/usr/share/snmp/mibs
Cannot find module (CISCO-SMI): At line 31 in /usr/share/snmp/mibs/CISCO-OSCP-MIB.mib
Did not find 'ciscoMgmt' in module #-1 (/usr/share/snmp/mibs/CISCO-OSCP-MIB.mib)
Unlinked OID in CISCO-OSCP-MIB: ciscoOscpMIB ::= { ciscoMgmt 202 }
Undefined identifier: ciscoMgmt near line 34 of /usr/share/snmp/mibs/CISCO-OSCP-MIB.mib
Cannot adopt OID in CISCO-OSCP-MIB: ciscoOscpMIBGroups ::= { ciscoOscpMIBConformance 2 }

Pour résoudre le problème, il faut regarder la ligne suivante : 

Cannot find module (CISCO-SMI): At line 31 in /usr/share/snmp/mibs/CISCO-OSCP-MIB.mib

On comprend donc que snmpttconvertmib n'a pas accès au module CISCO-SMI.

La raison de ce problème est que la MIB à compiler à des dépendances.

On peut les identifier dans le fichier même de la MIB, en recherchant un bloc comme celui-ci, au début du fichier :

IMPORTS
        MODULE-IDENTITY,
        OBJECT-TYPE,
        NOTIFICATION-TYPE,
        Counter32,
        Gauge32,
        Unsigned32
                                                    FROM SNMPv2-SMI
        TEXTUAL-CONVENTION,
        TruthValue,
        RowStatus
                                                    FROM SNMPv2-TC
        InterfaceIndex
                                                    FROM IF-MIB
        MODULE-COMPLIANCE,
        OBJECT-GROUP,
        NOTIFICATION-GROUP
                                                    FROM SNMPv2-CONF
        ciscoMgmt
                                                    FROM CISCO-SMI
        ;

Il indique toutes les dépendances nécessaires pour compiler la MIB. 

Dans cet exemple, on remarque donc que les MIBs nécessaires pour la compiler sont :

• SNMPv2-SMI,
• SNMPv2-TC,
• IF-MIB,
• SNMPv2-CONF,
• CISCO-SMI.

Et CISCO-SMI est aussi le module indiqué dans le message d'erreur.

Pour régler le problème, il faut télécharger la MIB manquante. On peut par exemple se diriger sur ce site : http://www.circitor.fr/Mibs/Mibs.php qui répertorie une large variété de MIBs différentes.

Une fois la MIB téléchargée, il suffit de la mettre dans le dossier /usr/share/snmp/mibs du serveur de supervision, avec la MIB à compiler.

Relancer la commande de compilation de la MIB, qui donnera un message de retour ressemblant à celui-ci :

$ snmpttconvertmib --in=/usr/share/snmp/mibs/CISCO-OSCP-MIB.mib --out=/etc/snmp/test.txt --exec='/var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2'
exec: /var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2


*****  Processing MIB file *****

snmptranslate version: NET-SNMP version: 5.7.2
severity: Normal

File to load is:        /usr/share/snmp/mibs/CISCO-OSCP-MIB.mib
File to APPEND TO:      /etc/snmp/test.txt

MIBS environment var:   /usr/share/snmp/mibs/CISCO-OSCP-MIB.mib
mib name: CISCO-OSCP-MIB


Processing MIB:         CISCO-OSCP-MIB
#
skipping a TRAP-TYPE / NOTIFICATION-TYPE line - probably an import line.
#
Line: 677
NOTIFICATION-TYPE: coscpNotifyTransDown
Variables: coscpLinkTransDown
Enterprise: ciscoOscpNotificationsPrefix
Looking up via snmptranslate: CISCO-OSCP-MIB::coscpNotifyTransDown
OID: .1.3.6.1.4.1.9.9.202.2.0.1

Résumé du fonctionnement

Il ne reste plus qu'à importer les MIBs et faire la liaison avec Shinken de la même façon que dans l'exemple.

Pour résumer, la chaîne est la suivante suivante :

Vérifier le bon fonctionnement ( Test avec une MIB factice )

Création d'un check passif

Dans l’Interface de Configuration, il faut créer le check à associer à un hôte, en passif, non actif et volatil, afin de recevoir une notification dès un changement d'état. Le seuil d'expiration des états reçus des outils externes ( freshness_threshold ) doit également être paramétré.

Voici un exemple avec la syntaxe d'un fichier de configuration, modèle de check dédié au modèle d'hôte "TRAP-modele" :

define service{
        service_description     TRAP
        check_command           check-host-alive
        host_name               TRAP-modele
		is_volatile             1
        passive_checks_enabled  1
		active_checks_enabled  	0
		check_freshness			1
		freshness_threshold		300
        register                0
        check_interval      	1
        retry_interval      	1
}
 
define host{
        name    				TRAP-modele
        register        		0
}

Appliquer le modèle d'hôte "TRAP-modele" à un hôte accessible sur le réseau (le paramètre "adresse" doit être rempli), par exemple un hôte "test-trap".

Envoi d'un trap via une MIB factice

Créer une MIB factice pour pouvoir tester toute la chaîne depuis la capture du trap jusqu’au traitement par Shinken :

• Créer la MIB dans le fichier /usr/share/snmp/mibs/UCD-TRAP-TEST-MIB avec le contenu suivant :
  
  

UCD-TRAP-TEST-MIB DEFINITIONS ::= BEGIN
      IMPORTS ucdExperimental FROM UCD-SNMP-MIB;
 
demotraps OBJECT IDENTIFIER ::= { ucdExperimental 990 }
 
demoTrap TRAP-TYPE
      ENTERPRISE demotraps
      VARIABLES { sysLocation }
      DESCRIPTION "It's a trap !"
      ::= 17
 
END

• Exporter cette MIB :
  
  

export MIBS=+/usr/share/snmp/mibs/UCD-TRAP-TEST-MIB

• Compiler en précisant la commande submit_check_result_to_receiver, c’est ici que se fait la jonction avec Shinken :
  
  

snmpttconvertmib --in=/usr/share/snmp/mibs/UCD-TRAP-TEST-MIB \
--out=/etc/snmp/snmptt.conf.test \
--exec='/var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2'

• Cela va générer un fichier de cette forme :
  
  

MIB: UCD-TRAP-TEST-MIB (file:/usr/share/snmp/mibs/UCD-TRAP-TEST-MIB) converted on Tue Jan 31 15:03:39 2023 using snmpttconvertmib v1.4.2
#
#
#
EVENT demoTrap .1.3.6.1.4.1.2021.13.990.0.17 "Status Events" Normal
FORMAT It's a trap ! $*
EXEC /var/lib/shinken-user/libexec/submit_check_result_to_receiver $r TRAP 2 "It's a trap ! $*"
SDESC
It's a trap !
Variables:
  1: sysLocation
EDESC

• $r correspond au nom de l'hôte à qui la trap est envoyée.
• $* correspond à la variable textuelle définie lors de l'envoi de la trap ( "It's a trap" plus bas dans l'exemple ).
• Prendre en compte ce fichier dans la configuration globale de SNMPTT  ( ajouter le fichier généré snmptt.conf.test à la fin du fichier /etc/snmp/snmptt.ini ) :
  
  

snmptt_conf_files = <<END
/etc/snmp/snmptt.conf
/etc/snmp/snmptt.conf.test
END

• Relancer les services :
  
  

service snmptt restart
service snmpd restart
service snmptrapd restart

• Modifier le fichier /etc/snmp/snmptt.conf.test :
  
  

EVENT demo-trap .1.3.6.1.4.1.2021.13.990.0.17 "Status Events" Normal
FORMAT Trap received ! $*
EXEC /var/lib/shinken-user/libexec/submit_check_result_to_receiver $1 TRAP 2 "Trap received ! $2 $1"
SDESC
Trap received !
Variables:
  1: sysLocation
EDESC

• Lancer une trap de test manuellement :
  
  

snmptrap -v 1 -c public 127.0.0.1 UCD-TRAP-TEST-MIB::demotraps localhost 6 17 '' SNMPv2-MIB::sysLocation.0 s "NOM-DE-L'HÔTE" SNMPv2-MIB::sysLocation.0 s "It's a trap"

• Cette trap ne sera pas envoyée sur le serveur Shinken mais sur l'hôte désiré

Le fichier de logs /var/log/snmptt/snmptt.log  permettra de vérifier que la trap a bien été reçue :

Thu Mar 18 16:57:38 2021 .1.3.6.1.4.1.2021.13.990.0.17 Normal "Status Events" localhost - Trap received ! It's a trap

Ou encore dans le fichier /var/log/messages ou la sortie de la commande journalctl --no-pager | grep snmp :

Mar 18 16:57:38 shinken281 snmptrapd[6539]: 2021-03-18 16:57:38 localhost [127.0.0.1] (via UDP: [127.0.0.1]:52791->[127.0.0.1]:162) TRAP, SNMP v1, community public#012#011UCD-SNMP-MIB::ucdEx
perimental.990 Enterprise Specific Trap (17) Uptime: 6:54:17.07#012#011SNMPv2-MIB::sysLocation.0 = STRING: It's a trap
Mar 18 16:57:38 shinken281 snmptt[17098]: .1.3.6.1.4.1.2021.13.990.0.17 Normal "Status Events" localhost - Trap received ! It's a trap

• Le check associé à l'hôte défini plus haut passe en critique, ce qui permet de confirmer que la trap fonctionne.