Aller au contenu principal
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 SMTP (authentification utilisateur) avec Extension Chrome et Logto.

Prérequis

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 Application monopage, 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". Get started
  2. Dans la fenêtre modale qui s'ouvre, cliquez sur la section "Application monopage" ou filtrez tous les frameworks "Application monopage" disponibles en utilisant les cases à cocher de filtre rapide à gauche. Cliquez sur la carte du framework "Extension Chrome" pour commencer à créer votre application. Frameworks
  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 Logto SDK

astuce:
  • La démonstration suivante a été testée sur Chrome v123.0.6312.87 (arm64). D'autres versions devraient également fonctionner, tant qu'elles prennent en charge les API chrome utilisées dans le SDK.
  • Le projet d'exemple est disponible sur notre répertoire GitHub.

Installation

npm i @logto/chrome-extension

Le flux d'authentification

En supposant que vous ayez placé un bouton "Se connecter" dans le popup de votre extension Chrome, le flux d'authentification ressemblera à ceci :

Pour d'autres pages interactives dans votre extension, vous devez simplement remplacer le participant Popup de l'extension par le nom de la page. Dans ce tutoriel, nous nous concentrerons sur la page popup.

Concernant la connexion basée sur la redirection

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

Mettre à jour le manifest.json

Le SDK Logto nécessite les permissions suivantes dans le manifest.json :

manifest.json
{
"permissions": ["identity", "storage"],
"host_permissions": ["https://*.logto.app/*"]
}
  • permissions.identity : Nécessaire pour l'API Chrome Identity, utilisée pour se connecter et se déconnecter.
  • permissions.storage : Nécessaire pour stocker la session de l'utilisateur.
  • host_permissions : Nécessaire pour que le SDK Logto communique avec les APIs Logto.
remarque:

Si vous utilisez un domaine personnalisé sur Logto Cloud, vous devez mettre à jour le host_permissions pour correspondre à votre domaine.

Configurer un script d'arrière-plan (service worker)

Dans le script d'arrière-plan de votre extension Chrome, initialisez le SDK Logto :

service-worker.js
import LogtoClient from '@logto/chrome-extension';

export const logtoClient = new LogtoClient({
endpoint: '<your-logto-endpoint>'
appId: '<your-logto-app-id>',
});

Remplacez <your-logto-endpoint> et <your-logto-app-id> par les valeurs réelles. Vous pouvez trouver ces valeurs sur la page de l'application que vous venez de créer dans la Logto Console.

Si vous n'avez pas de script d'arrière-plan, vous pouvez suivre le guide officiel pour en créer un.

info:

Pourquoi avons-nous besoin d'un script d'arrière-plan ?

Les pages d'extension normales comme le popup ou la page d'options ne peuvent pas s'exécuter en arrière-plan et peuvent être fermées pendant le processus d'authentification. Un script d'arrière-plan garantit que le processus d'authentification peut être correctement géré.

Ensuite, nous devons écouter le message provenant d'autres pages d'extension et gérer le processus d'authentification :

service-worker.js
chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
// Dans le code ci-dessous, puisque nous retournons `true` pour chaque action, nous devons appeler `sendResponse`
// pour notifier l'expéditeur. Vous pouvez également gérer les erreurs ici, ou utiliser d'autres moyens pour notifier l'expéditeur.

if (message.action === 'signIn') {
const redirectUri = chrome.identity.getRedirectURL('/callback');
logtoClient.signIn(redirectUri).finally(sendResponse);
return true;
}

if (message.action === 'signOut') {
const redirectUri = chrome.identity.getRedirectURL();
logtoClient.signOut(redirectUri).finally(sendResponse);
return true;
}

return false;
});

Vous remarquerez peut-être qu'il y a deux URIs de redirection utilisées dans le code ci-dessus. Elles sont toutes deux créées par chrome.identity.getRedirectURL, qui est une API Chrome intégrée pour générer une URL de redirection pour les flux d'authentification. Les deux URIs seront :

  • https://<extension-id>.chromiumapp.org/callback pour la connexion.
  • https://<extension-id>.chromiumapp.org/ pour la déconnexion.

Notez que ces URIs ne sont pas accessibles et sont uniquement utilisées pour que Chrome déclenche des actions spécifiques pour le processus d'authentification.

Mettre à jour les paramètres de l'application Logto

