Comment construire une connexion OIDC avec Go

Pour nos nouveaux amis:

Logto est une alternative à Auth0 conçue pour les applications modernes et les produits SaaS. Il offre des services 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 passer en revue les étapes pour construire rapidement l'expérience de connexion OIDC (authentification utilisateur) avec Go et Logto.

Prérequis

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

astuce:

La démonstration suivante est construite sur le Gin Web Framework. Vous pouvez également intégrer Logto dans d'autres frameworks en suivant les mêmes étapes.
Le projet d'exemple Go est disponible sur notre dépôt Go SDK.

Installation

Exécutez dans le répertoire racine du projet :

go get github.com/logto-io/go

Ajoutez le package github.com/logto-io/go/client à votre code d'application :

main.go
// main.go
package main

import (
	"github.com/gin-gonic/gin"
	// Add dependency
	"github.com/logto-io/go/client"
)

func main() {
	router := gin.Default()
	router.GET("/", func(c *gin.Context) {
		c.String(200, "Hello Logto!")
	})
	router.Run(":3000")
}

Créer un stockage de session

Dans les applications web traditionnelles, les informations d'Authentification (Authentication) de l'utilisateur sont stockées dans la session utilisateur.

Le SDK Logto fournit une interface Storage, vous pouvez implémenter un adaptateur Storage basé sur votre framework web afin que le SDK Logto puisse stocker les informations d'Authentification (Authentication) de l'utilisateur dans la session.

remarque:

Nous ne recommandons PAS d'utiliser des sessions basées sur les cookies, car les informations d'Authentification (Authentication) de l'utilisateur stockées par Logto peuvent dépasser la limite de taille des cookies. Dans cet exemple, nous utilisons des sessions basées sur la mémoire. Vous pouvez utiliser Redis, MongoDB et d'autres technologies en production pour stocker les sessions selon vos besoins.

Le type Storage dans le SDK Logto est le suivant :

github.com/logto-io/client/storage.go
package client

type Storage interface {
	GetItem(key string) string
	SetItem(key, value string)
}

Nous utilisons le middleware github.com/gin-contrib/sessions comme exemple pour démontrer ce processus.

Appliquez le middleware à l'application, afin que nous puissions obtenir la session utilisateur par le contexte de la requête utilisateur dans le gestionnaire de route :

main.go
package main

import (
	"github.com/gin-contrib/sessions"
	"github.com/gin-contrib/sessions/memstore"
	"github.com/gin-gonic/gin"
	"github.com/logto-io/go/client"
)

func main() {
	router := gin.Default()

	// Nous utilisons une session basée sur la mémoire dans cet exemple
	store := memstore.NewStore([]byte("your session secret"))
	router.Use(sessions.Sessions("logto-session", store))

	router.GET("/", func(ctx *gin.Context) {
		// Obtenir la session utilisateur
		session := sessions.Default(ctx)
		// ...
		ctx.String(200, "Hello Logto!")
	})
	router.Run(":3000")
}

Créez un fichier session_storage.go, définissez un SessionStorage et implémentez les interfaces Storage du SDK Logto :

session_storage.go
package main

import (
	"github.com/gin-contrib/sessions"
)

type SessionStorage struct {
	session sessions.Session
}

func (storage *SessionStorage) GetItem(key string) string {
	value := storage.session.Get(key)
	if value == nil {
		return ""
	}
	return value.(string)
}

func (storage *SessionStorage) SetItem(key, value string) {
	storage.session.Set(key, value)
	storage.session.Save()
}

Maintenant, dans le gestionnaire de route, vous pouvez créer un stockage de session pour Logto :

session := sessions.Default(ctx)
sessionStorage := &SessionStorage{session: session}

Initialiser LogtoClient

Tout d'abord, créez une configuration Logto :

main.go
func main() {
	// ...
	logtoConfig := &client.LogtoConfig{
		Endpoint:  "<your-logto-endpoint>", // Par exemple, http://localhost:3001
		AppId:     "<your-application-id>",
		AppSecret: "<your-application-secret>",
	}
	// ...
}

