398 lines
19 KiB
Markdown
398 lines
19 KiB
Markdown
# OpenFlyers SSO pour WordPress
|
|
|
|
Plugin d'authentification permettant aux membres d'un club de se connecter a un espace prive
|
|
WordPress avec leurs identifiants OpenFlyers. Le mot de passe est saisi sur OpenFlyers et n'est
|
|
jamais transmis ni stocke sur le site WordPress.
|
|
|
|
Le plugin implemente le flux `authorization_code` avec PKCE, l'authentification TLS mutuelle et la
|
|
signature HTTP exigees par le serveur d'autorisation OpenFlyers, ainsi que la verification de la
|
|
signature des reponses du serveur.
|
|
|
|
## Documentation
|
|
|
|
- Documentation publique, cote plateforme OpenFlyers :
|
|
<https://doc4-fr.openflyers.com/Plugin-WordPress>
|
|
- API OpenFlyers, procedures de declaration d'un client et d'emission des certificats :
|
|
<https://doc4-fr.openflyers.com/API-OpenFlyers>
|
|
|
|
Le present fichier decrit l'installation et l'exploitation du plugin cote WordPress. La
|
|
documentation publique decrit ce qui se passe cote OpenFlyers. Les deux se completent et se
|
|
referencent mutuellement.
|
|
|
|
## En bref
|
|
|
|
| Qui | Fait quoi |
|
|
| --- | --- |
|
|
| Le prestataire du site | Genere deux bi-cles et deux demandes de certificat sur le serveur (section 2), installe et configure le plugin (sections 4 et 5) |
|
|
| Le club (ou OpenFlyers) | Declare le client depuis l'administration de la plateforme, ce qui signe les deux demandes et delivre les certificats, le `client_id` et la passphrase (section 3) |
|
|
| Le club | Coche **Connexion depuis l'exterieur (OAuth2)** pour les profils concernes, puis associe chaque membre a son compte WordPress ou active la creation automatique (section 7) |
|
|
| Le membre | Clique sur "Se connecter avec OpenFlyers", saisit ses identifiants sur OpenFlyers, revient connecte sur le site |
|
|
|
|
Comptez une demi-journee pour une premiere mise en place, l'essentiel du temps etant l'echange des
|
|
certificats.
|
|
|
|
## 1. Prerequis
|
|
|
|
Sur l'hebergement WordPress :
|
|
|
|
- PHP 7.4 ou superieur, avec les extensions `curl` et `openssl` ;
|
|
- la possibilite d'utiliser un certificat client sortant (`CURLOPT_SSLCERT`). Certains hebergements
|
|
mutualises le bloquent : c'est le point a verifier en premier ;
|
|
- un emplacement de stockage hors de la racine web pour les cles privees ;
|
|
- le site accessible en HTTPS, avec une URL stable.
|
|
|
|
Cote OpenFlyers :
|
|
|
|
- un compte disposant des droits d'administration sur la plateforme du club ;
|
|
- le code plateforme (par exemple `acat-lfcl`) ;
|
|
- la case **Connexion depuis l'exterieur (OAuth2)** cochee pour les profils des membres concernes.
|
|
Sans elle, OpenFlyers refuse l'autorisation apres la saisie des identifiants, avec le message
|
|
*Connected user is not allowed to login*. Voir la section 7.
|
|
|
|
La procedure officielle de declaration d'un client est documentee sur le wiki OpenFlyers, chapitre
|
|
*Enregistrer un client* : <https://doc4-fr.openflyers.com/API-OpenFlyers>. Les sections 2 et 3
|
|
ci-dessous en donnent la version courte, limitee a ce dont ce plugin a besoin.
|
|
|
|
## 2. Generer les cles et les demandes de certificat
|
|
|
|
Deux bi-cles distinctes sont necessaires : une pour le TLS mutuel, une pour la signature HTTP.
|
|
Sur le serveur, dans un dossier hors de la racine web (ici `/home/site/of-certs`) :
|
|
|
|
```
|
|
openssl req -new -newkey rsa:2048 -nodes \
|
|
-keyout auth.key -out auth.csr \
|
|
-subj "/C=FR/O=Nom du club/CN=www.exemple.fr"
|
|
|
|
openssl req -new -newkey rsa:2048 -nodes \
|
|
-keyout sign.key -out sign.csr \
|
|
-subj "/C=FR/O=Nom du club/CN=www.exemple.fr"
|
|
|
|
chmod 600 auth.key sign.key
|
|
```
|
|
|
|
Conserver les deux fichiers `.key` a l'abri : ils ne doivent jamais quitter le serveur ni etre
|
|
accessibles depuis le web.
|
|
|
|
La procedure officielle (chapitre *Generer des certificats* du wiki) passe par des fichiers de
|
|
configuration `.conf` et produit des cles chiffrees, sans `-nodes`. Les deux approches conviennent :
|
|
si vous suivez celle du wiki, renseignez la passphrase des cles dans les reglages du plugin.
|
|
|
|
## 3. Declarer le client dans OpenFlyers
|
|
|
|
Dans OpenFlyers, **Admin > Transferts > Exports > API OAuth2**, bouton **Ajouter un client** :
|
|
|
|
- **Nom du client** : le nom du site WordPress ;
|
|
- **Type d'autorisation** : `authorization_code` (ajouter `refresh_token` pour des sessions longues) ;
|
|
- **URL de redirection** : l'URL affichee en haut de la page de reglages du plugin, typiquement
|
|
`https://www.exemple.fr/?of_sso=callback`. Elle doit correspondre au caractere pres ;
|
|
- **CSR TLS mutuel** : contenu de `auth.csr` ;
|
|
- **CSR signature HTTP** : contenu de `sign.csr`.
|
|
|
|
Apres validation, OpenFlyers renvoie les deux certificats signes (valables 3 ans), a enregistrer
|
|
sous `auth_cert.crt` et `sign_cert.crt` dans le meme dossier. Relever egalement le `client_id` et la
|
|
passphrase : **ils ne sont affiches qu'une seule fois**, et les regenerer invalide les precedents.
|
|
|
|
Cette declaration se fait entierement depuis l'administration de la plateforme : le club, ou son
|
|
prestataire s'il en a les droits, peut la realiser sans intervention d'OpenFlyers.
|
|
|
|
Deux fichiers supplementaires sont a demander a OpenFlyers et a deposer dans ce dossier :
|
|
|
|
- `ca.crt` : autorite de certification OpenFlyers ;
|
|
- `sign_cert_server.crt` : certificat avec lequel le serveur signe ses reponses.
|
|
|
|
Le dossier contient alors :
|
|
|
|
```
|
|
/home/site/of-certs/
|
|
├── auth.key
|
|
├── auth_cert.crt
|
|
├── sign.key
|
|
├── sign_cert.crt
|
|
├── ca.crt
|
|
└── sign_cert_server.crt
|
|
```
|
|
|
|
## 4. Installer le plugin
|
|
|
|
Copier le dossier `openflyers-sso` dans `wp-content/plugins/`, ou televerser l'archive
|
|
`openflyers-sso-1.2.0.zip` depuis Extensions > Ajouter > Televerser une extension. Activer ensuite
|
|
le plugin depuis l'administration WordPress.
|
|
|
|
## 5. Configurer
|
|
|
|
Reglages > OpenFlyers SSO. Trois choses a renseigner, pas davantage :
|
|
|
|
1. le code plateforme, le `client_id` et la passphrase ;
|
|
2. le **dossier des certificats**, un seul chemin absolu. Les six fichiers y sont retrouves par
|
|
leurs noms standard, ceux de la section 3. Si l'un d'eux porte un autre nom ou se trouve
|
|
ailleurs, depliez *Chemins personnalises (avance)* et indiquez-le individuellement ;
|
|
3. le mode de gestion des comptes.
|
|
|
|
### Verifier que tout fonctionne
|
|
|
|
Le bouton **Tester la connexion a OpenFlyers**, en haut de la page, envoie une vraie requete au
|
|
serveur avec un code d'autorisation volontairement invalide. Tout ce qui protege le point de
|
|
terminaison est donc traverse : certificat TLS, signature HTTP et identifiants du client. Seul le
|
|
code ne peut pas etre valide. Si la reponse ne reproche que le code, c'est que toute la chaine
|
|
d'authentification est acceptee, et le plugin l'annonce en clair.
|
|
|
|
C'est la verification decisive, et elle ne demande ni membre, ni navigateur, ni rendez-vous : elle
|
|
peut se faire des que les certificats sont en place. En cas d'echec, le message designe le maillon
|
|
en cause (certificat, signature, identifiants, ou type d'autorisation du client) plutot qu'un code
|
|
d'erreur brut.
|
|
|
|
Le bloc **Diagnostic** en bas de page complete cela hors ligne : extensions PHP, lisibilite des
|
|
fichiers, dates d'expiration, correspondance entre chaque certificat et sa cle, et permissions des
|
|
cles privees sur les serveurs qui les gerent.
|
|
|
|
### Gestion des comptes
|
|
|
|
Deux modes, selon ce que souhaite le club :
|
|
|
|
- **Comptes existants uniquement** (par defaut) : le membre doit deja avoir un compte WordPress
|
|
portant son identifiant OpenFlyers. Cet identifiant se saisit dans la fiche de l'utilisateur
|
|
WordPress, section OpenFlyers. Mode recommande quand l'espace membres compte peu d'utilisateurs
|
|
ou quand les comptes existent deja.
|
|
- **Creation automatique** : tout membre qui se connecte via OpenFlyers obtient un compte WordPress
|
|
avec le role choisi. Le compte cree porte l'identifiant `of-<identifiant OpenFlyers>`. Son nom et
|
|
son adresse e-mail sont renseignes si un rapport des coordonnees est configure (voir section 8).
|
|
|
|
## 6. Utiliser dans les pages
|
|
|
|
Bouton de connexion :
|
|
|
|
```
|
|
[openflyers_login]
|
|
[openflyers_login label="Acceder a l'espace membres" redirect="https://www.exemple.fr/espace-membres/"]
|
|
```
|
|
|
|
Contenu reserve aux membres :
|
|
|
|
```
|
|
[openflyers_membre]
|
|
Contenu visible uniquement par les membres connectes via OpenFlyers.
|
|
[/openflyers_membre]
|
|
```
|
|
|
|
Dans un theme :
|
|
|
|
```php
|
|
if (function_exists('of_sso_is_member') && of_sso_is_member()) {
|
|
// Contenu reserve.
|
|
}
|
|
|
|
echo '<a href="' . esc_url(of_sso_login_url()) . '">Se connecter</a>';
|
|
```
|
|
|
|
## 7. Au quotidien : gerer les acces
|
|
|
|
### Autoriser les membres cote OpenFlyers
|
|
|
|
Prealable indispensable, a faire une fois. Dans OpenFlyers, **Admin > Utilisateurs > Profils**,
|
|
onglet **Generalites** : cocher la case **Connexion depuis l'exterieur (OAuth2)** pour les profils
|
|
dont les membres doivent pouvoir se connecter au site (pilotes, eleves, instructeurs, selon le
|
|
club).
|
|
|
|
OpenFlyers verifie cette autorisation apres la saisie des identifiants. Un membre dont aucun profil
|
|
ne la porte voit sa connexion refusee avec *Connected user is not allowed to login*, meme si tout le
|
|
reste est correctement configure. C'est aussi le levier qui permet de restreindre l'espace membres a
|
|
une categorie d'adherents : seuls les profils coches ici accedent au site.
|
|
|
|
### Ce que vit le membre
|
|
|
|
Il clique sur le bouton de connexion, arrive sur la page de connexion OpenFlyers de la plateforme
|
|
du club, saisit ses identifiants habituels, et revient sur le site deja connecte. Il ne cree pas de
|
|
compte, ne choisit pas de mot de passe, et n'a rien a retenir de plus. La deconnexion se fait
|
|
normalement depuis WordPress ; elle ne le deconnecte pas d'OpenFlyers.
|
|
|
|
### Associer un membre a un compte WordPress
|
|
|
|
Necessaire uniquement si la creation automatique est desactivee.
|
|
|
|
1. Dans OpenFlyers, ouvrir la fiche du membre (administration des utilisateurs). Son identifiant
|
|
apparait dans l'URL de la fiche, dans le parametre `menuParameter`.
|
|
2. Dans WordPress, Utilisateurs > modifier l'utilisateur concerne, section **OpenFlyers**, saisir cet
|
|
identifiant et enregistrer.
|
|
|
|
Un identifiant ne peut etre associe qu'a un seul compte WordPress.
|
|
|
|
### Retirer un acces
|
|
|
|
Videz le champ **Identifiant du membre** dans la fiche WordPress de la personne : elle ne pourra
|
|
plus se connecter via OpenFlyers, sans que son compte WordPress soit supprime. Un membre radie du
|
|
club perd de toute facon l'acces des que son compte OpenFlyers est desactive, puisque
|
|
l'authentification se fait chez nous.
|
|
|
|
### Un membre n'arrive pas a se connecter
|
|
|
|
- **"Connected user is not allowed to login"**, affiche par OpenFlyers juste apres la saisie des
|
|
identifiants : le membre n'appartient a aucun profil ou la case **Connexion depuis l'exterieur
|
|
(OAuth2)** est cochee. Voir le
|
|
debut de cette section. C'est de loin la cause la plus frequente lors d'une premiere mise en
|
|
service.
|
|
- **"Aucun compte de ce site n'est associe a votre compte OpenFlyers"** : la liaison decrite
|
|
ci-dessus n'a pas ete faite, ou l'identifiant saisi n'est pas le bon.
|
|
- **"Session de connexion expiree ou invalide"** : le membre a mis plus de dix minutes a se
|
|
connecter, ou a utilise un vieil onglet. Il suffit de recommencer.
|
|
- **La page de connexion OpenFlyers refuse ses identifiants** : le probleme est cote OpenFlyers, pas
|
|
cote site. Verifier son compte dans la plateforme.
|
|
|
|
Pour tout le reste, activer la journalisation dans les reglages et consulter la section 9.
|
|
|
|
## 8. Recuperer le nom et l'e-mail du membre
|
|
|
|
La connexion ne transmet que l'identifiant OpenFlyers du membre. Pour afficher son nom (dans les
|
|
commentaires par exemple) et renseigner son e-mail, le plugin lit un rapport personnalise
|
|
OpenFlyers a chaque connexion. Aucun code n'est a ecrire.
|
|
|
|
### Cote OpenFlyers, une seule fois
|
|
|
|
**Gestion > Rapports > Rapports personnalises > Creer/Modifier**, bouton **Ajouter** :
|
|
|
|
- Intitule : *Mes coordonnees (site WordPress)*
|
|
- Requete SQL :
|
|
|
|
```sql
|
|
SELECT person.first_name, person.last_name, person.email
|
|
FROM person
|
|
WHERE person.id = $connectedPersonId
|
|
```
|
|
|
|
- **Visible pour les profils** : cocher les memes profils que ceux autorises a se connecter depuis
|
|
l'exterieur (section 7). Les profils ayant le droit de voir ou de gerer tous les rapports y ont
|
|
acces de toute facon.
|
|
|
|
L'acces suit la regle de l'interface web, appliquee a chaque profil que le membre peut choisir a
|
|
la connexion (un profil non selectionnable par l'utilisateur ne compte pas) : un membre dont un
|
|
profil est coche voit le rapport ; le droit de voir tous les rapports est retire, comme sur le web,
|
|
quand une validite expiree ou un solde insuffisant restreint ses droits ; un membre dont la
|
|
connexion a OpenFlyers est refusee ne voit aucun rapport.
|
|
- Valider, puis noter le **numero** du rapport, affiche dans la liste des rapports.
|
|
|
|
`$connectedPersonId` est une variable reservee : OpenFlyers la remplace par l'identifiant de la
|
|
personne qui execute le rapport (l'utilisateur du jeton pour le plugin, l'utilisateur connecte dans
|
|
OpenFlyers). Il n'y a aucun champ metier a creer pour elle, et elle ne peut pas etre saisie : un
|
|
champ metier qui porterait ce nom serait ignore.
|
|
|
|
Les noms de colonnes `first_name`, `last_name` et `email` sont attendus tels quels. Une colonne
|
|
absente est simplement ignoree : un rapport sans `email` ne renseigne que le nom.
|
|
|
|
### Cote WordPress
|
|
|
|
Reglages > OpenFlyers SSO, champ **Rapport des coordonnees des membres** : saisir le numero du
|
|
rapport et enregistrer. Le plugin demande alors en plus le scope `reports.readonly` a la connexion.
|
|
|
|
A chaque connexion, le prenom, le nom, le nom affiche et l'e-mail du compte WordPress sont mis a
|
|
jour depuis OpenFlyers :
|
|
|
|
- un nouveau membre les recoit des sa premiere connexion ;
|
|
- un compte existant, cree avant la mise en place du rapport, est mis a jour a sa connexion
|
|
suivante ;
|
|
- l'identifiant de connexion WordPress reste `of-<identifiant>` : WordPress ne permet pas de le
|
|
modifier, mais c'est le nom affiche qui apparait sur le site ;
|
|
- une adresse e-mail deja utilisee par un autre compte WordPress n'est pas recopiee, car WordPress
|
|
impose une adresse unique par compte ;
|
|
- si le rapport ne peut pas etre lu, la connexion se fait quand meme, sans ces informations. La
|
|
cause est ecrite dans le journal PHP lorsque la journalisation est activee.
|
|
|
|
OpenFlyers est la source de ces informations : une modification faite dans WordPress est remplacee
|
|
a la connexion suivante.
|
|
|
|
### Confidentialite
|
|
|
|
Le rapport n'expose que les donnees choisies dans sa requete, et seulement celles de la personne
|
|
qui l'execute : le plugin n'envoie aucun identifiant, et `$connectedPersonId` ne peut pas etre
|
|
remplace par une valeur de la requete. Un membre qui ouvre le rapport dans OpenFlyers, ou qui
|
|
l'appelle avec son propre jeton, ne voit que ses propres coordonnees.
|
|
|
|
Ne pas filtrer le rapport sur une variable saisissable (un champ metier comme `$memberId`) : tout
|
|
profil coche pourrait alors lire les coordonnees de n'importe quel membre.
|
|
|
|
Le scope `reports.readonly` donne au site un jeton qui peut lire tous les rapports personnalises
|
|
visibles par le membre, pas seulement celui-ci : pour un membre ayant le droit de voir tous les
|
|
rapports (bureau, administrateur), ce sont tous les rapports du club. Le plugin ne lit que le rapport
|
|
renseigne, mais le jeton est aussi transmis a l'action `of_sso_after_login` : n'y brancher que du code
|
|
de confiance.
|
|
|
|
### Aller plus loin
|
|
|
|
Le filtre `of_sso_user_profile` recoit les champs lus dans le rapport et peut les completer ou les
|
|
modifier avant leur enregistrement :
|
|
|
|
```php
|
|
add_filter('of_sso_user_profile', function ($profile, $ofUserId, $token, $client) {
|
|
// $profile : first_name, last_name, user_email, display_name lus dans le rapport.
|
|
return $profile;
|
|
}, 10, 4);
|
|
```
|
|
|
|
Autres points d'extension :
|
|
|
|
- `of_sso_scope` : modifier les scopes demandes a la connexion ;
|
|
- `of_sso_client_config` : modifier la configuration du client avant chaque appel ;
|
|
- `of_sso_after_login` : action declenchee apres la connexion, avec l'utilisateur WordPress,
|
|
l'identifiant OpenFlyers et le jeton.
|
|
|
|
## 9. Depannage
|
|
|
|
Commencez par le bouton **Tester la connexion a OpenFlyers** (section 5) : il nomme le maillon en
|
|
cause. Pour aller plus loin, activez la journalisation dans les reglages et consultez le journal
|
|
PHP du site, ou vous retrouverez le message exact renvoye par le serveur.
|
|
|
|
| Message renvoye par OpenFlyers | Cause probable |
|
|
| --- | --- |
|
|
| `invalid_client` | `client_id` errone, ou client non declare sur cette plateforme. |
|
|
| `invalid_certificate` | Le certificat TLS envoye ne correspond pas a celui enregistre. Si les certificats sont corrects, l'hebergeur termine probablement le TLS sur un proxy : activer l'option `X-SSL-CERT`. |
|
|
| `invalid_request` / `Invalid signature` | Signature HTTP invalide : mauvaise cle de signature, ou horloge du serveur desynchronisee. Verifier la synchronisation NTP. |
|
|
| `invalid_grant` | Code d'autorisation expire (10 minutes) ou `redirect_uri` different de celui declare dans OpenFlyers. |
|
|
| Erreur cURL 58 / 35 | Cle privee illisible par PHP, ou certificat client refuse lors de la negociation TLS. |
|
|
| `Report access denied` (rapport des coordonnees) | Aucun profil selectionnable du membre n'est coche dans **Visible pour les profils** du rapport (section 8), OpenFlyers refuse sa connexion (par exemple une validite expiree reglee sur « pas d'acces »), ou le numero saisi dans **Rapport des coordonnees des membres** ne correspond a aucun rapport personnalise. |
|
|
| `Requested report was not found` | Le numero saisi ne correspond a aucun rapport personnalise (message vu seulement par les profils ayant le droit de voir tous les rapports). |
|
|
| `The report returned no row for member ...` | La requete du rapport ne filtre pas sur `$connectedPersonId` (section 8), ou OpenFlyers n'est pas encore a jour. |
|
|
|
|
## 10. Securite
|
|
|
|
- Les cles privees restent hors de la racine web, en permissions `600`.
|
|
- La passphrase du client est stockee dans les options WordPress : la base de donnees du site doit
|
|
etre protegee au meme titre qu'un secret applicatif.
|
|
- Le parametre `state` et le PKCE sont verifies a chaque connexion ; une demande non aboutie expire
|
|
au bout de 10 minutes.
|
|
- La signature et l'empreinte des reponses du serveur sont verifiees avant exploitation du jeton.
|
|
- En cas de compromission, revoquer le client dans l'administration OpenFlyers : les certificats
|
|
emis pour ce client cessent immediatement d'etre acceptes.
|
|
|
|
## 11. Tests
|
|
|
|
Deux tests sont fournis, aucun ne contacte de serveur.
|
|
|
|
Le premier verifie le protocole : generation PKCE, URL d'autorisation, signature HTTP, et rejet des
|
|
reponses alterees (empreinte ou signature invalide, statut HTTP en erreur). Il genere son propre
|
|
certificat et fonctionne sans WordPress, ce qui permet de valider l'installation PHP de
|
|
l'hebergement avant meme de configurer le client :
|
|
|
|
```
|
|
php tests/smoke-test.php
|
|
```
|
|
|
|
Le second verifie l'integration WordPress : activation du plugin, enregistrement des reglages,
|
|
resolution du dossier de certificats, demarrage de la connexion, rejet d'un retour invalide,
|
|
association des comptes, lecture du nom et de l'e-mail depuis le rapport, shortcodes, page de reglages et champ de liaison dans la fiche
|
|
utilisateur. Il se lance depuis la racine du site :
|
|
|
|
```
|
|
php wp-content/plugins/openflyers-sso/tests/wordpress-test.php
|
|
```
|
|
|
|
Si le dossier du plugin est un lien symbolique vers une copie de travail situee ailleurs, indiquez
|
|
le site explicitement :
|
|
|
|
```
|
|
php wordpress-test.php /chemin/vers/le/site
|
|
```
|
|
|
|
Il cree ses propres comptes de test (`pilote.test`, `of-7777`, `of-8888`, `of-9191`, `of-9292`, `of-9393`) et les supprime a chaque
|
|
execution. A ne pas lancer sur le site de production.
|
|
|
|
Ces deux tests portent sur le plugin lui-meme. Pour verifier la configuration reelle d'un site,
|
|
c'est le bouton **Tester la connexion a OpenFlyers** de la page de reglages qu'il faut utiliser.
|