formations/modules_EOLE_envole/documents/tronc-commun-2/ircd-irc2.tex

\documentclass[a4paper,11pt]{report}
\usepackage{ifxetex}
\ifxetex
  %\usepackage{fontspec}
  %\usepackage{xunicode}
   \usepackage{xltxtra}
   \defaultfontfeatures{Mapping=tex-text} % To support LaTeX quoting style
   \setmainfont{Caviar Dreams}
\else
   \usepackage[utf8]{inputenc}
   \usepackage[T1]{fontenc}
   \usepackage{amsfonts}
\fi
\usepackage{pifont}
\usepackage{geometry}
\usepackage{fancybox}
\usepackage{verbatim}
\usepackage{eurosym}
\usepackage[english, francais]{babel}
\usepackage{listings}
\usepackage{color}
\usepackage{graphicx}
\usepackage{hyperref}
\usepackage{titlesec}
\usepackage{fancyhdr}
\usepackage{lastpage}
\usepackage{minted}

\setlength{\hoffset}{-18pt}        
\setlength{\oddsidemargin}{0pt} % Marge gauche sur pages impaires
\setlength{\evensidemargin}{9pt} % Marge gauche sur pages paires
\setlength{\marginparwidth}{54pt} % Largeur de note dans la marge
\setlength{\textwidth}{481pt} % Largeur de la zone de texte (17cm)
\setlength{\voffset}{-18pt} % Bon pour DOS
\setlength{\marginparsep}{7pt} % Séparation de la marge
\setlength{\topmargin}{0pt} % Pas de marge en haut
\setlength{\headheight}{13pt} % Haut de page
\setlength{\headsep}{10pt} % Entre le haut de page et le texte
\setlength{\footskip}{27pt} % Bas de page + séparation
\setlength{\textheight}{708pt} % Hauteur de la zone de texte (25cm)
\definecolor{bg}{rgb}{0.9,0.9,0.9}

% TITRE DU DOCUMENT !
\title{Corrigé des exercices : intégration de ircd-irc2 dans EOLE}

%\date{}

\begin{document}
\maketitle
\normalsize
\vspace{2cm}
\textbf{Rédacteurs :}                        
\begin{itemize}
   \item Emmanuel Garette (egarette@cadoles.com) 
   \item Vincent Febvre (vfebvre@cadoles.com)   \newline  
\end{itemize}
\vspace{2cm}
\textbf{Version} : 1.0  \newline                                

\chapter{Création d'un dictionnaire vierge}

Le répertoire des dictionnaires personnalisés local est dans /usr/share/eole/creole/dicos/local.

Créé un fichier en suivant les conventions suivantes :

\begin{itemize}
 \item deux chiffres en préfix
 \item le séparateur \_
 \item le nom du projet
 \item l'extention .xml
\end{itemize}

Créer le fichier 00\_ircd.xml avec la structure de base suivante :

\begin{minted}[bgcolor=bg]{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
    </files>

    <variables>
    </variables>

    <constraints>
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Installation du paquet et gestion du service}

Le logiciel doit s'installer à l'instanciation du serveur et le service doit être géré par EOLE :

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
            <package>ircd-irc2</package>
            <service>ircd-irc2</service>
\end{minted}
\begin{minted}{xml}
    </files>

    <variables>
    </variables>

    <constraints>
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Ouverture du firewall et tcpwrapper}
\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
            <service>ircd-irc2</service>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
            <service_access service='ircd-irc2'>
		<port>6667</port>
            </service_access>
\end{minted}
\begin{minted}{xml}
    </files>

    <variables>
    </variables>

    <constraints>
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Activation/désactivation du service}

Ajouter une variable pour activer/désactiver le service :

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
            <service>ircd-irc2</service>
            <service_access service='ircd-irc2'>
		<port>6667</port>
            </service_access>
    </files>

    <variables>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
        <family name='services'>
            <variable name='activer_ircd' type='oui/non'
                         description="Activer le serveur IRC" >
                <value>oui</value>
            </variable>
        </family>
\end{minted}
\begin{minted}{xml}
    </variables>

    <constraints>
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Ajout des variables}
Dans le template nous allons utiliser des variables définis dans le dictionnaire. Nous allons ajouter les variable pour configurer les M line et les K line :

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
            <service>ircd-irc2</service>
            <service_access service='ircd-irc2'>
		<port>6667</port>
            </service_access>
    </files>

    <variables>
        <family name='services'>
            <variable name='activer_ircd' type='oui/non'
                         description="Activer le serveur IRC" >
                <value>oui</value>
            </variable>
        </family>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
        <family name='ircd'>
            <variable name='ircd_domaine' type='domain'
                description="Nom de domaine utilisé pour accéder au serveur IRC"/>
            <variable name='ircd_libelle' type='string'
                description="Libellé du serveur IRC"/>
            <variable name='ircd_port' type='port' description="Port du serveur IRC"
                    mode='expert'>
                <value>6667</value>
            </variable>
            <variable name='ircd_banned_hostname' type='domain'
                description="Hote banni sur le serveur IRC" multi="True"
                mandatory="True"/>
            <variable name='ircd_banned_comment' type='string'
                    description="Motif du bannissement du serveur IRC">
                <value>Vous êtes banni, contacter votre administrateur</value>
            </variable>
        </family>
