OpenFlyers SSO WordPress plugin 1.2.0
Read the member name and email from a custom report (profile_report_id).
This commit is contained in:
109
README.md
109
README.md
@@ -115,7 +115,7 @@ Le dossier contient alors :
|
||||
## 4. Installer le plugin
|
||||
|
||||
Copier le dossier `openflyers-sso` dans `wp-content/plugins/`, ou televerser l'archive
|
||||
`openflyers-sso-1.1.0.zip` depuis Extensions > Ajouter > Televerser une extension. Activer ensuite
|
||||
`openflyers-sso-1.2.0.zip` depuis Extensions > Ajouter > Televerser une extension. Activer ensuite
|
||||
le plugin depuis l'administration WordPress.
|
||||
|
||||
## 5. Configurer
|
||||
@@ -154,8 +154,8 @@ Deux modes, selon ce que souhaite le club :
|
||||
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>` et n'a pas
|
||||
d'adresse e-mail tant que celle-ci n'est pas fournie (voir section 8).
|
||||
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
|
||||
|
||||
@@ -241,32 +241,94 @@ Pour tout le reste, activer la journalisation dans les reglages et consulter la
|
||||
|
||||
## 8. Recuperer le nom et l'e-mail du membre
|
||||
|
||||
Le scope `default.login` retourne uniquement l'identifiant interne OpenFlyers du membre. Pour
|
||||
alimenter le nom ou l'e-mail du compte WordPress, il faut creer un rapport dans OpenFlyers exposant
|
||||
ces donnees, autoriser le scope de lecture correspondant sur le client, puis brancher le filtre
|
||||
`of_sso_user_profile` :
|
||||
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_scope', function () {
|
||||
return 'default.login reports.readonly';
|
||||
});
|
||||
|
||||
add_filter('of_sso_user_profile', function ($profile, $ofUserId, $token, $client) {
|
||||
// 42 : identifiant du rapport OpenFlyers renvoyant les coordonnees des membres.
|
||||
$report = $client->getReport($token, 42, 'report', array('userId' => $ofUserId));
|
||||
|
||||
// Adapter l'extraction aux colonnes du rapport.
|
||||
// $profile['user_email'] = ...;
|
||||
// $profile['first_name'] = ...;
|
||||
// $profile['last_name'] = ...;
|
||||
// $profile['display_name'] = ...;
|
||||
|
||||
// $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.
|
||||
@@ -284,6 +346,9 @@ PHP du site, ou vous retrouverez le message exact renvoye par le serveur.
|
||||
| `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
|
||||
|
||||
@@ -311,7 +376,7 @@ 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, shortcodes, page de reglages et champ de liaison dans la fiche
|
||||
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 :
|
||||
|
||||
```
|
||||
@@ -325,7 +390,7 @@ le site explicitement :
|
||||
php wordpress-test.php /chemin/vers/le/site
|
||||
```
|
||||
|
||||
Il cree ses propres comptes de test (`pilote.test`, `of-7777`, `of-8888`) et les supprime a chaque
|
||||
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,
|
||||
|
||||
Reference in New Issue
Block a user