documentation update

This commit is contained in:
Thomas NOËL 2014-01-29 16:15:49 +01:00
parent 5fe72e82de
commit ea358253cc
17 changed files with 298 additions and 106 deletions

View File

@ -25,13 +25,13 @@
<list>
<item><p>Gestion d'utilisateurs "en masse" dans l'IdP local</p>
<list>
<item><p>possibilité de créer "n" utilisateurs avec la même base de login (login-N)</p></item>
<item><p>possibilité de créer plusieurs utilisateurs avec la même base de login (login-N)</p></item>
<item><p>import d'un fichier CSV pour créer/mettre à jour un ensemble d'utilisateurs</p></item>
<item><p>affichage des détails d'un utilisateur ou d'un ensemble d'utilisateurs</p></item>
<item><p>export CSV d'un ensemble de compte</p></item>
<item><p>export CSV d'un ensemble d'utilisateurs</p></item>
<item><p>lors de la création ou de l'import d'un utilisateur, création du mot de passe s'il n'est pas fourni ;
ces mots de passe sont affichés</p></item>
<item><p>retrait de la limitation sur la durée de vie d'un compte</p></item>
ces mots de passe sont affichés ou exportés dans les CSV</p></item>
<item><p>retrait de la limitation sur la durée de vie d'un utilisateur</p></item>
</list>
</item>
<item><p>Amélioration et optimisations</p>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

View File

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 27 KiB

View File

@ -23,9 +23,9 @@
<links type="topic" groups="
idp-installation-configuration
idp-connexions-multiples
idp-interface-activation
idp-interface
idp-logs
idp-devel"/>
idp-logs"/>
</page>

View File

@ -1,29 +0,0 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" style="task"
id="idep-devel" xml:lang="fr">
<info>
<link type="guide" xref="fournisseur-d-identite" group="idep-devel"/>
<desc></desc>
<revision pkgversion="20120605" version="1.0" date="10-06-2012" status="final"/>
<credit type="author">
<name>Thomas Noël</name>
<email>tnoël@entrouvert.com</email>
</credit>
<credit type="maintainer">
<name>Pierre Cros</name>
<email>pcros@entrouvert.com</email>
</credit>
</info>
<title>Fonctionnalités à venir</title>
<p>Quelques fonctionnalités ne sont pas encore disponibles dans Univnautes par rapport à cet IdP :</p>
<list>
<item><p>Il n'y a pas encore d'interface pour les clients mobiles et netbook</p></item>
<item><p>Il n'y a pas encore de textes configurables comme pour le portail captif</p></item>
</list>
<p>D'autres fonctionnalités peuvent être demandées, cependant il est illusoire d'imaginer de faire de cet IdP un système complet : l'intégration dans Univnautes (pfSense/FreeBSD) limite les possibilités d'extension. Un IdP autonome serait plus à même de remplir des fonctionnalités avancées pour la gestion des comptes invités (on peut imaginer une connexion via les comptes google ou facebook des participants, une connexion à un ou plusieurs LDAP, Radius, PAM, etc.)</p>
</page>

View File

@ -231,4 +231,15 @@ En éditant l'utilisateur (petit icône « e » à droite de sa ligne), on peut
<p>Vous pouvez alors jouer avec la création/modification d'utilisateurs (menu <em>System / User managment</em>) pour définir votre politique d'accès.</p>
</section>
<section id="limitations">
<title>Limitations</title>
<p>La principale limitation de ce fournisseur d'identités est lié au fait qu'il
se base sur les comptes du système pfSense. Ces comptes sont de type "Unix" et
ne disposent que d'un login et d'une date d'expiration.</p>
<p>Pour la même raison, il n'est pas raisonnable d'utiliser ce petit IdP local
pour gérer un grand nombre de comptes (supérieur à un millier).</p>
</section>
</page>

View File