astuce:

Vous pouvez trouver et copier le "Secret de l'application" depuis la page des détails de l'application dans la Console d'administration :

Ensuite, vous pouvez créer un LogtoClient pour chaque requête utilisateur avec la configuration Logto ci-dessus :

main.go
func main() {
	// ...

	router.GET("/", func(ctx *gin.Context) {
		// Créer LogtoClient
		session := sessions.Default(ctx)
		logtoClient := client.NewLogtoClient(
			logtoConfig,
			&SessionStorage{session: session},
		)

		// Utiliser Logto pour contrôler le contenu de la page d'accueil
		authState := "Vous n'êtes pas connecté à ce site. :("

		if logtoClient.IsAuthenticated() {
			authState = "Vous êtes connecté à ce site ! :)"
		}

		homePage := `<h1>Bonjour Logto</h1>` +
			"<div>" + authState + "</div>"

		ctx.Data(http.StatusOK, "text/html; charset=utf-8", []byte(homePage))
	})

	// ...
}

Après avoir configuré l'URI de redirection, nous ajoutons une route sign-in pour gérer la requête d’authentification (Authentication) et ajoutons également un lien de connexion sur la page d'accueil :

main.go
func main() {
	// ...

	// Ajouter un lien pour effectuer une requête d’authentification (Authentication) sur la page d'accueil
	router.GET("/", func(ctx *gin.Context) {
		// ...
		homePage := `<h1>Hello Logto</h1>` +
			"<div>" + authState + "</div>" +
			// Ajouter un lien
			`<div><a href="/sign-in">Sign In</a></div>`

		ctx.Data(http.StatusOK, "text/html; charset=utf-8", []byte(homePage))
	})

	// Ajouter une route pour gérer les requêtes d’authentification (Authentication)
	router.GET("/sign-in", func(ctx *gin.Context) {
		session := sessions.Default(ctx)
		logtoClient := client.NewLogtoClient(
			logtoConfig,
			&SessionStorage{session: session},
		)

		// La requête d’authentification (Authentication) est gérée par Logto.
		// L'utilisateur sera redirigé vers l'URI de redirection une fois connecté.
		signInUri, err := logtoClient.SignIn("http://localhost:3000/callback")
		if err != nil {
			ctx.String(http.StatusInternalServerError, err.Error())
			return
		}

		// Rediriger l'utilisateur vers la page de connexion Logto.
		ctx.Redirect(http.StatusTemporaryRedirect, signInUri)
	})

	// ...
}

Maintenant, lorsque votre utilisateur visite http://localhost:3000/sign-in, il sera redirigé vers la page de connexion Logto.

Implémenter la route de rappel

Lorsque l'utilisateur se connecte avec succès sur la page de connexion Logto, Logto redirigera l'utilisateur vers l'URI de redirection.

Étant donné que l'URI de redirection est http://localhost:3000/callback, nous ajoutons la route /callback pour gérer le rappel après la connexion.

main.go
func main() {
	// ...

	// Ajouter une route pour gérer les requêtes de rappel de connexion
	router.GET("/callback", func(ctx *gin.Context) {
		session := sessions.Default(ctx)
		logtoClient := client.NewLogtoClient(
			logtoConfig,
			&SessionStorage{session: session},
		)

		// La requête de rappel de connexion est gérée par Logto
		err := logtoClient.HandleSignInCallback(ctx.Request)
		if err != nil {
			ctx.String(http.StatusInternalServerError, err.Error())
			return
		}

		// Aller à la page spécifiée par le développeur.
		// Cet exemple ramène l'utilisateur à la page d'accueil.
		ctx.Redirect(http.StatusTemporaryRedirect, "/")
	})

	// ...
}

Implémenter la route de déconnexion

Similaire au flux de connexion, lorsque l'utilisateur se déconnecte, Logto redirigera l'utilisateur vers l'URI de redirection post-déconnexion.

Ajoutons maintenant la route sign-out pour gérer la requête de déconnexion et ajoutons également un lien de déconnexion sur la page d'accueil :

