README

[需要维护者] Laravel的Keycloak Web Guard

此包允许您使用 Keycloak服务器进行用户认证。

它在前端工作。对于API，我们推荐 laravel-keycloak-guard。

要求

拥有Keycloak服务器。
拥有配置好的域和一个接受认证的客户端。

支持

此包已在以下环境中测试：

Laravel: 5.8 / 7 / 8 / 9 / 10 / 11
Keycloak: 18.0.0

其他版本不保证能正常工作。

此项目是开源的，在我空闲时间维护。所以，如果您有任何问题，您可以提交一个包含所有详细信息的问题（laravel版本、keycloak版本、问题描述等），我会很乐意尝试帮助您。

流程

用户访问受保护的路由，并被重定向到Keycloak登录。
用户登录并获取一个代码。
用户被重定向到回调页面，我们将代码转换为访问令牌。
我们将其存储在会话中并验证用户。
用户已登录。
我们将用户重定向到配置的“redirect_url”路由或目标路由。

安装

要求包

composer require vizir/laravel-keycloak-web-guard

如果您想更改路由或Keycloak的默认值，请发布配置文件

php artisan vendor:publish  --provider="Vizir\KeycloakWebGuard\KeycloakWebGuardServiceProvider"

配置

发布 config/keycloak-web.php 文件后，您可以更改路由

'redirect_url' => '/admin',

'routes' => [
    'login' => 'login',
    'logout' => 'logout',
    'register' => 'register',
    'callback' => 'callback',
]

范围 openid 总是包含在内，但如果您需要额外的范围，您可以将其作为字符串添加到数组中

'scopes' => [],

示例

'scopes' => ['example_scope_1', 'example_scope_2'],

更改任何值以更改URL。

其他配置可以更改为新默认值，但我们建议使用 .env 文件

KEYCLOAK_BASE_URL

Keycloak服务器的URL。通常如下所示： https://your-domain.com/auth。

KEYCLOAK_REALM

Keycloak域。默认为 master。

KEYCLOAK_REALM_PUBLIC_KEY

Keycloak服务器域的公钥（字符串）。

在仪表板中，转到：Keycloak >> 域设置 >> 密钥 >> RS256 >> 公钥。

KEYCLOAK_CLIENT_ID

Keycloak客户端ID。

在仪表板中，转到：Keycloak >> 客户端 >> 安装。

KEYCLOAK_CLIENT_SECRET

Keycloak客户端密钥。如果为空，我们不会将其发送到令牌端点。

在仪表板中，转到：Keycloak >> 客户端 >> 安装。

KEYCLOAK_CACHE_OPENID

我们可以缓存OpenId配置：这是我们要求Keycloak的端点列表。

如果您启用它，请记住在更改域或URL时清空缓存。

只需将您想要作为数组的选项添加到“to”中即可。例如，将选项添加到keycloak-web.php配置文件的guzzle_options数组中。

Laravel认证

您应将Keycloak Web guard添加到您的 config/auth.php。

只需将 keycloak-web 添加到您想要配置的配置的“driver”选项中。

由于我的默认是web，所以我添加到其中

'guards' => [
    'web' => [
        'driver' => 'keycloak-web',
        'provider' => 'users',
    ],

    // ...
],

并更改您的提供者配置

'providers' => [
    'users' => [
        'driver' => 'keycloak-users',
        'model' => Vizir\KeycloakWebGuard\Models\KeycloakUser::class,
    ],

    // ...
]

注意：如果您想使用其他用户模型，请查看FAQ 如何实现我的模型？。

API

我们实现了Illuminate\Contracts\Auth\Guard接口。因此，所有Laravel默认方法都将可用。

例如：Auth::user()返回已认证的用户。

角色

您可以通过Auth::hasRole('role')简单检查用户是否具有某个角色；

此方法接受两个参数：第一个是角色（字符串或字符串数组），第二个是资源。

如果没有提供，资源将默认为client_id，这是您验证到前端客户端的常规检查。

Keycloak Web网关

您可以使用Laravel授权网关来检查用户是否具有一个或多个角色（以及资源）。

例如，在您的控制器中，您可以检查一个角色

if (Gate::denies('keycloak-web', 'manage-account')) {
  return abort(403);
}

