How to Use Keycloak with Laravel

Install Laravel Keycloak Package

To simplify the integration process, you can use the Laravel Keycloak package. Install the package using Composer by running the following command in your Laravel project directory:

composer require aacotroneo/laravel-oidc

Configure Laravel Keycloak Package

After installing the package, you need to configure it to connect to your Keycloak instance. Open the config/oidc.php file and provide the necessary configuration details, such as the Keycloak server URL, realm, client ID, client secret, and redirect URL.

Implement Keycloak Authentication in Laravel

To enable Keycloak authentication in your Laravel application, you need to make some changes to the config/auth.php file. Update the guards array to include a new guard for Keycloak, like this:

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],

    'keycloak' => [
        'driver' => 'keycloak',
        'provider' => 'users',
    ],
],

Next, update the providers array to include a new provider for Keycloak, like this:

'providers' => [
    'users' => [
        'driver' => 'keycloak',
        'model' => App\Models\User::class,
    ],
],

Protect Routes with Keycloak Authentication

To protect specific routes with Keycloak authentication, you can use the keycloak middleware provided by the Laravel Keycloak package. Simply add the middleware to the desired routes or route groups in your routes/web.php file, like this:

Route::middleware('keycloak')->group(function () {
    // Routes that require Keycloak authentication
});

Test Keycloak Authentication

You can now test Keycloak authentication by accessing the protected routes in your Laravel application. If everything is configured correctly, users will be redirected to the Keycloak login page when accessing these routes.

That's it! You have successfully integrated Keycloak with Laravel using the Laravel Keycloak package. Now, you can enjoy the benefits of a secure and robust authentication system for your Laravel application.

For more information and advanced usage of the Laravel Keycloak package, refer to the package's documentation on GitHub.

---