Cómo construir el inicio de sesión de GitHub 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 GitHub (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 GitHub 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 la Consola de Logto. En la sección "Comenzar", haz clic en el enlace "Ver todo" para abrir la lista de marcos de aplicaciones. Alternativamente, puedes navegar a Consola de Logto > Aplicaciones, y hacer clic en el botón "Crear aplicación".
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 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 "Crear aplicación".

🎉 ¡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 del SDK de Go.

Instalación

Ejecuta en el directorio raíz del proyecto:

# Instala el paquete core para acceder a valores y tipos predefinidos
go get github.com/logto-io/go/v2/core

# Instala el paquete client para interactuar con Logto
go get github.com/logto-io/go/v2/client

Agrega los paquetes github.com/logto-io/go/v2/core y github.com/logto-io/go/v2/client a tu código de aplicación:

main.go
// main.go
package main

import (
	"github.com/gin-gonic/gin"
	// Añade la dependencia
	"github.com/logto-io/go/v2/core"
	"github.com/logto-io/go/v2/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 almacena 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:

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/v2/client"
)

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

	// Usamos sesión basada en memoria en este ejemplo
	store := memstore.NewStore([]byte("your session secret"))
	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 GitHub

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 "GitHub".
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 GitHub OAuth app

Paso 1: Crea una aplicación OAuth en GitHub

Antes de poder usar GitHub como proveedor de autenticación, debes crear una aplicación OAuth en GitHub para obtener credenciales de OAuth 2.0.

Ve a GitHub e inicia sesión con tu cuenta, o crea una nueva si es necesario.
Navega a Settings > Developer settings > OAuth apps.
Haz clic en New OAuth App para registrar una nueva aplicación:
- Application name: Ingresa un nombre descriptivo para tu aplicación.
- Homepage URL: Ingresa la URL de la página principal de tu aplicación.
- Authorization callback URL: Copia el Callback URI de tu conector de GitHub en Logto y pégalo aquí. Después de que los usuarios inicien sesión con GitHub, serán redirigidos aquí con un código de autorización que Logto utiliza para completar la autenticación.
- Application description: (Opcional) Agrega una breve descripción de tu aplicación.
Haz clic en Register application para crear la aplicación OAuth.

nota:

Sugerimos no marcar la casilla Enable Device Flow, ya que los usuarios que inicien sesión con GitHub en dispositivos móviles tendrían que confirmar la acción inicial de inicio de sesión en la aplicación móvil de GitHub. Muchos usuarios de GitHub no instalan la aplicación móvil de GitHub en sus teléfonos, lo que podría bloquear el flujo de inicio de sesión. Solo habilita esto si esperas que los usuarios finales confirmen su flujo de inicio de sesión a través de la aplicación móvil de GitHub. Consulta los detalles sobre el device flow.

Para más detalles sobre cómo configurar aplicaciones OAuth en GitHub, consulta Creating an OAuth App.

Paso 2: Configura tu conector de Logto

Después de crear la aplicación OAuth en GitHub, serás redirigido a una página de detalles donde podrás copiar el Client ID y generar un Client secret.

Copia el Client ID de tu aplicación OAuth de GitHub y pégalo en el campo clientId en Logto.
Haz clic en Generate a new client secret en GitHub para crear un nuevo secreto, luego cópialo y pégalo en el campo clientSecret en Logto.
Haz clic en Save and Done en Logto para conectar tu sistema de identidad con GitHub.

aviso:

Mantén tu Client secret seguro y nunca lo expongas en código del lado del cliente. Los client secrets de GitHub no se pueden recuperar si se pierden; tendrás que generar uno nuevo.

Paso 3: Configura los alcances (Scopes) (Opcional)

Los alcances (Scopes) definen los permisos que tu aplicación solicita a los usuarios y controlan a qué datos puede acceder tu aplicación desde sus cuentas de GitHub.

Utiliza el campo Scopes en Logto para solicitar permisos adicionales a GitHub. Elige uno de los siguientes enfoques según tus necesidades:

Opción 1: No se necesitan alcances de API adicionales

Deja el campo Scopes en tu conector de GitHub en Logto en blanco.
Se solicitará el alcance predeterminado read:user para asegurar que Logto pueda obtener correctamente la información básica del usuario (por ejemplo, correo electrónico, nombre, avatar).

Consulta todos los alcances de GitHub para aplicaciones OAuth disponibles y agrega solo los que tu aplicación necesite.
Ingresa todos los alcances deseados en el campo Scopes, separados por espacios.
Cualquier alcance que listes aquí sobrescribe los valores predeterminados, así que siempre incluye el alcance de autenticación: read:user.
Alcances adicionales comunes incluyen:
- repo: Control total de repositorios privados
- public_repo: Acceso a repositorios públicos
- user:email: Acceso a direcciones de correo electrónico del usuario
- notifications: Acceso a notificaciones
Asegúrate de que todos los alcances estén escritos correctamente y sean válidos. Un alcance incorrecto o no soportado resultará en un error de "Invalid scope" por parte de GitHub.

Opción 3: Solicitar alcances incrementales más adelante

Después de que el usuario inicie sesión, puedes solicitar alcances adicionales bajo demanda reiniciando un flujo de autorización social federado y actualizando el conjunto de tokens almacenados del usuario.
Estos alcances adicionales no necesitan ser ingresados en el campo Scopes de tu conector de GitHub en Logto, y pueden lograrse a través de la Social Verification API de Logto.

Siguiendo estos pasos, tu conector de GitHub en Logto solicitará exactamente los permisos que tu aplicación necesita, ni más ni menos.

tip:

Si tu aplicación solicita estos alcances para acceder a la API de GitHub y realizar acciones, asegúrate de habilitar Store tokens for persistent API access en el conector de GitHub de Logto. Consulta la siguiente sección para más detalles.

Paso 4: Configuración general

Aquí tienes algunas configuraciones generales que no bloquearán la conexión con GitHub pero pueden afectar la experiencia de autenticación del usuario final.

Sincronizar información del perfil

En el conector de GitHub, puedes establecer la política para sincronizar la información del perfil, como nombres de usuario y avatares. Elige entre:

Solo sincronizar al registrarse: La información del perfil se obtiene una vez cuando el usuario inicia sesión por primera vez.
Siempre sincronizar al iniciar sesión: La información del perfil se actualiza cada vez que el usuario inicia sesión.

Almacenar tokens para acceder a las APIs de GitHub (Opcional)

Si deseas acceder a las APIs de GitHub y realizar acciones con la autorización del usuario (ya sea mediante inicio de sesión social o vinculación de cuentas), Logto necesita obtener alcances de API específicos y almacenar los tokens.

Agrega los alcances requeridos siguiendo las instrucciones anteriores.
Habilita Store tokens for persistent API access en el conector de GitHub de Logto. Logto almacenará de forma segura los tokens de acceso de GitHub en el Secret Vault.

nota:

Cuando usas una OAuth App de GitHub como se describe en este tutorial, no puedes obtener un refresh token de GitHub porque su token de acceso no expira a menos que el usuario lo revoque manualmente. Por lo tanto, no necesitas agregar offline_access en el campo Scopes; hacerlo puede causar un error.

Si deseas que el token de acceso expire o usar refresh tokens, considera integrar con una GitHub App en su lugar. Aprende sobre las diferencias entre GitHub Apps y OAuth Apps.

Paso 5: Prueba tu integración (Opcional)

Antes de lanzar, prueba tu integración con GitHub:

Usa el conector en un tenant de desarrollo de Logto.
Verifica que los usuarios puedan iniciar sesión con GitHub.
Comprueba que se soliciten los alcances correctos.
Prueba las llamadas a la API si estás almacenando tokens.

Las aplicaciones OAuth de GitHub funcionan con cualquier cuenta de usuario de GitHub de inmediato; no es necesario tener usuarios de prueba ni aprobación de la aplicación como en otras plataformas.

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 GitHub debería estar disponible ahora.

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

Navega a Consola > Experiencia de inicio de sesión > Registro e inicio de sesión.
(Opcional) Elige "No aplicable" para el identificador de registro si solo necesitas inicio de sesión social.
Añade el conector GitHub 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 GitHub. ¡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 GitHub​

Configura GitHub OAuth app​

Paso 1: Crea una aplicación OAuth en GitHub​

Paso 2: Configura tu conector de Logto​

Paso 3: Configura los alcances (Scopes) (Opcional)​

Opción 1: No se necesitan alcances de API adicionales​

Opción 2: Solicitar alcances adicionales al iniciar sesión​

Opción 3: Solicitar alcances incrementales más adelante​

Paso 4: Configuración general​

Sincronizar información del perfil​

Almacenar tokens para acceder a las APIs de GitHub (Opcional)​

Paso 5: Prueba tu integración (Opcional)​

Guarda tu configuración​

Habilitar el conector GitHub 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 GitHub

Configura GitHub OAuth app

Paso 1: Crea una aplicación OAuth en GitHub

Paso 2: Configura tu conector de Logto

Paso 3: Configura los alcances (Scopes) (Opcional)

Opción 1: No se necesitan alcances de API adicionales

Opción 2: Solicitar alcances adicionales al iniciar sesión

Opción 3: Solicitar alcances incrementales más adelante

Paso 4: Configuración general

Sincronizar información del perfil

Almacenar tokens para acceder a las APIs de GitHub (Opcional)

Paso 5: Prueba tu integración (Opcional)

Guarda tu configuración

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

Pruebas y Validación

Lecturas adicionales