English
  • Deutsch
  • English
  • Français
  • Español
  • Português
  • 日本語
lumen logo
php logo
api
authorization
rbac

Lumen/PHP Authorization: API Role-Based Access Control

api
authorization
rbac
Dan Arias
By Dan Arias, R&D Engineering ManagerLast update on November 19, 2021

This code sample demonstrates how to implement Role-Based Access Control (RBAC) in a Lumen API server using Auth0. This code sample shows you how to accomplish the following tasks:

  • Create permissions, roles, and users in the Auth0 Dashboard.

  • Use Lumen middleware to enforce API security policies.

  • Perform Role-Based Access Control (RBAC) in Lumen using a token-based authorization strategy powered by JSON Web Tokens (JWTs).

  • Validate access tokens in JSON Web Token (JWT) format using Lumen middleware.

  • Request resources that require different access levels from a secure API server.

Code Sample Specs

This code sample uses the following main tooling versions:

  • Lumen v8.3.1
  • PHP v7.4.25
  • Auth0 PHP SDK v8.0.3

The Lumen project dependency installations were tested with Composer v2.1.14.

Quick Auth0 Set Up

First and foremost, if you haven't already, sign up for an Auth0 account to connect your API with the Auth0 Identity Platform.

Next, you'll connect your API with Auth0. You'll need to create an API registration in the Auth0 Dashboard and get two configuration values: the Auth0 Audience and the Auth0 Domain.

Get the Auth0 audience

  • Open the APIs section of the Auth0 Dashboard.

  • Click on the Create API button and fill out the "New API" form with the following values:

Name
Hello World API Server
Identifier
https://hello-world.example.com
  • Click on the Create button.

Visit the "Register APIs" document for more details.

When setting up APIs, we also refer to the API identifier as the Audience value. Store that value in the following field to set up your API server in the next section:

Get the Auth0 domain

Now, follow these steps to get the Auth0 Domain value.

  • Open the Auth0 Domain Settings

  • Locate the bold text in the page description that follows this pattern: tenant-name.region.auth0.com. That's your Auth0 domain!

  • Paste the Auth0 domain value in the following field so that you can use it in the next section to set up your API server:

The region subdomain (au, us, or eu) is optional. Some Auth0 Domains don't have it.

Set Up and Run the Lumen Project

Start by cloning the Lumen project and checking out the basic-role-based-access-control branch:

git clone https://github.com/auth0-developer-hub/api_lumen_php_hello-world.git --branch basic-role-based-access-control

Make the project directory your current working directory:

cd api_lumen_php_hello-world

Install the Lumen project dependencies:

composer install

Now, create a .env file under the project directory and populate it as follows:

.env
PORT=6060
CLIENT_ORIGIN_URL=http://localhost:4040
AUTH0_AUDIENCE=AUTH0-AUDIENCE
AUTH0_DOMAIN=AUTH0-DOMAIN

Execute the following command to run the Lumen API server:

php -S localhost:6060 -t public

Optional: Add Caching to Your Project

The Auth0 PHP SDK supports (and recommends) using a PSR-6 Compatible Caching Library to increase the performance of the authorization process. You can use that library to temporarily store the JWKS public keys. Adding this cache layer avoids making a request to the Auth0 well-known endpoint every time you need to verify an access token.

Follow these steps to add cache to this project.

Start by adding the symfony/cache dependency:

composer require symfony/cache

You need this dependency as it provides an adapter that wraps Lumen's cache as a PSR-6 compatible interface, which the Auth0 PHP SDK requires.

Set the cache driver on your .env file using a CACHE_DRIVER variable:

.env
PORT=6060
CLIENT_ORIGIN_URL=http://localhost:4040
AUTH0_AUDIENCE=AUTH0-AUDIENCE
AUTH0_DOMAIN=AUTH0-DOMAIN
CACHE_DRIVER=file

Lumen supports a wide variety of cache drivers. Please refer to the "Cache" Lumen document for more details.

Now, create a cache.php file under the config directory to configure your cache:

config/cache.php
<?php
return [
'default' => env('CACHE_DRIVER'),
'stores' => [
'file' => [
'driver' => 'file',
'path' => env('CACHE_PATH', storage_path('framework/cache')),
],
],
];

