PHPackages                             equipe-web/laravel-keycloak - 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. equipe-web/laravel-keycloak

ActiveLibrary[Authentication & Authorization](/categories/authentication)

equipe-web/laravel-keycloak
===========================

Pacote de integração de projetos Laravel com o sistema KeyCloak de autenticação e autorização

v1.2.8(4mo ago)085MITPHPPHP ^8.4|^8.3

Since Dec 4Pushed 4mo ago1 watchersCompare

[ Source](https://github.com/waltersilvacruz/laravel-keycloak)[ Packagist](https://packagist.org/packages/equipe-web/laravel-keycloak)[ RSS](/packages/equipe-web-laravel-keycloak/feed)WikiDiscussions main Synced today

READMEChangelog (10)Dependencies (4)Versions (21)Used By (0)

TCEMT KEYCLOAK
==============

[](#tcemt-keycloak)

Instalação
==========

[](#instalação)

### Requerimentos

[](#requerimentos)

- PHP 8.0+
- Laravel 9.0+

Instale o componente via comando do composer:

```
composer require equipe-web/laravel-keycloak

```

Configuração
============

[](#configuração)

Abra o arquivo `bootstrap/providers.php` e adicione na lista de providers:

```
TCEMT\KeyCloak\Providers\KeyCloakServiceProvider::class

```

limpe o cache de configurações

```
php artisan config:cache

```

Edite o arquivo .env e adicione a configuração básicas para o componente de segurança:

```
KEYCLOAK_KEY_FILE="app/credentials/keycloak-jwt-public-key.txt" # JWT Public Key do KeyCloak
KEYCLOAK_CLIENT_ID=client_id                                    # chave pública da aplicação dentro do REALM
KEYCLOAK_CLIENT_SECRET=secret                                   # chave secreta do aplicação dentro do REALM
KEYCLOAK_REDIRECT_URI="${APP_URL}/auth/callback"                # callback da autenticação oauth
KEYCLOAK_BASE_URL=https://d-iam.tce.mt.gov.br                   # url base do servidor KeyCloak
KEYCLOAK_REALM=master                                           # realm da aplicação
KEYCLOAK_ENABLED=true/false                                     # se FALSE ativa o bypass nas autorizações
KEYCLOAK_CACHE_TIMEOUT=30                                       # tempo de timeout em segundos para as requisições HTTP
KEYCLOAK_ENABLED=true/false                                     # se TRUE ativa o KeyCloak na aplicação
KEYCLOAK_LOAD_CREDENTIALS=true/false                            # se TRUE ele puxa as credenciais do KeyClock
KEYCLOAK_JWT_LEEWAY=0                                           # tempo de tolerância em segundos para expiração do token JWT

```

Adicione as configurações do KeyCloak no arquivo `config/services.php`:

```
...
    'keycloak' => [
        'enabled' => env('KEYCLOAK_ENABLED', false),
        'key_file' => env('KEYCLOAK_KEY_FILE'),
        'client_id' => env('KEYCLOAK_CLIENT_ID'),
        'client_secret' => env('KEYCLOAK_CLIENT_SECRET'),
        'redirect' => env('KEYCLOAK_REDIRECT_URI'),
        'base_url' => env('KEYCLOAK_BASE_URL'),
        'realms' => env('KEYCLOAK_REALM'),
        'enabled' => env('KEYCLOAK_ENABLED'),
        'load_credentials' => env('KEYCLOAK_LOAD_CREDENTIALS', false),
        'jwt_leeway' => env('KEYCLOAK_JWT_LEEWAY', 0),
    ],
...

```

limpe o cache de configurações novamente

```
php artisan config:cache

```

Execute os comandos abaixo:

```
php artisan clear-compiled && composer dumpautoload && php artisan optimize

```

Utilização
==========

[](#utilização)

Links para login e logout via Oauth2
------------------------------------

[](#links-para-login-e-logout-via-oauth2)

O ServiceProvider desta biblioteca automaticamente irá registrar as seguintes rotas para o processo de autenticação:

- `GET /auth/redirect`: esta rota irá redirecionar a aplicação para a autenticação Oauth2 no servidor KeyCloak.
- `GET /auth/callback`: após validar o login e senha, o usuário será redirecionado para esta rota que finalizará o processo de autenticação e autorização.
- `GET /auth/logout`: efetua o logout do usuário

#### Diretivas Blade para gerar os links de login/logout

[](#diretivas-blade-para-gerar-os-links-de-loginlogout)

Dentro do template blade você pode utilizar a diretiva `@keycloak_login_url($label, $css)` e `@keycloak_logout_url($label, $css)` para gerar os links de login e logout respectivamente.

Exemplo:

```

    @keycloak_login_url("Login", "btn btn-primary")

    @keycloak_logout_url("Logout", "btn btn-primary")

```

Se você utilizar a diretiva de logout, o usuário será redirecionado para a tela de logout do KeyCloak e depois será redirecionado para a URL de logout da sua aplicação. Dessa forma, ao efetuar o logout a sessão do usuário será encerrada nas duas aplicações. Caso você queira que o usuário seja desconectado apenas da sua aplicação e mantenha a sessão autenticada no KeyClock (para logar novamente sem precisar redigitar o login/senha) você deve utilizar a rota `auth.logout` ao invés da diretiva:

```
Desconectar

```

Dentro de um Controller
-----------------------

[](#dentro-de-um-controller)

Utilize o facade `Gate` para verificar as permissões dos usuários no controller. O método `Gate::allows($recurso)` se encarrega de fazer a verificação e retorna verdadeiro ou falso.

```