Fournisseurs OAuth2 génériques

Introduction

Le plugin de connexion sociale Capgo comprend un moteur OAuth2 et OpenID Connect intégré. Vous pouvez l'utiliser pour vous connecter à tout fournisseur d'identité conforme aux normes, notamment :

• GitHub
• Azure AD / Microsoft Entra ID
• Auth0
• Okta
• Keycloak
• Serveurs OAuth2 ou OIDC personnalisés

La oauth2 La configuration est multi-fournisseur par conception. Vous pouvez enregistrer plusieurs fournisseurs à la fois et sélectionner ensuite un à l'heure du connexion avec providerId.

Ce dont vous avez besoin

Avant de configurer un fournisseur, collectez :

• Votre ID client OAuth
• Une URL de redirection qui correspond à votre schéma d'application ou à l'URL de rappel web
• Un point de terminaison d'autorisation
• Un point de terminaison de jeton pour le flux d'autorisation code issuerUrl pour la découverte OIDC
• Les étendues dont votre application a besoin, telles que openid profile email

Configuration de plusieurs fournisseurs

Utilisez SocialLogin.initialize() une seule fois lors du démarrage de l'application et enregistrez chaque fournisseur dont vous avez besoin :

import { SocialLogin } from '@capgo/capacitor-social-login';

await SocialLogin.initialize({
  oauth2: {
    github: {
      appId: 'your-github-client-id',
      authorizationBaseUrl: 'https://github.com/login/oauth/authorize',
      accessTokenEndpoint: 'https://github.com/login/oauth/access_token',
      redirectUrl: 'myapp://oauth/github',
      scope: 'read:user user:email',
      pkceEnabled: true,
      resourceUrl: 'https://api.github.com/user',
    },
    azure: {
      appId: 'your-azure-client-id',
      authorizationBaseUrl: 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize',
      accessTokenEndpoint: 'https://login.microsoftonline.com/common/oauth2/v2.0/token',
      redirectUrl: 'myapp://oauth/azure',
      scope: 'openid profile email User.Read',
      pkceEnabled: true,
      resourceUrl: 'https://graph.microsoft.com/v1.0/me',
    },
    auth0: {
      issuerUrl: 'https://your-tenant.auth0.com',
      appId: 'your-auth0-client-id',
      redirectUrl: 'myapp://oauth/auth0',
      scope: 'openid profile email offline_access',
      pkceEnabled: true,
      additionalParameters: {
        audience: 'https://your-api.example.com',
      },
    },
  },
});

Découverte OIDC et alias

Si votre fournisseur expose un document de découverte OpenID Connect, issuerUrl est la configuration la plus simple :

await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      issuerUrl: 'https://sso.example.com/realms/mobile',
      clientId: 'mobile-app',
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email offline_access',
      pkceEnabled: true,
    },
  },
});

Le plugin prend également en charge les alias OAuth et OIDC courants :

• clientId en tant que synonyme de appId
• authorizationEndpoint en tant que synonyme de authorizationBaseUrl
• tokenEndpoint en tant que synonyme de accessTokenEndpoint
• endSessionEndpoint en tant que synonyme de logoutUrl
• scopes En outre disponible : scope

pour les surcharges de requêtes d'authentification

• additionalParameters pour les surcharges d'échange de jetons
• additionalTokenParameters pour les en-têtes d'endpoint de ressource personnalisés
• additionalResourceHeaders et
• additionalLogoutParameters pour les flux de déconnexion postLogoutRedirectUrl __CAPGO_KEEP_0__
• loginHint, prompt, et iosPrefersEphemeralSession

Préférences compatibles avec Auth Connect

Si vous migrez de Ionic Auth Connect et que vous souhaitez conserver les mêmes noms de fournisseur, utilisez SocialLoginAuthConnect.

import { SocialLoginAuthConnect } from '@capgo/capacitor-social-login';

