Logto est une alternative à Auth0 conçue pour les applications modernes et les produits SaaS. Il offre des services 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 passer en revue les étapes pour construire rapidement l'expérience de connexion OIDC (authentification utilisateur) avec Python et Logto.
Prérequis
- Une instance Logto en cours d'exécution. Consultez la page d'introduction pour commencer.
- Connaissances de base de Python.
- Un compte OIDC 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
await
lors 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
signIn
pour 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 OIDC
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 l'entrée de plusieurs 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 "OIDC".
- 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 Application OIDC standard
Créez votre application OIDC
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 OIDC, 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 pertinente pour l'autorisation OIDC.
Configurez votre connecteur
Nous prenons en charge UNIQUEMENT le type de subvention "Authorization Code" pour des raisons de sécurité, et cela s'adapte parfaitement au scénario de Logto.
clientId
et clientSecret
peuvent être trouvés sur la page des détails de vos applications OIDC.
clientId : L'ID client est un identifiant unique qui identifie l'application cliente lors de l'enregistrement auprès du serveur d'autorisation. Cet ID est utilisé par le serveur d'autorisation pour vérifier l'identité de l'application cliente et pour associer tout jeton d’accès autorisé à cette application cliente spécifique.
clientSecret : Le secret client est une clé confidentielle qui est 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 gardé en sécurité à tout moment.
tokenEndpointAuthMethod : La méthode d'authentification du point de terminaison de 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 au point de terminaison de découverte OpenID Connect du fournisseur de services OAuth 2.0, ou référez-vous à la documentation pertinente fournie par le fournisseur de services 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 qui est envoyé au serveur d'autorisation lors de la demande de jeton.
scope : Le paramètre de portée est utilisé pour spécifier l'ensemble des ressources et des permissions auxquelles l'application cliente demande l'accès. Le paramètre de portée est généralement défini comme une liste de valeurs séparées par des espaces qui représentent des permissions spécifiques. Par exemple, une valeur de portée de "read write" pourrait indiquer que l'application cliente demande un accès en lecture et en écriture aux données d'un utilisateur.
Vous êtes censé trouver authorizationEndpoint
, tokenEndpoint
, jwksUri
et issuer
comme informations de configuration du fournisseur OpenID. Ils devraient être disponibles 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’identifiant qui peut être utilisé pour accéder aux ressources demandées. L'application cliente envoie généralement une demande au point de terminaison de jeton avec un type de subvention et un code d'autorisation pour recevoir un jeton d’identifiant.
jwksUri : C'est l'URL du point de terminaison où l'ensemble de clés Web JSON (JWKS) du fournisseur d'identité sociale (IdP en abrégé) peut être obtenu. Le JWKS est un ensemble de clés cryptographiques que l'IdP utilise pour signer et vérifier les JSON Web Tokens (JWT) qui sont émis lors du processus d'authentification. Le jwksUri
est utilisé par la partie de confiance (RP) pour obtenir les clés publiques utilisées par l'IdP pour signer les JWT, afin que la RP puisse vérifier l'authenticité et l'intégrité des JWT reçus de l'IdP.
issuer : C'est l'identifiant unique de l'IdP qui est utilisé par la RP pour vérifier les JWT reçus de l'IdP. Il est inclus dans les JWT en tant que revendication iss
claim (le jeton d’identifiant est toujours un JWT). La valeur de l'émetteur doit correspondre à l'URL du serveur d'autorisation de l'IdP, et elle doit être une URI que la RP considère comme fiable. Lorsque la RP reçoit un JWT, elle vérifie la revendication iss
pour s'assurer qu'il a été émis par un IdP de confiance, et que le JWT est destiné à être utilisé avec la RP.
Ensemble, jwksUri
et issuer
fournissent un mécanisme sécurisé pour que la RP vérifie l'identité de l'utilisateur final lors du processus d'authentification. En utilisant les clés publiques obtenues à partir du jwksUri
, la RP peut vérifier l'authenticité et l'intégrité des JWT émis par l'IdP. La valeur de l'émetteur garantit que la RP n'accepte que les JWT qui ont été émis par un IdP de confiance, et que les JWT sont destinés à être utilisés avec la RP.
Étant donné qu'une requête d’authentification est toujours requise, un authRequestOptionalConfig
est fourni pour regrouper toutes les configurations optionnelles, vous pouvez trouver des détails sur OIDC Authentication Request. Vous pouvez également constater que nonce
est absent de cette configuration. Étant donné que nonce
doit être identique pour chaque requête, nous avons placé la génération de nonce
dans l'implémentation du code. Donc, ne vous inquiétez pas ! Les jwksUri
et issuer
mentionnés précédemment sont également inclus dans idTokenVerificationConfig
.
Vous vous demandez peut-être pourquoi un protocole OIDC standard prend en charge à la fois les flux implicites et hybrides, alors que le connecteur Logto ne prend en charge que le flux d'autorisation. Il a été déterminé que les flux implicites et hybrides sont moins sécurisés que le flux d'autorisation. En raison de l'accent mis par Logto sur la sécurité, il ne prend en charge que le flux d'autorisation pour offrir le plus haut niveau de sécurité à ses utilisateurs, malgré sa nature légèrement moins pratique.
responseType
et grantType
peuvent UNIQUEMENT être des valeurs FIXES avec le flux "Authorization Code", nous les rendons donc optionnels et les valeurs par défaut seront automatiquement remplies.
Pour tous les types de flux, nous avons fourni une clé customConfig
OPTIONNELLE pour placer vos paramètres personnalisés.
Chaque fournisseur d'identité sociale pourrait avoir sa propre variante du protocole standard OIDC. Si votre fournisseur d'identité sociale souhaité respecte strictement le protocole standard OIDC, alors vous n'avez pas besoin de vous soucier de customConfig
.
Types de configuration
Nom | Type | Requis |
---|---|---|
scope | string | Vrai |
clientId | string | Vrai |
clientSecret | string | Vrai |
authorizationEndpoint | string | Vrai |
tokenEndpoint | string | Vrai |
idTokenVerificationConfig | IdTokenVerificationConfig | Vrai |
authRequestOptionalConfig | AuthRequestOptionalConfig | Faux |
customConfig | Record<string, string> | Faux |
Propriétés AuthRequestOptionalConfig | Type | Requis |
---|---|---|
responseType | string | Faux |
tokenEndpoint | string | Faux |
responseMode | string | Faux |
display | string | Faux |
prompt | string | Faux |
maxAge | string | Faux |
uiLocales | string | Faux |
idTokenHint | string | Faux |
loginHint | string | Faux |
acrValues | string | Faux |
Propriétés IdTokenVerificationConfig | Type | Requis |
---|---|---|
jwksUri | string | Vrai |
issuer | string | string[] | Faux |
audience | string | string[] | Faux |
algorithms | string[] | Faux |
clockTolerance | string | number | Faux |
crit | Record<string, string | boolean> | Faux |
currentDate | Date | Faux |
maxTokenAge | string | number | Faux |
subject | string | Faux |
typ | string | Faux |
Voir ici pour plus de détails sur IdTokenVerificationConfig
.
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 OIDC devrait être disponible maintenant.
Activer le connecteur OIDC 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 OIDC" dans l'Expérience de connexion.
- Accédez à Console > Expérience de connexion > Inscription et connexion.
- (Optionnel) Choisissez "Non applicable" pour l'identifiant d'inscription si vous avez uniquement besoin de la connexion sociale.
- Ajoutez le connecteur OIDC configuré à la section "Connexion sociale".
Tests et validation
Retournez à votre application Python. Vous devriez maintenant pouvoir vous connecter avec OIDC. 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à.