Distribution EOLE

{{toc}}

h1. Gestion des journaux

Les objectifs fondamentaux de la journalisation sont les suivants :

* conserver l'information en vue d'établir des diagnostics de panne,

* conserver l'information en vue de statistiques d'utilisation,

* conserver l'information par contrainte légale.

Les écueils à éviter sont les suivants :

* saturation de la partition stockant les journaux,

* compromission des informations des journaux par application de droits d'accès inadaptés.

Ces objectifs et écueils guident la politique de journalisation à mettre en œuvre. Les contraintes les plus fortes sont l'obligation légale de conserver l'information et le risque de saturation du support de stockage. Les journaux, ou partie de journaux, concernés par l'obligation légale doivent être traités prioritairement. Les autres doivent s’accommoder de la contrainte d'espace de stockage.

h2. Contextes de journalisation

La gestion des journaux d'une distribution EOLE est guidée par différents contextes d'utilisation. Un contexte d'utilisation est une topologie réseau particulière de machines, virtuelles ou physiques, à laquelle s'applique une politique de journalisation commune. Les rôles possibles dans un réseau sont :

* une machine émettrice : transmission des journaux à une machine réceptrice ;

* une machine réceptrice : conservation des journaux locaux, réception des journaux de machines émettrices.

Les machines émettrices se déclinent en matériel réseau, machines physiques et conteneurs LXC. Cette distinction introduit une distinction entre les machines réceptrices qui ne gèrent que les conteneurs qu'elles hébergent et celles qui centralisent les journaux de matériels physiques distants. Certains modules de la distribution EOLE se prêtent plus à l'exécution d'un rôle particulier. ZéphirLog, notamment a été créé pour assumer le rôle de machine réceptrice vis-à-vis des autres modules. Cependant, la modularité permet à un autre module de jouer ce rôle. L'utilisation du mode conteneur ou non est plus contraignant sur les rôles par contre.

h3. Solution EOLE en mode non conteneur

Une machine en mode non conteneur est le cas le plus simple :

* un seul environnement d'exécution ;

* la machine peut jouer les rôles de machine émettrice et transmettre ses journaux et de machine réceptrice et recevoir des journaux.

h3. Solution EOLE en mode conteneur

Une machine en mode conteneur amène un autre niveau :

* une hiérarchie d'environnement d'exécution à deux niveaux :

** un maître ;

** des conteneurs ;

* les conteneurs jouent le rôle de machines émettrices et transmettent leurs journaux ;

* les maîtres jouent forcément le rôle de machines réceptrices, au moins vis-à-vis des conteneurs, et peuvent jouer le rôle de machines émettrices et transmettre leurs journaux.

h3. Autre

Le reste du matériel participant au réseau (équipement réseau, machines clientes hors solutions EOLE, etc.) jouent le rôle de machines émettrices dans la structure envisagée.

h2. La problématique de la transmission réseau

Une machine réceptrice peut potentiellement recevoir de plusieurs sources : 

* des conteneurs ;

* des machines distantes pouvant utiliser le protocole RELP ;

* des machines distantes pouvant utiliser le protocole TCP ;

* des machines distantes pouvant utiliser le protocole UDP.

La transmission devant être fiable, le protocole RELP est à privilégier, ainsi que l'usage des queues, essentiellement pour les journaux à valeur légale. Le protocole TCP est encore incontournable pour l'utilisation d'une liaison sécurisée avec GnuTLS. Le protocole UDP est à réserver pour les équipements ne pouvant utiliser le protocole TCP ou RELP.

Il doit être possible de trier les journaux par zone émettrice. Différentes granularités sont envisageables pour définir les zones émettrices. La granularité la plus grossière distingue la zone interne (les conteneurs) de la zone externe.

h2. Les services

Les services prioritaires sont ceux dont les journaux ont une valeur légale et une durée de rétention prévue par la loi.

h2. La configuration de rsyslog dans EOLE

Le service rsyslog est démarré par défaut sur tous les modules EOLE, maître et conteneurs.

La configuration minimale est composée d'une partie commune et de fichiers de configuration rattachés aux différents services.

