Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6b54fd524b |
109
README.md
109
README.md
@@ -115,7 +115,7 @@ Le dossier contient alors :
|
|||||||
## 4. Installer le plugin
|
## 4. Installer le plugin
|
||||||
|
|
||||||
Copier le dossier `openflyers-sso` dans `wp-content/plugins/`, ou televerser l'archive
|
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.
|
le plugin depuis l'administration WordPress.
|
||||||
|
|
||||||
## 5. Configurer
|
## 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
|
WordPress, section OpenFlyers. Mode recommande quand l'espace membres compte peu d'utilisateurs
|
||||||
ou quand les comptes existent deja.
|
ou quand les comptes existent deja.
|
||||||
- **Creation automatique** : tout membre qui se connecte via OpenFlyers obtient un compte WordPress
|
- **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
|
avec le role choisi. Le compte cree porte l'identifiant `of-<identifiant OpenFlyers>`. Son nom et
|
||||||
d'adresse e-mail tant que celle-ci n'est pas fournie (voir section 8).
|
son adresse e-mail sont renseignes si un rapport des coordonnees est configure (voir section 8).
|
||||||
|
|
||||||
## 6. Utiliser dans les pages
|
## 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
|
## 8. Recuperer le nom et l'e-mail du membre
|
||||||
|
|
||||||
Le scope `default.login` retourne uniquement l'identifiant interne OpenFlyers du membre. Pour
|
La connexion ne transmet que l'identifiant OpenFlyers du membre. Pour afficher son nom (dans les
|
||||||
alimenter le nom ou l'e-mail du compte WordPress, il faut creer un rapport dans OpenFlyers exposant
|
commentaires par exemple) et renseigner son e-mail, le plugin lit un rapport personnalise
|
||||||
ces donnees, autoriser le scope de lecture correspondant sur le client, puis brancher le filtre
|
OpenFlyers a chaque connexion. Aucun code n'est a ecrire.
|
||||||
`of_sso_user_profile` :
|
|
||||||
|
### 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
|
```php
|
||||||
add_filter('of_sso_scope', function () {
|
|
||||||
return 'default.login reports.readonly';
|
|
||||||
});
|
|
||||||
|
|
||||||
add_filter('of_sso_user_profile', function ($profile, $ofUserId, $token, $client) {
|
add_filter('of_sso_user_profile', function ($profile, $ofUserId, $token, $client) {
|
||||||
// 42 : identifiant du rapport OpenFlyers renvoyant les coordonnees des membres.
|
// $profile : first_name, last_name, user_email, display_name lus dans le rapport.
|
||||||
$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'] = ...;
|
|
||||||
|
|
||||||
return $profile;
|
return $profile;
|
||||||
}, 10, 4);
|
}, 10, 4);
|
||||||
```
|
```
|
||||||
|
|
||||||
Autres points d'extension :
|
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_client_config` : modifier la configuration du client avant chaque appel ;
|
||||||
- `of_sso_after_login` : action declenchee apres la connexion, avec l'utilisateur WordPress,
|
- `of_sso_after_login` : action declenchee apres la connexion, avec l'utilisateur WordPress,
|
||||||
l'identifiant OpenFlyers et le jeton.
|
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_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. |
|
| `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. |
|
| 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
|
## 10. Securite
|
||||||
|
|
||||||
@@ -311,7 +376,7 @@ php tests/smoke-test.php
|
|||||||
|
|
||||||
Le second verifie l'integration WordPress : activation du plugin, enregistrement des reglages,
|
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,
|
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 :
|
utilisateur. Il se lance depuis la racine du site :
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -325,7 +390,7 @@ le site explicitement :
|
|||||||
php wordpress-test.php /chemin/vers/le/site
|
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.
|
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,
|
Ces deux tests portent sur le plugin lui-meme. Pour verifier la configuration reelle d'un site,
|
||||||
|
|||||||
@@ -93,6 +93,9 @@ class OF_SSO_Admin
|
|||||||
$output[$key] = isset($input[$key]) ? trim(wp_strip_all_tags($input[$key])) : '';
|
$output[$key] = isset($input[$key]) ? trim(wp_strip_all_tags($input[$key])) : '';
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 0 means "no report": members then keep the technical name built from their identifier.
|
||||||
|
$output['profile_report_id'] = isset($input['profile_report_id']) ? absint($input['profile_report_id']) : 0;
|
||||||
|
|
||||||
$boolKeys = array('send_x_ssl_cert', 'auto_create', 'show_login_button', 'debug');
|
$boolKeys = array('send_x_ssl_cert', 'auto_create', 'show_login_button', 'debug');
|
||||||
foreach ($boolKeys as $key) {
|
foreach ($boolKeys as $key) {
|
||||||
$output[$key] = empty($input[$key]) ? 0 : 1;
|
$output[$key] = empty($input[$key]) ? 0 : 1;
|
||||||
@@ -192,6 +195,8 @@ class OF_SSO_Admin
|
|||||||
self::checkboxRow('auto_create', __('Creer automatiquement les comptes', 'openflyers-sso'), $settings['auto_create'], __('Si decoche, seuls les membres deja associes a un compte WordPress peuvent se connecter.', 'openflyers-sso'));
|
self::checkboxRow('auto_create', __('Creer automatiquement les comptes', 'openflyers-sso'), $settings['auto_create'], __('Si decoche, seuls les membres deja associes a un compte WordPress peuvent se connecter.', 'openflyers-sso'));
|
||||||
self::roleRow('default_role', __('Role des comptes crees', 'openflyers-sso'), $settings['default_role']);
|
self::roleRow('default_role', __('Role des comptes crees', 'openflyers-sso'), $settings['default_role']);
|
||||||
self::textRow('redirect_after_login', __('Page apres connexion', 'openflyers-sso'), $settings['redirect_after_login'], home_url('/espace-membres/'));
|
self::textRow('redirect_after_login', __('Page apres connexion', 'openflyers-sso'), $settings['redirect_after_login'], home_url('/espace-membres/'));
|
||||||
|
self::textRow('profile_report_id', __('Rapport des coordonnees des membres', 'openflyers-sso'), $settings['profile_report_id'] ? $settings['profile_report_id'] : '', '');
|
||||||
|
self::descriptionRow(__('Numero du rapport personnalise OpenFlyers qui renvoie le prenom, le nom et l\'e-mail du membre connecte (filtre sur $connectedPersonId). Ils sont alors mis a jour a chaque connexion. Laisser vide pour ne pas les recuperer.', 'openflyers-sso'));
|
||||||
self::checkboxRow('show_login_button', __('Bouton sur la page de connexion WordPress', 'openflyers-sso'), $settings['show_login_button'], '');
|
self::checkboxRow('show_login_button', __('Bouton sur la page de connexion WordPress', 'openflyers-sso'), $settings['show_login_button'], '');
|
||||||
self::checkboxRow('debug', __('Journalisation', 'openflyers-sso'), $settings['debug'], __('Ecrit les erreurs dans le journal PHP (error_log).', 'openflyers-sso'));
|
self::checkboxRow('debug', __('Journalisation', 'openflyers-sso'), $settings['debug'], __('Ecrit les erreurs dans le journal PHP (error_log).', 'openflyers-sso'));
|
||||||
?>
|
?>
|
||||||
|
|||||||
@@ -252,6 +252,80 @@ class OF_SSO_Client
|
|||||||
return $this->apiRequest($this->config['resource_uri'], $post, $token, false);
|
return $this->apiRequest($this->config['resource_uri'], $post, $token, false);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read the member's name and e-mail from an OpenFlyers custom report.
|
||||||
|
*
|
||||||
|
* The report filters on the reserved $connectedPersonId variable, which OpenFlyers replaces by the
|
||||||
|
* user of the access token: no member identifier is sent, so a member can only read their own row.
|
||||||
|
* It returns one row with the 'first_name', 'last_name' and 'email' columns. Requires the
|
||||||
|
* 'reports.readonly' scope.
|
||||||
|
*
|
||||||
|
* @param array $token Token array returned by exchangeCode().
|
||||||
|
* @param int $reportId Identifier of the custom report in OpenFlyers.
|
||||||
|
* @param int $ofUserId OpenFlyers identifier of the member, used in the error message only.
|
||||||
|
* @return array|false Profile with the first_name, last_name, user_email and display_name keys
|
||||||
|
* that the report provides, or false on failure.
|
||||||
|
*/
|
||||||
|
public function getMemberProfile(array $token, $reportId, $ofUserId)
|
||||||
|
{
|
||||||
|
$csv = $this->getReport($token, $reportId, 'report');
|
||||||
|
|
||||||
|
if (!is_string($csv)) {
|
||||||
|
$this->lastError = $this->lastError ? $this->lastError : 'Unexpected report response';
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$row = self::parseReportCsv($csv);
|
||||||
|
|
||||||
|
if (empty($row)) {
|
||||||
|
$this->lastError = 'The report returned no row for member ' . (int) $ofUserId;
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
$profile = array();
|
||||||
|
|
||||||
|
foreach (array('first_name' => 'first_name', 'last_name' => 'last_name', 'email' => 'user_email') as $column => $field) {
|
||||||
|
if (isset($row[$column]) and trim($row[$column]) !== '') {
|
||||||
|
$profile[$field] = trim($row[$column]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$displayName = trim((isset($profile['first_name']) ? $profile['first_name'] : '') . ' ' . (isset($profile['last_name']) ? $profile['last_name'] : ''));
|
||||||
|
|
||||||
|
if ($displayName !== '') {
|
||||||
|
$profile['display_name'] = $displayName;
|
||||||
|
}
|
||||||
|
|
||||||
|
return $profile;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return the first data row of a report exported by OpenFlyers, keyed by column name.
|
||||||
|
*
|
||||||
|
* OpenFlyers writes one header line, ';' as separator, '\n' as end of line, and replaces any ';'
|
||||||
|
* found in the data by ',' : a plain split is therefore exact.
|
||||||
|
*
|
||||||
|
* @param string $csv CSV text returned by the resource server.
|
||||||
|
* @return array Column name => value, empty when the report has no data row.
|
||||||
|
*/
|
||||||
|
public static function parseReportCsv($csv)
|
||||||
|
{
|
||||||
|
$lines = preg_split('/\r\n|\n/', trim((string) $csv, "\r\n"));
|
||||||
|
|
||||||
|
if (count($lines) < 2 or trim($lines[1]) === '') {
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
$header = array_map('trim', explode(';', $lines[0]));
|
||||||
|
$values = explode(';', $lines[1]);
|
||||||
|
|
||||||
|
if (count($header) !== count($values)) {
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
return array_combine($header, $values);
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Revoke a token on the authorization server.
|
* Revoke a token on the authorization server.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
* Plugin Name: OpenFlyers SSO
|
* Plugin Name: OpenFlyers SSO
|
||||||
* Plugin URI: https://openflyers.com
|
* Plugin URI: https://openflyers.com
|
||||||
* Description: Authentification des membres d'un espace prive WordPress avec leurs identifiants OpenFlyers (OAuth 2.0, mTLS et signature HTTP). Aucun mot de passe OpenFlyers n'est stocke sur le site.
|
* Description: Authentification des membres d'un espace prive WordPress avec leurs identifiants OpenFlyers (OAuth 2.0, mTLS et signature HTTP). Aucun mot de passe OpenFlyers n'est stocke sur le site.
|
||||||
* Version: 1.1.0
|
* Version: 1.2.0
|
||||||
* Author: OpenFlyers
|
* Author: OpenFlyers
|
||||||
* License: GPL-2.0-or-later
|
* License: GPL-2.0-or-later
|
||||||
* Text Domain: openflyers-sso
|
* Text Domain: openflyers-sso
|
||||||
@@ -19,7 +19,7 @@ if (!defined('ABSPATH')) {
|
|||||||
exit;
|
exit;
|
||||||
}
|
}
|
||||||
|
|
||||||
define('OF_SSO_VERSION', '1.1.0');
|
define('OF_SSO_VERSION', '1.2.0');
|
||||||
define('OF_SSO_FILE', __FILE__);
|
define('OF_SSO_FILE', __FILE__);
|
||||||
define('OF_SSO_PATH', plugin_dir_path(__FILE__));
|
define('OF_SSO_PATH', plugin_dir_path(__FILE__));
|
||||||
define('OF_SSO_OPTION', 'of_sso_settings');
|
define('OF_SSO_OPTION', 'of_sso_settings');
|
||||||
@@ -75,6 +75,7 @@ function of_sso_get_settings()
|
|||||||
'auto_create' => 0,
|
'auto_create' => 0,
|
||||||
'default_role' => 'subscriber',
|
'default_role' => 'subscriber',
|
||||||
'redirect_after_login' => '',
|
'redirect_after_login' => '',
|
||||||
|
'profile_report_id' => 0,
|
||||||
'show_login_button' => 1,
|
'show_login_button' => 1,
|
||||||
'debug' => 0,
|
'debug' => 0,
|
||||||
);
|
);
|
||||||
@@ -297,11 +298,15 @@ class OF_SSO_Auth
|
|||||||
self::STATE_TTL
|
self::STATE_TTL
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// Reading the member's name and e-mail from a report needs the custom reports scope.
|
||||||
|
$settings = of_sso_get_settings();
|
||||||
|
$scope = empty($settings['profile_report_id']) ? 'default.login' : 'default.login reports.readonly';
|
||||||
|
|
||||||
$url = $client->getAuthorizeUrl(
|
$url = $client->getAuthorizeUrl(
|
||||||
of_sso_get_redirect_uri(),
|
of_sso_get_redirect_uri(),
|
||||||
$state,
|
$state,
|
||||||
OF_SSO_Client::computeCodeChallenge($codeVerifier),
|
OF_SSO_Client::computeCodeChallenge($codeVerifier),
|
||||||
apply_filters('of_sso_scope', 'default.login')
|
apply_filters('of_sso_scope', $scope)
|
||||||
);
|
);
|
||||||
|
|
||||||
wp_redirect($url);
|
wp_redirect($url);
|
||||||
@@ -400,9 +405,12 @@ class OF_SSO_Auth
|
|||||||
)
|
)
|
||||||
);
|
);
|
||||||
|
|
||||||
// Extra data (name, e-mail, membership status) is not exposed by the 'default.login' scope.
|
/*
|
||||||
// Sites needing it hook this filter and feed it from an OpenFlyers report.
|
* Name and e-mail are not exposed by the 'default.login' scope. They come from the report set
|
||||||
$profile = apply_filters('of_sso_user_profile', array(), $ofUserId, $token, $client);
|
* in the settings, and sites needing more can still adjust them through this filter.
|
||||||
|
*/
|
||||||
|
$profile = apply_filters('of_sso_user_profile', self::fetchReportProfile($ofUserId, $token, $client), $ofUserId, $token, $client);
|
||||||
|
$profile = is_array($profile) ? $profile : array();
|
||||||
|
|
||||||
if (!empty($existing)) {
|
if (!empty($existing)) {
|
||||||
$user = $existing[0];
|
$user = $existing[0];
|
||||||
@@ -411,6 +419,8 @@ class OF_SSO_Auth
|
|||||||
return $user;
|
return $user;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$profile = self::withoutForeignEmail($profile, 0);
|
||||||
|
|
||||||
if (empty($settings['auto_create'])) {
|
if (empty($settings['auto_create'])) {
|
||||||
OF_SSO_Logger::log('No WordPress user linked to OpenFlyers id ' . $ofUserId);
|
OF_SSO_Logger::log('No WordPress user linked to OpenFlyers id ' . $ofUserId);
|
||||||
|
|
||||||
@@ -429,6 +439,8 @@ class OF_SSO_Auth
|
|||||||
'user_pass' => wp_generate_password(32, true, true),
|
'user_pass' => wp_generate_password(32, true, true),
|
||||||
'user_email' => $email,
|
'user_email' => $email,
|
||||||
'display_name' => !empty($profile['display_name']) ? $profile['display_name'] : $login,
|
'display_name' => !empty($profile['display_name']) ? $profile['display_name'] : $login,
|
||||||
|
'first_name' => !empty($profile['first_name']) ? $profile['first_name'] : '',
|
||||||
|
'last_name' => !empty($profile['last_name']) ? $profile['last_name'] : '',
|
||||||
'role' => $settings['default_role'],
|
'role' => $settings['default_role'],
|
||||||
)
|
)
|
||||||
);
|
);
|
||||||
@@ -440,11 +452,70 @@ class OF_SSO_Auth
|
|||||||
}
|
}
|
||||||
|
|
||||||
update_user_meta($userId, OF_SSO_USER_META, (string) $ofUserId);
|
update_user_meta($userId, OF_SSO_USER_META, (string) $ofUserId);
|
||||||
self::applyProfile($userId, $profile);
|
|
||||||
|
|
||||||
return get_user_by('id', $userId);
|
return get_user_by('id', $userId);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read the member's name and e-mail from the OpenFlyers report set in the settings.
|
||||||
|
*
|
||||||
|
* A failure never blocks the login: the member is logged in without these details.
|
||||||
|
*
|
||||||
|
* @param int $ofUserId OpenFlyers user identifier.
|
||||||
|
* @param array $token Token array.
|
||||||
|
* @param OF_SSO_Client $client Configured client.
|
||||||
|
* @return array Profile fields, empty when no report is set or when it could not be read.
|
||||||
|
*/
|
||||||
|
private static function fetchReportProfile($ofUserId, array $token, OF_SSO_Client $client)
|
||||||
|
{
|
||||||
|
$settings = of_sso_get_settings();
|
||||||
|
|
||||||
|
if (empty($settings['profile_report_id'])) {
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
$profile = $client->getMemberProfile($token, (int) $settings['profile_report_id'], $ofUserId);
|
||||||
|
|
||||||
|
if (!is_array($profile)) {
|
||||||
|
OF_SSO_Logger::log('Member report ' . (int) $settings['profile_report_id'] . ' could not be read: ' . $client->getLastError());
|
||||||
|
|
||||||
|
return array();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $profile;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Drop an e-mail address that is invalid or already used by another WordPress account.
|
||||||
|
*
|
||||||
|
* Two accounts cannot share an address in WordPress, and an account is never linked to a member
|
||||||
|
* on the strength of its e-mail address alone.
|
||||||
|
*
|
||||||
|
* @param array $profile Profile fields.
|
||||||
|
* @param int $userId WordPress user receiving the profile, 0 for an account about to be created.
|
||||||
|
* @return array
|
||||||
|
*/
|
||||||
|
private static function withoutForeignEmail(array $profile, $userId)
|
||||||
|
{
|
||||||
|
if (empty($profile['user_email'])) {
|
||||||
|
return $profile;
|
||||||
|
}
|
||||||
|
|
||||||
|
$email = sanitize_email($profile['user_email']);
|
||||||
|
$owner = is_email($email) ? email_exists($email) : false;
|
||||||
|
|
||||||
|
if (!is_email($email) or ($owner and (int) $owner !== (int) $userId)) {
|
||||||
|
OF_SSO_Logger::log('E-mail address of the member ignored: invalid or already used by another account');
|
||||||
|
unset($profile['user_email']);
|
||||||
|
|
||||||
|
return $profile;
|
||||||
|
}
|
||||||
|
|
||||||
|
$profile['user_email'] = $email;
|
||||||
|
|
||||||
|
return $profile;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Copy the optional profile fields onto the WordPress user.
|
* Copy the optional profile fields onto the WordPress user.
|
||||||
*
|
*
|
||||||
@@ -455,7 +526,7 @@ class OF_SSO_Auth
|
|||||||
private static function applyProfile($userId, array $profile)
|
private static function applyProfile($userId, array $profile)
|
||||||
{
|
{
|
||||||
$fields = array_intersect_key(
|
$fields = array_intersect_key(
|
||||||
$profile,
|
self::withoutForeignEmail($profile, $userId),
|
||||||
array_flip(array('user_email', 'display_name', 'first_name', 'last_name'))
|
array_flip(array('user_email', 'display_name', 'first_name', 'last_name'))
|
||||||
);
|
);
|
||||||
|
|
||||||
@@ -464,7 +535,11 @@ class OF_SSO_Auth
|
|||||||
}
|
}
|
||||||
|
|
||||||
$fields['ID'] = $userId;
|
$fields['ID'] = $userId;
|
||||||
wp_update_user($fields);
|
$result = wp_update_user($fields);
|
||||||
|
|
||||||
|
if (is_wp_error($result)) {
|
||||||
|
OF_SSO_Logger::log('Profile update failed for user ' . (int) $userId . ': ' . $result->get_error_message());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
@@ -1,9 +1,4 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
// Command-line only: this script rewrites settings and accounts, it must never run from a web request.
|
|
||||||
if (PHP_SAPI !== 'cli') {
|
|
||||||
exit;
|
|
||||||
}
|
|
||||||
/**
|
/**
|
||||||
* Smoke test for the WordPress plugin protocol client, run outside WordPress.
|
* Smoke test for the WordPress plugin protocol client, run outside WordPress.
|
||||||
* Checks the HTTP signature generation and the response verification (Digest + Signature)
|
* Checks the HTTP signature generation and the response verification (Digest + Signature)
|
||||||
@@ -180,5 +175,54 @@ check('an HTML certificate refusal is reported as a failure', $result === false)
|
|||||||
check('it is recognized as a certificate problem', $client->getLastErrorCode() === 'ssl_certificate_error');
|
check('it is recognized as a certificate problem', $client->getLastErrorCode() === 'ssl_certificate_error');
|
||||||
check('the reason reaches the error message', strpos($client->getLastError(), 'SSL certificate error') !== false);
|
check('the reason reaches the error message', strpos($client->getLastError(), 'SSL certificate error') !== false);
|
||||||
|
|
||||||
|
// --- member report (name and e-mail) ------------------------------------------
|
||||||
|
// Body exactly as the OpenFlyers resource server returns a custom report: the CSV text, JSON encoded.
|
||||||
|
$reportBody = '"first_name;last_name;email\nÉlodie;D\'Artagnan;elodie.test@example.org\n"';
|
||||||
|
$reportResp = "HTTP/1.1 200 OK\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n" . $reportBody;
|
||||||
|
$csv = $parse->invoke($client, $reportResp, $config['resource_uri'], false);
|
||||||
|
check('a report response is decoded to its CSV text', is_string($csv) && strpos($csv, 'first_name;') === 0);
|
||||||
|
|
||||||
|
$row = OF_SSO_Client::parseReportCsv($csv);
|
||||||
|
check('the report row is keyed by column name', $row === array('first_name' => 'Élodie', 'last_name' => "D'Artagnan", 'email' => 'elodie.test@example.org'));
|
||||||
|
check('a report without data row gives an empty row', OF_SSO_Client::parseReportCsv("first_name;last_name;email\n") === array());
|
||||||
|
check('an empty report gives an empty row', OF_SSO_Client::parseReportCsv("\n") === array());
|
||||||
|
check('a row that does not match the header is ignored', OF_SSO_Client::parseReportCsv("first_name;last_name\nA;B;C\n") === array());
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Client whose report call is answered locally, to check the mapping to WordPress fields.
|
||||||
|
*/
|
||||||
|
class OF_SSO_Report_Stub_Client extends OF_SSO_Client
|
||||||
|
{
|
||||||
|
public $answer;
|
||||||
|
public $lastCall;
|
||||||
|
|
||||||
|
public function getReport(array $token, $reportId, $resourceType = 'report', array $replacementList = array())
|
||||||
|
{
|
||||||
|
$this->lastCall = array($reportId, $resourceType, $replacementList);
|
||||||
|
return $this->answer;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$stub = new OF_SSO_Report_Stub_Client($config);
|
||||||
|
$stub->answer = $csv;
|
||||||
|
$profile = $stub->getMemberProfile(array('access_token' => 'abc'), 12, 24);
|
||||||
|
check('the report is called without any member identifier', $stub->lastCall === array(12, 'report', array()));
|
||||||
|
check('the profile maps to WordPress fields', $profile === array(
|
||||||
|
'first_name' => 'Élodie',
|
||||||
|
'last_name' => "D'Artagnan",
|
||||||
|
'user_email' => 'elodie.test@example.org',
|
||||||
|
'display_name' => "Élodie D'Artagnan",
|
||||||
|
));
|
||||||
|
|
||||||
|
$stub->answer = "first_name;last_name;email\nJean;MARTIN;\n";
|
||||||
|
$profile = $stub->getMemberProfile(array('access_token' => 'abc'), 12, 25);
|
||||||
|
check('an empty e-mail is left out', $profile === array('first_name' => 'Jean', 'last_name' => 'MARTIN', 'display_name' => 'Jean MARTIN'));
|
||||||
|
|
||||||
|
$stub->answer = "first_name;last_name;email\n";
|
||||||
|
check('a member missing from the report is a failure', $stub->getMemberProfile(array('access_token' => 'abc'), 12, 26) === false);
|
||||||
|
|
||||||
|
$stub->answer = false;
|
||||||
|
check('a refused report call is a failure', $stub->getMemberProfile(array('access_token' => 'abc'), 12, 24) === false);
|
||||||
|
|
||||||
echo $fail === 0 ? "\nAll checks passed.\n" : "\n$fail check(s) failed.\n";
|
echo $fail === 0 ? "\nAll checks passed.\n" : "\n$fail check(s) failed.\n";
|
||||||
exit($fail === 0 ? 0 : 1);
|
exit($fail === 0 ? 0 : 1);
|
||||||
|
|||||||
@@ -1,9 +1,4 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
// Command-line only: this script rewrites settings and accounts, it must never run from a web request.
|
|
||||||
if (PHP_SAPI !== 'cli') {
|
|
||||||
exit;
|
|
||||||
}
|
|
||||||
/**
|
/**
|
||||||
* Functional test of the plugin inside a real WordPress installation.
|
* Functional test of the plugin inside a real WordPress installation.
|
||||||
*
|
*
|
||||||
@@ -99,7 +94,7 @@ require_once ABSPATH . 'wp-admin/includes/template.php';
|
|||||||
require_once ABSPATH . 'wp-admin/includes/screen.php';
|
require_once ABSPATH . 'wp-admin/includes/screen.php';
|
||||||
|
|
||||||
// Remove anything left by a previous run so the script is repeatable.
|
// Remove anything left by a previous run so the script is repeatable.
|
||||||
foreach (array('pilote.test', 'of-7777', 'of-8888') as $login) {
|
foreach (array('pilote.test', 'of-7777', 'of-8888', 'of-9191', 'of-9292', 'of-9393') as $login) {
|
||||||
$stale = get_user_by('login', $login);
|
$stale = get_user_by('login', $login);
|
||||||
if ($stale) {
|
if ($stale) {
|
||||||
wp_delete_user($stale->ID);
|
wp_delete_user($stale->ID);
|
||||||
@@ -336,6 +331,68 @@ check('the profile filter fills the e-mail', $created->user_email === 'nouveau@e
|
|||||||
check('the profile filter fills the display name', $created->display_name === 'Nouveau Membre', $created->display_name);
|
check('the profile filter fills the display name', $created->display_name === 'Nouveau Membre', $created->display_name);
|
||||||
remove_all_filters('of_sso_user_profile');
|
remove_all_filters('of_sso_user_profile');
|
||||||
|
|
||||||
|
// --- member report (name and e-mail) ------------------------------------------
|
||||||
|
/**
|
||||||
|
* Client whose report call is answered locally, the way the OpenFlyers resource server answers: the
|
||||||
|
* row is the one of the token's user ($connectedPersonId), here carried by the test token.
|
||||||
|
*/
|
||||||
|
class OF_SSO_Report_Test_Client extends OF_SSO_Client
|
||||||
|
{
|
||||||
|
public $answers = array();
|
||||||
|
public $replacementLists = array();
|
||||||
|
|
||||||
|
public function getReport(array $token, $reportId, $resourceType = 'report', array $replacementList = array())
|
||||||
|
{
|
||||||
|
$this->replacementLists[] = $replacementList;
|
||||||
|
$memberId = isset($token['test_user_id']) ? $token['test_user_id'] : 0;
|
||||||
|
return isset($this->answers[$memberId]) ? $this->answers[$memberId] : false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$settings['profile_report_id'] = '12';
|
||||||
|
update_option('of_sso_settings', OF_SSO_Admin::sanitize($settings));
|
||||||
|
check('the report number is stored as an integer', of_sso_get_settings()['profile_report_id'] === 12);
|
||||||
|
|
||||||
|
$redirects = array();
|
||||||
|
$_GET = array('of_sso' => 'login');
|
||||||
|
capture(array('OF_SSO_Auth', 'route'));
|
||||||
|
parse_str((string) parse_url((string) end($redirects), PHP_URL_QUERY), $query);
|
||||||
|
check('the custom reports scope is requested once a report is set', $query['scope'] === 'default.login reports.readonly', $query['scope']);
|
||||||
|
$_GET = array();
|
||||||
|
|
||||||
|
$reportClient = new OF_SSO_Report_Test_Client(array());
|
||||||
|
$reportClient->answers = array(
|
||||||
|
9191 => "first_name;last_name;email\nÉlodie;D'Artagnan;elodie@example.test\n",
|
||||||
|
4242 => "first_name;last_name;email\nPaul;PILOTE;paul.pilote@example.test\n",
|
||||||
|
9292 => "first_name;last_name;email\nJean;MARTIN;paul.pilote@example.test\n",
|
||||||
|
);
|
||||||
|
|
||||||
|
$result = $resolve->invoke(null, 9191, array('test_user_id' => 9191), $reportClient);
|
||||||
|
$created = get_user_by('id', $result->ID);
|
||||||
|
check('a new member gets the name from the report', $created->first_name === 'Élodie' && $created->last_name === "D'Artagnan");
|
||||||
|
check('a new member is displayed under that name', $created->display_name === "Élodie D'Artagnan", $created->display_name);
|
||||||
|
check('a new member gets the e-mail from the report', $created->user_email === 'elodie@example.test', $created->user_email);
|
||||||
|
check('the login name stays technical', $created->user_login === 'of-9191');
|
||||||
|
|
||||||
|
$result = $resolve->invoke(null, 4242, array('test_user_id' => 4242), $reportClient);
|
||||||
|
$updated = get_user_by('id', $linkedId);
|
||||||
|
check('a linked member is updated at the next login', $updated->display_name === 'Paul PILOTE' && $updated->user_email === 'paul.pilote@example.test', $updated->display_name . ' ' . $updated->user_email);
|
||||||
|
|
||||||
|
$result = $resolve->invoke(null, 9292, array('test_user_id' => 9292), $reportClient);
|
||||||
|
check('an e-mail used by another account does not block the login', $result instanceof WP_User, is_wp_error($result) ? $result->get_error_message() : '');
|
||||||
|
$created = get_user_by('id', $result->ID);
|
||||||
|
check('that e-mail is not copied to the new account', $created->user_email === '', $created->user_email);
|
||||||
|
check('the name is still filled', $created->display_name === 'Jean MARTIN', $created->display_name);
|
||||||
|
|
||||||
|
$result = $resolve->invoke(null, 9393, array('test_user_id' => 9393), $reportClient);
|
||||||
|
check('an unreadable report does not block the login', $result instanceof WP_User, is_wp_error($result) ? $result->get_error_message() : '');
|
||||||
|
check('the member then keeps the technical name', get_user_by('id', $result->ID)->display_name === 'of-9393');
|
||||||
|
check('no member identifier is ever sent to the report', $reportClient->replacementLists === array(array(), array(), array(), array()), wp_json_encode($reportClient->replacementLists));
|
||||||
|
|
||||||
|
$settings['profile_report_id'] = '';
|
||||||
|
update_option('of_sso_settings', OF_SSO_Admin::sanitize($settings));
|
||||||
|
check('an empty report number disables the report', of_sso_get_settings()['profile_report_id'] === 0);
|
||||||
|
|
||||||
// --- shortcodes -------------------------------------------------------------
|
// --- shortcodes -------------------------------------------------------------
|
||||||
check('the login shortcode is registered', shortcode_exists('openflyers_login'));
|
check('the login shortcode is registered', shortcode_exists('openflyers_login'));
|
||||||
check('the member shortcode is registered', shortcode_exists('openflyers_membre'));
|
check('the member shortcode is registered', shortcode_exists('openflyers_membre'));
|
||||||
@@ -366,6 +423,7 @@ check('the settings page renders', strlen($page) > 1000, strlen($page) . ' bytes
|
|||||||
check('it shows the callback URL to declare', strpos($page, esc_html(of_sso_get_redirect_uri())) !== false);
|
check('it shows the callback URL to declare', strpos($page, esc_html(of_sso_get_redirect_uri())) !== false);
|
||||||
check('it exposes every certificate field', substr_count($page, 'of_sso_settings[') >= 15);
|
check('it exposes every certificate field', substr_count($page, 'of_sso_settings[') >= 15);
|
||||||
check('it offers the certificate folder field', strpos($page, 'name="of_sso_settings[cert_dir]"') !== false);
|
check('it offers the certificate folder field', strpos($page, 'name="of_sso_settings[cert_dir]"') !== false);
|
||||||
|
check('it offers the member report field', strpos($page, 'name="of_sso_settings[profile_report_id]"') !== false);
|
||||||
check('it offers the connection test button', strpos($page, 'name="of_sso_test_connection"') !== false);
|
check('it offers the connection test button', strpos($page, 'name="of_sso_test_connection"') !== false);
|
||||||
check('the stored secret is never printed back', strpos($page, 'value="secret"') === false);
|
check('the stored secret is never printed back', strpos($page, 'value="secret"') === false);
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user