Comment construire une connexion SAML avec Extension Chrome

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 SAML (authentification utilisateur) avec Extension Chrome et Logto.

Prérequis

Une instance Logto en cours d'exécution. Consultez la page d'introduction pour commencer.
Connaissance de base de Extension Chrome.
Un compte SAML 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 monopage, 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 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.
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 Extension Chrome

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
Yarn
pnpm

npm i @logto/chrome-extension

yarn add @logto/chrome-extension

pnpm add @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.

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.

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.

Allez sur la page de l'application dans la Logto Console.
Dans la section "URIs de redirection", ajoutez l'URI : https://<extension-id>.chromiumapp.org/callback.
Dans la section "URIs de redirection après déconnexion", ajoutez l'URI : https://<extension-id>.chromiumapp.org/.
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.
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.

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 :

Ouvrez le popup de l'extension.
Cliquez sur le bouton "Se connecter".
Vous serez redirigé vers la page de connexion Logto.
Connectez-vous avec votre compte Logto.
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 :

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 SAML

Pour activer une connexion rapide et améliorer la conversion des utilisateurs, connectez-vous avec Extension Chrome 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 :

Accédez à Console > Connectors > Social Connectors.
Cliquez sur "Add social connector" et sélectionnez "SAML".
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 Application SAML standard

Passons en revue les configurations du connecteur SAML.

Avant de commencer, vous pouvez vous rendre chez un fournisseur d'identité sociale qui prend en charge le protocole SAML et créer votre propre compte. Okta, OneLogin, Salesforce et certaines autres plateformes prennent en charge l'authentification basée sur le protocole SAML.

Si votre IdP exige le chiffrement de l'assertion SAML et la réception de requêtes d'authentification signées, vous devez générer votre clé privée et le certificat correspondant en utilisant l'algorithme RSA. Conservez la clé privée pour votre utilisation SP et téléchargez le certificat sur IdP.

Vous devez également configurer l'URL ACS (Assertion Consumer Service) comme ${your_logto_origin}/api/authn/saml/${connector_id} pour gérer l'assertion SAML de l'IdP. Vous pouvez trouver votre connectorId sur la page des détails du connecteur SAML dans la console d'administration de Logto.

remarque:

Selon la conception actuelle de Logto, nous ne prenons en charge que la liaison par redirection pour l'envoi de requêtes d'authentification et la liaison par POST pour la réception d'assertions SAML. Bien que cela ne semble pas très cool, nous pensons que la conception actuelle peut gérer la plupart de vos cas d'utilisation. Si vous avez des problèmes, n'hésitez pas à nous contacter !

Configurer le connecteur SAML (SP)

Dans cette section, nous allons présenter chaque attribut en détail.

entityID `Requis`