await SocialLoginAuthConnect.initialize({
  authConnect: {
    auth0: {
      domain: 'https://your-tenant.auth0.com',
      clientId: 'your-auth0-client-id',
      redirectUrl: 'myapp://oauth/auth0',
      audience: 'https://your-api.example.com',
    },
    azure: {
      tenantId: 'common',
      clientId: 'your-azure-client-id',
      redirectUrl: 'myapp://oauth/azure',
    },
    okta: {
      issuer: 'https://dev-12345.okta.com/oauth2/default',
      clientId: 'your-okta-client-id',
      redirectUrl: 'myapp://oauth/okta',
    },
  },
});

Identifiants de fournisseur de préférences pris en charge :

• auth0
• azure
• cognito
• okta
• onelogin

Si un fournisseur nécessite des points de terminaison personnalisés, vous pouvez soit les surcharger dans la préférence, soit contourner les préférences et configurer le fournisseur directement dans oauth2.

Options de configuration

Option	Type	Obligatoire	Description
appId / clientId	chaîne de caractères	Oui	Identifiant client OAuth2
issuerUrl	chaîne de caractères	Non	URL de base de découverte OIDC
authorizationBaseUrl / authorizationEndpoint	chaîne de caractères	Oui*	URL du point de terminaison d'autorisation
accessTokenEndpoint / tokenEndpoint	chaîne de caractères	Non*	Adresse URL de point de terminaison
redirectUrl	__CAPGO_KEEP_0__	Oui	Adresse URL de rappel
scope / scopes	__CAPGO_KEEP_1__ / __CAPGO_KEEP_1__[]	Non	Étendues requises
pkceEnabled	boolean	Non	Par défaut true
responseType	'code' ou 'token'	Non	Par défaut 'code'
resourceUrl	__CAPGO_KEEP_0__	Non	Informations de l'utilisateur ou point de terminaison de ressource
logoutUrl / endSessionEndpoint	__CAPGO_KEEP_0__	Non	URL de déconnexion ou fin de session
postLogoutRedirectUrl	__CAPGO_KEEP_0__	Non	URL de redirection après déconnexion
additionalParameters	Record<string, string>	Non	Paramètres supplémentaires de requête d'authentification
additionalTokenParameters	Record<string, string>	Non	Paramètres supplémentaires pour requête de jeton
additionalResourceHeaders	Record<string, string>	Non	En-têtes supplémentaires pour resourceUrl
additionalLogoutParameters	Record<string, string>	Non	Paramètres supplémentaires pour déconnexion
loginHint	chaîne	Non	Abréviation pour additionalParameters.login_hint
prompt	chaîne	Non	Abréviation pour additionalParameters.prompt
iosPrefersEphemeralSession	boolean	Non	Préférez une session de navigateur éphémère sur iOS
logsEnabled	boolean	Non	Activer la journalisation de débogage détaillée

authorizationBaseUrl et accessTokenEndpoint ne sont que facultatifs lorsque issuerUrl est suffisant pour la découverte. Les points de terminaison explicites l'emportent toujours sur les valeurs découvertes.

Utilisation de l'authentification OAuth2

Se connecter

const result = await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'github',
    scope: 'read:user user:email',
    loginHint: 'user@example.com',
  },
});

Flux de redirection sur le web

Utilisez flow: 'redirect' si vous souhaitez une redirection de page complète au lieu d'une fenêtre contextuelle :

await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'auth0',
    flow: 'redirect',
  },
});

Sur la page qui reçoit l'appel de retour, analysez le résultat de connexion :

const result = await SocialLogin.handleRedirectCallback();
if (result?.provider === 'oauth2') {
  console.log(result.result.providerId);
}

Statut de connexion et déconnexion

const status = await SocialLogin.isLoggedIn({
  provider: 'oauth2',
  providerId: 'github',
});

await SocialLogin.logout({
  provider: 'oauth2',
  providerId: 'github',
});

Refresh tokens

await SocialLogin.refresh({
  provider: 'oauth2',
  options: {
    providerId: 'github',
  },
});

