Ajoutez l’authentification à votre application web PHP

Ce guide vous montrera comment intégrer Logto dans votre application web PHP.

astuce

L' exemple utilise Laravel, mais les concepts sont les mêmes pour d'autres frameworks.

Prérequis

Un compte Logto Cloud ou un Logto auto-hébergé (Consultez le guide Introduction pour en créer un si vous n'en avez pas).
Une application web traditionnelle Logto créée.

Installation

composer require logto/sdk

Intégration

Initialiser LogtoClient

Tout d'abord, créez une configuration Logto :

index.php
use Logto\Sdk\LogtoClient;
use Logto\Sdk\LogtoConfig;

$client = new LogtoClient(
  new LogtoConfig(
    endpoint: "https://you-logto-endpoint.app",
    appId: "replace-with-your-app-id",
    appSecret: "replace-with-your-app-secret",
  ),
);

astuce

Vous pouvez trouver et copier le "Secret de l'application" depuis la page des détails de l'application dans la Console d'administration :

Par défaut, le SDK utilise la session PHP intégrée pour stocker les données Logto. Si vous souhaitez utiliser un autre stockage, vous pouvez passer un objet de stockage personnalisé en tant que deuxième paramètre :

index.php
$client = new LogtoClient(
  new LogtoConfig(
    // ...
  ),
  new YourCustomStorage(),
);

Voir Storage pour plus de détails.

Configurer les URIs de redirection

Avant de plonger dans les détails, voici un aperçu rapide de l'Expérience utilisateur. Le processus de connexion peut être simplifié comme suit :

Votre application lance la méthode de connexion.
L'utilisateur est redirigé vers la page de connexion Logto. Pour les applications natives, le navigateur système est ouvert.
L'utilisateur se connecte et est redirigé vers votre application (configurée comme l'URI de redirection).

Concernant la connexion basée sur la redirection

Ce processus d'authentification (Authentication) suit le protocole OpenID Connect (OIDC), et Logto applique des mesures de sécurité strictes pour protéger la connexion utilisateur.
Si vous avez plusieurs applications, vous pouvez utiliser le même fournisseur d’identité (Logto). Une fois que l'utilisateur se connecte à une application, Logto complétera automatiquement le processus de connexion lorsque l'utilisateur accède à une autre application.

Pour en savoir plus sur la logique et les avantages de la connexion basée sur la redirection, consultez Expérience de connexion Logto expliquée.

remarque

Dans les extraits de code suivants, nous supposons que votre application fonctionne sur http://localhost:3000/.

Configurer les URIs de redirection

Passez à la page des détails de l'application de Logto Console. Ajoutez une URI de redirection http://localhost:3000/callback.

Tout comme pour la connexion, les utilisateurs doivent être redirigés vers Logto pour se déconnecter de la session partagée. Une fois terminé, il serait idéal de rediriger l'utilisateur vers votre site web. Par exemple, ajoutez http://localhost:3000/ comme section d'URI de redirection après déconnexion.

Ensuite, cliquez sur "Enregistrer" pour sauvegarder les modifications.

Gérer le rappel

Après que l'utilisateur se soit connecté, Logto redirigera l'utilisateur vers l'URL de rappel que vous avez définie dans la Logto Console. Dans cet exemple, nous utilisons /callback comme URL de rappel :

Route::get('/callback', function () {
  try {
    $client->handleSignInCallback(); // Gérer beaucoup de choses
  } catch (\Throwable $exception) {
    return $exception; // Changez ceci pour votre logique de gestion des erreurs
  }
  return redirect('/'); // Rediriger l'utilisateur vers la page d'accueil après une connexion réussie
});

Implémenter la route de connexion

Dans votre application web, ajoutez une route pour gérer correctement la requête de connexion des utilisateurs. Par exemple :

Route::get('/sign-in', function () {
return redirect($client->signIn('http://localhost:3000/callback'));
});

Remplacez http://localhost:3000/callback par l'URL de rappel que vous avez définie dans votre Logto Console pour cette application.