Nous devons maintenant mettre à jour les paramètres de l'application Logto pour autoriser les URIs de redirection que nous venons de créer.

  1. Allez sur la page de l'application dans la Logto Console.
  2. Dans la section "URIs de redirection", ajoutez l'URI : https://<extension-id>.chromiumapp.org/callback.
  3. Dans la section "URIs de redirection après déconnexion", ajoutez l'URI : https://<extension-id>.chromiumapp.org/.
  4. Dans la section "Origines autorisées pour CORS", ajoutez l'URI : chrome-extension://<extension-id>. Le SDK dans l'extension Chrome utilisera cette origine pour communiquer avec les APIs Logto.
  5. Cliquez sur Enregistrer les modifications.

N'oubliez pas de remplacer <extension-id> par votre ID d'extension réel. Vous pouvez trouver l'ID de l'extension sur la page chrome://extensions.

Ajouter des boutons de connexion et de déconnexion au popup

Nous y sommes presque ! Ajoutons les boutons de connexion et de déconnexion et la logique nécessaire à la page popup.

Dans le fichier popup.html :

popup.html
<button id="sign-in">Se connecter</button> <button id="sign-out">Se déconnecter</button>

Dans le fichier popup.js (en supposant que popup.js est inclus dans le popup.html) :

popup.js
document.getElementById('sign-in').addEventListener('click', async () => {
await chrome.runtime.sendMessage({ action: 'signIn' });
// Connexion terminée (ou échouée), vous pouvez mettre à jour l'interface utilisateur ici.
});

document.getElementById('sign-out').addEventListener('click', async () => {
await chrome.runtime.sendMessage({ action: 'signOut' });
// Déconnexion terminée (ou échouée), vous pouvez mettre à jour l'interface utilisateur ici.
});

Point de contrôle : Tester le flux d'authentification

Vous pouvez maintenant tester le flux d'authentification dans votre extension Chrome :

  1. Ouvrez le popup de l'extension.
  2. Cliquez sur le bouton "Se connecter".
  3. Vous serez redirigé vers la page de connexion Logto.
  4. Connectez-vous avec votre compte Logto.
  5. Vous serez redirigé vers Chrome.

Vérifier l'état d'authentification

Puisque Chrome fournit des APIs de stockage unifiées, en dehors du flux de connexion et de déconnexion, toutes les autres méthodes du SDK Logto peuvent être utilisées directement dans la page popup.

Dans votre popup.js, vous pouvez réutiliser l'instance LogtoClient créée dans le script d'arrière-plan, ou en créer une nouvelle avec la même configuration :

popup.js
import LogtoClient from '@logto/chrome-extension';

const logtoClient = new LogtoClient({
endpoint: '<your-logto-endpoint>'
appId: '<your-logto-app-id>',
});

// Ou réutilisez l'instance logtoClient créée dans le script d'arrière-plan
import { logtoClient } from './service-worker.js';

Ensuite, vous pouvez créer une fonction pour charger l'état d'authentification et le profil de l'utilisateur :

popup.js
const loadAuthenticationState = async () => {
const isAuthenticated = await logtoClient.isAuthenticated();
// Mettez à jour l'interface utilisateur en fonction de l'état d'authentification

if (isAuthenticated) {
const user = await logtoClient.getIdTokenClaims(); // { sub: '...', email: '...', ... }
// Mettez à jour l'interface utilisateur avec le profil de l'utilisateur
}
};

Vous pouvez également combiner la fonction loadAuthenticationState avec la logique de connexion et de déconnexion :

popup.js
document.getElementById('sign-in').addEventListener('click', async () => {
await chrome.runtime.sendMessage({ action: 'signIn' });
await loadAuthenticationState();
});

document.getElementById('sign-out').addEventListener('click', async () => {
await chrome.runtime.sendMessage({ action: 'signOut' });
await loadAuthenticationState();
});

Voici un exemple de la page popup avec l'état d'authentification :

Page popup

Autres considérations

  • Bundling du service worker : Si vous utilisez un bundler comme Webpack ou Rollup, vous devez explicitement définir la cible sur browser ou similaire pour éviter le bundling inutile de modules Node.js.
  • Résolution de module : Le SDK Logto pour extension Chrome est un module uniquement ESM.

Consultez notre projet d'exemple pour un exemple complet avec TypeScript, Rollup, et d'autres configurations.

Ajouter le connecteur SMTP

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

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

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

