Keycloak OAuth2 Provider for Laravel Socialite

Installation

 clone : git clone https://github.com/avdevs/keycloak.git
installing package : composer require avdevs/keycloak

Requirements

 Download latest keycloak server repository from https://www.keycloak.org/ and setup keycloak server at admin console.

Environment Setup

Add below key array in '/config/services.php' file.

'keycloak' => [
'authServerUrl' => env('KEYCLOAK_AUTHSERVERURL'),
'realm' => env('KEYCLOAK_REALM'),
'clientId' => env('KEYCLOAK_CLIENTID'),
'clientSecret' => env('KEYCLOAK_CLIENTSECRET'),
'redirectUri' => env('KEYCLOAK_REDIRECTURI'),
'encryptionAlgorithm' => env('KEYCLOAK_ENCRYPTIONALGORITHM'),
'encryptionKeyPath' => env('KEYCLOAK_ENCRYPTIONKEYPATH'),
'encryptionKey' => env('KEYCLOAK_ENCRYPTIONKEY'),
]

Laravel AppServiceProvider

Add below code in /app/Providers/AppServiceProvider.php file which helps to execute keycloak as a socialite provider.

useAvdevs\Keycloak\KeycloakProvider;

In boot() method, add below code

$this->bootKeycloakSocialite();

Add Function

privatefunctionbootKeycloakSocialite()
{
$socialite = $this->app->make('Laravel\Socialite\Contracts\Factory');
$socialite->extend(
'keycloak',
function ($app) use ($socialite) {
$config = $app['config']['services.keycloak'];
returnnewKeycloakProvider($config);
}
);
}

Laravel Functions and Routes

useSocialite;

 Route::get('/redirect/{provider}', 'ProviderAuthController@redirectToProvider');
/** * Redirect to keycloak server. * @provider * @return */publicfunctionredirectToProvider($provider)
{
/* where $provider = 'keycloak' */return Socialite::driver($provider)
->stateless()
->scopes([]) // Array ex : name
->redirect();
}

 Route::get('/callback/{provider}', 'ProviderAuthController@CallbackFunction');
/** * retrieve user information which is located at keycloak serve. * @provider * @return */publicfunctionCallbackFunction($provider)
{
/* where $provider = 'keycloak' */$userData = Socialite::driver($provider)
->stateless()
->user();
/* Note : *//* 1) Callback url is same for login and logout request. so this function executed twice. *//* 2) Must add below code, Because user data not retrieved while logout calls is requested. */if(!isset($userData->email)){
returnredirect()->back();
}
/* your logic for add or get user detail */
}

 Route::get('/logout/{provider}', 'ProviderAuthController@ProviderLogout');
/** * Log the user out of the application. * @provider * @return void */publicfunctionProviderLogout($provider)
{
/* where $provider = 'keycloak' *//* logout from laravel auth */
Auth::logout();
/* redirect to keycloak logout url */returnredirect(
Socialite::driver($provider)
->getLogoutUrl()
);
}