const refreshed = await SocialLogin.refreshToken({
  provider: 'oauth2',
  providerId: 'github',
  refreshToken: 'existing-refresh-token',
});

refresh() utilise le jeton de rafraîchissement stocké par le plugin. refreshToken() vous permet de passer un jeton de rafraîchissement vous-même et renvoie la réponse OAuth2 fraîche.

Obtenez le jeton d'accès actuel

const code = await SocialLogin.getAuthorizationCode({
  provider: 'oauth2',
  providerId: 'github',
});

console.log(code.accessToken);

Exemples spécifiques au fournisseur

GitHub exemple

Utilisez GitHub lorsque vous souhaitez un flux d'application OAuth simple et des données de profil de base :

await SocialLogin.initialize({
  oauth2: {
    github: {
      appId: 'your-github-client-id',
      authorizationBaseUrl: 'https://github.com/login/oauth/authorize',
      accessTokenEndpoint: 'https://github.com/login/oauth/access_token',
      redirectUrl: 'myapp://oauth/github',
      scope: 'read:user user:email',
      pkceEnabled: true,
      resourceUrl: 'https://api.github.com/user',
    },
  },
});

const githubResult = await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'github',
  },
});

console.log(githubResult.result.accessToken?.token);
console.log(githubResult.result.resourceData);

Exemple d'Azure AD / Microsoft Entra ID

Utilisez Azure lorsque vous avez besoin de données Microsoft Graph telles que le profil de l'utilisateur :

await SocialLogin.initialize({
  oauth2: {
    azure: {
      appId: 'your-azure-client-id',
      authorizationBaseUrl: 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize',
      accessTokenEndpoint: 'https://login.microsoftonline.com/common/oauth2/v2.0/token',
      redirectUrl: 'myapp://oauth/azure',
      scope: 'openid profile email User.Read',
      pkceEnabled: true,
      resourceUrl: 'https://graph.microsoft.com/v1.0/me',
    },
  },
});

const azureResult = await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'azure',
  },
});

console.log(azureResult.result.idToken);
console.log(azureResult.result.resourceData);

Exemple d'Auth0

Auth0 est un bon choix lorsque vous avez besoin d'OIDC plus d'un auditeur personnalisé API :

await SocialLogin.initialize({
  oauth2: {
    auth0: {
      appId: 'your-auth0-client-id',
      authorizationBaseUrl: 'https://your-tenant.auth0.com/authorize',
      accessTokenEndpoint: 'https://your-tenant.auth0.com/oauth/token',
      redirectUrl: 'myapp://oauth/auth0',
      scope: 'openid profile email offline_access',
      pkceEnabled: true,
      additionalParameters: {
        audience: 'https://your-api.example.com',
      },
    },
  },
});

const auth0Result = await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'auth0',
    flow: 'redirect',
  },
});

Si vous utilisez le flux de redirection sur le web, lisez le résultat à nouveau sur la page de rappel :

const auth0Result = await SocialLogin.handleRedirectCallback();
if (auth0Result?.provider === 'oauth2') {
  console.log(auth0Result.result.idToken);
}

Exemple Okta

await SocialLogin.initialize({
  oauth2: {
    okta: {
      appId: 'your-okta-client-id',
      authorizationBaseUrl: 'https://your-domain.okta.com/oauth2/default/v1/authorize',
      accessTokenEndpoint: 'https://your-domain.okta.com/oauth2/default/v1/token',
      redirectUrl: 'myapp://oauth/okta',
      scope: 'openid profile email offline_access',
      pkceEnabled: true,
      resourceUrl: 'https://your-domain.okta.com/oauth2/default/v1/userinfo',
    },
  },
});

const oktaResult = await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'okta',
  },
});

console.log(oktaResult.result.resourceData);

Exemple Keycloak

Utiliser la découverte lorsque votre fournisseur publie /.well-known/openid-configuration:

