Cómo construir el inicio de sesión de OAuth2 con Go

Para nuestros nuevos amigos:

Logto es una alternativa a Auth0 diseñada para aplicaciones modernas y productos SaaS. Ofrece servicios tanto de Cloud como de código abierto para ayudarte a lanzar rápidamente tu sistema de gestión e identidad (IAM). Disfruta de autenticación, autorización y gestión multi-tenant todo en uno.

Recomendamos comenzar con un tenant de desarrollo gratuito en Logto Cloud. Esto te permite explorar todas las características fácilmente.

En este artículo, repasaremos los pasos para construir rápidamente la experiencia de inicio de sesión de OAuth2 (autenticación de usuario) con Go y Logto.

Requisitos previos

Una instancia de Logto en funcionamiento. Consulta la página de introducción para comenzar.
Conocimientos básicos de Go.
Una cuenta de OAuth2 utilizable.

Crear una aplicación en Logto

Logto se basa en la autenticación OpenID Connect (OIDC) y la autorización OAuth 2.0. Admite la gestión de identidad federada a través de múltiples aplicaciones, comúnmente llamada inicio de sesión único (SSO).

Para crear tu aplicación Traditional web, simplemente sigue estos pasos:

Abre el Logto Console. En la sección "Get started", haz clic en el enlace "View all" para abrir la lista de marcos de aplicaciones. Alternativamente, puedes navegar a Logto Console > Applications, y hacer clic en el botón "Create application".
En el modal que se abre, haz clic en la sección "Traditional web" o filtra todos los marcos "Traditional web" disponibles usando las casillas de verificación de filtro rápido a la izquierda. Haz clic en la tarjeta del marco "Go" para comenzar a crear tu aplicación.
Ingresa el nombre de la aplicación, por ejemplo, "Librería", y haz clic en "Create application".

🎉 ¡Ta-da! Acabas de crear tu primera aplicación en Logto. Verás una página de felicitaciones que incluye una guía de integración detallada. Sigue la guía para ver cómo será la experiencia en tu aplicación.

Integrar el SDK de Go

tip:

La siguiente demostración está construida sobre el Gin Web Framework. También puedes integrar Logto en otros frameworks siguiendo los mismos pasos.
El proyecto de ejemplo en Go está disponible en nuestro repositorio de Go SDK.

Instalación

Ejecuta en el directorio raíz del proyecto:

go get github.com/logto-io/go

Añade el paquete github.com/logto-io/go/client a tu código de aplicación:

main.go
// main.go
package main

import (
	"github.com/gin-gonic/gin"
	// Añadir dependencia
	"github.com/logto-io/go/client"
)

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

Crear un almacenamiento de sesión

En las aplicaciones web tradicionales, la información de autenticación del usuario se almacenará en la sesión del usuario.

El SDK de Logto proporciona una interfaz Storage, puedes implementar un adaptador Storage basado en tu framework web para que el SDK de Logto pueda almacenar la información de autenticación del usuario en la sesión.

nota:

NO recomendamos usar sesiones basadas en cookies, ya que la información de autenticación del usuario almacenada por Logto puede exceder el límite de tamaño de las cookies. En este ejemplo, usamos sesiones basadas en memoria. Puedes usar Redis, MongoDB y otras tecnologías en producción para almacenar sesiones según sea necesario.

El tipo Storage en el SDK de Logto es el siguiente:

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

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

Usamos el middleware github.com/gin-contrib/sessions como ejemplo para demostrar este proceso.

Aplica el middleware a la aplicación, para que podamos obtener la sesión del usuario mediante el contexto de la solicitud del usuario en el manejador de rutas:

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()

	// Usamos sesiones basadas en memoria en este ejemplo
	store := memstore.NewStore([]byte("tu secreto de sesión"))
	router.Use(sessions.Sessions("logto-session", store))

	router.GET("/", func(ctx *gin.Context) {
		// Obtener la sesión del usuario
		session := sessions.Default(ctx)
		// ...
		ctx.String(200, "¡Hola Logto!")
	})
	router.Run(":3000")
}

Crea un archivo session_storage.go, define un SessionStorage e implementa las interfaces Storage del SDK de 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()
}

Ahora, en el manejador de rutas, puedes crear un almacenamiento de sesión para Logto:

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

Iniciar LogtoClient

Primero, crea una configuración de Logto:

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

tip:

Puedes encontrar y copiar el "App Secret" desde la página de detalles de la aplicación en la Consola de Administración:

