Configurer la connexion sociale avec le protocole OAuth 2.0

Le connecteur officiel Logto pour le protocole OAuth 2.0.

astuce:

Ce guide suppose que vous avez une compréhension de base des Connecteurs Logto. Pour ceux qui ne sont pas familiers, veuillez vous référer au guide des Connecteurs pour commencer.

Commencer

Le connecteur OAuth permet la connexion de Logto à un fournisseur d'identité sociale arbitraire qui prend en charge le protocole OAuth 2.0.

remarque:

Le connecteur OAuth est un type spécial de connecteur dans Logto, vous pouvez ajouter quelques connecteurs basés sur le protocole OAuth.

Créez votre application OAuth

Lorsque vous ouvrez cette page, nous supposons que vous savez déjà quel fournisseur d'identité sociale vous souhaitez connecter. La première chose à faire est de confirmer que le fournisseur d'identité prend en charge le protocole OAuth, qui est une condition préalable pour configurer un connecteur valide. Ensuite, suivez les instructions du fournisseur d'identité pour enregistrer et créer l'application pertinente pour l'autorisation OAuth.

Configurez votre connecteur

Nous prenons en charge UNIQUEMENT le type de subvention "Authorization Code" pour des raisons de sécurité et il peut parfaitement s'adapter au scénario de Logto.

clientId et clientSecret peuvent être trouvés sur la page des détails de vos applications OAuth.

clientId : L'ID client est un identifiant unique qui identifie l'application cliente lors de l'enregistrement auprès du serveur d'autorisation. Cet ID est utilisé par le serveur d'autorisation pour vérifier l'identité de l'application cliente et pour associer tout jeton d’accès autorisé à cette application cliente spécifique.

clientSecret : Le secret client est une clé confidentielle qui est délivrée à l'application cliente par le serveur d'autorisation lors de l'enregistrement. L'application cliente utilise cette clé secrète pour s'authentifier auprès du serveur d'autorisation lors de la demande de jetons d’accès. Le secret client est considéré comme une information confidentielle et doit être gardé en sécurité à tout moment.

tokenEndpointAuthMethod : La méthode d'authentification du point de terminaison de jeton est utilisée par l'application cliente pour s'authentifier auprès du serveur d'autorisation lors de la demande de jetons d’accès. Pour découvrir les méthodes prises en charge, consultez le champ token_endpoint_auth_methods_supported disponible au point de terminaison de découverte OpenID Connect du fournisseur de services OAuth 2.0, ou référez-vous à la documentation pertinente fournie par le fournisseur de services OAuth 2.0.

clientSecretJwtSigningAlgorithm (Optionnel) : Requis uniquement lorsque tokenEndpointAuthMethod est client_secret_jwt. L'algorithme de signature JWT du secret client est utilisé par l'application cliente pour signer le JWT qui est envoyé au serveur d'autorisation lors de la requête de jeton.

scope : Le paramètre de portée est utilisé pour spécifier l'ensemble des ressources et des permissions auxquelles l'application cliente demande l'accès. Le paramètre de portée est généralement défini comme une liste de valeurs séparées par des espaces qui représentent des permissions spécifiques. Par exemple, une valeur de portée de "read write" pourrait indiquer que l'application cliente demande un accès en lecture et écriture aux données d'un utilisateur.

Vous êtes censé trouver authorizationEndpoint, tokenEndpoint et userInfoEndpoint dans la documentation du fournisseur social.

authenticationEndpoint : Ce point de terminaison est utilisé pour initier le processus d'authentification. Le processus d'authentification implique généralement que l'utilisateur se connecte et accorde l'autorisation à l'application cliente d'accéder à ses ressources.

tokenEndpoint : Ce point de terminaison est utilisé par l'application cliente pour obtenir un jeton d’accès qui peut être utilisé pour accéder aux ressources demandées. L'application cliente envoie généralement une requête au point de terminaison de jeton avec un type de subvention et un code d'autorisation pour recevoir un jeton d’accès.

userInfoEndpoint : Ce point de terminaison est utilisé par l'application cliente pour obtenir des informations supplémentaires sur l'utilisateur, telles que son nom complet, son adresse e-mail ou sa photo de profil. Le point de terminaison des informations utilisateur est généralement accessible après que l'application cliente a obtenu un jeton d’accès du point de terminaison de jeton.

Logto fournit également un champ profileMap que les utilisateurs peuvent personnaliser pour le mappage des profils des fournisseurs sociaux qui ne sont généralement pas standard. Les clés sont les noms de champs de profil utilisateur standard de Logto et les valeurs correspondantes doivent être les noms de champs des profils sociaux. À l'heure actuelle, Logto ne se préoccupe que de 'id', 'name', 'avatar', 'email' et 'phone' du profil social, seul 'id' est requis et les autres sont des champs optionnels.

responseType et grantType peuvent UNIQUEMENT être des valeurs FIXES avec le type de subvention par code d'autorisation, nous les rendons donc optionnels et les valeurs par défaut seront automatiquement remplies.

Par exemple, vous pouvez trouver la réponse du profil utilisateur de Google et donc son profileMap devrait ressembler à :

{
  "id": "sub",
  "avatar": "picture"
}

remarque:

Nous avons fourni une clé customConfig OPTIONNELLE pour mettre vos paramètres personnalisés. Chaque fournisseur d'identité sociale pourrait avoir sa propre variante sur le protocole standard OAuth. Si votre fournisseur d'identité sociale souhaité respecte strictement le protocole standard OAuth, alors vous n'avez pas besoin de vous soucier de customConfig.

Types de configuration

Nom	Type	Requis
authorizationEndpoint	string	true
userInfoEndpoint	string	true
clientId	string	true
clientSecret	string	true
tokenEndpointResponseType	enum	false
responseType	string	false
grantType	string	false
tokenEndpoint	string	false
scope	string	false
customConfig	Record<string, string>	false
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

Le cadre d'autorisation OAuth 2.0