Configurer Connecteur e-mail SMTP

Configurer le connecteur SMTP

SMTP est un protocole de transmission qui n'est pas exclusif à certains fournisseurs de services de messagerie spécifiques, mais peut fonctionner avec tous les fournisseurs.

Nous proposons désormais des guides sur la façon d'utiliser le connecteur SMTP pour envoyer des e-mails via les fournisseurs suivants afin de mieux comprendre :

  • Gmail est le fournisseur de service de messagerie le plus populaire au monde.
  • Aliyun direct mail et SendGrid mail. Certains d'entre vous connaissent peut-être ces deux fournisseurs de services de messagerie car l'équipe Logto a fourni des connecteurs correspondants ; vous en avez probablement déjà une idée générale.

Nous espérons que vous pourrez configurer tous les autres fournisseurs de messagerie à l'aide des exemples suivants 🚀

Configuration pour l'utilisation de Gmail

Vous pouvez obtenir un nouveau compte Gmail sur Gmail, ou utiliser un compte existant si vous en avez déjà un.

Un article officiel de Gmail explique comment déterminer les valeurs des propriétés requises pour utiliser Gmail via un connecteur SMTP.

Intégration avec SendGrid SMTP API

Nous partons du principe que vous disposez déjà d'un compte SendGrid. Sinon, créez un nouveau compte sur le site SendGrid.

Vous trouverez un guide étape par étape sur "Intégration avec l’API SMTP".

Les développeurs peuvent accéder aux détails de l’expéditeur sur la page "Gestion des expéditeurs".

Configuration avec un compte Aliyun direct mail

Connectez-vous au site Aliyun. Inscrivez-vous si vous n'avez pas encore de compte.

Suivez le guide Envoyer des e-mails via SMTP et effectuez les "tâches" pour obtenir les paramètres et informations nécessaires.

Vous pouvez consulter la page d'adresse du service SMTP pour choisir un hôte d'adresse de service SMTP et un numéro de port appropriés.

Pour vérifier les "Adresses d'expéditeur", vous trouverez l'entrée dans le menu de navigation de gauche sur la console DirectMail. Vous devriez voir ici Sender address et SMTP Password.

remarque:

Un seul modèle d'exemple est fourni dans les cas précédents pour simplifier les choses. Vous devriez ajouter d'autres modèles pour d'autres cas d'utilisation. Vous devez modifier les valeurs entourées de "<" et ">" selon les paramètres de votre compte Gmail, SendGrid ou Aliyun et choisir de conserver les autres champs sans "<" et ">". Ajoutez {{code}} comme espace réservé dans le contenu des modèles pour afficher un code de vérification aléatoire dans les e-mails envoyés.

Tester le connecteur SMTP

Vous pouvez saisir une adresse e-mail et cliquer sur "Envoyer" pour vérifier si les paramètres fonctionnent avant de cliquer sur "Enregistrer et terminer".

C'est tout. N'oubliez pas de Activer le connecteur dans l’expérience de connexion.

Types de configuration

NomType
hoststring
portstring
fromEmailstring
templatesTemplate[]
Propriétés du modèleTypeValeurs énumérées
subjectstringN/A
contentstringN/A
usageTypeenum string'Register' / 'SignIn' / 'ForgotPassword' / 'Generic'
contentTypeenum string'text/plain' / 'text/html'

Options d’authentification nom d’utilisateur et mot de passe

NomTypeValeurs énumérées
userstringN/A
passstringN/A
typeenum string (OPTIONNEL)'login'

Vous pouvez également configurer les Options d’authentification OAuth2 et d'autres configurations avancées. Voir ici pour plus de détails.

Nous avons donné un exemple de configuration avec tous les paramètres configurables dans la zone de texte pour vous aider à configurer votre propre configuration. (Vous êtes responsable de la configuration, certaines valeurs sont fournies à titre d'exemple et peuvent ne pas convenir à votre cas d'utilisation.)

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

Activer le connecteur SMTP dans l'expérience de connexion

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.

  1. Accédez à Console > Expérience de connexion > Inscription et connexion.
  2. 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.
  3. 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.
  4. Cliquez sur "Enregistrer les modifications" et testez-le dans "Aperçu en direct".
Onglet Expérience de connexion

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 Extension Chrome. Vous devriez maintenant pouvoir vous connecter avec SMTP. 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à.