main.go
func main() {
	// ...

	// Ajoutez un lien pour effectuer une requête de déconnexion sur la page d'accueil
	router.GET("/", func(ctx *gin.Context) {
		// ...
		homePage := `<h1>Bonjour Logto</h1>` +
			"<div>" + authState + "</div>" +
			`<div><a href="/sign-in">Se connecter</a></div>` +
			// Ajouter un lien
			`<div><a href="/sign-out">Se déconnecter</a></div>`

		ctx.Data(http.StatusOK, "text/html; charset=utf-8", []byte(homePage))
	})

	// Ajoutez une route pour gérer les requêtes de déconnexion
	router.GET("/sign-out", func(ctx *gin.Context) {
		session := sessions.Default(ctx)
		logtoClient := client.NewLogtoClient(
			logtoConfig,
			&SessionStorage{session: session},
		)

		// La requête de déconnexion est gérée par Logto.
		// L'utilisateur sera redirigé vers l'URI de redirection post-déconnexion une fois déconnecté.
		signOutUri, signOutErr := logtoClient.SignOut("http://localhost:3000")

		if signOutErr != nil {
			ctx.String(http.StatusOK, signOutErr.Error())
			return
		}

		ctx.Redirect(http.StatusTemporaryRedirect, signOutUri)
	})

	// ...
}

Après que l'utilisateur ait effectué une requête de déconnexion, Logto effacera toutes les informations d'authentification de l'utilisateur dans la session.

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 OIDC

Pour activer une connexion rapide et améliorer la conversion des utilisateurs, connectez-vous avec Go en tant que fournisseur d’identité (IdP). Le connecteur social Logto vous aide à établir cette connexion en quelques minutes en permettant l'entrée de plusieurs 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 "OIDC".
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 OIDC standard

Créez votre application OIDC

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 OIDC, ce 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 OIDC.

Configurez votre connecteur

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

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

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) : Nécessaire 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 demande 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 en écriture aux données d'un utilisateur.

Vous êtes censé trouver authorizationEndpoint, tokenEndpoint, jwksUri et issuer comme informations de configuration du fournisseur OpenID. Ils devraient être disponibles 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’identifiant qui peut être utilisé pour accéder aux ressources demandées. L'application cliente envoie généralement une demande au point de terminaison de jeton avec un type de subvention et un code d'autorisation pour recevoir un jeton d’identifiant.

jwksUri : C'est l'URL du point de terminaison où l'ensemble de clés Web JSON (JWKS) du fournisseur d'identité sociale (IdP en abrégé) peut être obtenu. Le JWKS est un ensemble de clés cryptographiques que l'IdP utilise pour signer et vérifier les JSON Web Tokens (JWT) qui sont émis lors du processus d'authentification. Le jwksUri est utilisé par la partie de confiance (RP) pour obtenir les clés publiques utilisées par l'IdP pour signer les JWT, afin que la RP puisse vérifier l'authenticité et l'intégrité des JWT reçus de l'IdP.

issuer : C'est l'identifiant unique de l'IdP qui est utilisé par la RP pour vérifier les JWT reçus de l'IdP. Il est inclus dans les JWT en tant que revendication iss claim (le jeton d’identifiant est toujours un JWT). La valeur de l'émetteur doit correspondre à l'URL du serveur d'autorisation de l'IdP, et elle doit être une URI que la RP considère comme fiable. Lorsque la RP reçoit un JWT, elle vérifie la revendication iss pour s'assurer qu'il a été émis par un IdP de confiance, et que le JWT est destiné à être utilisé avec la RP.

Ensemble, jwksUri et issuer fournissent un mécanisme sécurisé pour que la RP vérifie l'identité de l'utilisateur final lors du processus d'authentification. En utilisant les clés publiques obtenues à partir du jwksUri, la RP peut vérifier l'authenticité et l'intégrité des JWT émis par l'IdP. La valeur de l'émetteur garantit que la RP n'accepte que les JWT qui ont été émis par un IdP de confiance, et que les JWT sont destinés à être utilisés avec la RP.