La stratégie d'agrégation des journaux est décidée à l'instanciation.

h3. La configuration minimale

* Sur le maître, sur un module en mode conteneur ou non conteneur :

** Un dispatcher pour les journaux locaux et conteneurs dans @/var/log/rsyslog/local/<APPLI>/<APPLI>.<SEVERITY>.log@

** Un dispatcher pour les journaux des hôtes réseaux dans @/var/log/rsyslog/remote/<HOSTNAME>/<APPLI>/<APPLI>.<SEVERITY>.log@

* Sur les conteneurs :

** Des règles avec mise en place de queues pour les journaux sensibles

** Une règle globale pour le reste

h3. L'agrégation

L'agrégation des journaux des conteneurs sur le maître est imposée.

Le choix du mode d'agrégation porte sur :

* l'activation de l'envoi : spécification de l'adresse de destination, protocole imposé (RELP), port imposé (20515 ?) ;

* l'activation de la réception :

** réception de clients utilisant RELP : schéma de répartition, liste des adresses des clients, port imposé (20515 ?) ;

** réception de clients utilisant TCP : schéma de répartition, liste des adresses des clients, port imposé (10514 ?) ;

** réception de clients utilisant UDP : schéma de répartition, liste des adresses des clients, port imposé (514) ;

* utilisation du chiffrement : emplacement du certificat.

h3. L'organisation de la configuration (< EOLE 2.3.9)

La lecture séquentielle de la configuration de rsyslog impose une organisation particulière :

* les modules (entrée, sortie) doivent être chargés avant d'être utilisés ;

* les ensembles de règles doivent être spécifiés avant d'être associés aux entrées ;

* les modèles doivent être spécifiés avant d'être utilisés ;

* les messages ne doivent pas être sortis de la chaîne de traitement prématurément.

Plages de fichiers :

00-09 : fichiers EOLE contenant la configuration générique en début de chaîne de traitement

10-19 : fichiers EOLE de règles non-destructrices

20-49 : fichiers de règles personnalisées non-destructrices

50 : seuil d'utilisation de & ~ pour enlever les messages de la file après traitement

50-79 : fichiers de règles personnalisées destructrices

80-98 : fichiers EOLE de règles destructrices

99-general_dispatch.conf

h4. rsyslog.conf

eole-common:source:tmpl/rsyslog.conf

<pre>

$ModLoad imuxsock # provides support for local system logging

$ModLoad immark  # provides --MARK-- message capability

# commented in container (eole-conteneur/lxc_install.sh l.216-7)

$ModLoad imklog   # provides kernel logging support (previously done by rklogd)

$KLogPath /proc/kmsg

$PreserveFQDN on

# utilisation du protocole RELP

%if %%mode_conteneur_actif == 'oui' or %%activer_reception_logs_relp == 'oui'

$ModLoad imrelp

$InputRELPServerRun 20514

%end if

# utilisation du protocole TCP

%if %%activer_reception_logs_tcp == 'oui'

$ModLoad imtcp

# utilisation du chiffrement

%if %%rsyslog_tls == "oui" and (%%rsyslog_envoi_tls == "oui" or %%rsyslog_reception_tls == "oui")

# configuration general pour le chiffrement

$DefaultNetstreamDriver gtls

$DefaultNetstreamDriverCAFile %%rsyslog_ca_file

$DefaultNetstreamDriverCertFile  /etc/ssl/certs/eole.crt

$DefaultNetstreamDriverKeyFile  /etc/ssl/certs/eole.key

# configuration propre a la reception

%if %%rsyslog_reception_tls == "oui"

$InputTCPServerStreamDriverMode 1

$InputTCPServerStreamDriverAuthMode anon

%for %%client_ip in %%adresses_ip_clients_logs_tcp

$InputTCPServerStreamDriverPermittedPeer %%client_ip

%end for

%end if

%end if

$AllowedSender TCP, %%custom_join(%%adresses_ip_clients_logs_tcp, separator=', ')

$InputTCPServerRun 10514

%end if

# utilisation du protocole UDP

%if %%activer_reception_logs_udp == 'oui'

$ModLoad imudp