await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      issuerUrl: 'https://sso.example.com/realms/mobile',
      clientId: 'mobile-app',
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email offline_access',
      pkceEnabled: true,
    },
  },
});

const keycloakResult = await SocialLogin.login({
  provider: 'oauth2',
  options: {
    providerId: 'keycloak',
  },
});

console.log(keycloakResult.result.idToken);

Forme de la réponse OAuth2

Les logins OAuth2 réussis retournent :

Champ	Description
providerId	La clé du fournisseur configurée utilisée pour le connexion
accessToken	Charge utile du jeton d'accès ou null
idToken	Si le fournisseur a retourné un jeton ID OIDC
refreshToken	Si les scopes demandés le permettaient
resourceData	JSON brut récupéré de resourceUrl
scope	Scopes concédés
tokenType	Généralement bearer
expiresIn	Durée de vie du jeton en secondes

Référence de configuration du fournisseur

GitHub

1. Créer une application OAuth Ouvrir GitHub Paramètres du développeur et créer une nouvelle application OAuth.

2. Définir l'URL de rappel Utilisez l'URL de redirection de votre application, par exemple myapp://oauth/github.

3. Configurer le plugin

   await SocialLogin.initialize({
     oauth2: {
       github: {
         appId: 'your-github-client-id',
         authorizationBaseUrl: 'https://github.com/login/oauth/authorize',
         accessTokenEndpoint: 'https://github.com/login/oauth/access_token',
         redirectUrl: 'myapp://oauth/github',
         scope: 'read:user user:email',
         pkceEnabled: true,
         resourceUrl: 'https://api.github.com/user',
       },
     },
   });

Azure AD / Microsoft Entra ID

1. Inscrire une application Allez sur le Portail Azure, ouvrez App registrationset créez l'enregistrement d'une application native ou mobile.

2. Ajoutez l'URI de redirection Ajoutez l'URI de redirection mobile ou de bureau qui correspond à l'URL de rappel de votre application.

3. Configurez le plugin

   await SocialLogin.initialize({
     oauth2: {
       azure: {
         appId: 'your-azure-client-id',
         authorizationBaseUrl: 'https://login.microsoftonline.com/common/oauth2/v2.0/authorize',
         accessTokenEndpoint: 'https://login.microsoftonline.com/common/oauth2/v2.0/token',
         redirectUrl: 'myapp://oauth/azure',
         scope: 'openid profile email User.Read',
         pkceEnabled: true,
         resourceUrl: 'https://graph.microsoft.com/v1.0/me',
       },
     },
   });

   Remarque

   Remplacez common par votre ID de locataire si votre application est multilocataire.

Auth0

1. Créez une application native Ouvrez le Tableau de bord Auth0 et créez une application native.

2. Définissez les URL de rappel autorisées Ajoutez l'URL de redirection exacte utilisée par votre Capacitor application.

3. Configurez le plugin

   await SocialLogin.initialize({
     oauth2: {
       auth0: {
         appId: 'your-auth0-client-id',
         authorizationBaseUrl: 'https://your-tenant.auth0.com/authorize',
         accessTokenEndpoint: 'https://your-tenant.auth0.com/oauth/token',
         redirectUrl: 'myapp://oauth/auth0',
         scope: 'openid profile email offline_access',
         pkceEnabled: true,
         additionalParameters: {
           audience: 'https://your-api.example.com',
         },
         logoutUrl: 'https://your-tenant.auth0.com/v2/logout',
       },
     },
   });

Okta

1. Créez une application native OIDC Dans le console d'administration Okta, créez une application Native OIDC.

2. Ajoutez votre URI de redirection Enregistrez l'URL de rappel exacte utilisée par votre application.