Si vous souhaitez afficher la page d'inscription sur le premier écran, vous pouvez définir interactionMode sur signUp :

Route::get('/sign-in', function () {
return redirect($client->signIn('http://localhost:3000/callback', InteractionMode::signUp));
});

Désormais, chaque fois que vos utilisateurs visitent http://localhost:3000/sign-in, cela lancera une nouvelle tentative de connexion et redirigera l'utilisateur vers la page de connexion Logto.

Remarque Créer une route de connexion n'est pas le seul moyen de lancer une tentative de connexion. Vous pouvez toujours utiliser la méthode signIn pour obtenir l'URL de connexion et y rediriger l'utilisateur.

Implémenter la route de déconnexion

Après que l'utilisateur ait fait une demande de déconnexion, Logto effacera toutes les informations d'authentification (Authentication) de l'utilisateur dans la session.

Pour nettoyer la session PHP et la session Logto, une route de déconnexion peut être implémentée comme suit :

Route::get('/sign-out', function () {
return redirect(
  // Rediriger l'utilisateur vers la page d'accueil après une déconnexion réussie
  $client->signOut('http://localhost:3000/')
);
});

postLogoutRedirectUri est facultatif, et s'il n'est pas fourni, l'utilisateur sera redirigé vers une page par défaut de Logto après une déconnexion réussie (sans être redirigé vers votre application).

Remarque Le nom postLogoutRedirectUri provient de la spécification OpenID Connect RP-Initiated Logout. Bien que Logto utilise "déconnexion" au lieu de "logout", le concept est le même.

Gérer le statut d'authentification

Dans le SDK Logto, nous pouvons utiliser $client->isAuthenticated() pour vérifier le statut d'authentification. Si l'utilisateur est connecté, la valeur sera vraie, sinon, la valeur sera fausse.

Nous devons également implémenter une page d'accueil pour la démonstration :

Si l'utilisateur n'est pas connecté, afficher un bouton de connexion ;
Si l'utilisateur est connecté, afficher un bouton de déconnexion.

Route::get('/', function () {
  if ($client->isAuthenticated() === false) {
    return "Non authentifié <a href='/sign-in'>Se connecter</a>";
  }

  return "<a href='/sign-out'>Se déconnecter</a>";
});

Point de contrôle : Testez votre application

Maintenant, vous pouvez tester votre application :

Exécutez votre application, vous verrez le bouton de connexion.
Cliquez sur le bouton de connexion, le SDK initiera le processus de connexion et vous redirigera vers la page de connexion Logto.
Après vous être connecté, vous serez redirigé vers votre application et verrez le bouton de déconnexion.
Cliquez sur le bouton de déconnexion pour effacer le stockage local et vous déconnecter.

Obtenir des informations sur l'utilisateur

Afficher les informations de l'utilisateur

Pour afficher les informations de l'utilisateur, vous pouvez utiliser soit la méthode getIdTokenClaims, soit la méthode fetchUserInfo pour obtenir les informations de l'utilisateur. Alors que getIdTokenClaims renvoie les informations de l'utilisateur contenues dans le jeton d’identifiant, fetchUserInfo récupère les informations de l'utilisateur à partir du point de terminaison userinfo.

index.php
Route::get('/userinfo', function () {
  if ($client->isAuthenticated() === false) {
    return "Non authentifié <a href='/sign-in'>Se connecter</a>";
  }

  return (
    // Obtenir les revendications du jeton d’identifiant local
    json_decode($client->getIdTokenClaims())
    . "<br>"
    // Récupérer les informations de l'utilisateur à partir du point de terminaison userinfo de Logto
    json_decode($client->fetchUserInfo())
  );
});

Nos modèles de données sont basés sur JsonModel, qui accepte sans risque les clés non définies lors de l'encodage ou du décodage JSON.

Notez qu'un champ (revendication) avec une valeur null ne signifie pas que le champ est défini. La raison peut être que la portée liée n'est pas demandée, ou que l'utilisateur n'a pas le champ.