$AllowedSender UDP, %%custom_join(%%adresses_ip_clients_logs_udp, separator=', ')

$UDPServerRun 514

%end if

###########################

#### GLOBAL DIRECTIVES ####

###########################

#

# Use traditional timestamp format.

# To enable high precision timestamps, comment out the following line.

#

$ActionFileDefaultTemplate RSYSLOG_TraditionalFileFormat

# Filter duplicated messages

$RepeatedMsgReduction on

#

# Set the default permissions for all log files.

#

$FileOwner syslog

$FileGroup adm

$FileCreateMode 0640

$DirCreateMode 0755

$Umask 0022

$PrivDropToUser syslog

$PrivDropToGroup adm

#

# Include all config files in /etc/rsyslog.d/

#

$IncludeConfig /etc/rsyslog.d/*.conf

</pre>

h4. rsyslog.d/

eole-common:source:tmpl/00-aggregation.conf

<pre>

%if %%is_defined('activer_envoi_logs') and %%activer_envoi_logs == 'oui'

%if %%rsyslog_envoi_tls == 'non'

$ModLoad omrelp

%end if

$WorkDirectory /var/log/rsyslog

$ActionQueueType LinkedList

%if %%is_defined('activate_squid_realtime') and %%activate_squid_realtime == 'non'

$ActionQueueDequeueTimeBegin %%squid_heure_debut

$ActionQueueDequeueTimeEnd %%squid_heure_fin

%end if

$ActionQueueFileName relpact

$ActionQueueSaveOnShutdown on

%if %%rsyslog_envoi_tls == 'oui'

$ActionSendStreamDriverAuthMode anon

$ActionSendStreamDriverPermittedPeer %%adresse_ip_serveur_logs

$ActionSendStreamDriverMode 1

:programname, isequal, "squid" @@%%adresse_ip_serveur_logs:10514

$ActionSendStreamDriverAuthMode anon

$ActionSendStreamDriverPermittedPeer %%adresse_ip_serveur_logs

$ActionSendStreamDriverMode 1

:programname, !isequal, "squid"	@@%%adresse_ip_serveur_logs:10514

%else

:programname, isequal, "squid" :omrelp:%%adresse_ip_serveur_logs:20514

:programname, !isequal, "squid" :omrelp:%%adresse_ip_serveur_logs:20514

%end if

%else

# cette machine n'est pas configurée pour transmettre ses logs à une machine distante

%end if

</pre>

eole-common:source:tmpl/00-conteneur.conf

<pre>

$ModLoad omrelp

$WorkDirectory /var/log/rsyslog

$ActionQueueType LinkedList

%if %%is_defined('activate_squid_realtime') and %%activate_squid_realtime == 'non'

$ActionQueueDequeueTimeBegin %%squid_heure_debut

$ActionQueueDequeueTimeEnd %%squid_heure_fin

%end if

$ActionQueueFileName relpact

$ActionQueueSaveOnShutdown on

:programname, isequal, "squid" :omrelp:%%adresse_ip_br0:20514

& ~

*.*	:omrelp:%%adresse_ip_br0:20514

& ~

</pre>

eole-common:source:tmpl/01-templates.conf

<pre>

$template DynLocalDispatch, "/var/log/rsyslog/local/%programname%/%programname%.%syslogseverity-text%.log"

$template DynRemoteDispatch, "/var/log/rsyslog/remote/%hostname:::secpath-replace%/%programname%/%programname%.%syslogseverity-text%.log"

</pre>

eole-common:source:tmpl/10-erreurs.conf

<pre>

*.err  /var/log/syslog

</pre>

20-auth.conf

<pre>

$template DynLocalAuth, "/var/log/rsyslog/local/auth/auth.%syslogseverity-text%.log"

$template DynRemotelAuth, "/var/log/rsyslog/remote/%hostname:::secpath-replace%/auth/auth.%syslogseverity-text%.log"

%if %%activer_reception_logs == 'non'

auth, authpriv.* ?DynLocalAuth

%else

if $syslogfacility-text startswith 'auth' and $fromhost-ip startswith '127' then ?DynLocalAuth

%if %%mode_conteneur_actif == 'oui'

if $syslogfacility-text startswith 'auth' and $fromhost-ip startswith '%%adresse_ip_br0[:-2]' then ?DynLocalAuth

%end if

if $syslogfacility-text startswith 'auth' and not ($fromhost-ip startswith '%%adresse_ip_br0[:-2]' or $fromhost-ip startswith '127') then ?DynRemoteAuth

%end if

</pre>

50-79….conf : les règles personnalisées pour filter les services individuellement sur le modèle de 80-rsyslog.conf

eole-common:source:tmpl/80-rsyslog.conf

<pre>

$template DynLocalRsyslog, "/var/log/rsyslog/local/rsyslog/rsyslog.%syslogseverity-text%.log"

$template DynRemoteRsyslog, "/var/log/rsyslog/remote/%hostname:::secpath-replace%/rsyslog/rsyslog.%syslogseverity-text%.log"

%if %%activer_reception_logs == 'non'

:programname, startswith, "rsyslog" ?DynLocalRsyslog

%else

if $programname startswith 'rsyslog' and $fromhost-ip startswith '127' then ?DynLocalRsyslog

& ~

%if %%mode_conteneur_actif == 'oui'

if $programname startswith 'rsyslog' and $fromhost-ip startswith '%%adresse_ip_br0[:-2]' then ?DynLocalRsyslog

& ~

%end if

:programname, startswith, "rsyslog" ?DynRemoteRsyslog

& ~

%end if

</pre>

eole-common:source:tmpl/99-general_dispatch.conf

<pre>

%if %%activer_reception_logs == 'non'

*.* ?DynLocalDispatch

%else

:fromhost-ip, isequal, "127" ?DynLocalDispatch

& ~

%if %%mode_conteneur_actif == 'oui'

:fromhost-ip, startswith, "%%adresse_ip_brO[:-2]" ?DynLocalDispatch

& ~

%end if

*.* ?DynRemoteDispatch

%end if

</pre>

Actuellement, les services qui disposent de règles spécifiques sont squid, charon, iptables, ufw, smbd, nmbd, named, exim4. Une règle générale peut être ajoutée pour traiter les autres cas. Ces règles personnalisées ne sont pas essentielles sauf dans le cas de fork (exemple de rsyslog qui ajoute le numéro de PID au nom de programme de ses différentes instances). Dans ce cas, il faut une règle avec une expression régulière ou startswith (ou utiliser la facility si elle est univoque).

h3. Utilisation des ensembles de règles

Les règles peuvent être regroupées et les groupes exécutées en fonction de la provenance des messages. La dissociation des ports pour les différentes sources permet d'exécuter des jeux de règles différents pour les messages originaires des conteneurs, de machines distantes ou les messages locaux.

Le protocole RELP ne bénéficie pas de la possibilité d'utiliser les ensembles de règles (la directive pour associer un ensemble donné à une connection RELP n'apparaît que dans la version 6.3.6 : la version prévue pour precise est la 5.8.6).

h2. L'arborescence typique

<pre>

/var/log/syslog

├── local

│   ├── exim

│   │   ├── exim.alert

│   │   ├── exim.info

│   │   └── exim.notice

│   └── smbd

│       ├── smbd.debug

│       └── smbd.info

└── remote

    ├── 10.11.12.13

    │   ├── aaa

    │   │   └── aaa.info

    │   └── ipsec

    │       └── ipsec.error

    ├── 15.16.17.18

    │   ├── apache2

    │   │   └── apache2.error

    │   └── kerberos

    │       └── kerberos.info

    └── sw12-4

        └── aaa

            └── aaa.info

</pre>

h2. Rotation des journaux

h3. Principes de logrotate

* options globales : des options peuvent être définies en début de fichier ;

* -overriding : les fichiers sont lus séquentiellement, celui qui parle en dernier à raison- ;

* gobbling : les règles spécifques peuvent utiliser le wildcard * (problème des redondances de règles cependant.

h3. Mise en œuvre de logrotate

Pour composer avec les contraintes de logrotate, on ajoute .log à la fin de chaque fihier. Cela permet d'utiliser le globbing sur un dossier en excluant les journaux archivés.