Uma simples biblioteca para "authentication/authorization" no sso keycloack ultilizando o protrotocolo openid-connect.
A authorization funciona apens para permissoes baseadas em escopos ou permissoes baseadas em recursos, para saber mais acesse KeyCloack Authorization Services
-
Instalar usando o composer:
composer require cometa/key-cloack
-
Publicar arquivos de configuração:Execulte o senguite codigo no terminal
php artisan vendor:publish --tag=config
isso fará com com o laravel crie o arquivo de configuração em config/ caso isso não sai como esperado será necessario fazer isso manualmente. Basta copiar _vendor/cometa-keycloack/config/keyCloack.php para config/. -
Registrar Middlewares: Em app/Http/Kenel.php adicioner os dois items no array $routeMiddleware
$routerMiddleware = [
'auth' => Cometa\KeyCloack\Middlewares\Authenticate::class,
'permission' => Cometa\KeyCloack\Middlewares\Authorization::class
...
];
- Configurar config/auth.php: Alterar a key _guards
'guards' => [
'api' => [
'driver' => 'keycloak',
'provider' => 'users',
],
]
- Instalar usando o composer:
composer require cometa/key-cloack
- Publicar configurações:
- Copiar vendor/cometa-keycloack/config/keyCloack.php para config/.
- Copiar vendor/cometa-keycloack/config/auth.php para config/., caso o arquivo auth já exista fazer apenas um merger das informações de acordo com sua necessidade, as extrutura as chaves a baixo devem ficar da seguite forma.
// config/auth.php
[
'defaults' => [
'guard' => 'api',
'passwords' => 'users',
],
'guards' => [
'api' => [
'driver' => 'keycloak',
'provider' => 'users',
],
],
'providers' => [
'users' => [
'driver' => 'eloquent',
'model' => User::class
]
]
];
- Registrar Providers: Adicione a linha em bootstrap/app.php
$app->register(Cometa\KeyCloack\Providers\KeyCloackServiceProvider::class);
- Registrar middlewares authorization e authentication: adicionar as linhas em bootstrap/app.php
$app->routeMiddleware([
'auth' => Cometa\KeyCloack\Middlewares\Authenticate::class,
'permission' => Cometa\KeyCloack\Middlewares\Authorization::class
]);
Se voce seguiu todas os passos corretamente basta chamar o middleware um sua rota. O middleware permission recebe um parametro route#scoped, para entender mais sobre contrele de acesso com keyclock acesse keycloack
$router->get('/keycloack', [
'uses' => "KeyCloackController@index",
'middleware' => ['auth', 'permission:users#list-all']
]);
- Captura o usuario autheticado
/**
* @return \Illuminate\Contracts\Auth\Authenticatable|null
**/
Illuminate\Support\Facades\Auth::user();
- Verificar se o usuario logado possui um papel
/**
* @param array<App\Model\Role>| Role
* @return bool
**/
Illuminate\Support\Facades\Auth::hasRoles(Role::admin);
## OR
Illuminate\Support\Facades\Auth::hasRoles([Role::admin, Role::gestor]);
- Retornar todas as permissoes do usuario logado
/**
* @return array
**/
Illuminate\Support\Facades\Auth::allPermission();
- Retornar todos os papeis
/**
* @return array
**/
Illuminate\Support\Facades\Auth::getRoles();
- Retornar um atributos contido no token
/**
* @param string
* @return mixed
**/
Illuminate\Support\Facades\Auth::getAttribute("name");