Comment construire une connexion sans mot de passe Mailgun Email avec Python

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 Mailgun (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 Mailgun 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 Logto SDK

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.

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 :

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 Mailgun

Le connecteur Email est une méthode utilisée pour envoyer des mots de passe à usage unique (OTP) pour l'authentification. Il permet la vérification de Adresse e-mail pour prendre en charge l'authentification sans mot de passe, y compris l'inscription, la connexion, l'authentification à deux facteurs (2FA) et la récupération de compte basées sur Email. Vous pouvez facilement connecter Mailgun en tant que fournisseur Email. Avec le connecteur Email de Logto, vous pouvez configurer cela en quelques minutes seulement.

Pour ajouter un connecteur Email, suivez simplement ces étapes :

Accédez à Console > Connector > Email and SMS connectors.
Pour ajouter un nouveau connecteur Email, cliquez sur le bouton "Configurer" et sélectionnez "Mailgun".
Consultez la documentation README pour le fournisseur sélectionné.
Complétez les champs de configuration dans la section "Configuration des paramètres".
Personnalisez le modèle Email à l'aide de l'éditeur JSON.
Testez votre configuration en envoyant un code de vérification à votre Adresse e-mail.

remarque:

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

Configurer Connecteur d’e-mail Mailgun

Prérequis

Un compte Mailgun
Une clé API de votre compte Mailgun, nécessitant la permission d'envoyer des messages (e-mails). Voir Où puis-je trouver ma clé API et mes identifiants SMTP ? pour plus d'informations.

Configuration de base

Remplissez le champ endpoint si vous utilisez un point de terminaison API Mailgun différent, par exemple, la région UE doit être https://api.eu.mailgun.net. La valeur par défaut est https://api.mailgun.net.
Remplissez le champ domain avec le domaine que vous avez enregistré dans votre compte Mailgun. Cette valeur se trouve dans la section Domains du tableau de bord Mailgun. Le domaine doit être au format example.com, sans le préfixe https:// ou http://.
Remplissez le champ apiKey avec la clé API que vous avez générée dans votre compte Mailgun.
Remplissez le champ from avec l'adresse e-mail à partir de laquelle vous souhaitez envoyer les e-mails. Cette adresse e-mail doit être enregistrée dans votre compte Mailgun. L'adresse e-mail doit être au format Nom de l'expéditeur <[email protected]>.

Livraisons

Objet de configuration

La section "Livraisons" vous permet de configurer le contenu des e-mails à envoyer dans différents scénarios. Il s'agit d'une carte clé-valeur JSON où la clé est le type d'utilisation et la valeur est un objet contenant la configuration du contenu pour l'e-mail à envoyer.

{
  "<usage-type>": {
    // ...
  }
}

Types d'utilisation

Les types d'utilisation suivants sont pris en charge :

Register : L'e-mail à envoyer lorsqu'un utilisateur s'inscrit.
SignIn : L'e-mail à envoyer lorsqu'un utilisateur se connecte.
ForgotPassword : L'e-mail à envoyer lorsqu'un utilisateur réinitialise son mot de passe.
Generic : L'e-mail à envoyer lorsqu'un utilisateur effectue une action générique, par exemple, tester le connecteur d'e-mail.

remarque:

Si le type d'utilisation n'est pas spécifié dans la configuration des livraisons, l'e-mail générique sera envoyé. Si l'e-mail générique n'est pas spécifié, le connecteur retournera une erreur.

Configuration du contenu

Le connecteur prend en charge à la fois le contenu HTML direct et le modèle Mailgun. Vous pouvez utiliser l'un ou l'autre pour chaque type d'utilisation.

Dans le sujet et le contenu, vous pouvez utiliser l'espace réservé {{code}} pour insérer le code de vérification.

Pour utiliser un contenu HTML direct, remplissez les champs suivants :

subject : L'objet de l'e-mail à envoyer.
replyTo : L'adresse e-mail à utiliser comme adresse de réponse.
html : (Obligatoire) Le contenu HTML de l'e-mail à envoyer.
text : La version texte brut de l'e-mail à envoyer.

Pour utiliser un modèle Mailgun, remplissez les champs suivants :

subject : L'objet de l'e-mail à envoyer.
replyTo : L'adresse e-mail à utiliser comme adresse de réponse.
template : (Obligatoire) Le nom du modèle Mailgun à utiliser.
variables : Les variables à transmettre au modèle Mailgun. Doit être une carte clé-valeur JSON car elle sera convertie en chaîne avant l'envoi à Mailgun. Notez qu'il n'est pas nécessaire d'inclure la variable code car elle sera automatiquement ajoutée par le connecteur.

Exemple

Voici un exemple de configuration des livraisons :

{
  "Register": {
    "subject": "{{code}} est votre code de vérification",
    "replyTo": "Foo <[email protected]>",
    "html": "<h1>Bienvenue sur Logto</h1><p>Votre code de vérification est {{code}}.</p>",
    "text": "Bienvenue sur Logto. Votre code de vérification est {{code}}."
  },
  "SignIn": {
    "subject": "Bon retour sur Logto",
    "replyTo": "Foo <[email protected]>",
    "template": "logto-sign-in",
    "variables": {
      "bar": "baz"
    }
  }
}

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

Une fois que vous avez créé un connecteur avec succès, vous pouvez activer la connexion et l'inscription sans mot de passe basées sur le numéro de téléphone.

Accédez à Console > Expérience de connexion > Inscription et connexion.
Configurez les méthodes d'inscription (Optionnel) :
1. Sélectionnez "Adresse e-mail" ou "Email ou numéro de téléphone" comme identifiant d'inscription.
2. "Vérifier à l'inscription" est forcé d'être activé. Vous pouvez également activer "Créer un mot de passe" lors de l'inscription.
Configurez les méthodes de connexion :
1. Sélectionnez Adresse e-mail comme l'un des identifiants de connexion. Vous pouvez fournir plusieurs identifiants disponibles (email, numéro de téléphone et nom d'utilisateur).
2. Sélectionnez "Code de vérification" et / ou "Mot de passe" comme facteur d'authentification.
Cliquez sur "Enregistrer les modifications" et testez-le dans "Aperçu en direct".

En plus de l'inscription et de la connexion via les OTP , vous pouvez également activer la récupération de mot de passe et la vérification de sécurité basée sur , ainsi que lier Adresse e-mail au profil. Voir Flux des utilisateurs finaux pour plus de détails.

Test et validation

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

Créer une application dans Logto​

Intégrer Logto SDK​

Installation​

Init LogtoClient​

Implémenter la connexion et la déconnexion​

Gérer le statut d'authentification​

Point de contrôle : Testez votre application​

Ajouter le connecteur Mailgun​

Configurer Connecteur d’e-mail Mailgun​

Prérequis​

Configuration de base​

Livraisons​

Objet de configuration​

Types d'utilisation​

Configuration du contenu​

Exemple​

Enregistrer votre configuration​

Activer le connecteur Mailgun dans l'expérience de connexion​

Test et validation​

Lectures complémentaires​