@ -0,0 +1,85 @@
<page xmlns="http://projectmallard.org/1.0/"
type="topic" style="task"
id="idp-interface-activation" xml:lang="fr">
<info>
<link type="guide" xref="fournisseur-d-identite" group="idp-interface-activation"/>
<desc>Procédure à suivre dans l'admin de pfSense pour activer l'interface simplifiée de gestion des comptes.</desc>
<revision pkgversion="20120605" version="1.0" date="10-06-2012" status="final"/>
<credit type="author">
<name>Thomas Noël</name>
<email>tnoël@entrouvert.com</email>
</credit>
<credit type="maintainer">
<name>Pierre Cros</name>
<email>pcros@entrouvert.com</email>
</credit>
</info>
<title>Activation de l'interface simplifiée de gestion des comptes</title>
<p>La gestion des comptes de l'IdP local peut se faire depuis l'interface de
pfSense, au niveau du menu System / User Manager. Cependant l'accès à cette
interface nécessite un accès à l'administration de tous les utilisateurs de
pfSense : on ne peut donc pas y donner accès à n'importe qui.</p>
<p>Il existe dans UnivNautes, depuis la version 20120626, une interface
simplifiée et ergonomique qui permet de ne gérer que les comptes de l'IdP. Elle
est disponible à l'adresse : <link
href="https://nom-de-votre.serveur.eduspot:4443/users-admin/">https://nom-de-votre.serveur.eduspot:4443/users-admin/</link></p>
<section id="activer">
<title>Activer l'interface</title>
<p>Pour activer cette interface, il faut :</p>
<steps>
<item><p>que l'IdP local soit activé (Services / Captive portal, onglet Univnautes,
cocher la case "Enable local IdP" et indiquer les clés, privée et publique).</p></item>
<item><p>qu'il soit accessible et donc que le port 4443/tcp soit ouvert (Firewall /
Rules, onglet LAN ou WAN, ouvrir le port 4443 ou son alias "LocalIDP" s'il
existe déjà).</p></item>
<item><p>Créer un compte sur pfSense qui aura les droits d'accès à cette interface.
Voici ci-dessous la procédure.</p></item>
</steps>
</section>
<section id="compte-gestionnaire">
<title>Création d'un compte de gestionnaire des comptes de l'IdP local</title>
<p>Il suffit de créer un compte possédant les deux privilèges :</p>
<list>
<item><p>UnivNautes IdP - account</p></item>
<item><p>UnivNautes IdP - administrator</p></item>
</list>
<p>Pour cela, créer d'abord un compte classique depuis System / User Managment :</p>
<figure>
<title>Création du compte de l'administrateur des utilsateurs de l'IdP (1)</title>
<media type="image" mime="image/png" src="figures/admin-idp-1.png" >
</media>
</figure>
<figure>
<title>Création du compte de l'administrateur des utilsateurs de l'IdP (2) : configuration du compte</title>
<media type="image" mime="image/png" src="figures/admin-idp-2.png" >
</media>
</figure>
<p>Puis lui donner les droits d'accès : cliquer sur le compte créé et ajouter les deux privilèges « UnivNautes IdP - account » et « UnivNautes IdP - administrator »</p>
<figure>
<title>Création du compte de l'administrateur des utilsateurs de l'IdP (2) : attribution des privilèges nécessaires</title>
<media type="image" mime="image/png" src="figures/admin-idp-3.png" >
</media>
</figure>
</section>
<section id="acces-interface">
<title>Accès à l'interface</title>
<p>Se rendre sur <link href="https://nom-de-votre.serveur.eduspot:4443/users-admin/">https://nom-de-votre.serveur.eduspot:4443/users-admin/</link> et se connecter avec le compte créé ci-dessus.</p>
</section>
</page>

View File