Luego, puedes crear un LogtoClient para cada solicitud de usuario con la configuración de Logto anterior:

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

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

		// Usar Logto para controlar el contenido de la página de inicio
		authState := "No estás conectado a este sitio web. :("

		if logtoClient.IsAuthenticated() {
			authState = "¡Estás conectado a este sitio web! :)"
		}

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

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

	// ...
}

Después de que el URI de redirección esté configurado, añadimos una ruta sign-in para manejar la solicitud de inicio de sesión y también añadimos un enlace de inicio de sesión en la página de inicio:

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

	// Añadir un enlace para realizar una solicitud de inicio de sesión en la página de inicio
	router.GET("/", func(ctx *gin.Context) {
		// ...
		homePage := `<h1>Hello Logto</h1>` +
			"<div>" + authState + "</div>" +
			// Añadir enlace
			`<div><a href="/sign-in">Sign In</a></div>`

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

	// Añadir una ruta para manejar las solicitudes de inicio de sesión
	router.GET("/sign-in", func(ctx *gin.Context) {
		session := sessions.Default(ctx)
		logtoClient := client.NewLogtoClient(
			logtoConfig,
			&SessionStorage{session: session},
		)

		// La solicitud de inicio de sesión es manejada por Logto.
		// El usuario será redirigido al URI de redirección al iniciar sesión.
		signInUri, err := logtoClient.SignIn("http://localhost:3000/callback")
		if err != nil {
			ctx.String(http.StatusInternalServerError, err.Error())
			return
		}

		// Redirigir al usuario a la página de inicio de sesión de Logto.
		ctx.Redirect(http.StatusTemporaryRedirect, signInUri)
	})

	// ...
}

Ahora, cuando tu usuario visite http://localhost:3000/sign-in, será redirigido a la página de inicio de sesión de Logto.

Implementar la ruta de callback

Cuando el usuario inicia sesión con éxito en la página de inicio de sesión de Logto, Logto redirigirá al usuario al URI de redirección.

Dado que el URI de redirección es http://localhost:3000/callback, añadimos la ruta /callback para manejar el callback después de iniciar sesión.

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

	// Añadir una ruta para manejar las solicitudes de callback de inicio de sesión
	router.GET("/callback", func(ctx *gin.Context) {
		session := sessions.Default(ctx)
		logtoClient := client.NewLogtoClient(
			logtoConfig,
			&SessionStorage{session: session},
		)

		// La solicitud de callback de inicio de sesión es manejada por Logto
		err := logtoClient.HandleSignInCallback(ctx.Request)
		if err != nil {
			ctx.String(http.StatusInternalServerError, err.Error())
			return
		}

		// Saltar a la página especificada por el desarrollador.
		// Este ejemplo lleva al usuario de vuelta a la página de inicio.
		ctx.Redirect(http.StatusTemporaryRedirect, "/")
	})

	// ...
}

Implementar la ruta de cierre de sesión

Similar al flujo de inicio de sesión, cuando el usuario cierra sesión, Logto redirigirá al usuario al URI de redirección posterior al cierre de sesión.