或多个角色

if (Gate::denies('keycloak-web', ['manage-account'])) {
  return abort(403);
}

以及资源的角色

if (Gate::denies('keycloak-web', 'manage-account', 'another-resource')) {
  return abort(403);
}

最后一种用法不简单，但您可以扩展Guard以请求多个资源的认证/授权。默认情况下，我们只请求当前客户端。

Keycloak Can中间件

如果您不想使用网关或已经实现了中间件，您可以使用keycloak-web-can中间件来检查用户是否具有一个或多个角色。

将此添加到您的控制器中的__construct方法

$this->middleware('keycloak-web-can:manage-something-cool');

// For multiple roles, separate with '|'
$this->middleware('keycloak-web-can:manage-something-cool|manage-something-nice|manage-my-application');

此中间件在默认资源（client_id）上搜索所有角色。

您可以扩展它，在Kernel.php中注册自己的中间件，或者只需在控制器中使用Auth::hasRole($roles, $resource)。

常见问题解答（FAQ）

如何实现我的模型？

我们在config/auth.php中注册了一个新的用户提供者，名为"keycloak-users"。

在相同的配置中，您设置了模型。因此，您可以注册自己的模型，通过扩展Vizir\KeycloakWebGuard\Models\KeycloakUser类并更改此配置来实现。

您可以实现自己的用户提供者：只需记住实现接收Keycloak Profile信息的retrieveByCredentials方法以检索模型实例。

Eloquent/数据库用户提供者应该可以很好地工作，因为它们将解析Keycloak Profile并在数据库中执行“where”操作。因此，您的用户数据必须与Keycloak Profile匹配。

我找不到我的登录表单。

我们注册了一个login路由，用于重定向到Keycloak服务器。登录后，我们将接收并处理令牌以认证用户。

没有登录/注册表单。

如何保护一个路由？

只需添加keycloak-web中间件

// On RouteServiceProvider.php for example

Route::prefix('admin')
  ->middleware('keycloak-web')
  ->namespace($this->namespace)
  ->group(base_path('routes/web.php'));

// Or with Route facade in another place

Route::group(['middleware' => 'keycloak-web'], function () {
    Route::get('/admin', 'Controller@admin');
});

访问/刷新令牌和状态在哪里持久化？

在会话中。如果您有负载均衡，我们建议实现数据库驱动程序。

什么是状态？

状态是一个唯一且难以猜测的字符串，用于减轻CSRF攻击。

我们将每个即将发起的认证请求与一个随机状态关联，并在回调时检查。如果您正在扩展/实现自己的Auth控制器，则应该这样做。

使用KeycloakWeb::saveState()方法将已生成的状态保存到会话中，并使用KeycloakWeb::validateState()方法检查当前状态与保存的状态是否一致。

我在会话（卡在登录循环中）有问题。

由于某种原因，Laravel可能会遇到EncryptCookies中间件更改会话ID的问题。

在这种情况下，我们将始终尝试登录，因为无法检索令牌。

您可以从加密中移除session_id cookie。

// On your EncryptCookies middleware

class EncryptCookies extends Middleware
{
    protected $except = [];

    public function __construct(EncrypterContract $encrypter)
    {
        parent::__construct($encrypter);

        /**
         * This will disable in runtime.
         *
         * If you have a "session.cookie" option or don't care about changing the app name
         * (in another environment, for example), you can only add it to "$except" array on top
         */
        $this->disableFor(config('session.cookie'));
    }
}

我的客户端不是公开的。

如果您的客户端不是公开的，您应该在.env中提供KEYCLOAK_CLIENT_SECRET。

如何覆盖默认的Guzzle选项？

在某些用例中，您可能需要覆盖默认的Guzzle选项——可能需要禁用SSL验证或设置代理以使所有请求通过该代理路由。

每个Guzzle请求选项都受支持，并且直接传递给Guzzle客户端实例。

只需在 keycloak-web.php 配置文件中将您想添加的选项添加到 guzzle_options 数组中。例如

'guzzle_options' => [
    'verify' => false
]

开发者

马里奥·瓦内尼 @mariovalney

与 GitHub 贡献者合作 ❤️

vizir / laravel-keycloak-web-guard

维护者

详细信息