mise à jour et amélioration de la doc.

This commit is contained in:
Alexandre Anriot 2005-09-24 09:48:17 +00:00
parent b84b8b1714
commit e99c4f32b2
2 changed files with 46 additions and 55 deletions

73
README
View file

@ -10,42 +10,40 @@ Evoauth.
L'utilisateur saisit ses identifiants (login et mot de passe) et
parvient à une page sur laquelle il est authentifié. Il peut :
- activer son accès : son adresse ip est récupérée et indexée dans
un fichier historique. une règle d'autorisation est chargée dans le
firewall et l'utilisateur reste connecté jusqu'à ce que la pop-up
soit fermée ou que sa connexion se termine (un script annexe
supprimera des connexions actives).
l'utilisateur peut consulter son crédit restant, celui-ci est
mis à jour chaque minute.
- activer son accès : son adresse ip est récupérée et indexée dans
un fichier historique. une règle d'autorisation est chargée dans
le firewall et l'utilisateur reste connecté jusqu'à ce que la
pop-up soit fermée ou que sa connexion se termine (un script
annexe supprimera des connexions actives). L'utilisateur peut
consulter son crédit restant, celui-ci est mis à jour chaque
minute.
- changer son mot de passe : l'utilisateur est invité à saisir
à deux reprises son nouveau mot de passe, sur une page dédiée
- changer son mot de passe : l'utilisateur est invité à saisir
à deux reprises son nouveau mot de passe, sur une page dédiée.
- se déconnecter
- se déconnecter, lorsque l'utilisation d'Evoauth est terminée.
2 - Partie WEB et administrateur
--------------------------------
Celui-ci possède toutes les possibilités précédemment évoquées, mais
peut également procéder à l'administration du logiciel :
Celui-ci possède toutes les possibilités précédemment évoquées. Les
identifiants sont :
- ajout d'un compte utilisateur
login : admin
pass : ...
Le compte d'administration par défaut est :
Voici les fonctionnalités proposées :
login : admin
pass : ...
- ajout d'un nouvel utilisateur
- suppression d'un ou plusieurs compte(s) utilisateur
- suppression d'un ou plusieurs utilisateur(s)
- déconnexion d'utilisateurs
- désactivation d'utilisateurs
- désactivation d'utilisateurs
- expulsion d'un utilisateur (provisoirement)
- expulsion d'un utilisateur, et ce de façon provisoire
- changement du texte de bienvenue de l'utilisateur
- changement du texte de bienvenue des utilisateurs
3 - Suivis de l'activité
@ -62,19 +60,23 @@ est également disponible dans /var/log/evoauth.log.
4 - Maintenance
---------------
Le script perl "Evoauth.pl" doit être ajouté à la crontab (vous pouvez
pour celà vous inspirer du fichier install/crontab.sample) et permet de
Le script perl "evoauth" doit être ajouté à la crontab (vous pouvez pour
celà vous inspirer du fichier install/crontab.sample) et permet de
supprimer du fichier de status les adresses ip des utilisateurs qui ne
sont plus connectés.
Il travaille par défaut sur une durée de 70 secondes (variable
'timetodel' dans evoauth.conf').
La suppression est par défaut effectuée sur une durée de 70 secondes
(variable 'timetodel' dans evoauth.conf'). Evoauth peut pour des raisons
de sécurité être amené à supprimer la dernière ip de connexion d'un
utilisateur si celui-ci n'est plus connecté; la mention "Supprimée"
apparaitra alors dans l'interface d'administration.
Vous accédez aux fonctions principales suivantes :
Vous accédez aux fonctions principales suivantes grâce au script
/usr/local/bin/evoauth :
- le démarrage (initialisation) d'Evoauth, via l'option '-i'
- l'arrêt d'Evoauth, via l'option '-s'
- le redémarrage d'Evoauth, via l'option '-r'
- le démarrage (initialisation) d'Evoauth, via l'option '-i'
- l'arrêt d'Evoauth, via l'option '-s'
- le redémarrage d'Evoauth, via l'option '-r'
D'autres options non détaillées ici permettent d'influer directement sur
le comportement d'Evoauth.
@ -85,14 +87,15 @@ les changements deviennent effectifs.
Arborescence par defaut
-----------------------
/etc/evoauth/evoauth.conf : fichier de configuration
/etc/evoauth/evoauth.rules : fichier de règles firewall
/usr/local/bin/evoauth : script d'administration
/etc/evoauth/evoauth.conf : fichier de configuration
/etc/evoauth/evoauth.rules : fichier de règles firewall
/var/www/evoauth/{,images,includes} : interface web
/var/www/evoauth/accueil.txt : texte d'accueil
/usr/local/share/evoauth : interface d'administration
/usr/local/share/doc/evoauth : documentation, licence
/var/log/evoauth.log : journal d'utilisation
/var/log/evoauth.log : journal d'utilisation

View file

@ -13,7 +13,7 @@ temporaire, comme /tmp, et exécutez :
# cd evoauth
# make install
Evoauth est à présent installé sur votre système. Passon à la
Evoauth est à présent installé sur votre système. Passons à la
configuration :
- /etc/evoauth/evoauth.conf pour la configuration de la partie
@ -22,7 +22,7 @@ configuration :
- /etc/evoauth/evoauth.rules pour la configuration des règles de
firewall
Il est à noter que les séparations entre les éléments du fichier de
Il est à noter que les séparations entre les éléments du fichier de
configuration peuvent être des epaces ou des tabulations.
Vous pouvez également ajouter des commentaires sur des lignes
@ -35,11 +35,11 @@ Il faut également installer sudo et mettre les lignes suivantes dans le
fichier sudoers (par exemple via la commande `vipw`) :
User_Alias WWW = www-data
Cmnd_Alias EVOAUTH = /usr/local/share/evoauth/Evoauth.pl
Cmnd_Alias EVOAUTH = /usr/local/bin/evoauth
WWW ALL= NOPASSWD: EVOAUTH
Changez par sécurité la somme md5 du mot de passe de 'admin' dans
/home/aanriot/cvs/evoauth/htdocs/includes/config.php :
/var/www/htdocs/evoauth/includes/config.php :
$ echo -n PASS | md5sum
@ -112,15 +112,15 @@ En prévision pour la version 0.9 :
Enfin, initialiser Evoauth grâce à la commande :
# perl /usr/local/share/evoauth/Evoauth.pl -i
# /usr/local/bin/evoauth -i
Si vous devez l'arrêter :
# perl /usr/local/share/evoauth/Evoauth.pl -s
# /usr/local/bin/evoauth -s
Si vous voulez juste le redémarrer :
# perl /usr/local/share/evoauth/Evoauth.pl -r
# /usr/local/bin/evoauth -r
@ -131,7 +131,7 @@ FAQ
iptables: Bad rule (does a matching rule exist in that chain?)
R : Vous avez probablement oublié d'initialiser Evoauth, ceci peut
être fait par la commande 'perl Evoauth.pl -i'
être fait par la commande 'evoauth -i'
2 - Q : Une personne de ce bureau s'est déconnectée, et mon accès a été
coupé.
@ -140,15 +140,3 @@ FAQ
même si les adresses MAC seront à terme gérées, par des adresses
IP. A cause du mécanisne de NAT, toutes les personnes connectées
via une même IP seront affectées par une décision.
Arborescence par defaut
-----------------------
/etc/evoauth/evoauth.conf : fichier de configuration
/etc/evoauth/evoauth.rules : fichier de règles firewall
/var/www/evoauth/{,images,includes} : interface web
/var/www/evoauth/accueil.txt : texte d'accueil
/usr/local/share/evoauth : interface d'administration
/usr/local/share/doc/evoauth : documentation, licence
/var/log/evoauth.log : journal d'utilisation