pickmap/keycloak-middleware

keycloak

0.5.0 2023-09-10 07:09 UTC

Requires

• firebase/php-jwt: ^6.8
• laravel/framework: 8.*|9.*|10.*
• pickmap/response: ^0.2.0

MIT

• alireza salehi

• php
• middleware
• laravel
• Microservice
• keycloak
• laravel-auth

README

step #1

install package with below code

composer require pickmap/keycloak-middleware

step #2

‍‍ Go to ‍‍‍‍‍‍‍/config/app.php and put KeycloakMiddlewareServiceProvider::class code

    'providers' => ServiceProvider::defaultProviders()->merge([
        /*
         * Package Service Providers...
         */
        KeycloakMiddlewareServiceProvider::class,

step #3

add this command in terminal in your root of project

php artisan vendor:publish --tag=keycloak-middleware

than add your keycloak public key in /config/keycloak-middleware.php

return [
    'public_key' => null,
];

step #4

Now you can check keycloak tokens by installing middleware ‍‍‍keycloak-middleware for your route

Route::get('/', function () {
    dd(request()->all());
})->middleware('keycloak-middleware');

Scope And Role

Also, you can limit the access of users by sending the required scopes or roles

" * " means all (role or scope)

Route::group(['prefix' => 'v1','middleware' => 'keycloak-middleware:*,*'],function(){
    #  routes
});

Route::group(['prefix' => 'v1','middleware' => 'keycloak-middleware:admin,*'],function(){
    #  routes
});

Route::group(['prefix' => 'v1','middleware' => 'keycloak-middleware:admin|user,view.profile|send.email'],function(){
    #  routes
});