3. Configurez le plugin

   await SocialLogin.initialize({
     oauth2: {
       okta: {
         appId: 'your-okta-client-id',
         authorizationBaseUrl: 'https://your-domain.okta.com/oauth2/default/v1/authorize',
         accessTokenEndpoint: 'https://your-domain.okta.com/oauth2/default/v1/token',
         redirectUrl: 'myapp://oauth/okta',
         scope: 'openid profile email offline_access',
         pkceEnabled: true,
         resourceUrl: 'https://your-domain.okta.com/oauth2/default/v1/userinfo',
       },
     },
   });

Keycloak et fournisseurs OIDC personnalisés

Si votre fournisseur prend en charge la découverte OpenID Connect, préférez issuerUrl:

await SocialLogin.initialize({
  oauth2: {
    keycloak: {
      issuerUrl: 'https://sso.example.com/realms/mobile',
      clientId: 'mobile-app',
      redirectUrl: 'myapp://oauth/keycloak',
      scope: 'openid profile email offline_access',
      pkceEnabled: true,
    },
  },
});

Si la découverte n'est pas disponible, configurez les points de terminaison d'autorisation et de jeton manuellement.

Notes spécifiques à la plateforme

iOS

• Le plugin utilise ASWebAuthenticationSession.
• Définir iosPrefersEphemeralSession: true Si vous souhaitez une session de navigateur privée sans cookies partagés.

Android

• Les redirections OAuth retournent par votre schéma et votre hôte d'application.
• Assurez-vous que l'URL de rappel du fournisseur correspond exactement à votre configuration de lien profond Android.
• Le plugin gère déjà l'activité OAuth. Ajoutez uniquement des filtres d'intent personnalisés si votre application nécessite un modèle de redirection différent.

Web

• Le flux de popup est le mode par défaut et fonctionne bien pour les applications monopage.
• Le flux de redirection est préférable lorsque le fournisseur bloque les popup ou que vos règles d'autorisation nécessitent une navigation de niveau supérieur.
• Certains fournisseurs bloquent l'échange de jetons directement par navigateur avec CORS. Dans ces cas, utilisez un échange backend ou une configuration de fournisseur qui permet aux clients publics.

Meilleures pratiques de sécurité

1. Utilisez PKCE Conservez pkceEnabled: true pour les clients publics.

2. La mise en œuvre de l'code flux est plus sûre que le flux implicite. responseType: 'code' Vérifiez les jetons sur votre serveur

3. Décodez et vérifiez l'émetteur, l'audience, la date d'expiration et la signature côté serveur. Stockez les jetons de rappel de manière sécurisée

4. Pour les applications natives, associez ce plugin avec Utilisez un échange backend ou une configuration de fournisseur qui permet aux clients publics. @capgo/capacitor-compte-persistant.

5. Utilisez HTTPS partout Les points de terminaison d'authentification et de déconnexion en production doivent toujours utiliser HTTPS.

Résolution des problèmes

providerId is required

Chaque méthode OAuth2 nécessite la clé de fournisseur configurée :

await SocialLogin.login({
  provider: 'oauth2',
  options: { providerId: 'github' },
});

OAuth2 provider "xxx" not configured

Appel SocialLogin.initialize() avant la connexion et assurez-vous que providerId correspond à la clé de l'objet sous oauth2.

Mauvaise correspondance de l'URL de redirection

• Comparez l'URL de redirection configurée dans votre application et dans le tableau de bord du fournisseur caractère par caractère.
• Faites attention aux slash finals, aux incohérences de schéma et aux hôtes différents.
• Assurez-vous que les schémas d'URL des applications mobiles soient enregistrés avant de tester sur appareil.

Aucun jeton de renouvellement retourné

La plupart des fournisseurs ne retournent des jetons de renouvellement que lorsque vous demandez des scopes comme offline_access ou que vous forcez explicitement le consentement. Consultez la politique spécifique au fournisseur.

Débogage de l'échange de jetons

Activez la débogage logsEnabled: true sur la configuration du fournisseur pour inspecter les URL générées et les détails de l'échange de jetons.

docs connexes

• Démarrage de l'authentification par les réseaux sociaux
• Migration vers Ionic Auth Connect