How to build Google Workspace enterprise SSO with 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 Google Workspace enterprise SSO (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 Google Workspace enterprise SSO utilisable.

Create an application in 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.

Integrate Go SDK

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.

Add Google Workspace enterprise SSO connector

To simplify access management and gain enterprise-level safeguards for your big clients, connect with Go as a federated identity provider. The Logto enterprise SSO connector helps you establish this connection in minutes by allowing several parameter inputs.

To add an enterprise SSO connector, simply follow these steps:

Navigate to Logto console > Enterprise SSO.

SSO page

Click "Add enterprise connector" button and choose your SSO provider type. Choose from prebuilt connectors for Microsoft Entra ID (Azure AD), Google Workspace, and Okta, or create a custom SSO connection using the standard OpenID Connect (OIDC) or SAML protocol.
Provide a unique name (e.g., SSO sign-in for Acme Company).

Select your SSO provider

Configure the connection with your IdP in the "Connection" tab. Check the guides above for each connector types.

SSO connection

Customize the SSO experience and enterprise’s email domain in the "Experience" tab. Users sign in with the SSO-enabled email domain will be redirected to SSO authentication.

SSO experience

Save changes.

Set up Google Cloud Platform

Étape 1 : Créer un nouveau projet sur Google Cloud Platform

Avant de pouvoir utiliser Google Workspace comme fournisseur d'authentification, vous devez configurer un projet dans la Google API Console pour obtenir des identifiants OAuth 2.0. Si vous avez déjà un projet, vous pouvez passer cette étape. Sinon, créez un nouveau projet sous votre organisation Google.

Pour créer de nouvelles informations d'identification OIDC, vous devez configurer l'écran de consentement pour votre application.

Accédez à la page Écran de consentement OAuth et sélectionnez le type d'utilisateur Interne. Cela rendra l'application OAuth uniquement disponible pour les utilisateurs au sein de votre organisation.

Type d'utilisateur de l'écran de consentement Google Workspace.webp

Remplissez les paramètres de l'Écran de consentement en suivant les instructions de la page. Vous devez fournir les informations minimales suivantes :

Nom de l'application : Le nom de votre application. Il sera affiché sur l'écran de consentement.
Email de support : L'email de support de votre application. Il sera affiché sur l'écran de consentement.

Paramètres de l'écran de consentement Google Workspace.webp

Définissez les Portées pour votre application. Afin de récupérer correctement les informations d'identité et l'adresse e-mail de l'utilisateur depuis le fournisseur d'identité (IdP), les connecteurs SSO de Logto doivent accorder les portées suivantes depuis l'IdP :

Portées de l'écran de consentement Google Workspace.webp

openid : Cette portée est requise pour l'authentification OIDC. Elle est utilisée pour récupérer le jeton d'identifiant et accéder au point de terminaison userInfo de l'IdP.
profile : Cette portée est requise pour accéder aux informations de profil de base de l'utilisateur.
email : Cette portée est requise pour accéder à l'adresse e-mail de l'utilisateur.

Cliquez sur le bouton Enregistrer pour sauvegarder les paramètres de l'écran de consentement.

Étape 3 : Créer une nouvelle accréditation OAuth

Accédez à la page Credentials et cliquez sur le bouton Create Credentials. Sélectionnez l'option OAuth client ID dans le menu déroulant pour créer une nouvelle référence OAuth pour votre application.

Google Workspace create credentials.webp

Continuez à configurer la référence OAuth en remplissant les informations suivantes :

Google Workspace credentials config.webp

Sélectionnez Web application comme type d'application.
Remplissez le Name de votre application cliente, par exemple Logto SSO Connector. Cela vous aidera à identifier les références à l'avenir.
Remplissez les Authorized redirect URIs avec l'URI de rappel Logto. C'est l'URI vers lequel Google redirigera le navigateur de l'utilisateur après une authentification réussie. Après qu'un utilisateur s'est authentifié avec succès auprès du fournisseur d’identité (IdP), l'IdP redirige le navigateur de l'utilisateur vers cet URI désigné avec un code d'autorisation. Logto complétera le processus d'authentification basé sur le code d'autorisation reçu de cet URI.
Remplissez les Authorized JavaScript origins avec l'origine de l'URI de rappel Logto. Cela garantit que seule votre application Logto peut envoyer des requêtes au serveur OAuth de Google.
Cliquez sur le bouton Create pour créer la référence OAuth.

Étape 4 : Configurer le connecteur Logto avec les identifiants du client

Après avoir créé avec succès les informations d'identification OAuth, vous recevrez une fenêtre modale avec l'ID client et le secret client.

Google Workspace client credentials.webp

Copiez l'ID client et le secret client et remplissez les champs correspondants dans l'onglet Connection du connecteur SSO de Logto.

Vous avez maintenant configuré avec succès un connecteur SSO Google Workspace sur Logto.

Étape 5 : Portées supplémentaires (Optionnel)

Utilisez le champ Scope pour ajouter des portées supplémentaires à votre requête OAuth. Cela vous permettra de demander plus d'informations au serveur OAuth de Google. Veuillez vous référer à la documentation des Portées OAuth de Google pour plus d'informations.

Indépendamment des paramètres de portée personnalisés, Logto enverra toujours les portées openid, profile et email au fournisseur d’identité (IdP). Cela garantit que Logto peut récupérer correctement les informations d'identité de l'utilisateur et l'adresse e-mail.

Étape 6 : Définir les domaines de messagerie et activer le connecteur SSO

Fournissez les domaines de messagerie de votre organisation dans l'onglet Expérience SSO du connecteur Logto. Cela activera le connecteur SSO comme méthode d'authentification pour ces utilisateurs.

Les utilisateurs ayant des adresses e-mail dans les domaines spécifiés seront redirigés pour utiliser votre connecteur SSO comme seule méthode d'authentification.

Pour plus d'informations sur le connecteur SSO Google Workspace, veuillez consulter Google OpenID Connector.

Save your 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 Google Workspace enterprise SSO devrait être disponible maintenant.

You don’t need to configure enterprise connectors individually, Logto simplifies SSO integration into your applications with just one click.

Navigate to: Console > Sign-in experience > Sign-up and sign-in.
Enable the "Enterprise SSO" toggle.
Save changes.

Once enabled, a "Single Sign-On" button will appear on your sign-in page. Enterprise users with SSO-enabled email domains can access your services using their enterprise identity providers (IdPs).

Auto detect SSO sign-in via email domain

To learn more about the SSO user experience, including SP-initiated SSO and IdP-initiated SSO, refer to User flows: Enterprise SSO.

Testing and Validation

Retournez à votre application Go. Vous devriez maintenant pouvoir vous connecter avec Google Workspace enterprise SSO. Profitez-en !

Create an application in Logto​

Integrate Go SDK​

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​

Add Google Workspace enterprise SSO connector​

Set up Google Cloud Platform​

Étape 1 : Créer un nouveau projet sur Google Cloud Platform​

Étape 2 : Configurer l’écran de consentement pour votre application​

Étape 3 : Créer une nouvelle accréditation OAuth​

Étape 4 : Configurer le connecteur Logto avec les identifiants du client​

Étape 5 : Portées supplémentaires (Optionnel)​

Étape 6 : Définir les domaines de messagerie et activer le connecteur SSO​

Save your configuration​

Enable Google Workspace enterprise SSO connector in Sign-in Experience​

Testing and Validation​

Further readings​