Por Evan Sims
Esta guía muestra cómo integrar Auth0 con una aplicación PHP mediante el SDK de Auth0 para PHP. Le recomendamos iniciar sesión para seguir esta guía de inicio rápido con ejemplos configurados para su cuenta.
Obtén las claves de tu aplicación
- Dominio
- ID de cliente
- Secreto del cliente
Si descargas el ejemplo de la parte superior de esta página, estos datos ya estarán completados.
Si está siguiendo el proyecto de ejemplo que descargó en la parte superior de esta página, la URL de callback que debe agregar al campo Allowed Callback URLs es http://127.0.0.1:3000/.
returnTo. La URL de cierre de sesión de tu aplicación debe agregarse al campo Allowed Logout URLs de la configuración de la aplicación. Si este campo no está configurado, los usuarios no podrán cerrar sesión en la aplicación y recibirán un error.
Si estás siguiendo el proyecto de ejemplo que descargaste al principio de esta página, la URL de cierre de sesión que debes agregar al campo Allowed Logout URLs es http://127.0.0.1:3000.
Integra tu aplicación PHP
Instalación del cliente HTTP y de las factorías de mensajería
composer require guzzlehttp/guzzle guzzlehttp/psr7 http-interop/http-factory-guzzle
composer require auth0/auth0-php
vendor dentro de tu proyecto y descargará todas las dependencias necesarias para usar el SDK de PHP de Auth0. También creará un archivo vendor/autoload.php, que se usa en el ejemplo para cargar todas las clases necesarias para que tu aplicación funcione. Es importante que incluyas este archivo de carga automática en tu proyecto para que el SDK funcione.
Para empezar, crea un archivo .env en la raíz del directorio de tu proyecto para almacenar la configuración de la aplicación de ejemplo y completar las variables de entorno:
Como PHP no puede leer por sí solo nuestro archivo .env, tendremos que instalar una biblioteca que nos ayude con eso. Aunque para nuestra aplicación de ejemplo usaremos una biblioteca concreta, en una aplicación real servirá cualquier cargador de dotenv que prefiera. Desde el directorio del proyecto, ejecuta el siguiente comando de shell para instalar la biblioteca:
composer require vlucas/phpdotenv
index.php, y a configurar una instancia del SDK de PHP de Auth0 para nuestra aplicación de ejemplo:
<?php
// Importar el Autoloader de Composer para hacer accesibles las clases del SDK:
require 'vendor/autoload.php';
// Cargar las variables de entorno desde el archivo .env:
(Dotenv\Dotenv::createImmutable(__DIR__))->load();
// Instanciar la clase Auth0 con nuestra configuración:
$auth0 = new \Auth0\SDK\Auth0([
'domain' => $_ENV['AUTH0_DOMAIN'],
'clientId' => $_ENV['AUTH0_CLIENT_ID'],
'clientSecret' => $_ENV['AUTH0_CLIENT_SECRET'],
'cookieSecret' => $_ENV['AUTH0_COOKIE_SECRET']
]);
Configuración de las rutas de la aplicación
composer require steampixel/simple-php-router
index.php y demos vida a nuestra aplicación. Empiece por importar la biblioteca de enrutamiento y definir las URL completas de las rutas de nuestra aplicación de ejemplo como constantes con nombre para mayor comodidad, ya que necesitaremos hacer referencia a ellas en varios puntos de la aplicación:
// 👆 Continuamos desde los pasos anteriores. Agrega esto a tu archivo index.php.
// Importa nuestra biblioteca de enrutamiento:
use Steampixel\Route;
// Define las constantes de ruta:
define('ROUTE_URL_INDEX', rtrim($_ENV['AUTH0_BASE_URL'], '/'));
define('ROUTE_URL_LOGIN', ROUTE_URL_INDEX . '/login');
define('ROUTE_URL_CALLBACK', ROUTE_URL_INDEX . '/callback');
define('ROUTE_URL_LOGOUT', ROUTE_URL_INDEX . '/logout');
Comprobar si hay una sesión
getCredentials(), para comprobar si nuestro usuario se ha autenticado y ha devuelto su perfil. Vamos a usarlo en nuestra ruta de índice para mostrar el perfil del usuario si ha iniciado sesión o indicar que necesita iniciarla.
// 👆 Continuamos desde los pasos anteriores. Agrega esto a tu archivo index.php.
Route::add('/', function() use ($auth0) {
$session = $auth0->getCredentials();
if ($session === null) {
// El usuario no ha iniciado sesión.
echo '<p>Please <a href="/docs/login">log in</a>.</p>';
return;
}
// El usuario ha iniciado sesión.
echo '<pre>';
print_r($session->user);
echo '</pre>';
echo '<p>You can now <a href="/docs/logout">log out</a>.</p>';
});
user, que es un array. Así, por ejemplo, podemos obtener el apodo del usuario con $session->user<a href="https://auth0.com/docs/users/user-profile-structure" target="_blank" rel="noreferrer">nickname, o su dirección de correo electrónico desde $session->useremail. La estructura es la de un perfil de usuario normalizado, sobre la que puedes obtener más información aquí.
Es importante tener en cuenta que el contenido del perfil del usuario variará en función del proveedor o proveedores sociales que uses, por lo que nunca debes dar por hecho que un valor concreto siempre estará presente en la lógica de tu aplicación. Usa construcciones del lenguaje PHP, como isset o la coalescencia nula, para gestionar correctamente la presencia de un valor, o su ausencia; por ejemplo:
// ✋ No es necesario incluir esto en nuestra aplicación de ejemplo, es solo un ejemplo.
$name = $session->user['name'] ?? $session->user['nickname'] ?? $session->user['email'] ?? 'Unknown';
login() del SDK de PHP de Auth0 para configurar la sesión del usuario y devolver una URL personalizada a la página de Universal Login de Auth0 para que el usuario inicie sesión.
// 👆 Continuamos desde los pasos anteriores. Agrega esto a tu archivo index.php.
Route::add('/login', function() use ($auth0) {
// Es recomendable restablecer las sesiones de usuario cada vez que inicien sesión para evitar errores de "estado inválido", en caso de que encuentren problemas de red u otros inconvenientes que interrumpan un proceso de inicio de sesión previo:
$auth0->clear();
// Por último, configura la sesión local de la aplicación y redirige al usuario a la página de Universal Login de Auth0 para autenticarse.
header("Location: " . $auth0->login(ROUTE_URL_CALLBACK));
exit;
});
Gestión de la callback de autenticación
/callback, que gestionaremos en este paso.
Cuando Auth0 nos devuelve a nuestros usuarios, incluye algunos parámetros esenciales en la cadena de consulta de la solicitud HTTP. El método exchange() del SDK de PHP de Auth0 se encarga de gestionarlos, por lo que completar nuestro flujo de autenticación es sencillo:
// 👆 Continuamos desde los pasos anteriores. Añade esto a tu archivo index.php.
Route::add('/callback', function() use ($auth0) {
// Permite que el SDK complete el flujo de autenticación:
$auth0->exchange(ROUTE_URL_CALLBACK);
// Por último, redirige al usuario final de vuelta a la ruta / index para mostrar su perfil:
header("Location: " . ROUTE_URL_INDEX);
exit;
});
logout() del SDK de Auth0 para PHP se encarga de borrar las cookies de sesión de nuestra aplicación de ejemplo, redirigir al usuario al endpoint /logout de Auth0 (que cierra la capa de sesión de Auth0 y cualquier capa de sesión del proveedor de identidad) y, después, devolverlo a la ruta de índice / de nuestra aplicación.
// 👆 Continuamos desde los pasos anteriores. Agrega esto a tu archivo index.php.
Route::add('/logout', function() use ($auth0) {
// Borra la sesión local del usuario en nuestra app y redirigelo al endpoint de logout de Auth0 para cerrar su sesión de Auth0.
header("Location: " . $auth0->logout(ROUTE_URL_INDEX));
exit;
});
// 👆 Continuamos desde los pasos anteriores. Añade esto a tu archivo index.php.
// Esto le indica a nuestro enrutador que hemos terminado de configurar las rutas y que estamos listos para comenzar a enrutar las solicitudes HTTP entrantes:
Route::run('/');
php -S 127.0.0.1:3000 index.php
¿Qué puedes hacer a continuación?
Authenticate
Manage Users
Customize
Auth0 AI
Platform