README

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

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

要求

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

支持

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

Laravel: 5.8 / 7 / 8 / 9
Keycloak: 4.8.3.Final / 11.0.2 / 15

任何其他版本不能保证工作。

这是一个开源项目，我在业余时间维护。所以，如果您有任何问题，您可以创建一个包含所有详细信息（Laravel版本、Keycloak版本、问题的描述等）的Issue，我会很高兴尝试帮助。

流程

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

安装

需要该包

composer require lghs/laravel-keycloak-guard

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

php artisan vendor:publish  --provider="Lghs\KeycloakGuard\KeycloakServiceProvider"

配置

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

'redirect_url' => '/admin',

'redirect_guest' => 'hello',

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

更改任何值以更改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时清除缓存。

只需将您希望作为数组添加到"guzzle_options"数组中的选项添加到"keycloak.php"配置文件中。例如

Laravel认证

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

只需将keycloak添加到您想要的配置的"driver"选项中。

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

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

    // ...
],

并更改您的提供者配置

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

    // ...
]

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

API

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

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

角色

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

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

如果没有提供，资源将是客户端ID，这通常是在您认证到前端客户端时进行的常规检查。

Keycloak Web 网关

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

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

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

或 多个角色

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

以及 资源的角色

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

最后一种用法并不简单，但您可以通过扩展守卫来请求对多个资源的身份验证/授权。默认情况下，我们只请求当前客户端。

Keycloak 中间件

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

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

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

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

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

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

常见问题解答

如何实现我的模型？

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

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

您可以实现自己的用户提供程序：只需记住实现 retrieveByCredentials 方法，该方法接收 Keycloak 个人资料信息以检索模型实例。

Eloquent/数据库用户提供程序应该运行良好，因为它们将解析 Keycloak 个人资料并在数据库中创建 "where" 条件。因此，您的用户数据必须与 Keycloak 个人资料相匹配。

我找不到我的登录表单。

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

没有登录/注册表单。

如何保护路由？

只需添加 keycloak 中间件

// On RouteServiceProvider.php for example

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

// Or with Route facade in another place

Route::group(['middleware' => 'keycloak'], 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 请求选项](http://docs.guzzlephp.org/en/stable/request-options.html) 都受支持，并直接传递给 Guzzle 客户端实例。

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

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

开发者

Duman Haydar @dumanhaydar
Mário Valney @mariovalney
Vizir Software Studio

GitHub 上的贡献者 ❤️

lghs / laravel-keycloak-guard

维护者

详细信息