Préparer la mise en ligne de la console d'administration (#8)
README, section « Administration » : les écrans, les rôles à donner au compte de service portail-service — view-users, manage-users, view-events, view-clients, ceux du client master-realm puisque le compte vit dans master et administre master —, l'activation des événements de connexion, le journal, et la procédure de mise en ligne. Cette procédure commence par ISPConfig : en production, /admin/ est encore renvoyé par un ProxyPass vers l'ancienne application Flask (la réponse vient de gunicorn), d'où le 404 sur /admin/members.php. deploy.sh pousse bien web/admin, mais tant que ce ProxyPass reste, le PHP n'est pas atteint. .env.example : realm master et client portail-alpinux comme en production, JOURNAL_FILE et ROLES_SURVEILLES ; le secret du client OIDC qui y figurait est retiré. private/ est ignoré par git pour un portail lancé en local. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01V2csyno8m71DJFKYM1vgzV
This commit is contained in:
parent
b399db012c
commit
e761a3ff4e
3 changed files with 127 additions and 7 deletions
19
.env.example
19
.env.example
|
|
@ -1,13 +1,16 @@
|
|||
# ── Clé secrète PHP sessions ──────────────────────────────────────────
|
||||
SECRET_KEY=changez-moi-valeur-aleatoire-longue
|
||||
|
||||
# ── AlpID OIDC (client portail dans le realm alpinux) ─────────────────
|
||||
# ── AlpID OIDC ────────────────────────────────────────────────────────
|
||||
# En production : realm master, client portail-alpinux. Sans ALPID_REALM,
|
||||
# le code retombe sur « alpinux ».
|
||||
ALPID_BASE=https://alpid.alpinux.org
|
||||
ALPID_REALM=alpinux
|
||||
ALPID_CLIENT_ID=portail
|
||||
ALPID_CLIENT_SECRET=PortailAlpinux8281a984405f7c88d9b0
|
||||
ALPID_REALM=master
|
||||
ALPID_CLIENT_ID=portail-alpinux
|
||||
ALPID_CLIENT_SECRET=
|
||||
|
||||
# ── Keycloak Admin REST API — compte de service (realm master) ────────
|
||||
# Rôles à lui donner : voir README, « Administration ».
|
||||
KC_SERVICE_CLIENT_ID=portail-service
|
||||
KC_SERVICE_CLIENT_SECRET=
|
||||
|
||||
|
|
@ -35,6 +38,14 @@ ADHERENT_GROUP=adherents
|
|||
# Par défaut : /var/www/clients/client1/web16/../services.json (hors web root)
|
||||
SERVICES_FILE=/var/www/clients/client1/web16/private/services.json
|
||||
|
||||
# ── Console d'administration ──────────────────────────────────────────
|
||||
# Journal des gestes de la console (une ligne JSON par geste). Par défaut :
|
||||
# private/journal-console.jsonl, à côté de ce .env. Le dossier doit être
|
||||
# accessible en écriture à l'utilisateur PHP du site (web16).
|
||||
# JOURNAL_FILE=/var/www/clients/client1/web16/private/journal-console.jsonl
|
||||
# Rôles client pointés en tête de la fiche d'un compte (« client:rôle »).
|
||||
ROLES_SURVEILLES=messagerie:messagerie-admin,messagerie:messagerie-mailperso
|
||||
|
||||
# ── Déploiement (scripts/deploy.sh) ───────────────────────────────────
|
||||
PORTAIL_HOST=alpinux.org
|
||||
PORTAIL_PATH=/var/www/clients/client1/web16/web
|
||||
|
|
|
|||
2
.gitignore
vendored
2
.gitignore
vendored
|
|
@ -1,2 +1,4 @@
|
|||
.env
|
||||
web/inc/config.local.php
|
||||
# .env, journal et fichiers de données quand le portail tourne en local
|
||||
private/
|
||||
|
|
|
|||
113
README.md
113
README.md
|
|
@ -4,16 +4,123 @@ Portail membres de l'association Alpinux.
|
|||
|
||||
## Statut
|
||||
|
||||
Géré directement via **ISPConfig** sur le serveur. Le contenu de ce sous-domaine (Nextcloud, Dolibarr ou autre outil collaboratif) est installé et configuré côté serveur et n'est pas versioné dans ce dépôt.
|
||||
Site PHP sans dépendance, dans `web/`, servi par PHP-FPM sur le vhost
|
||||
ISPConfig `portail.alpinux.org` (web16) et déployé par `scripts/deploy.sh`.
|
||||
La configuration réelle est dans `private/.env` sur le serveur, hors dépôt
|
||||
(`.env.example` sert de modèle).
|
||||
|
||||
## Accès
|
||||
|
||||
- URL : https://portail.alpinux.org
|
||||
- Authentification : AlpID (SSO Keycloak — https://alpid.alpinux.org)
|
||||
|
||||
## Notes
|
||||
## Administration
|
||||
|
||||
Ce dossier est un espace réservé. Si un développement spécifique au portail est nécessaire (thème, plugin, scripts de déploiement), il sera ajouté ici.
|
||||
Une console, sous `/admin/`, pour vérifier et corriger un compte AlpID sans
|
||||
ouvrir la console Keycloak. Elle est réservée aux membres d'un groupe de
|
||||
`ADMIN_GROUPS` (par défaut `admins`), lu à la connexion dans la claim
|
||||
`groups` du userinfo — il faut donc un mappeur « Group Membership » (claim
|
||||
`groups`, sans le chemin complet) sur le client `portail-alpinux`. Un
|
||||
changement de groupe ne compte qu'à la connexion suivante.
|
||||
|
||||
### Les écrans
|
||||
|
||||
| Écran | Rôle |
|
||||
|---|---|
|
||||
| `members.php` | Recherche (`?q=`, identifiant, nom ou adresse), pagination par 50, validation et révocation d'adhésion. Chaque ligne mène à la fiche. |
|
||||
| `compte.php?id=<uuid>` | Fiche d'un compte : activé, adresse vérifiée, actions requises, OTP, groupes, rôles realm et client (directs et effectifs), sessions ouvertes, 20 derniers événements de connexion, gestes de la console sur ce compte. L'encadré « En bref » pointe les rôles de `ROLES_SURVEILLES` (par défaut `messagerie-admin` et `messagerie-mailperso` du client `messagerie`). |
|
||||
| | Gestes, tous en POST avec jeton CSRF : activer / désactiver, courriel « nouveau mot de passe » (`UPDATE_PASSWORD`), courriel de vérification d'adresse, retrait de l'OTP, fermeture de toutes les sessions, ajout à un groupe, retrait d'un groupe. Un administrateur ne peut ni se désactiver, ni se retirer d'un groupe administrateur ; fermer ses propres sessions demande une confirmation explicite. |
|
||||
| `groups.php` | Groupes Keycloak : création, suppression, services associés. |
|
||||
| `services.php` | Tuiles de services et groupes requis (`SERVICES_FILE`). |
|
||||
| `journal.php` | Les 200 derniers gestes de la console (`?compte=<uuid>` pour un seul compte). |
|
||||
|
||||
Pour le cas « reconnu, mais sans aucun droit » dans une application : la
|
||||
fiche dit si le compte est activé, s'il lui reste une action requise, et
|
||||
quels rôles il a **effectivement** sur le client de l'application, y compris
|
||||
ceux hérités d'un groupe. Pour la messagerie, seul `messagerie-admin` vient de
|
||||
Keycloak : les autres droits sont attribués dans la messagerie elle-même
|
||||
(`/droits`), que la fiche ne voit pas.
|
||||
|
||||
### Rôles du compte de service `portail-service`
|
||||
|
||||
La console appelle l'API d'administration avec le compte de service du client
|
||||
`portail-service` (`client_credentials` sur le realm master). Ce compte vit
|
||||
dans le realm **master** : ses droits sur un realm se donnent par les rôles du
|
||||
client `<realm>-realm` du realm master — **`master-realm`** pour administrer
|
||||
master lui-même, ce qui est le cas en production. C'est l'équivalent, pour un
|
||||
compte de master, des rôles `realm-management` d'un autre realm ; il n'y a pas
|
||||
de client `realm-management` dans master.
|
||||
|
||||
Dans la console Keycloak, realm master : *Clients* → `portail-service` →
|
||||
onglet *Service accounts roles* → *Assign role* → filtrer par clients →
|
||||
`master-realm`, et cocher :
|
||||
|
||||
| Rôle | Pour |
|
||||
|---|---|
|
||||
| `view-users` | lister, chercher et lire les comptes, leurs groupes, rôles, sessions et moyens d'authentification ; lister les groupes |
|
||||
| `manage-users` | tous les gestes de la fiche, valider / révoquer une adhésion, créer / supprimer un groupe ; aussi l'inscription et le profil des membres |
|
||||
| `view-events` | les derniers événements de connexion d'un compte et les réglages d'enregistrement |
|
||||
| `view-clients` | retrouver un client par son nom pour en lire les rôles effectifs (la messagerie, quand le compte n'y a aucun rôle direct) |
|
||||
|
||||
`query-groups` n'est pas nécessaire : `view-users` suffit à lister les
|
||||
groupes. Il ne faut le donner que si l'on retire `view-users`, ce qui
|
||||
priverait de toute façon la console de l'essentiel.
|
||||
|
||||
Un rôle manquant ne donne ni page blanche ni liste vide : l'écran affiche le
|
||||
refus (403) et nomme le rôle à ajouter.
|
||||
|
||||
### Événements de connexion
|
||||
|
||||
Keycloak n'enregistre les connexions que si on le lui demande. Dans le realm
|
||||
administré (master) : *Realm settings* → onglet *Events* → *User events
|
||||
settings* → activer *Save events*, choisir une *Expiration* (par exemple
|
||||
30 jours — ces événements portent l'adresse IP des membres, ne pas les garder
|
||||
plus que nécessaire), puis *Save*. Sans cela, la fiche l'indique au lieu
|
||||
d'afficher une liste vide.
|
||||
|
||||
Les courriels (mot de passe, vérification) partent du serveur d'envoi du
|
||||
realm : *Realm settings* → onglet *Email*. S'il n'est pas configuré, le geste
|
||||
échoue avec un message qui le dit.
|
||||
|
||||
### Journal de la console
|
||||
|
||||
Chaque geste ajoute une ligne JSON (date, administrateur, action, compte visé,
|
||||
détail, résultat, IP) dans `JOURNAL_FILE`, par défaut
|
||||
`private/journal-console.jsonl`, à côté du `.env`, hors racine web. Le dossier
|
||||
`private/` doit être accessible en écriture à l'utilisateur PHP du site. Si
|
||||
l'écriture échoue, le geste a lieu quand même et le message de retour le
|
||||
signale. Le fichier n'est pas tourné automatiquement.
|
||||
|
||||
### Mise en ligne
|
||||
|
||||
Aujourd'hui, `/admin/` ne mène pas au PHP : la réponse vient de **gunicorn**
|
||||
(l'ancienne application Flask de static.alpinux.org), et
|
||||
`/admin/members.php` y répond 404 alors que `/` est servi par Apache. Les
|
||||
directives Apache d'ISPConfig portent encore le `ProxyPass /admin/` dont
|
||||
`scripts/portail.alpinux.org.vhost.conf` demande le retrait. Déployer ne
|
||||
suffit donc pas. Dans l'ordre :
|
||||
|
||||
1. **Keycloak** : donner à `portail-service` les rôles ci-dessus, et activer
|
||||
l'enregistrement des événements.
|
||||
2. **ISPConfig** : *Sites* → `portail.alpinux.org` → onglet *Options* →
|
||||
*Apache Directives* : retirer les lignes `ProxyPass` / `ProxyPassReverse`
|
||||
de `/admin/`, enregistrer, attendre qu'ISPConfig ait réécrit le vhost
|
||||
(ne jamais modifier `/etc/apache2/sites-available/` à la main). Vérifier :
|
||||
`curl -sI https://portail.alpinux.org/admin/members.php` doit répondre
|
||||
`server: Apache` et une redirection vers `/auth/login.php`, et non plus
|
||||
`server: gunicorn`.
|
||||
3. **Configuration** : `private/.env` n'a besoin d'aucune variable nouvelle
|
||||
si les valeurs par défaut conviennent (`JOURNAL_FILE`,
|
||||
`ROLES_SURVEILLES`). Vérifier que `private/` est accessible en écriture à
|
||||
PHP.
|
||||
4. **Code** : `./scripts/deploy.sh -n` pour voir ce qui partira (le dossier
|
||||
`web/admin/`, `web/inc/journal.php`, `web/views/admin_nav.php` sont
|
||||
nouveaux), puis `./scripts/deploy.sh`.
|
||||
5. **Contrôle** : se connecter avec un compte du groupe `admins` (se
|
||||
reconnecter si on vient d'y entrer), ouvrir *Admin*, chercher un compte,
|
||||
ouvrir sa fiche : aucun bloc ne doit afficher de refus 403. Faire un geste
|
||||
sans conséquence (courriel de vérification à son propre compte) et
|
||||
vérifier qu'il apparaît dans *Journal*.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue