Pour nos nouveaux amis:

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 GitHub (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 GitHub 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 :

1. 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".
2. 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.
3. 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

astuce:

• 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 :

client.py

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",
    ),
)

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 :

Remplacez également le stockage en mémoire par défaut par un stockage persistant, par exemple :

client.py

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 :

flask.py

@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 :

flask.py

@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 :

flask.py

@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 :

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

Ajouter le connecteur GitHub

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 :

1. Accédez à Console > Connectors > Social Connectors.
2. Cliquez sur "Add social connector" et sélectionnez "GitHub".
3. Suivez le guide README et complétez les champs requis et personnalisez les paramètres.

remarque:

Si vous suivez le guide du connecteur sur place, vous pouvez passer à la section suivante.

Configurer GitHub OAuth app

Étape 1 : Créer une application OAuth sur GitHub

Avant de pouvoir utiliser GitHub comme fournisseur d'authentification, vous devez créer une application OAuth sur GitHub pour obtenir des identifiants OAuth 2.0.

1. Rendez-vous sur GitHub et connectez-vous avec votre compte, ou créez un nouveau compte si nécessaire.
2. Accédez à Paramètres > Paramètres développeur > Applications OAuth.
3. Cliquez sur Nouvelle application OAuth pour enregistrer une nouvelle application :
   • Nom de l'application : Saisissez un nom descriptif pour votre application.
   • URL de la page d'accueil : Saisissez l'URL de la page d'accueil de votre application.
   • URL de rappel d'autorisation : Copiez l'URI de rappel depuis votre connecteur GitHub Logto et collez-le ici. Après la connexion des utilisateurs avec GitHub, ils seront redirigés ici avec un code d'autorisation que Logto utilise pour finaliser l'authentification.
   • Description de l'application : (Optionnel) Ajoutez une brève description de votre application.
4. Cliquez sur Enregistrer l'application pour créer l'application OAuth.

remarque:

Nous vous recommandons de ne pas cocher la case Activer Device Flow, car les utilisateurs qui se connectent avec GitHub sur des appareils mobiles devront confirmer l'action de connexion initiale dans l'application mobile GitHub. De nombreux utilisateurs GitHub n'installent pas l'application mobile GitHub sur leur téléphone, ce qui pourrait bloquer le flux de connexion. Activez cette option uniquement si vous attendez des utilisateurs finaux qu'ils confirment leur connexion via l'application mobile GitHub. Voir les détails sur le device flow.

Pour plus de détails sur la configuration des applications OAuth GitHub, consultez Créer une application OAuth.

Étape 2 : Configurer votre connecteur Logto

Après avoir créé l'application OAuth sur GitHub, vous serez redirigé vers une page de détails où vous pourrez copier l'ID client et générer un secret client.

1. Copiez l'ID client de votre application OAuth GitHub et collez-le dans le champ clientId dans Logto.
2. Cliquez sur Générer un nouveau secret client sur GitHub pour créer un nouveau secret, puis copiez-le et collez-le dans le champ clientSecret dans Logto.
3. Cliquez sur Enregistrer et Terminer dans Logto pour connecter votre système d'identité à GitHub.

attention:

Gardez votre secret client en sécurité et ne l'exposez jamais dans du code côté client. Les secrets client GitHub ne peuvent pas être récupérés s'ils sont perdus — vous devrez en générer un nouveau.

Étape 3 : Configurer les portées (Optionnel)

Les portées (Scopes) définissent les permissions que votre application demande aux utilisateurs et contrôlent les données auxquelles votre application peut accéder depuis leurs comptes GitHub.

Utilisez le champ Scopes dans Logto pour demander des permissions supplémentaires à GitHub. Choisissez l'une des approches suivantes selon vos besoins :

Option 1 : Aucune portée API supplémentaire requise

• Laissez le champ Scopes vide dans votre connecteur GitHub Logto.
• La portée par défaut read:user sera demandée pour garantir que Logto puisse obtenir correctement les informations de base de l'utilisateur (par exemple, e-mail, nom, avatar).

Option 2 : Demander des portées supplémentaires à la connexion