Par exemple, si nous n'avons pas demandé la portée email lors de la connexion, le champ email sera null. Cependant, si nous avons demandé la portée email, le champ email sera l'adresse e-mail de l'utilisateur si elle est disponible.

Demander des revendications supplémentaires

Il se peut que certaines informations utilisateur soient manquantes dans l'objet retourné par getIdTokenClaims. Cela est dû au fait que OAuth 2.0 et OpenID Connect (OIDC) sont conçus pour suivre le principe du moindre privilège (PoLP), et Logto est construit sur ces normes.

Par défaut, des revendications limitées sont retournées. Si vous avez besoin de plus d'informations, vous pouvez demander des portées supplémentaires pour accéder à plus de revendications.

info

Une "revendication" est une assertion faite à propos d'un sujet ; une "portée" est un groupe de revendications. Dans le cas actuel, une revendication est une information sur l'utilisateur.

Voici un exemple non normatif de la relation portée - revendication :

astuce

La revendication "sub" signifie "sujet", qui est l'identifiant unique de l'utilisateur (c'est-à-dire l'ID utilisateur).

Le SDK Logto demandera toujours trois portées : openid, profile et offline_access.

Pour demander des portées supplémentaires, vous pouvez configurer l'option scopes lors de l'initialisation du client Logto :

index.php
$client = new LogtoClient(
  new LogtoConfig(
    // ...autres configurations
    scopes: ["email", "phone"], // Mettez à jour selon vos besoins
  ),
);

Alternativement, vous pouvez utiliser l'énumération UserScope pour ajouter des portées :

index.php
use Logto\Sdk\Constants\UserScope;

$client = new LogtoClient(
  new LogtoConfig(
    // ...autres configurations
    scopes: [UserScope::email, UserScope::phone], // Mettez à jour selon vos besoins
  ),
);

Ensuite, les revendications supplémentaires seront disponibles dans la valeur de retour de getIdTokenClaims ou fetchUserInfo.

Revendications nécessitant des requêtes réseau

Pour éviter de surcharger le jeton d’identifiant (ID token), certaines revendications nécessitent des requêtes réseau pour être récupérées. Par exemple, la revendication custom_data n'est pas incluse dans l'objet utilisateur même si elle est demandée dans les portées. Pour accéder à ces revendications, vous pouvez utiliser la méthode fetchUserInfo :

index.php
$client->fetchUserInfo()->custom_data;

Cette méthode récupérera les informations de l'utilisateur en faisant une requête à l' point de terminaison userinfo. Pour en savoir plus sur les portées et revendications disponibles, consultez la section Portées et revendications.

Portées et revendications

Logto utilise les conventions de portées et revendications OIDC pour définir les Portées et Revendications pour récupérer les informations utilisateur à partir du Jeton d’identifiant et du point de terminaison OIDC userinfo. Les termes "Portée" et "Revendication" proviennent des spécifications OAuth 2.0 et OpenID Connect (OIDC).

Voici la liste des Portées (Scopes) prises en charge et les Revendications (Claims) correspondantes :

openid

Nom de la revendication	Type	Description	Besoin d'userinfo ?
sub	`string`	L'identifiant unique de l'utilisateur	Non

profile

Nom de la revendication	Type	Description	Besoin d'userinfo ?
name	`string`	Le nom complet de l'utilisateur	Non
username	`string`	Le nom d'utilisateur de l'utilisateur	Non
picture	`string`	URL de la photo de profil de l'utilisateur final. Cette URL DOIT faire référence à un fichier image (par exemple, un fichier image PNG, JPEG ou GIF), plutôt qu'à une page Web contenant une image. Notez que cette URL DOIT spécifiquement référencer une photo de profil de l'utilisateur final adaptée à l'affichage lors de la description de l'utilisateur final, plutôt qu'une photo arbitraire prise par l'utilisateur final.	Non
created_at	`number`	Heure à laquelle l'utilisateur final a été créé. Le temps est représenté comme le nombre de millisecondes depuis l'époque Unix (1970-01-01T00:00:00Z).	Non
updated_at	`number`	Heure à laquelle les informations de l'utilisateur final ont été mises à jour pour la dernière fois. Le temps est représenté comme le nombre de millisecondes depuis l'époque Unix (1970-01-01T00:00:00Z).	Non

