Aplicación de ejemplo de OAuth 2.0 | Documentación del Centro de creación de Roblox

Roblox proporciona una aplicación de ejemplo en Node.js que muestra cómo utilizar OAuth 2.0 para permitir a los usuarios iniciar sesión en sus cuentas de Roblox y transmitir mensajes a través de sus juegos. Esta aplicación utiliza el flujo de código de autorización sin PKCE y, por lo tanto, es adecuada solo para clientes confidenciales, como los servidores privados.

Después de descargar el archivo .zip, extráelo en su propia carpeta.

Registrar la aplicación

El primer paso para configurar la aplicación es registrarla en el sitio web de Roblox y copiar el ID del cliente y el secreto en un lugar seguro. Luego sigue los pasos de registro estándar con estas configuraciones:

En Permisos, agrega los alcances openid, profile y universe-messaging-service:publish.
En URLs de Redirección, agrega la http://localhost:3000/oauth/callback. Si deseas usar un puerto no predeterminado para tu aplicación, especifícalo aquí.

Establecer variables de entorno

En lugar de almacenarlas en el código (no recomendado), la aplicación utiliza variables de entorno para tu ID de cliente y secreto. El proceso para agregar variables de entorno difiere según el sistema operativo.

En Windows, ejecuta los siguientes comandos de PowerShell:


$env:ROBLOX_CLIENT_ID='tu_id_de_cliente_aquí'
$env:ROBLOX_CLIENT_SECRET='tu_secreto_de_cliente_aquí'
$env:ROBLOX_PORT=3000 # Opcional. El valor predeterminado es 3000.

En Mac y la mayoría de las distribuciones de Linux, ejecuta estos comandos en la terminal:


export ROBLOX_CLIENT_ID=tu_id_de_cliente_aquí
export ROBLOX_CLIENT_SECRET=tu_secreto_de_cliente_aquí
export ROBLOX_PORT=3000 # Opcional. El valor predeterminado es 3000.

Si especificaste un puerto no predeterminado en la URL de redirección al registrar tu aplicación, asegúrate de agregar la variable ROBLOX_PORT.

Estos comandos solo establecen variables de entorno durante la duración de tu sesión de terminal. Si deseas cargar estas variables cada vez que abras una nueva ventana de terminal, añade los comandos a tu archivo de configuración de shell, como .zshrc o .bashrc. Muchos servicios de alojamiento tienen funciones para ayudarte a agregar variables de entorno a tus servidores.

Instalar dependencias

La aplicación tiene un puñado de dependencias, visibles en package.json. Para instalarlas, ejecuta:


npm ci

Ejecutar la aplicación

Para iniciar la aplicación, ejecuta:


npm start

Luego navega a http://localhost:3000 (o tu puerto no predeterminado) en un navegador web.

La aplicación te redirige inmediatamente a la pantalla de inicio de sesión de Roblox, momento en el cual puedes iniciar sesión, verificar los permisos que la aplicación está solicitando y hacer clic en Confirmar y Dar Acceso.

Roblox luego te redirige de vuelta a localhost, donde puedes ver que la aplicación ahora muestra alguna información mínima del usuario, un enlace de regreso a su perfil en Roblox y campos que puedes usar para transmitir mensajes a través de tus juegos.

Acerca de la aplicación

En términos generales, index.js realiza las siguientes operaciones:

Inicia un nuevo servidor web utilizando express.
Recupera la configuración de OpenID Connect (OIDC) de Roblox, que incluye puntos finales para autorización, información del usuario, etc. Para obtener más información sobre estos puntos finales, consulta autenticación OAuth 2.0.
Crea un nuevo cliente de Open ID utilizando openid-client y tus credenciales almacenadas. Este cliente simplifica drásticamente el proceso de formar y enviar correctamente las solicitudes HTTP a los puntos finales de OAuth 2.0.
Define las rutas para la aplicación, incluidos los redireccionamientos para los flujos de inicio de sesión y cierre de sesión y el retorno de llamada de OAuth 2.0.
Después de un inicio de sesión exitoso, almacena los diversos tokens como cookies, junto con alguna información mínima del usuario que se muestra como HTML con ayuda de getHomeHtml.js.