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 Vue y Logto.

Requisitos previos

• Una instancia de Logto en funcionamiento. Consulta la página de introducción para comenzar.
• Conocimientos básicos de Vue.
• 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 Single page app, simplemente sigue estos pasos:

1. 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".
2. En el modal que se abre, haz clic en la sección "Single page app" o filtra todos los marcos "Single page app" disponibles usando las casillas de filtro rápido a la izquierda. Haz clic en la tarjeta del marco "Vue" para comenzar a crear tu aplicación.
3. 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 Vue

tip:

• Logto Vue SDK está construido con la API de composición y aprovechando los composables, por lo tanto, solo es compatible con Vue 3.
• El video tutorial está disponible en nuestro canal de YouTube.
• El proyecto de muestra completo está disponible en nuestro repositorio SDK.

Instalación

npm

npm i @logto/vue

pnpm

pnpm add @logto/vue

yarn

yarn add @logto/vue

Inicializar LogtoClient

Importa y utiliza createLogto para instalar el plugin de Logto:

main.ts

import { createLogto, LogtoConfig } from '@logto/vue';
import { createApp } from 'vue';
import App from './App.vue';

const config: LogtoConfig = {
  endpoint: '<your-logto-endpoint>',
  appId: '<your-application-id>',
};

const app = createApp(App);

app.use(createLogto, config);
app.mount('#app');

Configurar URIs de redirección

Antes de entrar en los detalles, aquí tienes una visión general rápida de la experiencia del usuario final. El proceso de inicio de sesión se puede simplificar de la siguiente manera:

1. Tu aplicación invoca el método de inicio de sesión.
2. El usuario es redirigido a la página de inicio de sesión de Logto. Para aplicaciones nativas, se abre el navegador del sistema.
3. El usuario inicia sesión y es redirigido de vuelta a tu aplicación (configurada como el URI de redirección).

Sobre el inicio de sesión basado en redirección

1. Este proceso de autenticación sigue el protocolo OpenID Connect (OIDC), y Logto aplica medidas de seguridad estrictas para proteger el inicio de sesión del usuario.
2. Si tienes múltiples aplicaciones, puedes usar el mismo proveedor de identidad (Logto). Una vez que el usuario inicia sesión en una aplicación, Logto completará automáticamente el proceso de inicio de sesión cuando el usuario acceda a otra aplicación.

Para aprender más sobre la lógica y los beneficios del inicio de sesión basado en redirección, consulta Experiencia de inicio de sesión de Logto explicada.

---

nota:

En los siguientes fragmentos de código, asumimos que tu aplicación está ejecutándose en http://localhost:3000/.

Configurar URIs de redirección

Cambia a la página de detalles de la aplicación en Logto Console. Añade una URI de redirección http://localhost:3000/callback.

Al igual que al iniciar sesión, los usuarios deben ser redirigidos a Logto para cerrar la sesión de la sesión compartida. Una vez terminado, sería ideal redirigir al usuario de vuelta a tu sitio web. Por ejemplo, añade http://localhost:3000/ como la sección de URI de redirección posterior al cierre de sesión.

Luego haz clic en "Guardar" para guardar los cambios.

Manejar redirección

Todavía hay cosas por hacer después de que el usuario sea redirigido de vuelta a tu aplicación desde Logto. Vamos a manejarlo adecuadamente.

Primero, vamos a crear una página de callback:

views/CallbackView.vue

import { useHandleSignInCallback } from '@logto/vue';
import router from '@/router';

const { isLoading } = useHandleSignInCallback(() => {
  // Haz algo cuando termine, por ejemplo, redirigir a la página de inicio
});

<template>
  <!-- Cuando está en progreso -->
  <p v-if="isLoading">Redirigiendo...</p>
</template>

Inserta el siguiente código en tu ruta /callback que NO requiere autenticación:

router/index.ts

// Asumiendo vue-router
const router = createRouter({
  routes: [
    {
      path: '/callback',
      name: 'callback',
      component: CallbackView,
    },
  ],
});

Implementar inicio y cierre de sesión

Proporcionamos dos composables useHandleSignInCallback() y useLogto() que pueden ayudarte a gestionar fácilmente el flujo de autenticación.

nota:

Antes de llamar a .signIn(), asegúrate de haber configurado correctamente el URI de redirección en la Consola de Administración.

views/HomeView.vue

import { useLogto } from '@logto/vue';

const { signIn, signOut, isAuthenticated } = useLogto();

const onClickSignIn = () => signIn('http://localhost:3000/callback');
const onClickSignOut = () => signOut('http://localhost:3000');

<template>
  <button v-if="!isAuthenticated" @click="onClickSignIn">Iniciar sesión</button>
  <button v-else @click="onClickSignOut">Cerrar sesión</button>
</template>

Llamar a .signOut() borrará todos los datos de Logto en la memoria y en localStorage si existen.

Punto de control: Prueba tu aplicación

Ahora, puedes probar tu aplicación:

1. Ejecuta tu aplicación, verás el botón de inicio de sesión.
2. 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.
3. 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.
4. 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 Vue 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:

1. Navega a Console > Connectors > Social Connectors.
2. Haz clic en "Add social connector" y selecciona "GitHub".
3. 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.

1. Ve a GitHub e inicia sesión con tu cuenta, o crea una nueva si es necesario.
2. Navega a Settings > Developer settings > OAuth apps.
3. 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.
4. 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.

1. Copia el Client ID de tu aplicación OAuth de GitHub y pégalo en el campo clientId en Logto.
2. 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.
3. 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).

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

• 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.

1. Agrega los alcances requeridos siguiendo las instrucciones anteriores.
2. 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:

1. Usa el conector en un tenant de desarrollo de Logto.
2. Verifica que los usuarios puedan iniciar sesión con GitHub.
3. Comprueba que se soliciten los alcances correctos.
4. 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.

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

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.

1. Navega a Consola > Experiencia de inicio de sesión > Registro e inicio de sesión.
2. (Opcional) Elige "No aplicable" para el identificador de registro si solo necesitas inicio de sesión social.
3. Añade el conector GitHub configurado a la sección "Inicio de sesión social".

Pruebas y Validación

Regresa a tu aplicación Vue. 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á.