D'autres revendications standard incluent family_name, given_name, middle_name, nickname, preferred_username, profile, website, gender, birthdate, zoneinfo, et locale seront également incluses dans la portée profile sans avoir besoin de demander le point de terminaison userinfo. Une différence par rapport aux revendications ci-dessus est que ces revendications ne seront renvoyées que lorsque leurs valeurs ne sont pas vides, tandis que les revendications ci-dessus renverront null si les valeurs sont vides.

remarque

Contrairement aux revendications standard, les revendications created_at et updated_at utilisent des millisecondes au lieu de secondes.

email

Nom de la revendication	Type	Description	Besoin d'userinfo ?
email	`string`	L'adresse e-mail de l'utilisateur	Non
email_verified	`boolean`	Si l'adresse e-mail a été vérifiée	Non

phone

Nom de la revendication	Type	Description	Besoin d'userinfo ?
phone_number	`string`	Le numéro de téléphone de l'utilisateur	Non
phone_number_verified	`boolean`	Si le numéro de téléphone a été vérifié	Non

address

Veuillez vous référer à OpenID Connect Core 1.0 pour les détails de la revendication d'adresse.

custom_data

Nom de la revendication	Type	Description	Besoin d'userinfo ?
custom_data	`object`	Les données personnalisées de l'utilisateur	Oui

identities

Nom de la revendication	Type	Description	Besoin d'userinfo ?
identities	`object`	Les identités liées de l'utilisateur	Oui
sso_identities	`array`	Les identités SSO liées de l'utilisateur	Oui

urn:logto:scope:organizations

Nom de la revendication	Type	Description	Besoin d'userinfo ?
organizations	`string[]`	Les identifiants d'organisation auxquels l'utilisateur appartient	Non
organization_data	`object[]`	Les données d'organisation auxquelles l'utilisateur appartient	Oui

urn:logto:scope:organization_roles

Nom de la revendication	Type	Description	Besoin d'userinfo ?
organization_roles	`string[]`	Les rôles d'organisation auxquels l'utilisateur appartient avec le format `<organization_id>:<role_name>`	Non

En considérant la performance et la taille des données, si "Besoin d'userinfo ?" est "Oui", cela signifie que la revendication n'apparaîtra pas dans le Jeton d’identifiant (ID token), mais sera renvoyée dans la réponse du point de terminaison userinfo.

Ressources API et organisations

Nous vous recommandons de lire d'abord 🔐 Contrôle d’accès basé sur les rôles (RBAC) pour comprendre les concepts de base de Logto RBAC et comment configurer correctement les ressources API.

Configurer le client Logto

Une fois que vous avez configuré les ressources API, vous pouvez les ajouter lors de la configuration de Logto dans votre application :

index.php
$client = new LogtoClient(
  new LogtoConfig(
    // ...other configs
    resources: ["https://shopping.your-app.com/api", "https://store.your-app.com/api"], // Ajouter des ressources API
  ),
);

Chaque ressource API a ses propres permissions (portées).

Par exemple, la ressource https://shopping.your-app.com/api a les permissions shopping:read et shopping:write, et la ressource https://store.your-app.com/api a les permissions store:read et store:write.

Pour demander ces permissions, vous pouvez les ajouter lors de la configuration de Logto dans votre application :

index.php
$client = new LogtoClient(
  new LogtoConfig(
    // ...other configs
    scopes: ["shopping:read", "shopping:write", "store:read", "store:write"], // Ajouter des portées
    resources: ["https://shopping.your-app.com/api", "https://store.your-app.com/api"], // Ajouter des ressources API
  ),
);

Vous pouvez remarquer que les portées sont définies séparément des ressources API. Cela est dû au fait que les Indicateurs de ressource pour OAuth 2.0 spécifient que les portées finales pour la requête seront le produit cartésien de toutes les portées de tous les services cibles.