• Parcourez toutes les portées GitHub disponibles pour les applications OAuth et ajoutez uniquement celles dont votre application a besoin.
• Saisissez toutes les portées souhaitées dans le champ Scopes, séparées par des espaces.
• Toutes les portées que vous indiquez ici remplacent les valeurs par défaut, donc incluez toujours la portée d'authentification : read:user.
• Les portées supplémentaires courantes incluent :
  • repo : Contrôle total des dépôts privés
  • public_repo : Accès aux dépôts publics
  • user:email : Accès aux adresses e-mail de l'utilisateur
  • notifications : Accès aux notifications
• Assurez-vous que toutes les portées sont correctement orthographiées et valides. Une portée incorrecte ou non prise en charge entraînera une erreur "Invalid scope" de la part de GitHub.

Option 3 : Demander des portées incrémentielles ultérieurement

• Après la connexion de l'utilisateur, vous pouvez demander des portées supplémentaires à la demande en relançant un flux d'autorisation sociale fédérée et en mettant à jour l'ensemble de jetons stockés de l'utilisateur.
• Ces portées supplémentaires n'ont pas besoin d'être renseignées dans le champ Scopes de votre connecteur GitHub Logto, et peuvent être obtenues via l’API de vérification sociale de Logto.

En suivant ces étapes, votre connecteur GitHub Logto demandera exactement les permissions dont votre application a besoin — ni plus, ni moins.

astuce:

Si votre application demande ces portées pour accéder à l’API GitHub et effectuer des actions, assurez-vous d’activer Stocker les jetons pour un accès API persistant dans le connecteur GitHub Logto. Voir la section suivante pour plus de détails.

Étape 4 : Paramètres généraux

Voici quelques paramètres généraux qui ne bloqueront pas la connexion à GitHub mais peuvent affecter l'expérience d'authentification des utilisateurs finaux.

Synchroniser les informations de profil

Dans le connecteur GitHub, 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 à 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 GitHub (Optionnel)

Si vous souhaitez accéder aux API GitHub 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.

1. Ajoutez les portées requises en suivant les instructions ci-dessus.
2. Activez Stocker les jetons pour un accès API persistant dans le connecteur GitHub Logto. Logto stockera en toute sécurité les jetons d’accès GitHub dans le Secret Vault.

remarque:

Lorsque vous utilisez une application OAuth GitHub comme décrit dans ce tutoriel, vous ne pouvez pas obtenir de jeton de rafraîchissement de GitHub car son jeton d’accès n’expire pas, sauf si l’utilisateur le révoque manuellement. Par conséquent, il n’est pas nécessaire d’ajouter offline_access dans le champ Scopes — le faire peut provoquer une erreur.

Si vous souhaitez que le jeton d’accès expire ou utiliser des jetons de rafraîchissement, envisagez d’intégrer une application GitHub à la place. Découvrez les différences entre les applications GitHub et les applications OAuth.

Étape 5 : Tester votre intégration (Optionnel)

Avant de passer en production, testez votre intégration GitHub :

1. Utilisez le connecteur dans un tenant de développement Logto.
2. Vérifiez que les utilisateurs peuvent se connecter avec GitHub.
3. Vérifiez que les bonnes portées sont demandées.
4. Testez les appels API si vous stockez des jetons.

Les applications OAuth GitHub fonctionnent immédiatement avec n'importe quel compte utilisateur GitHub — il n'est pas nécessaire d'avoir des utilisateurs de test ou une approbation d'application comme sur d'autres plateformes.

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 GitHub devrait être disponible maintenant.

Activer le connecteur GitHub 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 GitHub" dans l'Expérience de connexion.

1. Accédez à Console > Expérience de connexion > Inscription et connexion.
2. (Facultatif) Choisissez "Non applicable" pour l'identifiant d'inscription si vous avez besoin uniquement de la connexion sociale.
3. Ajoutez le connecteur GitHub configuré à la section "Connexion sociale".

Tests et validation

Retournez à votre application Python. Vous devriez maintenant pouvoir vous connecter avec GitHub. 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à.