Download the PHP package olivier127/rbac-bundle without Composer

PhpRbacBundle

PhpRBACBundle is symfony 7 bundle with full access control library for PHP. It provides NIST Level 2 Standard Hierarchical Role Based Access Control as an easy to use library to PHP developers. It's a rework of the phprbac.net library made by OWASP for symfony 6.

✨ Features

• ✅ NIST Level 2 RBAC - Hierarchical role-based access control
• ✅ PHP 8.3 + Symfony 7.3 - Modern stack with latest features
• ✅ Multi-Database - MySQL, MariaDB, PostgreSQL support
• ✅ Performance Cache - 80-90% reduction in database queries
• ✅ Nested Set Model - Efficient hierarchical permissions
• ✅ Attributes Support - PHP 8 attributes for controllers
• ✅ Voter Integration - Symfony Security component integration
• ✅ Twig Extensions - Template helpers for permissions
• ✅ CLI Commands - Interactive management tools

Table of Content

• How it works ?
• Installation
• Configuration
  • Prepare Symfony
  • Add PhpRbac configuration
  • Cache Configuration
  • Roles and permissions creation
  • Make the rbac relations
  • Assign Role to the user and check permission
• RBAC for controller
• Voter based RBAC
• Cache System
• Symfony CLI commands
• Twig functions
• Documentation

How it works ?

Go to https://phprbac.net/ :) to have the representation of permissions and roles as well as their interactions.

Installation

just include the package with composer:

composer require olivier127/rbac-bundle

register the bundle inside config/bundles.php

Add the PhpRbacBundle\Entity\UserRoleTrait inside the User entity class to add the rbac role relation.

Update the database schema with doctrine migration or doctrine schema update to create all the tables

Configuration

Prepare Symfony

Specify the different sections requiring prior authentication in the firewall security configuration section.

Access control only applies to authenticated sections of the website. Therefore, we will use basic ROLE_USER for all users. ROLE_ADMIN can be used for the main administrator but his rights will only be allocated by being associated with the role '/' of the roles tree.

example :

Add PhpRbac configuration

You must create your own entities for driving permissions and roles.

example :

add php_rbac.yaml to associate theses entities to the rbac core

Cache Configuration

The bundle includes a powerful caching system that reduces database queries by 80-90%. The cache is enabled by default.

Configuration options:

• enabled: Enable or disable the cache (default: true)
• ttl: Cache time-to-live in seconds (default: 3600 - 1 hour)
• prefix: Cache key prefix to avoid collisions (default: 'rbac_')

Environment-specific configuration:

For more details, see the Cache Documentation.

Roles and permissions creation

Add all the roles and the permissions you need with the RoleManager and the PermissionManager

examples :

to add a permission to the root

To add a chain or permission

Make the rbac relations

Adding roles use same methods

for the example, i use the chain role "/editor/reviewer". The reviewer is the subrole of the editor, the editor is the subrole of the root "/".

Assign permissions to roles

The editor role will have /notepad permission and all sub permissions while the reviewer role will only have /notepad/todolist/read and /notepad/todolist/write permissions

Assign Role to the user and check permission

If the UserRoleTrait is in the class User, you will have addRbacRole. Just add the role in this entity

To test a user's permission or role, use the PhpRbacBundle\Core\Rbac class.

RBAC for controller

Just add attribute is granted like this example. The attributes IsGranted and HasRole check the security with the current user.

the first RBAC\IsGranted on the class check the lowest permission to access to the controller with the current user. The RBAC\IsGranted on each action check the minimum permission to make action work.

In the example :

• The permission /notepad/todolist/read gives the access to the all controller and so index and show action.
• The permission /notepad/todolist/write gives the access to edit the todolist
• The permission /notepad/todolist parent to the read and write permission gives the access to delete

The permission /notepad/todolist has also the read and write permission.

Voter based Rbac

With RbacVoter, you can use symfony security to check the user rbac permissions (not the roles).

example:

You need to set the security access control to be unanimous (all the voter must be ok)

add this lines to config/packages/security.yaml

Cache System

The bundle includes a high-performance caching system that dramatically reduces database queries.

Clear Cache Commands

Performance Impact

• 80-90% reduction in database queries
• First check: 15ms (DB + cache)
• Subsequent checks: 0.5ms (cache only)
• Over 100 checks: 1500ms → 65ms (95.7% faster)

For complete cache documentation, see docs/CACHE.md.

Symfony CLI commands

The install command sets the root node role and permission and associates them.

Add permission into the rbac permissions tree

Add permission into the rbac roles tree

Assign a permission to a role

Assign a role to a user

Clear RBAC cache

Theses commandes are interactives.

Twig

test if user has a role

test if user has a permission

Documentation

• Cache System - Complete cache documentation

Requirements

• PHP 8.3 or higher
• Symfony 7.3 or higher
• Doctrine ORM 3.3 or higher
• MySQL 5.7+, MariaDB 10.2+, or PostgreSQL 12+

License

This bundle is released under the MIT License. See the LICENSE file for details.