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

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 "SAML".
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 SAML standard

Passons en revue les configurations du connecteur SAML.

Avant de commencer, vous pouvez vous rendre chez un fournisseur d'identité sociale qui prend en charge le protocole SAML et créer votre propre compte. Okta, OneLogin, Salesforce et certaines autres plateformes prennent en charge l'authentification basée sur le protocole SAML.

Si votre IdP exige le chiffrement de l'assertion SAML et la réception de requêtes d'authentification signées, vous devez générer votre clé privée et le certificat correspondant en utilisant l'algorithme RSA. Conservez la clé privée pour votre utilisation SP et téléchargez le certificat sur IdP.

Vous devez également configurer l'URL ACS (Assertion Consumer Service) comme ${your_logto_origin}/api/authn/saml/${connector_id} pour gérer l'assertion SAML de l'IdP. Vous pouvez trouver votre connectorId sur la page des détails du connecteur SAML dans la console d'administration de Logto.

remarque:

Selon la conception actuelle de Logto, nous ne prenons en charge que la liaison par redirection pour l'envoi de requêtes d'authentification et la liaison par POST pour la réception d'assertions SAML. Bien que cela ne semble pas très cool, nous pensons que la conception actuelle peut gérer la plupart de vos cas d'utilisation. Si vous avez des problèmes, n'hésitez pas à nous contacter !

Configurer le connecteur SAML (SP)

Dans cette section, nous allons présenter chaque attribut en détail.

entityID `Requis`