@ -16,105 +16,230 @@
</credit>
</info>
<title>Interface de gestion des comptes de l'IdP local</title>
<p>La gestion des comptes de l'IdP local peut se faire depuis l'interface de
pfSense, au niveau du menu System / User Manager. Cependant l'accès à cette
interface nécessite un accès à l'administration de tous les utilisateurs de
pfSense : on ne peut donc pas y donner accès à n'importe qui.</p>
<p>Il existe dans UnivNautes, depuis la version 20120626, une interface
simplifiée et ergonomique qui permet de ne gérer que les comptes de l'IdP. Elle
est disponible à l'adresse : <link
href="https://nom-de-votre.serveur.eduspot:4443/users-admin/">https://nom-de-votre.serveur.eduspot:4443/users-admin/</link></p>
<section id="activer">
<title>Activer l'interface</title>
<p>Pour activer cette interface, il faut :</p>
<steps>
<item><p>que l'IdP local soit activé (Services / Captive portal, onglet Univnautes,
cocher la case "Enable local IdP" et indiquer les clés, privée et publique).</p></item>
<item><p>qu'il soit accessible et donc que le port 4443/tcp soit ouvert (Firewall /
Rules, onglet LAN ou WAN, ouvrir le port 4443 ou son alias "LocalIDP" s'il
existe déjà).</p></item>
<item><p>Créer un compte sur pfSense qui aura les droits d'accès à cette interface.
Voici ci-dessous la procédure.</p></item>
</steps>
</section>
<section id="compte-gestionnaire">
<title>Création d'un compte de gestionnaire des comptes de l'IdP local</title>
<p>Il suffit de créer un compte possédant les deux privilèges :</p>
<list>
<item><p>UnivNautes IdP - account</p></item>
<item><p>UnivNautes IdP - administrator</p></item>
</list>
<p>Pour cela, créer d'abord un compte classique depuis System / User Managment :</p>
<figure>
<title>Création du compte de l'administrateur des utilsateurs de l'IdP (1)</title>
<media type="image" mime="image/png" src="figures/admin-idp-1.png" >
</media>
</figure>
<figure>
<title>Création du compte de l'administrateur des utilsateurs de l'IdP (2) : configuration du compte</title>
<media type="image" mime="image/png" src="figures/admin-idp-2.png" >
</media>
</figure>
<p>Puis lui donner les droits d'accès : cliquer sur le compte créé et ajouter les deux privilèges « UnivNautes IdP - account » et « UnivNautes IdP - administrator »</p>
<figure>
<title>Création du compte de l'administrateur des utilsateurs de l'IdP (2) : attribution des privilèges nécessaires</title>
<media type="image" mime="image/png" src="figures/admin-idp-3.png" >
</media>
</figure>
</section>
<title>Interface simplifiée de gestion des comptes de l'IdP local</title>
<section id="acces-interface">
<title>Accès à l'interface</title>
<p>Se rendre sur <link href="https://nom-de-votre.serveur.eduspot:4443/users-admin/">https://nom-de-votre.serveur.eduspot:4443/users-admin/</link> et se connecter avec le compte créé ci-dessus.</p>
<p>La page d'accueil présente la liste des comptes de l'IdP local. On peut la trier par login, date d'expiration, description, en cliquant sur le titre de la colonne à trier.</p>
<p>Se rendre sur <link
href="https://nom-de-votre.serveur.eduspot:4443/users-admin/">https://nom-de-votre.serveur.eduspot:4443/users-admin/</link>
et se connecter avec le compte dédié créé dans pfSense.</p>
</section>
<section id="home">
<title>Page d'accueil : liste des utilisateurs</title>
<p>La page d'accueil présente la liste des comptes de l'IdP local. On peut la
trier par login, date d'expiration, description, en cliquant sur le titre de la
colonne à trier.</p>
<figure>
<title>Page d'accueil de l'interface de gestion des comptes de l'IdP local</title>
<media type="image" mime="image/png" src="figures/admin-idp-5.png" >
<media type="image" mime="image/png" src="figures/admin-idp-list.png">
</media>
</figure>
<p>Pour créer un utilisateur, cliquer sur le bouton « Créer un utilisateur ». Remplir les cases (login, mot de passe, date d'expiration, etc.) puis cliquer sur « Créer cet utilisateur ». C'est fait !</p>
<p>Un système de filtre permet d'afficher uniquement les comptes (login) suivant
un certain schéma. En indiquant "jour*" dans le champ de filtrage en haut à droite,
puis en cliquant sur "Filtrer", l'affichage de la liste ne présentera ensuite que
les logins qui commencent par les 4 lettres "jour".
</p>
<figure>
<title>Exemple de liste filtrée</title>
<media type="image" mime="image/png" src="figures/admin-idp-filter.png">
</media>
</figure>
<p>Le filtrage est persistant ; pour l'annuler il faut vider le champ "Filtre",
par exemple en cliquant sur la croix située à sa gauche, puis cliquer sur
"Filtrer".
</p>
</section>
<section id="create">
<title>Créer un utilisateur</title>
<p>Pour créer un utilisateur, cliquer sur le bouton « Créer un utilisateur ».
Indiquer un login, précisez la date d'expiration, puis cliquer sur le bouton
« Créer » en bas de page. C'est fait !</p>
<p><em>Note sur le mot de passe</em> : si vous n'en indiquez pas, un mot de
passe sera généré aléatoirement. Les mots de passe générés par le système sont
visibles lorsque vous affichez un utilisateur (seul ou dans une liste) et ils
sont présents dans l'export CSV des utilisateurs.</p>
<figure>
<title>Formulaire de création d'un compte sur l'IdP local</title>
<media type="image" mime="image/png" src="figures/admin-idp-6.png" >
<media type="image" mime="image/png" src="figures/admin-idp-create.png" >
</media>
</figure>
<p>Pour modifier un utilisateur existant, cliquer sur son login. Il est possible de modifier les informations du comptes (mot de passe, date d'expiration, description) mais aussi de le désactiver voire de le supprimer.</p>
</section>
<section id="create-group">
<title>Créer un ensemble d'utilisateurs</title>
<p>
La page de création d'un compte permet de créer un ensemble d'utilisateurs.
Ceux-ci auront un login de la forme "foobar-N" où N est un nombre.
</p>
<p>
Par exemple, pour créer 10 comptes de "journeefede-1" à "journeefede-10" il
faut demander la création de 10 comptes dont le premier numéro sera 1.
</p>
<figure>
<title>Création d'un groupe de 30 comptes confxyz-N</title>
<media type="image" mime="image/png" src="figures/admin-idp-create-group.png" >
</media>
</figure>
</section>
<section id="read">
<title>Afficher un utilisateur</title>
<p>Depuis la page d'accueil qui présente la liste des utilisateur, en cliquant
sur un des <em>logins</em> on affiche l'utilisateur correspondant. </p>
<p>Si le mot de passe de cet utilisateur a été généré automatiquement, il est
possible de le faire afficher via un simple clic (par défaut le mot de passe
n'est pas affiché pour éviter une éventuelle lecture "par dessus l'épaule" de
la personne qui gère les utilisateurs). </p>
<figure>
<title>Affichage d'un utilisateur seul</title>
<media type="image" mime="image/png" src="figures/admin-idp-read.png" >
</media>
</figure>
<p>A partir de la page d'affichage d'un utilisateur, on peut le modifier ou le
supprimer.</p>
</section>
<section id="update">
<title>Modifier un utilisateur</title>
<p>Pour modifier un utilisateur existant, cliquer sur son login. Il est
possible de modifier les informations du comptes (mot de passe, date
d'expiration, description) mais aussi de le désactiver voire de le
supprimer.</p>
<figure>
<title>Formulaire de modification ou suppression d'un compte sur l'IdP local</title>
<media type="image" mime="image/png" src="figures/admin-idp-7.png" >
<media type="image" mime="image/png" src="figures/admin-idp-update.png" >
</media>
</figure>
</section>
<section id="limitations">
<title>Limitations actuelles</title>
<section id="actions">
<title>Effectuer des actions sur plusieurs utilisateurs</title>
<p>Depuis la page d'accueil qui liste les utilisateurs, il est possible
d'effectuer des actions sur plusieurs utilisateurs d'un seul coup.</p>
<p>Ces limitations seront levées dans les prochaines versions ; la version actuelle permet d'abord de vérifier que tout se déploie bien.</p>
<p>Pour cela, il faut sélectionner les utilisateurs concernés en cliquant
sur la case à cocher à droite de leur ligne, puis choisir une action dans
la liste située en bas de l'écran, parmi :</p>
<list>
<item><p>L'interface ne permet pas de créer des comptes en masse, uniquement un par un.</p></item>
<item><p>La durée maximale des comptes est de 7 jours. Ce nombre n'est pas encore paramétrable dans l'interface de gestion pfSense ; cependant il est possiblede la modifier, en modifiant la ligne <code>IDP_UA_MAX_EXPIRES = 7</code> dans le fichier <code>/usr/local/univnautes/pfidp/settings.py</code> puis en relançant le service « univnautes_idp » depuis Status / Services/</p></item>
<item><p>Désactiver les utilisateurs choisis</p></item>
<item><p>Activer (ou ré-activer) les utilisateurs choisis</p></item>
<item><p>Supprimer les utilisateurs choisis</p></item>
<item><p>Afficher les utilisateurs choisis</p></item>
<item><p>Export en CSV</p></item>
</list>
<figure>
<title>Actions groupées disponibles</title>
<media type="image" mime="image/png" src="figures/admin-idp-actions.png" >
</media>
</figure>
<p>
<em>Note : </em> en utilisant le filtre présent en haut de la liste, on peut
rapidement sélectionner un groupe d'utilisateur avec des logins de la forme
"foobar-N" :</p>
<list type="numbered">
<item><p>indiquer "foobar-" (ou "foobar-*") dans le filter</p></item>
<item><p>cliquer sur la première case à cocher en haut de la liste : tous les comptes sont sélectionnés</p></item>
<item><p>choisir l'action à effectuer sur l'ensemble ainsi obtenu</p></item>
</list>
</section>
<section id="list">
<title>Afficher un ensemble d'utilisateurs</title>
<p>
L'action "Afficher les utilisateurs choisis" indiquée ci-dessus permet
d'obtenir un affichage d'un ensemble d'utilisateurs. Cet affichage est étudié
pour être imprimé, afin de distribuer des "tickets" aux utilisateurs.
</p>
<figure>
<title>Affichage d'une liste d'utilisateurs</title>
<media type="image" mime="image/png" src="figures/admin-idp-exporthtml.png" >
</media>
</figure>
<p>Rappel : seuls les mots de passe générés par le système sont affichés. Les
mots de passe indiqués lors de la création ou lors de l'import des utilisateurs
ne sont pas stockés en clair et ne sont donc pas affichables.</p>
</section>
<section id="export-import">
<title>Export ou import CSV</title>
<p>Voici un exemple du format de fichier CSV géré en import ou export :
</p>
<code>
"login","nom complet","expiration","mot de passe"
"joe","Joseph","2016-01-01","GxLGFP2"
"bar","Anne Honyme","2010-01-01",""
"team","","2014-07-22",""
</code>
<list>
<item><p>4 colonnes : login, nom complet, date d'expiration, mot de passe ;</p></item>
<item><p>date au format AAAA-MM-DD ;</p></item>
<item><p>séparateur : la virgule ;</p></item>
<item><p>codage UTF-8 ;</p></item>
<item><p>en import : si le mot de passe n'est pas fourni (vide), un mot de passe sera généré ;</p></item>
<item><p>en import : si l'utilisateur existe déjà, il sera mis à jour ;</p></item>
<item><p>la première ligne ne sera pas prise en compte.</p></item>
</list>
<section id="export">
<title>Exporter un ensemble d'utilisateurs</title>
<p>Pour exporter un ensemble d'utilisateurs sous la forme d'un fichier CSV,
utiliser l'action "Exporter en CSV" disponible en bas de la liste, sur la
page d'accueil.</p>
</section>
<section id="import">
<title>Importer un ensemble d'utilisateurs</title>
<p>
Pour importer un ensemble d'utilisateur, cliquer sur le bouton "Importer des utilisateurs" situé en haut
ou en bas de la page d'accueil.
</p>
<p>
Vous arriverez sur une page demandant un fichier et rappelant le format attendu.
</p>
<figure>
<title>Importer des utilisateurs</title>
<media type="image" mime="image/png" src="figures/admin-idp-import.png" >
</media>
</figure>
</section>
</section>
</page>