diff --git a/doc/suidchecker.man b/doc/suidchecker.man new file mode 100644 index 0000000..b9165c7 --- /dev/null +++ b/doc/suidchecker.man @@ -0,0 +1,76 @@ +.\" Automatically generated by Pandoc 2.0.6 +.\" +.TH "SUIDCHECKER" "1" "" "Version 1.0" "Breizh's \[lq]suidchecker\[rq] +Documentation" +.hy +.SH NAME +.PP +\f[B]suidchecker\f[] \[em] Vérifie les fichiers ayant le bit SUID du +système +.SH SYNOPSIS +.PP +\f[B]suidchecker\f[] +\f[B]\[en]init\f[]|\f[B]\[en]reinit\f[]|\f[B]\[en]add\f[]|\f[B]\[en]check\f[] +.PD 0 +.P +.PD +\f[B]suidchecker\f[] \f[B]\-h\f[]|\f[B]\[en]help\f[] +.SH DESCRIPTION +.PP +Indexe puis vérifie l'intégrité de tous les fichiers portant le bit +SUID. +La base de donnée est gérée avec sqlite3, il faut donc que ce logiciel +soit installé. +.SS Options +.TP +.B \f[B]\-h\f[], \f[B]\[en]help\f[] +Affiche un message d'aide et quitte le programme. +.RS +.RE +.TP +.B \f[B]\[en]init\f[] +Initialise la base de données, cherche les fichiers portant le bit SUID, +et les ajoutes, avec leur somme de contrôle et leur taille, dans la base +de données. +Échoue avec le code 1 si la base a déjà été initialisée. +.RS +.RE +.TP +.B \f[B]\[en]reinit\f[] +Réinitialise la base de données, en la supprimant puis en l'initialisant +comme avec init. +À utiliser quand un fichier existant a été légitimement modifié, par +exemple suite à une mise à jour. +Pour ajouter de nouveaux fichiers, préférer \f[B]\[en]add\f[], qui ne +supprime pas l'historique des contrôles et ne réinitilise pas les +informations des fichiers existants. +.RS +.RE +.TP +.B \f[B]\[en]add\f[] +Cherche les fichiers portant le bit SUID, et ajoute dans la base ceux +qui n'y était pas indexés. +À utiliser lors qu'un nouveau fichier portant le bit SUID est ajouté +dans le système. +.RS +.RE +.TP +.B \f[B]\[en]check\f[] +Vérifie, pour chaque fichier indexé dans la base, sa présence, sa somme +de contrôle et sa taille. +Indique sur la sortie standard si le fichier a été modifié, supprimé ou +s'il est identique aux informations d'origines. +L'historique des contrôles est stocké dans la base de données. +.RS +.RE +.SH FILES +.TP +.B \f[I]/etc/suidchecker.conf\f[] +contient la configuration du script. +Normalement généré à l'installation, il peut être modifié pour utiliser +une autre base de données. +.RS +.RE +.SH AUTHOR +.PP +Breizh diff --git a/doc/suidchecker.md b/doc/suidchecker.md new file mode 100644 index 0000000..399e63f --- /dev/null +++ b/doc/suidchecker.md @@ -0,0 +1,66 @@ +% SUIDCHECKER(1) Version 1.0 | Breizh's "suidchecker" Documentation + +NAME +==== + +**suidchecker** — Vérifie les fichiers ayant le bit SUID du système + +SYNOPSIS +======== + +| **suidchecker** **--init**|**--reinit**|**--add**|**--check** +| **suidchecker** **-h**|**--help** + +DESCRIPTION +=========== + +Indexe puis vérifie l'intégrité de tous les fichiers portant le bit SUID. La +base de donnée est gérée avec sqlite3, il faut donc que ce logiciel soit +installé. + +Options +------- + +**-h**, **--help** + +: Affiche un message d'aide et quitte le programme. + +**--init** + +: Initialise la base de données, cherche les fichiers portant le bit SUID, et + les ajoutes, avec leur somme de contrôle et leur taille, dans la base de + données. Échoue avec le code 1 si la base a déjà été initialisée. + +**--reinit** + +: Réinitialise la base de données, en la supprimant puis en l'initialisant + comme avec init. À utiliser quand un fichier existant a été légitimement + modifié, par exemple suite à une mise à jour. Pour ajouter de nouveaux + fichiers, préférer **--add**, qui ne supprime pas l'historique des + contrôles et ne réinitilise pas les informations des fichiers existants. + +**--add** + +: Cherche les fichiers portant le bit SUID, et ajoute dans la base ceux qui + n'y était pas indexés. À utiliser lors qu'un nouveau fichier portant le bit + SUID est ajouté dans le système. + +**--check** + +: Vérifie, pour chaque fichier indexé dans la base, sa présence, sa somme de + contrôle et sa taille. Indique sur la sortie standard si le fichier a été + modifié, supprimé ou s'il est identique aux informations d'origines. + L'historique des contrôles est stocké dans la base de données. + +FILES +===== + +*/etc/suidchecker.conf* + +: contient la configuration du script. Normalement généré à l'installation, + il peut être modifié pour utiliser une autre base de données. + +AUTHOR +====== + +Breizh