\end{minted}
\begin{minted}{xml}
    </variables>

    <constraints>
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Le port du firewall devient variable}

On modifie le type du port en variable :

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
            <service>ircd-irc2</service>
            <service_access service='ircd-irc2'>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
                <port port_type="SymLinkOption">ircd_port</port>
\end{minted}
\begin{minted}{xml}
            </service_access>
    </files>

    <variables>
        <family name='ircd'>
            <variable name='ircd_domaine' type='domain'
                description="Nom de domaine utilisé pour accéder au serveur IRC"/>
            <variable name='ircd_libelle' type='string'
                description="Libellé du serveur IRC"/>
            <variable name='ircd_port' type='port' description="Port du serveur IRC"
                    mode='expert'>
                <value>6667</value>
            </variable>
            <variable name='ircd_banned_hostname' type='domain'
                description="Hote banni sur le serveur IRC" multi="True"
                mandatory="True"/>
            <variable name='ircd_banned_comment' type='string'
                    description="Motif du bannissement du serveur IRC">
                <value>Vous êtes banni, contacter votre administrateur</value>
            </variable>
        </family>
    </variables>

    <constraints>
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Ajout du template}

Le fichier de configuration du service doit être "templatiser" par EOLE :

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
            <service>ircd-irc2</service>
            <service_access service='ircd-irc2'>
                <port port_type="SymLinkOption">ircd_port</port>
            </service_access>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
            <file name='/etc/ircd/ircd.conf'/>
\end{minted}
\begin{minted}{xml}
    </files>

    <variables>
        <family name='ircd'>
            <variable name='ircd_domaine' type='domain'
                description="Nom de domaine utilisé pour accéder au serveur IRC"/>
            <variable name='ircd_libelle' type='string'
                description="Libellé du serveur IRC"/>
            <variable name='ircd_port' type='port' description="Port du serveur IRC"
                    mode='expert'>
                <value>6667</value>
            </variable>
            <variable name='ircd_banned_hostname' type='domain'
                description="Hote banni sur le serveur IRC" multi="True"
                mandatory="True"/>
            <variable name='ircd_banned_comment' type='string'
                    description="Motif du bannissement du serveur IRC">
                <value>Vous êtes banni, contacter votre administrateur</value>
            </variable>
        </family>
    </variables>

    <constraints>
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Désactivation des éléments}

Si "activer\_ircd" est à "non" le service ne devrait plus être démarré, la famille ne doit plus être accessible et le fichier de configuration ne doit plus être généré :

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
            <service servicelist="ircd">ircd-irc2</service>
\end{minted}
\begin{minted}{xml}
            <service_access service='ircd-irc2'>
                <port port_type="SymLinkOption">ircd_port</port>
            </service_access>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
            <file filelist="ircd" name='/etc/ircd/ircd.conf'/>
\end{minted}
\begin{minted}{xml}
    </files>

    <variables>
        <family name='services'>
            <variable name='activer_ircd' type='oui/non'
                        description="Activer le serveur IRC" >
                <value>oui</value>
            </variable>
        </family>
        <family name='ircd'>
            <variable name='ircd_domaine' type='domain'
                description="Nom de domaine utilisé pour accéder au serveur IRC"/>
            <variable name='ircd_libelle' type='string'
                description="Libellé du serveur IRC"/>
            <variable name='ircd_port' type='port' description="Port du serveur IRC"
                    mode='expert'>
                <value>6667</value>
            </variable>
            <variable name='ircd_banned_hostname' type='domain'
                description="Hote banni sur le serveur IRC" multi="True"
                mandatory="True"/>
            <variable name='ircd_banned_comment' type='string'
                    description="Motif du bannissement du serveur IRC">
                <value>Vous êtes banni, contacter votre administrateur</value>
            </variable>
        </family>
    </variables>

    <constraints>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
        <condition name='disabled_if_in' source='activer_ircd'>
            <param>non</param>
            <target type='filelist'>ircd</target>
            <target type='servicelist'>ircd</target>
            <target type='family'>ircd</target>
        </condition>
\end{minted}
\begin{minted}{xml}
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Ajout du groupe}

