sindria/oauth2-keycloak

A wrapper for the Keycloak OAuth 2.0 Client Provider

1.0.0 2023-04-29 01:29 UTC

Requires

• php: ^7.3|^8.0
• firebase/php-jwt: ^4.0
• league/oauth2-client: ^2.0 <2.3.0

Requires (Dev)

• mockery/mockery: ~0.9
• phpunit/phpunit: ~4.0
• squizlabs/php_codesniffer: ~2.0

MIT

• Luca Pitzoi

• authorization
• client
• oauth
• oauth2
• authorisation
• keycloak

README

A wrapper for the Keycloak OAuth 2.0 Client Provider, support Authentication and Authorization.

Installation

To install, use composer:

composer require sindria/oauth2-keycloak

Init

$passport = Passport::init([
    'authServerUrl' => 'http://127.0.0.1:8080/auth',
    'realm'         => 'xxxx',
    'clientId'      => 'backend',
    'clientSecret'  => 'xxxxx',
    'redirectUri'   => 'http://127.0.0.1:8003/auto',
    'periodNoCheck' => 3600,
    'periodCheck'   => 180,
]);

Authentication

Login

$user = $passport->checkLogin();
$user->getAttr('username');
$user->toArray();

logout

$passport->logout();

Other Methds

$passport->getAccessToken(); // can save in client
$passport->getToken(); // secret
$passport->getAuthorizationUrl();
$passport->getLogoutUrl();

Authorization

$user = $passport->checkAuth();

// permission
$user->can($resource, $scope);
$user->cannot($resource, $scope);

// list
$user->getClients();
$user->getPermissions();

// role
$user->getRoles();
$user->hasRole($role);
$user->inRoles($roleList);