Ahora, agreguemos la ruta sign-out para manejar la solicitud de cierre de sesión y también agreguemos un enlace de cierre de sesión en la página de inicio:

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

	// Agregar un enlace para realizar una solicitud de cierre de sesión en la página de inicio
	router.GET("/", func(ctx *gin.Context) {
		// ...
		homePage := `<h1>Hello Logto</h1>` +
			"<div>" + authState + "</div>" +
			`<div><a href="/sign-in">Sign In</a></div>` +
			// Agregar enlace
			`<div><a href="/sign-out">Sign Out</a></div>`

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

	// Agregar una ruta para manejar solicitudes de cierre de sesión
	router.GET("/sign-out", func(ctx *gin.Context) {
		session := sessions.Default(ctx)
		logtoClient := client.NewLogtoClient(
			logtoConfig,
			&SessionStorage{session: session},
		)

		// La solicitud de cierre de sesión es manejada por Logto.
		// El usuario será redirigido al URI de redirección posterior al cierre de sesión al cerrar sesión.
		signOutUri, signOutErr := logtoClient.SignOut("http://localhost:3000")

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

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

	// ...
}

Después de que el usuario realice una solicitud de cierre de sesión, Logto borrará toda la información de autenticación del usuario en la sesión.

Punto de control: Prueba tu aplicación

Ahora, puedes probar tu aplicación:

Ejecuta tu aplicación, verás el botón de inicio de sesión.
Haz clic en el botón de inicio de sesión, el SDK iniciará el proceso de inicio de sesión y te redirigirá a la página de inicio de sesión de Logto.
Después de iniciar sesión, serás redirigido de vuelta a tu aplicación y verás el botón de cierre de sesión.
Haz clic en el botón de cierre de sesión para limpiar el almacenamiento de tokens y cerrar sesión.

Añadir el conector OAuth2

Para habilitar un inicio de sesión rápido y mejorar la conversión de usuarios, conéctate con Go como un proveedor de identidad (IdP). El conector social de Logto te ayuda a establecer esta conexión en minutos permitiendo la entrada de varios parámetros.

Para añadir un conector social, simplemente sigue estos pasos:

Navega a Console > Connectors > Social Connectors.
Haz clic en "Add social connector" y selecciona "OAuth2".
Sigue la guía README y completa los campos requeridos y personaliza la configuración.

nota:

Si estás siguiendo la guía del Conector en el lugar, puedes omitir la siguiente sección.

Configura Aplicación estándar OAuth 2.0

Crea tu aplicación OAuth

Cuando abres esta página, creemos que ya sabes qué proveedor de identidad social deseas conectar. Lo primero que debes hacer es confirmar que el proveedor de identidad admite el protocolo OAuth, que es un requisito previo para configurar un conector válido. Luego, sigue las instrucciones del proveedor de identidad para registrar y crear la aplicación relevante para la autorización OAuth.

Configura tu conector

SÓLO admitimos el tipo de concesión "Authorization Code" por razones de seguridad y se adapta perfectamente al escenario de Logto.

clientId y clientSecret se pueden encontrar en la página de detalles de tus aplicaciones OAuth.

clientId: El ID de cliente es un identificador único que identifica la aplicación cliente durante el registro con el servidor de autorización. Este ID es utilizado por el servidor de autorización para verificar la identidad de la aplicación cliente y asociar cualquier token de acceso autorizado con esa aplicación cliente específica.

clientSecret: El secreto de cliente es una clave confidencial que se emite a la aplicación cliente por el servidor de autorización durante el registro. La aplicación cliente utiliza esta clave secreta para autenticarse con el servidor de autorización al solicitar tokens de acceso. El secreto de cliente se considera información confidencial y debe mantenerse seguro en todo momento.

tokenEndpointAuthMethod: El método de autenticación del endpoint de token es utilizado por la aplicación cliente para autenticarse con el servidor de autorización al solicitar tokens de acceso. Para descubrir los métodos admitidos, consulta el campo token_endpoint_auth_methods_supported disponible en el endpoint de descubrimiento de OpenID Connect del proveedor de servicios OAuth 2.0, o consulta la documentación relevante proporcionada por el proveedor de servicios OAuth 2.0.

clientSecretJwtSigningAlgorithm (Opcional): Solo se requiere cuando tokenEndpointAuthMethod es client_secret_jwt. El algoritmo de firma JWT del secreto de cliente es utilizado por la aplicación cliente para firmar el JWT que se envía al servidor de autorización durante la solicitud de token.

scope: El parámetro de alcance se utiliza para especificar el conjunto de recursos y permisos a los que la aplicación cliente está solicitando acceso. El parámetro de alcance se define típicamente como una lista de valores separados por espacios que representan permisos específicos. Por ejemplo, un valor de alcance de "read write" podría indicar que la aplicación cliente está solicitando acceso de lectura y escritura a los datos de un usuario.

Se espera que encuentres authorizationEndpoint, tokenEndpoint y userInfoEndpoint en la documentación del proveedor social.

authenticationEndpoint: Este endpoint se utiliza para iniciar el proceso de autenticación. El proceso de autenticación generalmente implica que el usuario inicie sesión y otorgue autorización para que la aplicación cliente acceda a sus recursos.

tokenEndpoint: Este endpoint es utilizado por la aplicación cliente para obtener un token de acceso que se puede usar para acceder a los recursos solicitados. La aplicación cliente generalmente envía una solicitud al endpoint de token con un tipo de concesión y un código de autorización para recibir un token de acceso.

userInfoEndpoint: Este endpoint es utilizado por la aplicación cliente para obtener información adicional sobre el usuario, como su nombre completo, dirección de correo electrónico o foto de perfil. El endpoint de información del usuario se accede típicamente después de que la aplicación cliente ha obtenido un token de acceso del endpoint de token.

Logto también proporciona un campo profileMap que los usuarios pueden personalizar para mapear los perfiles de los proveedores sociales que generalmente no son estándar. Las claves son los nombres de los campos de perfil de usuario estándar de Logto y los valores correspondientes deben ser los nombres de los campos de los perfiles sociales. En la etapa actual, Logto solo se preocupa por 'id', 'name', 'avatar', 'email' y 'phone' del perfil social, solo 'id' es un campo requerido y los demás son opcionales.

responseType y grantType SOLO pueden ser valores FIJOS con el tipo de concesión de código de autorización, por lo que los hacemos opcionales y los valores predeterminados se completarán automáticamente.

Por ejemplo, puedes encontrar respuesta de perfil de usuario de Google y, por lo tanto, su profileMap debería ser como:

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

nota:

Proporcionamos una clave customConfig OPCIONAL para colocar tus parámetros personalizados. Cada proveedor de identidad social podría tener su propia variante en el protocolo estándar OAuth. Si tu proveedor de identidad social deseado se adhiere estrictamente al protocolo estándar OAuth, entonces no necesitas preocuparte por customConfig.

Tipos de configuración

Nombre	Tipo	Requerido
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

Campos de ProfileMap	Tipo	Requerido	Valor predeterminado
id	string	false	id
name	string	false	name
avatar	string	false	avatar
email	string	false	email
phone	string	false	phone

Guarda tu configuración

Verifica que hayas completado los valores necesarios en el área de configuración del conector Logto. Haz clic en "Guardar y listo" (o "Guardar cambios") y el conector OAuth2 debería estar disponible ahora.

Una vez que crees un conector social con éxito, puedes habilitarlo como un botón "Continuar con OAuth2" en la Experiencia de inicio de sesión.

Navega a Console > Sign-in experience > Sign-up and sign-in.
(Opcional) Elige "No aplicable" para el identificador de registro si solo necesitas inicio de sesión social.
Añade el conector OAuth2 configurado a la sección "Inicio de sesión social".

Pestaña de Experiencia de inicio de sesión

Pruebas y Validación

Regresa a tu aplicación Go. Ahora deberías poder iniciar sesión con OAuth2. ¡Disfruta!

Lecturas adicionales

Flujos de usuario final: Logto proporciona flujos de autenticación listos para usar, incluyendo MFA y SSO empresarial, junto con potentes APIs para la implementación flexible de configuraciones de cuenta, verificación de seguridad y experiencia multi-tenant.

Autorización (Authorization): La autorización define las acciones que un usuario puede realizar o los recursos a los que puede acceder después de ser autenticado. Explora cómo proteger tu API para aplicaciones nativas y de una sola página e implementar el Control de Acceso Basado en Roles (RBAC).

Organizaciones (Organizations): Particularmente efectivo en aplicaciones SaaS multi-tenant y B2B, la función de organización permite la creación de inquilinos, gestión de miembros, RBAC a nivel de organización y aprovisionamiento justo a tiempo.

Serie IAM del cliente: Nuestros artículos de blog en serie sobre la Gestión de Identidad y Acceso del Cliente (o Consumidor), desde los conceptos básicos hasta temas avanzados y más allá.

Crear una aplicación en Logto​

Integrar el SDK de Go​

Instalación​

Crear un almacenamiento de sesión​

Iniciar LogtoClient​

Implementar la ruta de inicio de sesión​

Implementar la ruta de callback​

Implementar la ruta de cierre de sesión​

Punto de control: Prueba tu aplicación​

Añadir el conector OAuth2​

Configura Aplicación estándar OAuth 2.0​

Crea tu aplicación OAuth​

Configura tu conector​

Tipos de configuración​

Guarda tu configuración​

Habilitar el conector OAuth2 en la Experiencia de inicio de sesión​

Pruebas y Validación​

Lecturas adicionales​

Crear una aplicación en Logto

Integrar el SDK de Go

Instalación

Crear un almacenamiento de sesión

Iniciar LogtoClient

Implementar la ruta de inicio de sesión

Implementar la ruta de callback

Implementar la ruta de cierre de sesión

Punto de control: Prueba tu aplicación

Añadir el conector OAuth2

Configura Aplicación estándar OAuth 2.0

Crea tu aplicación OAuth

Configura tu conector

Tipos de configuración

Guarda tu configuración

Habilitar el conector OAuth2 en la Experiencia de inicio de sesión

Pruebas y Validación

Lecturas adicionales