Étant donné qu'une requête d’authentification est toujours requise, un authRequestOptionalConfig est fourni pour regrouper toutes les configurations optionnelles, vous pouvez trouver des détails sur OIDC Authentication Request. Vous pouvez également constater que nonce est absent de cette configuration. Étant donné que nonce doit être identique pour chaque requête, nous avons placé la génération de nonce dans l'implémentation du code. Donc, ne vous inquiétez pas ! Les jwksUri et issuer mentionnés précédemment sont également inclus dans idTokenVerificationConfig.

Vous vous demandez peut-être pourquoi un protocole OIDC standard prend en charge à la fois les flux implicites et hybrides, alors que le connecteur Logto ne prend en charge que le flux d'autorisation. Il a été déterminé que les flux implicites et hybrides sont moins sécurisés que le flux d'autorisation. En raison de l'accent mis par Logto sur la sécurité, il ne prend en charge que le flux d'autorisation pour offrir le plus haut niveau de sécurité à ses utilisateurs, malgré sa nature légèrement moins pratique.

responseType et grantType peuvent UNIQUEMENT être des valeurs FIXES avec le flux "Authorization Code", nous les rendons donc optionnels et les valeurs par défaut seront automatiquement remplies.

remarque:

Pour tous les types de flux, nous avons fourni une clé customConfig OPTIONNELLE pour placer vos paramètres personnalisés. Chaque fournisseur d'identité sociale pourrait avoir sa propre variante du protocole standard OIDC. Si votre fournisseur d'identité sociale souhaité respecte strictement le protocole standard OIDC, alors vous n'avez pas besoin de vous soucier de customConfig.

Types de configuration

Nom	Type	Requis
scope	string	Vrai
clientId	string	Vrai
clientSecret	string	Vrai
authorizationEndpoint	string	Vrai
tokenEndpoint	string	Vrai
idTokenVerificationConfig	IdTokenVerificationConfig	Vrai
authRequestOptionalConfig	AuthRequestOptionalConfig	Faux
customConfig	Record<string, string>	Faux

Propriétés AuthRequestOptionalConfig	Type	Requis
responseType	string	Faux
tokenEndpoint	string	Faux
responseMode	string	Faux
display	string	Faux
prompt	string	Faux
maxAge	string	Faux
uiLocales	string	Faux
idTokenHint	string	Faux
loginHint	string	Faux
acrValues	string	Faux

Propriétés IdTokenVerificationConfig	Type	Requis
jwksUri	string	Vrai
issuer	string \| string[]	Faux
audience	string \| string[]	Faux
algorithms	string[]	Faux
clockTolerance	string \| number	Faux
crit	Record<string, string \| boolean>	Faux
currentDate	Date	Faux
maxTokenAge	string \| number	Faux
subject	string	Faux
typ	string	Faux

Voir ici pour plus de détails sur IdTokenVerificationConfig.

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 OIDC 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 OIDC" dans l'Expérience de connexion.

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

Onglet Expérience de connexion

Tests et validation

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

Installation​

Créer un stockage de session​

Initialiser LogtoClient​

Implémenter la route de connexion​

Implémenter la route de rappel​

Implémenter la route de déconnexion​

Point de contrôle : Testez votre application​

Ajouter le connecteur OIDC​

Configurer Application OIDC standard​

Créez votre application OIDC​

Configurez votre connecteur​

Types de configuration​

Enregistrer votre configuration​

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

Tests et validation​

Lectures complémentaires​

Créer une application dans Logto

Intégrer le SDK Go

Installation

Créer un stockage de session

Initialiser LogtoClient

Implémenter la route de connexion

Implémenter la route de rappel

Implémenter la route de déconnexion

Point de contrôle : Testez votre application

Ajouter le connecteur OIDC

Configurer Application OIDC standard

Créez votre application OIDC

Configurez votre connecteur

Types de configuration

Enregistrer votre configuration

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

Tests et validation

Lectures complémentaires