Logto est une alternative à Auth0 conçue pour les applications modernes et les produits SaaS. Il offre des services à la fois Cloud et Open-source pour vous aider à lancer rapidement votre système de gestion des identités et des accès (IAM). Profitez de l'authentification, de l'autorisation et de la gestion multi-locataires tout-en-un.
Nous recommandons de commencer avec un locataire de développement gratuit sur Logto Cloud. Cela vous permet d'explorer facilement toutes les fonctionnalités.
Dans cet article, nous allons parcourir les étapes pour construire rapidement l'expérience de connexion OAuth2 (authentification utilisateur) avec Python et Logto.
Prérequis
- Une instance Logto en cours d'exécution. Consultez la page d'introduction pour commencer.
- Connaissance de base de Python.
- Un compte OAuth2 utilisable.
Créer une application dans Logto
Logto est basé sur l'authentification OpenID Connect (OIDC) et l'autorisation OAuth 2.0. Il prend en charge la gestion des identités fédérées à travers plusieurs applications, communément appelée authentification unique (SSO).
Pour créer votre application Traditional web, suivez simplement ces étapes :
- Ouvrez la Logto Console. Dans la section "Get started", cliquez sur le lien "View all" pour ouvrir la liste des frameworks d'application. Alternativement, vous pouvez naviguer vers Logto Console > Applications, et cliquer sur le bouton "Create application".
- Dans la fenêtre modale qui s'ouvre, cliquez sur la section "Traditional web" ou filtrez tous les frameworks "Traditional web" disponibles en utilisant les cases à cocher de filtre rapide à gauche. Cliquez sur la carte du framework "Flask" pour commencer à créer votre application.
- Entrez le nom de l'application, par exemple, "Bookstore", et cliquez sur "Create application".
🎉 Ta-da ! Vous venez de créer votre première application dans Logto. Vous verrez une page de félicitations qui inclut un guide d'intégration détaillé. Suivez le guide pour voir quelle sera l'expérience dans votre application.
Intégrer le SDK Flask
- L'exemple utilise Flask, mais les concepts sont les mêmes pour d'autres frameworks.
- Le projet d'exemple Python est disponible sur notre répertoire SDK Python.
- Le SDK Logto utilise des coroutines, n'oubliez pas d'utiliser
awaitlors de l'appel de fonctions asynchrones.
Installation
Exécutez dans le répertoire racine du projet :
pip install logto # ou `poetry add logto` ou tout ce que vous utilisez
Init LogtoClient
Tout d'abord, créez une configuration Logto :
from logto import LogtoClient, LogtoConfig
client = LogtoClient(
LogtoConfig(
endpoint="https://you-logto-endpoint.app", # Remplacez par votre endpoint Logto
appId="replace-with-your-app-id",
appSecret="replace-with-your-app-secret",
),
)
Vous pouvez trouver et copier le "Secret de l'application" depuis la page des détails de l'application dans la Console d'administration :
Remplacez également le stockage en mémoire par défaut par un stockage persistant, par exemple :
from logto import LogtoClient, LogtoConfig, Storage
from flask import session
from typing import Union
class SessionStorage(Storage):
def get(self, key: str) -> Union[str, None]:
return session.get(key, None)
def set(self, key: str, value: Union[str, None]) -> None:
session[key] = value
def delete(self, key: str) -> None:
session.pop(key, None)
client = LogtoClient(
LogtoConfig(...),
storage=SessionStorage(),
)
Voir Storage pour plus de détails.
Implémenter la connexion et la déconnexion
Dans votre application web, ajoutez une route pour gérer correctement la requête de connexion des utilisateurs. Utilisons /sign-in comme exemple :
@app.route("/sign-in")
async def sign_in():
# Obtenez l'URL de connexion et redirigez l'utilisateur vers celle-ci
return redirect(await client.signIn(
redirectUri="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 :
@app.route("/sign-in")
async def sign_in():
return redirect(await client.signIn(
redirectUri="http://localhost:3000/callback",
interactionMode="signUp", # Afficher la page d'inscription sur le premier écran
))
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 la seule façon de lancer une tentative de connexion. Vous pouvez toujours utiliser la méthode
signInpour obtenir l'URL de connexion et rediriger l'utilisateur vers celle-ci.
Après que l'utilisateur ait fait une requête de déconnexion, Logto effacera toutes les informations d'authentification de l'utilisateur dans la session.
Pour nettoyer la session Python et la session Logto, une route de déconnexion peut être implémentée comme suit :
@app.route("/sign-out")
async def sign_out():
return redirect(
# Redirigez l'utilisateur vers la page d'accueil après une déconnexion réussie
await client.signOut(postLogoutRedirectUri="http://localhost:3000/")
)
Gérer le statut d'authentification
Dans le SDK Logto, nous pouvons utiliser client.isAuthenticated() pour vérifier le statut d'authentification (Authentication). Si l'utilisateur est connecté, la valeur sera true, sinon, la valeur sera false.
Ici, nous implémentons également une page d'accueil simple 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.
@app.route("/")
async def home():
if client.isAuthenticated() is False:
return "Non authentifié <a href='/sign-in'>Se connecter</a>"
return "Authentifié <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 des jetons et vous déconnecter.
Ajouter le connecteur OAuth2
Pour activer une connexion rapide et améliorer la conversion des utilisateurs, connectez-vous avec Flask en tant que fournisseur d’identité (IdP). Le connecteur social Logto vous aide à établir cette connexion en quelques minutes en permettant plusieurs entrées de paramètres.
Pour ajouter un connecteur social, suivez simplement ces étapes :
- Accédez à Console > Connectors > Social Connectors.
- Cliquez sur "Add social connector" et sélectionnez "OAuth2".
- Suivez le guide README et complétez les champs requis et personnalisez les paramètres.
Si vous suivez le guide du connecteur sur place, vous pouvez passer à la section suivante.
Configurer Standard OAuth 2.0 app
Créez votre application OAuth
Lorsque vous ouvrez cette page, nous supposons que vous savez déjà quel fournisseur d'identité sociale vous souhaitez connecter. La première chose à faire est de confirmer que le fournisseur d'identité prend en charge le protocole OAuth, ce qui est une condition préalable pour configurer un connecteur valide. Ensuite, suivez les instructions du fournisseur d'identité pour enregistrer et créer l'application correspondante pour l'autorisation OAuth.
Configurez votre connecteur
Nous prenons UNIQUEMENT en charge le type de flux "Authorization Code" pour des raisons de sécurité, et il s'adapte parfaitement au scénario de Logto.
clientId et clientSecret se trouvent sur la page de détails de votre application OAuth.
clientId : L'identifiant client est un identifiant unique qui identifie l'application cliente lors de l'enregistrement auprès du serveur d'autorisation. Cet identifiant est utilisé par le serveur d'autorisation pour vérifier l'identité de l'application cliente et associer tout jeton d’accès autorisé à cette application cliente spécifique.
clientSecret : Le secret client est une clé confidentielle délivrée à l'application cliente par le serveur d'autorisation lors de l'enregistrement. L'application cliente utilise cette clé secrète pour s'authentifier auprès du serveur d'autorisation lors de la demande de jetons d’accès. Le secret client est considéré comme une information confidentielle et doit être conservé en sécurité en tout temps.
tokenEndpointAuthMethod : La méthode d'authentification du point de terminaison du jeton est utilisée par l'application cliente pour s'authentifier auprès du serveur d'autorisation lors de la demande de jetons d’accès. Pour découvrir les méthodes prises en charge, consultez le champ token_endpoint_auth_methods_supported disponible sur le point de terminaison de découverte OpenID Connect du fournisseur de service OAuth 2.0, ou référez-vous à la documentation pertinente fournie par le fournisseur de service OAuth 2.0.
clientSecretJwtSigningAlgorithm (Optionnel) : Nécessaire uniquement lorsque tokenEndpointAuthMethod est client_secret_jwt. L'algorithme de signature JWT du secret client est utilisé par l'application cliente pour signer le JWT envoyé au serveur d'autorisation lors de la demande de jeton.
scope : Le paramètre scope est utilisé pour spécifier l'ensemble des ressources et permissions que l'application cliente demande à accéder. Le paramètre scope est généralement défini comme une liste de valeurs séparées par des espaces représentant des permissions spécifiques. Par exemple, une valeur de scope "read write" peut indiquer que l'application cliente demande un accès en lecture et écriture aux données d'un utilisateur.
Vous êtes censé trouver authorizationEndpoint, tokenEndpoint et userInfoEndpoint dans la documentation du fournisseur social.
authenticationEndpoint : Ce point de terminaison est utilisé pour initier le processus d'authentification. Le processus d'authentification implique généralement que l'utilisateur se connecte et accorde l'autorisation à l'application cliente d'accéder à ses ressources.
tokenEndpoint : Ce point de terminaison est utilisé par l'application cliente pour obtenir un jeton d’accès qui peut être utilisé pour accéder aux ressources demandées. L'application cliente envoie généralement une requête au point de terminaison du jeton avec un type de flux et un code d'autorisation pour recevoir un jeton d’accès.
userInfoEndpoint : Ce point de terminaison est utilisé par l'application cliente pour obtenir des informations supplémentaires sur l'utilisateur, telles que son nom complet, son adresse e-mail ou sa photo de profil. Le point de terminaison user info est généralement accessible après que l'application cliente a obtenu un jeton d’accès depuis le point de terminaison du jeton.
Logto fournit également un champ profileMap que les utilisateurs peuvent personnaliser pour la correspondance des profils des fournisseurs sociaux, qui ne sont généralement pas standardisés. Les clés sont les noms de champs de profil utilisateur standard de Logto et les valeurs correspondantes doivent être les noms de champs des profils sociaux. À ce stade, Logto ne prend en compte que 'id', 'name', 'avatar', 'email' et 'phone' du profil social, seul 'id' est requis et les autres sont des champs optionnels.
responseType et grantType ne peuvent être que des valeurs FIXES avec le flux authorization code, donc nous les rendons optionnels et les valeurs par défaut seront automatiquement renseignées.
Par exemple, vous pouvez trouver la réponse du profil utilisateur Google et donc son profileMap devrait ressembler à ceci :
{
"id": "sub",
"avatar": "picture"
}
Nous avons fourni une clé customConfig OPTIONNELLE pour y placer vos paramètres personnalisés.
Chaque fournisseur d'identité sociale peut avoir sa propre variante du protocole standard OAuth. Si votre fournisseur d'identité sociale respecte strictement le protocole standard OAuth, alors vous n'avez pas à vous soucier de customConfig.
Types de configuration
| Nom | Type | Requis |
|---|---|---|
| authorizationEndpoint | string | true |
| userInfoEndpoint | string | true |
| clientId | string | true |
| clientSecret | string | true |
| tokenEndpointResponseType | enum | false |
| responseType | string | false |
| grantType | string | false |
| tokenEndpoint | string | false |
| scope | string | false |
| customConfig | Record<string, string> | false |
| profileMap | ProfileMap | false |
| Champs ProfileMap | Type | Requis | Valeur par défaut |
|---|---|---|---|
| id | string | false | id |
| name | string | false | name |
| avatar | string | false | avatar |
| string | false | ||
| phone | string | false | phone |
Paramètres généraux
Voici quelques paramètres généraux qui ne bloqueront pas la connexion à votre fournisseur d'identité mais peuvent affecter l'expérience d'authentification de l'utilisateur final.
Nom et logo du bouton social
Si vous souhaitez afficher un bouton social sur votre page de connexion, vous pouvez définir le nom et le logo (mode sombre et mode clair) du fournisseur d'identité sociale. Cela aidera les utilisateurs à reconnaître l'option de connexion sociale.
Nom du fournisseur d'identité
Chaque connecteur social possède un nom unique de fournisseur d'identité (IdP) pour différencier les identités des utilisateurs. Alors que les connecteurs courants utilisent un nom IdP fixe, les connecteurs personnalisés nécessitent une valeur unique. En savoir plus sur les noms IdP pour plus de détails.
Synchroniser les informations de profil
Dans le connecteur OAuth, vous pouvez définir la politique de synchronisation des informations de profil, telles que les noms d'utilisateur et les avatars. Choisissez parmi :
- Synchroniser uniquement lors de l'inscription : Les informations de profil sont récupérées une seule fois lors de la première connexion de l'utilisateur.
- Toujours synchroniser à la connexion : Les informations de profil sont mises à jour à chaque connexion de l'utilisateur.
Stocker les jetons pour accéder aux API tierces (Optionnel)
Si vous souhaitez accéder aux API du fournisseur d'identité et effectuer des actions avec l'autorisation de l'utilisateur (que ce soit via la connexion sociale ou la liaison de compte), Logto doit obtenir des portées API spécifiques et stocker les jetons.
- Ajoutez les portées requises dans le champ scope en suivant les instructions ci-dessus
- Activez Stocker les jetons pour un accès API persistant dans le connecteur OAuth de Logto. Logto stockera en toute sécurité les jetons d’accès dans le Secret Vault.
- Pour les fournisseurs d'identité OAuth/OIDC standards, la portée
offline_accessdoit être incluse pour obtenir un jeton de rafraîchissement, évitant ainsi de demander à nouveau le consentement de l'utilisateur.
Gardez votre secret client en sécurité et ne l'exposez jamais dans le code côté client. En cas de compromission, générez-en un nouveau immédiatement dans les paramètres de l'application de votre fournisseur d'identité.
Utiliser le connecteur OAuth
Une fois que vous avez créé un connecteur OAuth et que vous l'avez connecté à votre fournisseur d'identité, vous pouvez l'intégrer dans vos flux utilisateurs finaux. Choisissez les options qui correspondent à vos besoins :
Activer le bouton de connexion sociale
- Dans la Console Logto, allez dans Expérience de connexion > Inscription et connexion.
- Ajoutez le connecteur OAuth dans la section Connexion sociale pour permettre aux utilisateurs de s'authentifier avec votre fournisseur d'identité.
En savoir plus sur l'expérience de connexion sociale.
Lier ou délier un compte social
Utilisez l’Account API pour créer un Centre de compte personnalisé dans votre application permettant aux utilisateurs connectés de lier ou délier leurs comptes sociaux. Suivez le tutoriel Account API
Il est possible d'activer le connecteur OAuth uniquement pour la liaison de compte et l'accès API, sans l'activer pour la connexion sociale.
Accéder aux API du fournisseur d'identité et effectuer des actions
Votre application peut récupérer les jetons d’accès stockés dans le Secret Vault pour appeler les API de votre fournisseur d'identité et automatiser des tâches backend. Les capacités spécifiques dépendent de votre fournisseur d'identité et des portées que vous avez demandées. Reportez-vous au guide sur la récupération des jetons stockés pour l'accès API.
Gérer l'identité sociale de l'utilisateur
Après qu'un utilisateur a lié son compte social, les administrateurs peuvent gérer cette connexion dans la Console Logto :
- Accédez à Console Logto > Gestion des utilisateurs et ouvrez le profil de l'utilisateur.
- Sous Connexions sociales, localisez l'élément du fournisseur d'identité et cliquez sur Gérer.
- Sur cette page, les administrateurs peuvent gérer la connexion sociale de l'utilisateur, voir toutes les informations de profil accordées et synchronisées depuis son compte social, et vérifier le statut du jeton d’accès.
Quelques réponses de jeton d’accès de fournisseur d'identité ne contiennent pas l'information de portée spécifique, donc Logto ne peut pas afficher directement la liste des permissions accordées par l'utilisateur. Cependant, tant que l'utilisateur a consenti aux portées demandées lors de l'autorisation, votre application disposera des permissions correspondantes lors de l'accès à l'API OAuth.
Enregistrer votre configuration
Vérifiez que vous avez rempli les valeurs nécessaires dans la zone de configuration du connecteur Logto. Cliquez sur "Enregistrer et terminer" (ou "Enregistrer les modifications") et le connecteur OAuth2 devrait être disponible maintenant.
Activer le connecteur OAuth2 dans l'Expérience de connexion
Une fois que vous avez créé un connecteur social avec succès, vous pouvez l'activer en tant que bouton "Continuer avec OAuth2" dans l'Expérience de connexion.
- Accédez à Console > Expérience de connexion > Inscription et connexion.
- (Facultatif) Choisissez "Non applicable" pour l'identifiant d'inscription si vous avez besoin uniquement de la connexion sociale.
- Ajoutez le connecteur OAuth2 configuré à la section "Connexion sociale".
Tests et validation
Retournez à votre application Python. Vous devriez maintenant pouvoir vous connecter avec OAuth2. Profitez-en !
Lectures complémentaires
Flux des utilisateurs finaux : Logto fournit des flux d'authentification prêts à l'emploi, y compris l'authentification multi-facteurs (MFA) et le SSO d’entreprise, ainsi que des API puissantes pour une mise en œuvre flexible des paramètres de compte, de la vérification de sécurité et de l'expérience multi-locataire.
Autorisation : L'autorisation définit les actions qu'un utilisateur peut effectuer ou les ressources auxquelles il peut accéder après avoir été authentifié. Découvrez comment protéger votre API pour les applications natives et monopages et mettre en œuvre le contrôle d’accès basé sur les rôles (RBAC).
Organisations : Particulièrement efficace dans les applications SaaS multi-locataires et B2B, la fonctionnalité d'organisation permet la création de locataires, la gestion des membres, le RBAC au niveau de l'organisation et l'approvisionnement juste-à-temps.
Série IAM client : Nos articles de blog en série sur la gestion des identités et des accès des clients (ou consommateurs), des sujets de base aux sujets avancés et au-delà.