entityID (c'est-à-dire issuer) est l'identifiant de l'entité. Il est utilisé pour identifier votre entité (entité SP SAML) et correspondre à l'équivalence dans chaque requête/réponse SAML.

signInEndpoint `Requis`

Le point de terminaison de l'IdP auquel vous envoyez les requêtes d'authentification SAML. Habituellement, vous pouvez trouver cette valeur sur la page des détails de l'IdP (c'est-à-dire l'URL SSO ou l'URL de connexion de l'IdP).

x509Certificate `Requis`

Le certificat x509 généré à partir de la clé privée de l'IdP, l'IdP est censé avoir cette valeur disponible.

Le contenu du certificat est accompagné de l'en-tête -----BEGIN CERTIFICATE----- et de la fin -----END CERTIFICATE-----.

idpMetadataXml `Requis`

Le champ est utilisé pour placer le contenu de votre fichier XML de métadonnées IdP.

remarque:

Le parseur XML que nous utilisons ne prend pas en charge les espaces de noms personnalisés. Si les métadonnées de l'IdP comportent un espace de noms, vous devez les supprimer manuellement. Pour l'espace de noms du fichier XML, voir référence.

assertionConsumerServiceUrl `Requis`

L'URL du service consommateur d'assertions (ACS) est le point de terminaison du SP pour recevoir les requêtes POST d'assertion SAML de l'IdP. Comme nous l'avons mentionné dans la partie précédente, elle est généralement configurée dans les paramètres de l'IdP, mais certains IdP obtiennent cette valeur à partir des requêtes d'authentification SAML, nous ajoutons donc également cette valeur en tant que champ REQUIS. Sa valeur devrait ressembler à ${your_logto_origin}/api/authn/saml/${connector_id}.

signAuthnRequest

La valeur booléenne qui contrôle si la requête d'authentification SAML doit être signée, dont la valeur par défaut est false.

encryptAssertion

encryptAssertion est une valeur booléenne qui indique si l'IdP chiffrera l'assertion SAML, avec une valeur par défaut false.

remarque:

Les attributs signAuthnRequest et encryptAssertion doivent être alignés avec les paramètres correspondants de l'IdP, sinon une erreur sera générée pour indiquer que la configuration ne correspond pas. Toutes les réponses SAML doivent être signées.

requestSignatureAlgorithm

Cela doit être aligné avec les algorithmes de signature de l'IdP afin que Logto puisse vérifier la signature de l'assertion SAML. Sa valeur doit être soit http://www.w3.org/2000/09/xmldsig#rsa-sha1, http://www.w3.org/2001/04/xmldsig-more#rsa-sha256 ou http://www.w3.org/2001/04/xmldsig-more#rsa-sha512 et la valeur par défaut est http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

messageSigningOrder

messageSigningOrder indique l'ordre de signature et de chiffrement de l'IdP, sa valeur doit être soit sign-then-encrypt soit encrypt-then-sign et la valeur par défaut est sign-then-encrypt.

privateKey et privateKeyPass

privateKey est une valeur OPTIONNELLE et est requise lorsque signAuthnRequest est true.

privateKeyPass est le mot de passe que vous avez défini lors de la création de privateKey, requis si nécessaire.

Si signAuthnRequest est true, le certificat correspondant généré à partir de privateKey est requis par l'IdP pour vérifier la signature.

encPrivateKey et encPrivateKeyPass

encPrivateKey est une valeur OPTIONNELLE et est requise lorsque encryptAssertion est true.

encPrivateKeyPass est le mot de passe que vous avez défini lors de la création de encPrivateKey, requis si nécessaire.

Si encryptAssertion est true, le certificat correspondant généré à partir de encPrivateKey est requis par l'IdP pour chiffrer l'assertion SAML.

remarque:

Pour la génération de clés et de certificats, openssl est un outil formidable. Voici une ligne de commande d'exemple qui pourrait être utile :

openssl genrsa -passout pass:${privateKeyPassword} -out ${encryptPrivateKeyFilename}.pem 4096
openssl req -new -x509 -key ${encryptPrivateKeyFilename}.pem -out ${encryptionCertificateFilename}.cer -days 3650

Les fichiers privateKey et encPrivateKey doivent être encodés dans le schéma pkcs1 en tant que chaîne pem, ce qui signifie que les fichiers de clé privée doivent commencer par -----BEGIN RSA PRIVATE KEY----- et se terminer par -----END RSA PRIVATE KEY-----.

nameIDFormat

nameIDFormat est un attribut OPTIONNEL qui déclare le format d'identifiant de nom qui répondrait. La valeur peut être parmi urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified, urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent et urn:oasis:names:tc:SAML:2.0:nameid-format:transient, et la valeur par défaut est urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified.

timeout

timeout est la tolérance de temps pour la validation temporelle, car le temps entre votre entité SP et l'entité IdP pourrait être différent et la connexion réseau peut également apporter un certain retard. L'unité est en millisecondes, et la valeur par défaut est 5000 (c'est-à-dire 5s).

profileMap

Logto fournit également un champ profileMap que les utilisateurs peuvent personnaliser pour mapper les profils des fournisseurs sociaux qui ne sont généralement pas standard. Chaque clé profileMap est le nom du champ de profil utilisateur standard de Logto et la valeur correspondante doit être le nom du champ de profil social. À l'heure actuelle, Logto ne concerne que 'id', 'name', 'avatar', 'email' et 'phone' du profil social, seul 'id' est REQUIS et les autres sont des champs optionnels.

Types de configuration

Nom	Type	Requis	Valeur par défaut
signInEndpoint	string	true
x509certificate	string	true
idpMetadataXml	string	true
entityID	string	true
assertionConsumerServiceUrl	string	true
messageSigningOrder	`encrypt-then-sign` \| `sign-then-encrypt`	false	`sign-then-encrypt`
requestSignatureAlgorithm	`http://www.w3.org/2000/09/xmldsig#rsa-sha1` \| `http://www.w3.org/2001/04/xmldsig-more#rsa-sha256` \| `http://www.w3.org/2001/04/xmldsig-more#rsa-sha512`	false	`http://www.w3.org/2001/04/xmldsig-more#rsa-sha256`
signAuthnRequest	boolean	false	false
encryptAssertion	boolean	false	false
privateKey	string	false
privateKeyPass	string	false
nameIDFormat	`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified` \| `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress` \| `urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName` \| `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent` \| `urn:oasis:names:tc:SAML:2.0:nameid-format:transient`	false	`urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified`
timeout	number	false	5000
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

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

Onglet Expérience de connexion

Tests et validation

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

Configurer Application SAML standard​

Créer un compte IdP social et enregistrer l'application SAML (IdP)​

Configurer le connecteur SAML (SP)​

entityID Requis​

signInEndpoint Requis​

x509Certificate Requis​

idpMetadataXml Requis​

assertionConsumerServiceUrl Requis​

signAuthnRequest​

encryptAssertion​

requestSignatureAlgorithm​

messageSigningOrder​

privateKey et privateKeyPass​

encPrivateKey et encPrivateKeyPass​

nameIDFormat​

timeout​

profileMap​

Types de configuration​

Référence​

Enregistrer votre configuration​

Activer le connecteur SAML 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 SAML

Configurer Application SAML standard

Créer un compte IdP social et enregistrer l'application SAML (IdP)

Configurer le connecteur SAML (SP)

entityID `Requis`

signInEndpoint `Requis`

x509Certificate `Requis`

idpMetadataXml `Requis`

assertionConsumerServiceUrl `Requis`

signAuthnRequest

encryptAssertion

requestSignatureAlgorithm

messageSigningOrder

privateKey et privateKeyPass

encPrivateKey et encPrivateKeyPass

nameIDFormat

timeout

profileMap

Types de configuration

Référence

Enregistrer votre configuration

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

Tests et validation

Lectures complémentaires