Comment construire une connexion WeCom 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 WeCom (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 WeCom 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 WeCom

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

Commencer

Connectez-vous à WeCom WebUI avec un compte administrateur ou cliquez sur Gérer l’entreprise (管理企业) depuis l’application WeCom.

Dans l’onglet "Gestion des applications", faites défiler la page vers le bas et cliquez sur "Créer une application".

Renseignez les informations appropriées selon votre application. Puis créez.

Nous avons maintenant l’ID d’agent (Agent ID, PAS APPID) et le Secret.

Informations sur le site web

Définissez les éléments nécessaires sur cette page. Cela pourrait être :

Utilisateurs autorisés : qui peut voir cette application
Page d’accueil de l’application : La page d’accueil de votre application. Par exemple, logto.io/demo-app

Important
Il y a trois éléments sur cette page concernant l’"API développeur (开发者接口)".

Autorisation Web et JS-SDK ;
Connexion via l’autorisation par WeCom ;
IP de confiance de l’entreprise ;

Remplissez-les selon le guide de WeCom.

ID d’entreprise (Corp ID)

Si vous êtes familier avec le développement WeChat, vous remarquerez peut-être que l’utilisation de l’ID d’entreprise (Corp ID) est la même que celle de l’APP ID.

Vous pouvez trouver le Corp ID en bas de l’onglet "Mon entreprise (我的企业)". Il ressemble à ww**** .

Configurer le connecteur

Nous avons donc l’Agent ID, le Secret et le Corp ID.

Complétons le formulaire pour le connecteur.

Vous pouvez laisser le champ Scope vide car il est optionnel. Sinon, vous pouvez saisir snsapi_base ou snsapi_privateinfo.

Enregistrez et c’est terminé

Tester le connecteur WeCom

C’est tout. Le connecteur WeCom devrait maintenant être disponible. N’oubliez pas de activer le connecteur social dans l’expérience de connexion.

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 WeCom 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 WeCom" 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 WeCom configuré à la section "Connexion sociale".

Tests et validation

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

Configurer Application WeCom​

Commencer​

Informations sur le site web​

ID d’entreprise (Corp ID)​

Configurer le connecteur​

Tester le connecteur WeCom​

Enregistrer votre configuration​

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

Tests et validation​

Lectures complémentaires​