[UPDATE] - man page generate

2022-03-18 10:44:35 +01:00
parent eef1df73ae
commit 29507b8851
26 changed files with 86 additions and 648 deletions
@@ -0,0 +1,112 @@
+---
+Title: MONITHOR-CLIENT
+section: 1
+header: Serveur bash de monitoring
+footer: monithor-server 1.7
+date: January 13, 2022
+---
+
+
+NAME
+=====
+
+** monithor-client ** - service
+
+
+SYNOPSIS
+=====
+
+`/usr/local/bin/monithor-client [start/stop]`
+
+`/etc/init.d/monithor-c [start/stop]`
+
+
+DESCRIPTION
+=====
+
+monithor-client(1) permet de surveiller votre système d'information 
+
+-   l'ensemble du service est basé sur l'ourverture d'une socket TCP via netcat
+
+-   il peut aussi utiliser cryptcat (chiffré)
+
+-   un serveur web en python est lancé sur votre machine de monitoring 
+
+INIT.D
+======
+
+le service peut être démarré et arrêté via system V
+
+- Démarrage
+
+`/etc/init.d/monithor-c start`
+
+- Arrêt
+
+`/etc/init.d/monithor-c start`
+
+CONFIGURATION SERVICE
+=====
+
+- Le fichier responsable de la gestion IP/PORT est : service.cfg 
+
+`$ cat etc/monithor-client/service.cfg `
+
+`RemoteIp=10.10.10.3:1666 `
+
+`LocalPassword='Evil@MonitoR-666'`
+
+`Crypted=no`
+
+`Rotation=1`
+
+`TimeOut=2`
+
+`WebPort=80`
+
+* RemoteIp : correspond au couple adresse IP/Port de l'interface réseau utilisée
+
+* LocalPassword : correspond au mot de passe utilisé pour chiffré la connexion si Crypted est à "yes"
+
+* Crypted : si la valeur est à "yes" le binnaire crypcat est utilisé, si non netcat est utilisé
+
+* Rotation : correspond à la valeur en seconde (float) entre chaque éxécution complète des sondes
+
+* TimeOut : correspond à la valeur en seconde (float) du temps maximal d'éxécution de chaque sonde
+
+* WebPort :  correpond au port utilisé pour lancer le serveur web python 
+
+CONFIGURATION SONDE
+=====
+
+- La configuration des sondes est stocké dans le répertoires : 
+
+/etc/monithor-client/conf/
+
+Tous les fichiers *.cfg sont lus.
+
+- Chaque sonde est composée de cette manière : 
+
+`IP:PORT#SONDE#arg1|arg2|arg3`
+
+* IP:PORT : correspond à l'adresse et le prot de communication du erveur monithor-server distant.
+
+* SONDE : correspond au nom de sonde envoyé sur le serveur monithor-server distant.
+
+* \# : séparateur entre le nom de la sonde et les arguments
+
+* arg1\|arg2\|arg3 : ensemble des arguments  envoyé sur le serveur monithor-server distant. Le séparateur est "\|"
+
+- Exemple : 
+
+`$ cat etc/monithor-client/conf/Card_10.10.10.3-1666.cfg `
+
+`10.10.10.3:1666#file#/tmp/test`
+
+`10.10.10.3:1666#part#/home/isen|50|80`
+
+`10.10.10.3:1666#process#sshd`
+
+- Multiple cible
+
+Chaque fichier peut s'organiser par cible ou par type de sonde ou tout mélangé
@@ -0,0 +1,118 @@
+---
+Title: MONITHOR-SERVER
+section: 1
+header: Serveur bash de monitoring
+footer: monithor-server 1.7
+date: January 13, 2022
+---
+
+
+
+NAME
+=====
+
+** monithor-server ** - service
+
+SYNOPSIS
+======
+
+`/usr/local/bin/monithor-server [start/stop]`
+
+`/etc/init.d/monithor-c [start/stop]`
+
+
+DESCRIPTION
+=====
+
+monithor-server(1) permet d'accépter des requêtes venant d'un instance monithor-client
+
+-   l'ensemble du service est basé sur l'ourverture d'une socket TCP via netcat
+
+-   il peut aussi utiliser cryptcat (chiffré)
+
+## INIT.D
+
+le service peut être démarré et arrêté via system V
+
+- Démarrage
+
+`/etc/init.d/monithor-c start`
+
+- Arrêt
+
+`/etc/init.d/monithor-c start`
+
+CONFIGURATION SERVICE
+=====
+
+- Le fichier responsable de la gestion IP/PORT est : service.cfg 
+
+`LocalIp=10.10.10.4`
+
+`LocalPort=1666`
+
+`Crypted=no`
+
+`LocalPassword='Evil@MonitoR-666'`
+
+* LocalIp : correspond à l'adresse IP de l'interface réseau en écoute
+
+* LocalPort : correspond au port de communication du client monithor
+
+* LocalPassword : correspond au mot de passe utilisé pour chiffré la connexion si Crypted est à "yes"
+
+* Crypted : si la valeur est à "yes" le binnaire crypcat est utilisé, si non netcat est utilisé
+
+CONFIGURATION SONDE
+=====
+
+- La configuration des sondes est stocké dans le répertoires : 
+
+/etc/monithor-server/sonde.cfg
+
+Chaque sonde est composé de cette manière : 
+
+`SONDE#SCRIPT`
+
+* SONDE : Nom de la sonde envoyé par monithor server et reçu par monithor client
+
+* SCRIPT : Script éxecuté sur l'instance avec le(s) argument(s) reçu(s) de monithor client
+
+SCRIPT
+=======
+
+les scripts sont tous stocké dans le répertoire : 
+
+/usr/local/bin/monithor-server.d/
+
+Exemple 
+======
+
+* Configuration server :
+
+`cat /etc/monithor-server/sonde.cfg`
+
+`part#part-space.sh`
+
+* Configuration client :
+
+`$ cat /etc/monithor-client/etc/monithor-client/conf/Card_10.10.10.3-1666.cfg`
+
+`10.10.10.3:1666#part#/home/isen|50|80`
+
+* Explication 
+
+CLIENT envoi à SERVEUR :  part#/home/isen|50|80
+
+SERVEUR compare la chaine part à son fichier de configuration /etc/monithor-server/sonde.cfg
+
+SERVEUR associe part#part-space.sh 
+
+SERVEUR exécute : /usr/local/bin/monithor-server.d/part-space.sh /home/isen 50 80
+
+SERVEUR renvoie les valeur récupéré à CLIENT 
+
+
+
+
+