Comment construire une connexion sans mot de passe GatewayAPI SMS avec SvelteKit

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 GatewayAPI (authentification utilisateur) avec SvelteKit et Logto.

Prérequis

Une instance Logto en cours d'exécution. Consultez la page d'introduction pour commencer.
Connaissance de base de SvelteKit.
Un compte GatewayAPI 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 Application web traditionnelle, 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 "Application web traditionnelle" ou filtrez tous les frameworks "Application web traditionnelle" disponibles en utilisant les cases à cocher de filtre rapide à gauche. Cliquez sur la carte du framework "SvelteKit" 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:

La démonstration suivante est construite sur SvelteKit 2.0.0.
Le projet d'exemple est disponible dans le répertoire GitHub.

Installation

Installez le SDK Logto via votre gestionnaire de paquets préféré :

npm
pnpm
yarn

npm i @logto/sveltekit

pnpm add @logto/sveltekit

yarn add @logto/sveltekit

Ajouter le hook Logto

Dans votre fichier hooks.server.ts, ajoutez le code suivant pour injecter le hook Logto dans votre serveur :

hooks.server.ts
import { handleLogto } from '@logto/sveltekit';

export const handle = handleLogto(
  {
    endpoint: '<your-logto-endpoint>',
    appId: '<your-logto-app-id>',
    appSecret: '<your-logto-app-secret>',
  },
  {
    encryptionKey: '<a-random-string>',
  }
);

Étant donné que ces informations sont sensibles, il est recommandé d'utiliser des variables d'environnement :

hooks.server.ts
import { handleLogto } from '@logto/sveltekit';
import { env } from '$env/dynamic/private';

export const handle = handleLogto(
  {
    endpoint: env.LOGTO_ENDPOINT,
    appId: env.LOGTO_APP_ID,
    appSecret: env.LOGTO_APP_SECRET,
  },
  {
    encryptionKey: env.LOGTO_COOKIE_ENCRYPTION_KEY,
  }
);

Si vous avez plusieurs hooks, vous pouvez utiliser la fonction helper sequence() pour les enchaîner :

hooks.server.ts
import { sequence } from '@sveltejs/kit/hooks';

export const handle = sequence(handleLogto, handleOtherHook);

Vous pouvez maintenant accéder au client Logto dans l'objet locals. Pour TypeScript, vous pouvez ajouter le type à app.d.ts :

import type { LogtoClient, UserInfoResponse } from '@logto/sveltekit';

declare global {
  namespace App {
    interface Locals {
      logtoClient: LogtoClient;
      user?: UserInfoResponse;
    }
  }
}

Nous discuterons de l'objet user plus tard.

remarque:

Dans les extraits de code suivants, nous supposons que votre application fonctionne sur http://localhost:3000/.

Avant de plonger dans les détails, voici un aperçu rapide de l'Expérience utilisateur. Le processus de connexion peut être simplifié comme suit :

Votre application lance la méthode de connexion.
L'utilisateur est redirigé vers la page de connexion Logto. Pour les applications natives, le navigateur système est ouvert.
L'utilisateur se connecte et est redirigé vers votre application (configurée comme l'URI de redirection).

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

Configurer les URIs de redirection

Passez à la page des détails de l'application de Logto Console. Ajoutez une URI de redirection http://localhost:3000/callback.

Tout comme pour la connexion, les utilisateurs doivent être redirigés vers Logto pour se déconnecter de la session partagée. Une fois terminé, il serait idéal de rediriger l'utilisateur vers votre site web. Par exemple, ajoutez http://localhost:3000/ comme section d'URI de redirection après déconnexion.

Ensuite, cliquez sur "Enregistrer" pour sauvegarder les modifications.

Dans la page où vous souhaitez implémenter la connexion et la déconnexion, définissez les actions suivantes :

+page.server.ts
import type { Actions } from './$types';

export const actions: Actions = {
  signIn: async ({ locals }) => {
    await locals.logtoClient.signIn('http://localhost:3000/callback');
  },
  signOut: async ({ locals }) => {
    await locals.logtoClient.signOut('http://localhost:3000/');
  },
};

Ensuite, utilisez ces actions dans votre composant Svelte :

+page.svelte
<form method="POST" action="?/{data.user ? 'signOut' : 'signIn'}">
  <button type="submit">Sign {data.user ? 'out' : 'in'}</button>
</form>

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 GatewayAPI

Le connecteur SMS est une méthode utilisée pour envoyer des mots de passe à usage unique (OTP) pour l'authentification. Il permet la vérification de Numéro de téléphone 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 SMS. Vous pouvez facilement connecter GatewayAPI en tant que fournisseur SMS. Avec le connecteur SMS de Logto, vous pouvez configurer cela en quelques minutes seulement.

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

Accédez à Console > Connector > Email and SMS connectors.
Pour ajouter un nouveau connecteur SMS, cliquez sur le bouton "Configurer" et sélectionnez "GatewayAPI".
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 SMS à l'aide de l'éditeur JSON.
Testez votre configuration en envoyant un code de vérification à votre Numéro de téléphone.

remarque:

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

Configurer Connecteur GatewayAPI SMS

Créer un compte GatewayAPI

Rendez-vous sur le site web de GatewayAPI et inscrivez-vous pour obtenir un compte GatewayAPI si vous n'en avez pas déjà un.

Activer le compte

Vous devrez peut-être activer votre compte avant d'utiliser le service SMS. Vous pouvez contacter le service client de GatewayAPI pour activer votre compte.

Obtenir un jeton API

Accédez à la page des clés API depuis la console GatewayAPI, puis trouvez le jeton API ou créez un nouveau jeton API.

Configurer dans Logto

Endpoint : Si votre compte GatewayAPI est dans la région UE, vous devez utiliser l'endpoint https://gatewayapi.com/rest/mtsms. Si votre compte GatewayAPI est dans la région US, vous devez utiliser l'endpoint https://gatewayapi.com/rest/mtsms.
Jeton API : Le jeton API que vous avez créé à l'étape précédente.
Expéditeur : L'expéditeur que vous souhaitez utiliser pour envoyer les SMS.
Modèles : Les modèles que vous souhaitez utiliser pour envoyer les SMS ; vous pouvez utiliser les modèles par défaut ou les modifier selon vos besoins.

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 GatewayAPI 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 "Numéro de téléphone" 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 Numéro de téléphone 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 Numéro de téléphone au profil. Voir Flux des utilisateurs finaux pour plus de détails.

Test et validation

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

Ajouter le hook Logto​

Implémenter la connexion et la déconnexion​

Concernant la connexion basée sur la redirection​

Configurer les URIs de redirection​

Point de contrôle : Testez votre application​

Ajouter le connecteur GatewayAPI​

Configurer Connecteur GatewayAPI SMS​

Créer un compte GatewayAPI​

Activer le compte​

Obtenir un jeton API​

Configurer dans Logto​

Enregistrer votre configuration​

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

Test et validation​

Lectures complémentaires​