Ainsi, dans le cas ci-dessus, les portées peuvent être simplifiées à partir de la définition dans Logto, les deux ressources API peuvent avoir les portées read et write sans le préfixe. Ensuite, dans la configuration de Logto :

index.php
$client = new LogtoClient(
  new LogtoConfig(
    // ...other configs
    scopes: ["read", "write"], // Ajouter des portées (scopes)
    resources: ["https://shopping.your-app.com/api", "https://store.your-app.com/api"], // Ajouter des ressources API
  ),
);

Pour chaque ressource API, il demandera à la fois les portées read et write.

remarque

Il est acceptable de demander des portées qui ne sont pas définies dans les ressources API. Par exemple, vous pouvez demander la portée email même si les ressources API n'ont pas la portée email disponible. Les portées non disponibles seront ignorées en toute sécurité.

Après une connexion réussie, Logto émettra les portées appropriées aux ressources API en fonction des rôles de l'utilisateur.

Récupérer le jeton d’accès pour la ressource API

Pour récupérer le jeton d’accès pour une ressource API spécifique, vous pouvez utiliser la méthode GetAccessToken :

index.php
$accessToken = $client->getAccessToken("https://shopping.your-app.com/api");

Cette méthode renverra un jeton d’accès JWT qui peut être utilisé pour accéder à la ressource API lorsque l’utilisateur a les Permissions associées. Si le jeton d’accès mis en cache actuel a expiré, cette méthode essaiera automatiquement d’utiliser un jeton de rafraîchissement pour obtenir un nouveau jeton d’accès.

Récupérer les jetons d’organisation

Si l'Organisation est nouvelle pour vous, veuillez lire 🏢 Organisations (Multi-tenancy) pour commencer.

Vous devez ajouter la portée core.UserScopeOrganizations lors de la configuration du client Logto :

use Logto\Sdk\Constants\UserScope;

$client = new LogtoClient(
  new LogtoConfig(
    // ...other configs
    scopes: [UserScope::organizations], // Ajouter des portées
  ),
);

Une fois l'utilisateur connecté, vous pouvez récupérer le jeton d’organisation pour l'utilisateur :

index.php
# Remplacez le paramètre par un ID d’organisation valide.
# Les ID d’organisations valides pour l’utilisateur peuvent être trouvés dans la revendication de jeton d’identifiant `organizations`.
$organizationToken = $client->getOrganizationToken(organization_id);
# ou
$claims = $client->getOrganizationTokenClaims(organization_id);

Lectures complémentaires

Flux utilisateur final : flux d'authentification, flux de compte et flux d'organisation Configurer les connecteurs Protéger votre API

Prérequis​

Installation​

Intégration​

Initialiser LogtoClient​

Configurer les URIs de redirection​

Configurer les URIs de redirection​

Gérer le rappel​

Implémenter la route de connexion​

Implémenter la route de déconnexion​

Gérer le statut d'authentification​

Point de contrôle : Testez votre application​

Obtenir des informations sur l'utilisateur​

Afficher les informations de l'utilisateur​

Demander des revendications supplémentaires​

Revendications nécessitant des requêtes réseau​

Portées et revendications​

Ressources API et organisations​

Configurer le client Logto​

Récupérer le jeton d’accès pour la ressource API​

Récupérer les jetons d’organisation​

Lectures complémentaires​

Prérequis

Installation

Intégration

Initialiser LogtoClient

Configurer les URIs de redirection

Configurer les URIs de redirection

Gérer le rappel

Implémenter la route de connexion

Implémenter la route de déconnexion

Gérer le statut d'authentification

Point de contrôle : Testez votre application

Obtenir des informations sur l'utilisateur

Afficher les informations de l'utilisateur

Demander des revendications supplémentaires

Revendications nécessitant des requêtes réseau

Portées et revendications

Ressources API et organisations

Configurer le client Logto

Récupérer le jeton d’accès pour la ressource API

Récupérer les jetons d’organisation

Lectures complémentaires