Il y a autant de message d'erreur que de nom d'hôte banni. Il est donc nécessaire de faire un groupe.

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
            <service servicelist="ircd">ircd-irc2</service>
            <service_access service='ircd-irc2'>
                <port port_type="SymLinkOption">ircd_port</port>
            </service_access>
            <file filelist="ircd" name='/etc/ircd/ircd.conf'/>
    </files>

    <variables>
        <family name='services'>
            <variable name='activer_ircd' type='oui/non'
                        description="Activer le serveur IRC" >
                <value>oui</value>
            </variable>
        </family>
        <family name='ircd'>
            <variable name='ircd_domaine' type='domain'
                description="Nom de domaine utilisé pour accéder au serveur IRC"/>
            <variable name='ircd_libelle' type='string'
                description="Libellé du serveur IRC"/>
            <variable name='ircd_port' type='port' description="Port du serveur IRC"
                    mode='expert'>
                <value>6667</value>
            </variable>
            <variable name='ircd_banned_hostname' type='domain'
                description="Hote banni sur le serveur IRC" multi="True"
                mandatory="True"/>
            <variable name='ircd_banned_comment' type='string'
                    description="Motif du bannissement du serveur IRC">
                <value>Vous êtes banni, contacter votre administrateur</value>
            </variable>
        </family>
    </variables>

    <constraints>
        <condition name='disabled_if_in' source='activer_ircd'>
            <param>non</param>
            <target type='filelist'>ircd</target>
            <target type='servicelist'>ircd</target>
            <target type='family'>ircd</target>
        </condition>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
	<group master="ircd_banned_hostname">
            <slave>icd_banned_comment</slave>
	</group>
\end{minted}
\begin{minted}{xml}
    </constraints>

    <help>
    </help>

</creole>
\end{minted}

\chapter{Ajout d'aide à la variable d'activation}

Ajouter de l'aide sur la variable activer\_ircd :

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
            <service servicelist="ircd">ircd-irc2</service>
            <service_access service='ircd-irc2'>
                <port port_type="SymLinkOption">ircd_port</port>
            </service_access>
            <file filelist="ircd" name='/etc/ircd/ircd.conf'/>
    </files>

    <variables>
        <family name='services'>
            <variable name='activer_ircd' type='oui/non'
                        description="Activer le serveur IRC" >
                <value>oui</value>
            </variable>
        </family>
        <family name='ircd'>
            <variable name='ircd_domaine' type='domain'
                description="Nom de domaine utilisé pour accéder au serveur IRC"/>
            <variable name='ircd_libelle' type='string'
                description="Libellé du serveur IRC"/>
            <variable name='ircd_port' type='port' description="Port du serveur IRC"
                    mode='expert'>
                <value>6667</value>
            </variable>
            <variable name='ircd_banned_hostname' type='domain'
                description="Hote banni sur le serveur IRC" multi="True"
                mandatory="True"/>
            <variable name='ircd_banned_comment' type='string'
                    description="Motif du bannissement du serveur IRC">
                <value>Vous êtes banni, contacter votre administrateur</value>
            </variable>
        </family>
    </variables>

    <constraints>
        <condition name='disabled_if_in' source='activer_ircd'>
            <param>non</param>
            <target type='filelist'>ircd</target>
            <target type='servicelist'>ircd</target>
            <target type='family'>ircd</target>
        </condition>

    </constraints>

    <help>
\end{minted}
\begin{minted}[bgcolor=bg]{xml}
        <variable name="activer_ircd">Cette variable permet d'activer un serveur IRC</variable>
\end{minted}
\begin{minted}{xml}
    </help>

</creole>
\end{minted}