This cache configuration will vary depending on the driver that you choose to use.

Next, update the bootstrap/app.php file to make your cache config file available to Lumen:

bootstrap/app.php
<?php
//...
// Make the cache config file available for the application
$app->configure('cache');
//...

Finally, open the config/auth0.php file and add useCache to enable caching for Auth0:

config/auth0.php
<?php
return [
'domain' => env('AUTH0_DOMAIN'),
'audience' => [ env('AUTH0_AUDIENCE') ],
'useCache' => true // Add this line
];
//...

Set Up Role-Based Access Control (RBAC)

Within the context of Auth0, Role-based access control (RBAC) systems assign permissions to users based on their role within an organization. Everyone who holds that role has the same set of access rights. Those who hold different roles have different access rights.

Developers who use Role-based access control (RBAC) for access management can mitigate the errors that come from assigning permissions to users individually.

You can use the Auth0 Dashboard to enable Role-Based Access Control (RBAC) in any API that you have already registered with Auth0. You then implement RBAC by creating API permissions, assigning those permissions to a role, and assigning that role to any of your users.

Whenever a user logs in to one of your client applications, the Auth0 authorization server issues an access token that the client can use to make authenticated requests to an API server. Auth0 authorization servers issue access tokens in JSON Web Token (JWT) format.

When you enable Auth0 Role-Based Access Control (RBAC) for an API, the access token will include a permissions claim that has all the permissions associated with any roles that you have assigned to that user.

For this particular API code sample, the access token present in the authorization header of a request must include a permissions claim that contains the read:admin-messages permission to access the GET /api/messages/admin endpoint.

Enable Role-Based Access Control (RBAC)

  • Open the APIs section of the Auth0 Dashboard and select your "Hello World API Server" registration.

  • Click on the "Settings" tab and locate the "RBAC Settings" section.

  • Switch on the "Enable RBAC" and "Add Permissions in the Access Token" options.

Visit the "Role-Based Access Control" document for more details.

Create an API permission

In the same Auth0 API registration page, follow these steps:

  • Click on the "Permissions" tab and fill a field from the "Add a Permission (Scope)" section with the following information:
Permission (Scope)
read:admin-messages
Description
Read admin messages
  • Click the "+ Add" button to store the permission.

Visit the "Add API Permissions" document for more details.

Create a role with permissions

Create a role

  • Open the User Management > Roles section of the Auth0 Dashboard.

  • Click on the Create role button and fill out the "New Role" form with the following values:

Name
messages-admin
Description
Access admin messaging features
  • Click on the Create button.

Visit the "Create Roles" document for more details.

Add permissions to the role

  • Click on the "Permissions" tab of the roles page.

  • Click on the "Add Permissions" button.

  • Select the "Hello World API Server" from the dropdown menu that comes up and click the "Add Permissions" button.

  • Select all the permissions available by clicking on them one by one or by using the "All" link.

  • Finally, click on the "Add Permissions" button to finish up.

Visit the "Add Permissions to Roles" document for more details.

Create an admin user

  • Open the User Management > Users section from the Auth0 Dashboard.

  • Click on the "Create user" button and fill out the form with the required information. Alternatively, you can also click on any of your existing users to give one of them the admin role.

  • On the user's page, click on the "Roles" tab and then click on the "Assign Roles" button.

  • Select the messages-admin role from the dropdown menu and click on the "Assign" button.

Visit the "Assign Roles to Users" document for more details.

Access the Admin Endpoint

Let's test access to the GET /api/messages/admin endpoint by simulating a real user login and requesting that protected resource using a real access token.

You can pair this API server with a client application that matches the technology stack that you use at work. Any "Hello World" client application can communicate with this "Hello World" API server sample.

When you log in to a "Hello World" client application as a user who has the messages-admin role, your access token will have the required permissions to access the GET /api/messages/admin endpoint.

You can simulate a secure full-stack application system in no time. Each client application sample gives you clear instructions to get it up and running quickly.

Pick a Single-Page Application (SPA) code sample in your preferred frontend framework and language: