PHPackages zuse/laravel-rbac-auto - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Authentication & Authorization](/categories/authentication) 4. / 5. zuse/laravel-rbac-auto ActiveLibrary[Authentication & Authorization](/categories/authentication) zuse/laravel-rbac-auto ====================== Automated Laravel integration package for Zuse RBAC - Automates the complete 12-step integration process 01PHP Since Aug 19Pushed 8mo agoCompare [ Source](https://github.com/rasandilikshana/zuse-laravel-rbac-auto)[ Packagist](https://packagist.org/packages/zuse/laravel-rbac-auto)[ RSS](/packages/zuse-laravel-rbac-auto/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) ๐Ÿš€ Zuse Laravel RBAC Auto-Integration Package ============================================ [](#-zuse-laravel-rbac-auto-integration-package) **Automate the complete 12-step Zuse RBAC integration process in just 2 minutes!** This package transforms the manual 2-4 hour integration process into a single automated command that handles everything for you. โœจ What This Package Does ------------------------ [](#-what-this-package-does) Instead of manually following 12 complex steps, this package automatically: - โœ… **Step 2**: Installs required dependencies (`firebase/php-jwt`, `guzzlehttp/guzzle`) - โœ… **Step 3**: Configures environment variables in `.env` - โœ… **Step 4**: Adds Keycloak service configuration - โœ… **Step 5**: Creates secure `KeycloakController` with best practices - โœ… **Step 6**: Registers authentication routes - โœ… **Step 7**: Enhances User model with RBAC methods - โœ… **Step 8**: Creates and registers `RoleMiddleware` - โœ… **Step 9**: Creates database migration for Keycloak fields - โœ… **Step 10**: Creates beautiful dashboard view - โœ… **Step 11**: Runs comprehensive integration tests ๐Ÿ“ฆ Installation & Usage -------------------------- [](#-installation--usage) ### Prerequisites [](#prerequisites) 1. Get your credentials from the **Lyceum RBAC middleware panel**: - Login to the Lyceum RBAC panel - Create a new application (Laravel type) - Copy your `Client ID` and `Client Secret` ### Quick Setup (2 minutes) [](#quick-setup-2-minutes) ``` # 1. Install the package composer require zuse/laravel-rbac-auto # 2. Run the automated integration php artisan zuse:integrate \ --client-id="your-client-id-from-lyceum-panel" \ --client-secret="your-client-secret-from-lyceum-panel" \ --test # 3. Apply database changes php artisan migrate # 4. Test your integration php artisan serve # Visit: http://localhost:8000/auth/keycloak ``` **That's it! ๐ŸŽ‰ Your Laravel app now has complete RBAC integration.** โš™๏ธ Command Options ------------------ [](#๏ธ-command-options) ``` php artisan zuse:integrate [options] ``` ### Required Options [](#required-options) - `--client-id`: Your client ID from Lyceum RBAC panel - `--client-secret`: Your client secret from Lyceum RBAC panel ### Optional Options [](#optional-options) - `--base-url`: Keycloak base URL (default: `https://keycloak.zuse.lk`) - `--realm`: Keycloak realm (default: `zuse`) - `--redirect-uri`: Custom redirect URI (default: auto-generated) - `--test`: Run integration tests after setup - `--force`: Force overwrite existing files ### Examples [](#examples) ``` # Basic integration php artisan zuse:integrate --client-id="abc123" --client-secret="secret456" # With custom settings php artisan zuse:integrate \ --client-id="abc123" \ --client-secret="secret456" \ --base-url="https://auth.mycompany.com" \ --realm="mycompany" \ --test # Force overwrite existing integration php artisan zuse:integrate \ --client-id="abc123" \ --client-secret="secret456" \ --force ``` ๐Ÿ” What Gets Created ------------------- [](#-what-gets-created) ### 1. Environment Configuration (`.env`) [](#1-environment-configuration-env) ``` KEYCLOAK_BASE_URL=https://keycloak.zuse.lk KEYCLOAK_REALM=zuse KEYCLOAK_CLIENT_ID=your-client-id KEYCLOAK_CLIENT_SECRET=your-client-secret KEYCLOAK_REDIRECT_URI=http://localhost:8000/auth/keycloak/callback ``` ### 2. Service Configuration (`config/services.php`) [](#2-service-configuration-configservicesphp) ``` 'keycloak' => [ 'base_url' => env('KEYCLOAK_BASE_URL'), 'realm' => env('KEYCLOAK_REALM'), 'client_id' => env('KEYCLOAK_CLIENT_ID'), 'client_secret' => env('KEYCLOAK_CLIENT_SECRET'), 'redirect_uri' => env('KEYCLOAK_REDIRECT_URI'), // ... complete configuration ], ``` ### 3. Authentication Controller [](#3-authentication-controller) - `app/Http/Controllers/Auth/KeycloakController.php` - Includes security best practices from your proven implementation - JWT signature verification for production - Refresh token rotation - State parameter validation ### 4. User Model Enhancement [](#4-user-model-enhancement) Your `User` model gets enhanced with RBAC methods: ``` public function hasRole($role): bool public function hasAnyRole(array $roles): bool public function belongsToGroup($group): bool ``` ### 5. Role Middleware [](#5-role-middleware) - `app/Http/Middleware/RoleMiddleware.php` - Automatically registered in `Kernel.php` ### 6. Authentication Routes [](#6-authentication-routes) ``` Route::get('/auth/keycloak', [KeycloakController::class, 'login']); Route::get('/auth/keycloak/callback', [KeycloakController::class, 'callback']); Route::post('/auth/keycloak/logout', [KeycloakController::class, 'logout']); Route::post('/auth/keycloak/refresh', [KeycloakController::class, 'refreshToken']); ``` ### 7. Database Migration [](#7-database-migration) Adds Keycloak fields to your users table: - `keycloak_id` (string, nullable, indexed) - `roles` (json, nullable) - `groups` (json, nullable) ### 8. Dashboard View [](#8-dashboard-view) Beautiful dashboard at `resources/views/dashboard.blade.php` showing: - User information - Roles and groups - Role-based content examples - Authentication status ๐Ÿ›ก๏ธ Usage Examples ----------------- [](#๏ธ-usage-examples) ### Protecting Routes with Roles [](#protecting-routes-with-roles) ``` // Protect routes with role middleware Route::middleware(['auth', 'role:admin'])->group(function () { Route::get('/admin', [AdminController::class, 'index']); }); // Multiple roles Route::middleware(['auth', 'role:admin,manager'])->group(function () { Route::get('/reports', [ReportsController::class, 'index']); }); ``` ### Using RBAC in Controllers [](#using-rbac-in-controllers) ``` class UserController extends Controller { public function index() { // Check if user has specific role if (!Auth::user()->hasRole('admin')) { abort(403, 'Admin access required'); } // Check for any of multiple roles if (!Auth::user()->hasAnyRole(['admin', 'manager'])) { abort(403, 'Management access required'); } return view('users.index'); } } ``` ### Using RBAC in Blade Views [](#using-rbac-in-blade-views) ``` @if(Auth::user()->hasRole('admin')) Admin Panel @endif @if(Auth::user()->hasAnyRole(['developer', 'admin'])) Developer Tools @endif ``` ๐Ÿงช Integration Testing --------------------- [](#-integration-testing) The package includes comprehensive tests that verify: - โœ… All required files are created - โœ… Environment variables are configured - โœ… Routes are properly registered - โœ… Middleware is configured - โœ… Database migration is created - โœ… Service configuration is valid - โœ… User model is properly enhanced Run tests with the `--test` flag: ``` php artisan zuse:integrate --client-id="abc123" --client-secret="secret456" --test ``` ๐Ÿ”ง Manual Steps (No Longer Needed!) ---------------------------------- [](#-manual-steps-no-longer-needed) This package replaces these manual steps: 1. Create New Laravel Project (you do this) 2. โœ… Install Required Dependencies - **AUTOMATED** 3. โœ… Configure Environment Variables - **AUTOMATED** 4. โœ… Configure Services - **AUTOMATED** 5. โœ… Create Authentication Controller - **AUTOMATED** 6. โœ… Add Authentication Routes - **AUTOMATED** 7. โœ… Update User Model - **AUTOMATED** 8. โœ… Create Role Middleware - **AUTOMATED** 9. โœ… Database Migration - **AUTOMATED** 10. โœ… Create Dashboard View - **AUTOMATED** 11. โœ… Test Your Integration - **AUTOMATED** 12. Deploy & Configure (you do this) **Result**: 2-4 hours โ†’ 2 minutes! ๐Ÿš€ โ“ Troubleshooting ----------------- [](#-troubleshooting) ### Common Issues [](#common-issues) **"Client ID and Client Secret are required"** - Make sure you've created an application in the Lyceum RBAC middleware panel - Copy the exact Client ID and Client Secret from the panel **"Authentication routes not registered"** - Clear your route cache: `php artisan route:clear` - Check that web routes file was updated **"Token validation failed"** - Verify your client credentials are correct - Check that your redirect URI matches the one configured in Lyceum panel **"User model missing RBAC methods"** - The package modifies your existing User model - If it fails, manually add the RBAC methods from the generated migration ### Getting Help [](#getting-help) - ๐Ÿ“– Documentation: - ๐ŸŽฏ Support: - ๐Ÿ› Issues: [GitHub Issues](https://github.com/zuse-lk/laravel-rbac-auto/issues) ๐Ÿ“Š Performance Benefits ---------------------- [](#-performance-benefits) MetricManual ProcessAutomated PackageImprovement**Setup Time**2-4 hours2 minutes**99% faster****Error Rate**~30% (config mistakes)~2% (rare edge cases)**93% reduction****Steps Required**12 manual steps1 command**92% simpler****Code Quality**Varies by developerConsistent best practices**100% consistent**๐ŸŽฏ Requirements -------------- [](#-requirements) - PHP 8.1 or higher - Laravel 10.x, 11.x, or 12.x - Access to Lyceum RBAC middleware panel - Valid Keycloak client credentials ๐Ÿ“ License --------- [](#-license) This package is open-source software licensed under the [MIT license](LICENSE.md). --- **Made with โค๏ธ by [Zuse Technologies](https://zuse.lk)** ### Health Score 16 โ€” LowBetter than 5% of packages Maintenance42 Moderate activity, may be stable Popularity1 Limited adoption so far Community6 Small or concentrated contributor base Maturity13 Early-stage or recently created project Bus Factor1 Top contributor holds 100% of commits โ€” single point of failure How is this calculated?**Maintenance (25%)** โ€” Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** โ€” Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** โ€” Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** โ€” Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/6413844e597a7661262f3ae9d3c746833f6810c45fd8d4ebcb4dbe891d208ec2?d=identicon)[rasandilikshana](/maintainers/rasandilikshana) --- Top Contributors [![rasandilikshana](https://avatars.githubusercontent.com/u/71342393?v=4)](https://github.com/rasandilikshana "rasandilikshana (2 commits)") ### Embed Badge ![Health badge](/badges/zuse-laravel-rbac-auto/health.svg) ``` [![Health](https://phpackages.com/badges/zuse-laravel-rbac-auto/health.svg)](https://phpackages.com/packages/zuse-laravel-rbac-auto) ``` ### Alternatives [namshi/jose JSON Object Signing and Encryption library for PHP. 1.8k99.6M101](/packages/namshi-jose)[league/oauth1-client OAuth 1.0 Client Library 99698.8M106](/packages/league-oauth1-client)[bezhansalleh/filament-shield Filament support for `spatie/laravel-permission`. 2.8k2.9M88](/packages/bezhansalleh-filament-shield)[gesdinet/jwt-refresh-token-bundle Implements a refresh token system over Json Web Tokens in Symfony 70516.4M35](/packages/gesdinet-jwt-refresh-token-bundle)[league/oauth2-google Google OAuth 2.0 Client Provider for The PHP League OAuth2-Client 41721.2M118](/packages/league-oauth2-google)[illuminate/auth The Illuminate Auth package. 9327.3M1.0k](/packages/illuminate-auth) PHPackages ยฉ 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)