\chapter{Ajout d'un calcul}

Ajouter un calcul sur la variable ircd\_domaine :

\begin{minted}{xml}
<?xml version="1.0" encoding="utf-8"?>
<creole>

    <files>
            <package>ircd-irc2</package>
            <service servicelist="ircd">ircd-irc2</service>
            <service_access service='ircd-irc2'>
                <port port_type="SymLinkOption">ircd_port</port>
            </service_access>
            <file filelist="ircd" name='/etc/ircd/ircd.conf'/>
    </files>

    <variables>
        <family name='services'>
            <variable name='activer_ircd' type='oui/non'
                        description="Activer le serveur IRC" >
                <value>oui</value>
            </variable>
        </family>
        <family name='ircd'>
            <variable name='ircd_domaine' type='domain'
                description="Nom de domaine utilisé pour accéder au serveur IRC"/>
            <variable name='ircd_libelle' type='string'
                description="Libellé du serveur IRC"/>
            <variable name='ircd_port' type='port' description="Port du serveur IRC"
                    mode='expert'>
                <value>6667</value>
            </variable>
            <variable name='ircd_banned_hostname' type='domain'
                description="Hote banni sur le serveur IRC" multi="True"
                mandatory="True"/>
            <variable name='ircd_banned_comment' type='string'
                    description="Motif du bannissement du serveur IRC">
                <value>Vous êtes banni, contacter votre administrateur</value>
            </variable>
        </family>
    </variables>

    <constraints>
        <condition name='disabled_if_in' source='activer_ircd'>
            <param>non</param>
            <target type='filelist'>ircd</target>
            <target type='servicelist'>ircd</target>
            <target type='family'>ircd</target>
        </condition>

\end{minted}
\begin{minted}[bgcolor=bg]{xml}
        <fill name="calc_val" target="ircd_domaine">
           <param type="eole">web_url</param>
        </fill>
\end{minted}
\begin{minted}{xml}
    </constraints>

    <help>
        <variable name="activer_ircd">Cette variable permet d'activer un serveur IRC</variable>
    </help>

</creole>
\end{minted}
\chapter{Test du dictionnaire}

Lancer gen\_config.Dans l'onglet service tester si l'onglet "Ircd" disparait bien si "Activer le serveur IRC" est à "non" et réapparait si la valeur est à "oui".

Renseigner la valeur de la variable "Nom de domaine utilisé pour accéder au serveur IRC" à "localhost.localdomaine".

\chapter{Création du template}

Si le variable pour activer le serveur est maintenant bien présente, le service n'est toujours pas fonctionnel.
En effet, il faut configurer l'application avec les informations fournis par l'utilisateur.

Pour cela, nous allons créé le template /usr/share/eole/creole/distrib/ircd.conf :

\begin{otherlanguage}{english}
\begin{minted}{cpp}
# This is ircd's config-file. Look at
# /usr/share/doc/ircd-irc2/ircd.conf.example.gz and
# and /usr/share/doc/ircd-irc2/INSTALL.* for more detailled information
# and instructions

# A-Line
A:Default:Default file:Welcome::ExampleNet

# Y-Lines
Y:1:90::100:512000:5.5:100.100
Y:2:90::300:512000:5.5:250.250

# I-Line
I:*:::0:1
I:127.0.0.1/32:::0:1

# P-Line
P::::6667:
\end{minted}
\end{otherlanguage}

\chapter{Configuration général du service}

L'utilisateur a renseigner un domaine, un label et un port pour IRCD. Il faut maintenant en tenir compte :
\begin{otherlanguage}{english}
\begin{minted}{cpp}
# This is ircd's config-file. Look at
# /usr/share/doc/ircd-irc2/ircd.conf.example.gz and
# and /usr/share/doc/ircd-irc2/INSTALL.* for more detailled information
# and instructions
\end{minted}
\begin{minted}[bgcolor=bg]{cpp}
# M-Line
M:%%ircd_domaine::%%ircd_libelle:%%ircd_port:000A
\end{minted}
\begin{minted}{cpp}
# A-Line
A:Default:Default file:Welcome::ExampleNet

# Y-Lines
Y:1:90::100:512000:5.5:100.100
Y:2:90::300:512000:5.5:250.250

# I-Line
I:*:::0:1
I:127.0.0.1/32:::0:1

# P-Line
P::::6667:
\end{minted}
\end{otherlanguage}


\chapter{Ajout des bannissements}

L'administrateur a la possibilité d'ajouté plusieurs lignes de bannissement. Il est donc nécessaire de récupérer les informations avec une boucle :

\begin{otherlanguage}{english}
\begin{minted}{cpp}
# This is ircd's config-file. Look at
# /usr/share/doc/ircd-irc2/ircd.conf.example.gz and
# and /usr/share/doc/ircd-irc2/INSTALL.* for more detailled information
# and instructions
# M-Line
M:%%ircd_domaine::%%ircd_libelle:%%ircd_port:000A
\end{minted}
\begin{minted}[bgcolor=bg]{cpp}
%for %%hostname in %%ircd_banned_hostname
# K-Line
K:%%hostname:%%hostname.ircd_banned_comment:*:0:
%end for
\end{minted}
\begin{minted}{cpp}
# A-Line
A:Default:Default file:Welcome::ExampleNet

# Y-Lines
Y:1:90::100:512000:5.5:100.100
Y:2:90::300:512000:5.5:250.250

# I-Line
I:*:::0:1
I:127.0.0.1/32:::0:1

# P-Line
P::::6667:
\end{minted}
\end{otherlanguage}

\chapter{Configuration et démarrage le service}

Il est maintenant possible de vérifier le fonctionnement du service.

Le service doit être démarré après le reconfigure si on active IRCD.

Le service doit être arrêté après le reconfigure si on désactive IRCD.

\end{document}