entityID (c'est-à-dire issuer) est l'identifiant de l'entité. Il est utilisé pour identifier votre entité (entité SP SAML) et correspondre à l'équivalence dans chaque requête/réponse SAML.

signInEndpoint `Requis`

Le point de terminaison de l'IdP auquel vous envoyez les requêtes d'authentification SAML. Habituellement, vous pouvez trouver cette valeur sur la page des détails de l'IdP (c'est-à-dire l'URL SSO ou l'URL de connexion de l'IdP).

x509Certificate `Requis`

Le certificat x509 généré à partir de la clé privée de l'IdP, l'IdP est censé avoir cette valeur disponible.

Le contenu du certificat est accompagné de l'en-tête -----BEGIN CERTIFICATE----- et de la fin -----END CERTIFICATE-----.

idpMetadataXml `Requis`

Le champ est utilisé pour placer le contenu de votre fichier XML de métadonnées IdP.

remarque:

Le parseur XML que nous utilisons ne prend pas en charge les espaces de noms personnalisés. Si les métadonnées de l'IdP comportent un espace de noms, vous devez les supprimer manuellement. Pour l'espace de noms du fichier XML, voir référence.

assertionConsumerServiceUrl `Requis`

L'URL du service consommateur d'assertions (ACS) est le point de terminaison du SP pour recevoir les requêtes POST d'assertion SAML de l'IdP. Comme nous l'avons mentionné dans la partie précédente, elle est généralement configurée dans les paramètres de l'IdP, mais certains IdP obtiennent cette valeur à partir des requêtes d'authentification SAML, nous ajoutons donc également cette valeur en tant que champ REQUIS. Sa valeur devrait ressembler à ${your_logto_origin}/api/authn/saml/${connector_id}.

signAuthnRequest

La valeur booléenne qui contrôle si la requête d'authentification SAML doit être signée, dont la valeur par défaut est false.

encryptAssertion

encryptAssertion est une valeur booléenne qui indique si l'IdP chiffrera l'assertion SAML, avec une valeur par défaut false.

remarque:

Les attributs signAuthnRequest et encryptAssertion doivent être alignés avec les paramètres correspondants de l'IdP, sinon une erreur sera générée pour indiquer que la configuration ne correspond pas. Toutes les réponses SAML doivent être signées.

requestSignatureAlgorithm

Cela doit être aligné avec les algorithmes de signature de l'IdP afin que Logto puisse vérifier la signature de l'assertion SAML. Sa valeur doit être soit http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 ou http://www.w3.org/2001/04/xmldsig-more#rsa-sha512 et la valeur par défaut est http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

messageSigningOrder

messageSigningOrder indique l'ordre de signature et de chiffrement de l'IdP, sa valeur doit être soit sign-then-encrypt soit encrypt-then-sign et la valeur par défaut est sign-then-encrypt.

privateKey et privateKeyPass

privateKey est une valeur OPTIONNELLE et est requise lorsque signAuthnRequest est true.

privateKeyPass est le mot de passe que vous avez défini lors de la création de privateKey, requis si nécessaire.

Si signAuthnRequest est true, le certificat correspondant généré à partir de privateKey est requis par l'IdP pour vérifier la signature.

encPrivateKey et encPrivateKeyPass

encPrivateKey est une valeur OPTIONNELLE et est requise lorsque encryptAssertion est true.

encPrivateKeyPass est le mot de passe que vous avez défini lors de la création de encPrivateKey, requis si nécessaire.

Si encryptAssertion est true, le certificat correspondant généré à partir de encPrivateKey est requis par l'IdP pour chiffrer l'assertion SAML.

remarque:

Pour la génération de clés et de certificats, openssl est un outil formidable. Voici une ligne de commande d'exemple qui pourrait être utile :

openssl genrsa -passout pass:${privateKeyPassword} -out ${encryptPrivateKeyFilename}.pem 4096
openssl req -new -x509 -key ${encryptPrivateKeyFilename}.pem -out ${encryptionCertificateFilename}.cer -days 3650

Les fichiers privateKey et encPrivateKey doivent être encodés dans le schéma pkcs1 en tant que chaîne pem, ce qui signifie que les fichiers de clé privée doivent commencer par -----BEGIN RSA PRIVATE KEY----- et se terminer par -----END RSA PRIVATE KEY-----.

nameIDFormat

nameIDFormat est un attribut OPTIONNEL qui déclare le format d'identifiant de nom qui répondrait. La valeur peut être parmi urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified, urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent et urn:oasis:names:tc:SAML:2.0:nameid-format:transient, et la valeur par défaut est urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified.

timeout

timeout est la tolérance de temps pour la validation temporelle, car le temps entre votre entité SP et l'entité IdP pourrait être différent et la connexion réseau peut également apporter un certain retard. L'unité est en millisecondes, et la valeur par défaut est 5000 (c'est-à-dire 5s).

profileMap

Logto fournit également un champ profileMap que les utilisateurs peuvent personnaliser pour mapper les profils des fournisseurs sociaux qui ne sont généralement pas standard. Chaque clé profileMap est le nom du champ de profil utilisateur standard de Logto et la valeur correspondante doit être le nom du champ de profil social. À l'heure actuelle, Logto ne concerne que 'id', 'name', 'avatar', 'email' et 'phone' du profil social, seul 'id' est REQUIS et les autres sont des champs optionnels.

Types de configuration

Nom	Type	Requis	Valeur par défaut
signInEndpoint	string	true
x509certificate	string	true
idpMetadataXml	string	true
entityID	string	true
assertionConsumerServiceUrl	string	true
messageSigningOrder	`encrypt-then-sign` \| `sign-then-encrypt`	false	`sign-then-encrypt`
requestSignatureAlgorithm	`http://www.w3.org/2000/09/xmldsig#rsa-sha1` \| `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` \| `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512`	false	`http://www.w3.org/2001/04/xmldsig-more#rsa-sha256`
signAuthnRequest	boolean	false	false
encryptAssertion	boolean	false	false
privateKey	string	false
privateKeyPass	string	false
nameIDFormat	`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified` \| `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` \| `urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName` \| `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` \| `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`	false	`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`
timeout	number	false	5000
profileMap	ProfileMap	false

Champs ProfileMap	Type	Requis	Valeur par défaut
id	string	false	id
name	string	false	name
avatar	string	false	avatar
email	string	false	email
phone	string	false	phone

Référence

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

Une fois que vous avez créé un connecteur social avec succès, vous pouvez l'activer en tant que bouton "Continuer avec SAML" dans l'Expérience de connexion.

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

Tests et validation

Retournez à votre application Extension Chrome. Vous devriez maintenant pouvoir vous connecter avec SAML. 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 le SDK Extension Chrome​

Installation​

Le flux d'authentification​

Concernant la connexion basée sur la redirection​

Mettre à jour le manifest.json​

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

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

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

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

Vérifier l'état d'authentification​

Autres considérations​

Ajouter le connecteur SAML​

Configurer Application SAML standard​

Créer un compte IdP social et enregistrer l'application SAML (IdP)​

Configurer le connecteur SAML (SP)​

entityID Requis​

signInEndpoint Requis​

x509Certificate Requis​

idpMetadataXml Requis​

assertionConsumerServiceUrl Requis​

signAuthnRequest​

encryptAssertion​

requestSignatureAlgorithm​

messageSigningOrder​

privateKey et privateKeyPass​

encPrivateKey et encPrivateKeyPass​

nameIDFormat​

timeout​

profileMap​

Types de configuration​

Référence​

Enregistrer votre configuration​

Activer le connecteur SAML dans l'Expérience de connexion​

Tests et validation​

Lectures complémentaires​

Créer une application dans Logto

Intégrer le SDK Extension Chrome

Installation

Le flux d'authentification

Concernant la connexion basée sur la redirection

Mettre à jour le `manifest.json`

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

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

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

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

Vérifier l'état d'authentification

Autres considérations

Ajouter le connecteur SAML

Configurer Application SAML standard

Créer un compte IdP social et enregistrer l'application SAML (IdP)

Configurer le connecteur SAML (SP)

entityID `Requis`

signInEndpoint `Requis`

x509Certificate `Requis`

idpMetadataXml `Requis`

assertionConsumerServiceUrl `Requis`

signAuthnRequest

encryptAssertion

requestSignatureAlgorithm

messageSigningOrder

privateKey et privateKeyPass

encPrivateKey et encPrivateKeyPass

nameIDFormat

timeout

profileMap

Types de configuration

Référence

Enregistrer votre configuration

Activer le connecteur SAML dans l'Expérience de connexion

Tests et validation

Lectures complémentaires