README

Laravel Keycloak 守卫

此包是 https://github.com/robsontenorio/laravel-keycloak-guard 的分支。

此包帮助您在基于 Keycloak 服务器生成的 JWT 令牌的基础上对 Laravel API 进行用户身份验证。

要求

✔️ 我正在使用 Laravel 构建一个 API。

✔️ 我不会使用 Laravel Passport 进行身份验证，因为 Keycloak 服务器会完成这项工作。

✔️ 前端是一个独立的项目。

✔️ 前端用户将直接在 Keycloak 服务器上认证以获取 JWT 令牌。这个过程与 Laravel API 没有关系。

✔️ 前端保留从 Keycloak 服务器获取的 JWT 令牌。

✔️ 前端使用该令牌向 Laravel API 发送请求。

💔 如果您的应用不符合这些要求，您可能需要查找 https://socialiteproviders.com/Keycloak 或 https://github.com/Vizir/laravel-keycloak-web-guard。

流程

前端用户在 Keycloak 服务器上认证
前端用户获得 JWT 令牌。
在另一个时刻，前端用户使用该令牌向 Laravel API 的受保护端点发送请求。
Laravel API（通过 Keycloak 守卫）处理它。
- 验证令牌签名。
- 验证令牌结构。
- 验证令牌过期时间。
- 验证我的 API 是否允许令牌进行 资源访问。
如果一切正常，那么在数据库中查找用户并在我 API 上进行认证。
可选地，用户可以在 API 的用户数据库中创建/更新。
返回响应

安装

Laravel / Lumen

需要此包

composer require robsontenorio/laravel-keycloak-guard

仅 Lumen

在您的 bootstrap 应用文件 bootstrap/app.php 中注册提供者

在文件的 "注册服务提供者" 部分的底部添加以下行。

$app->register(\KeycloakGuard\KeycloakGuardServiceProvider::class);

对于外观，在您的 bootstrap 应用文件 bootstrap/app.php 中取消注释 $app->withFacades();

配置

Keycloak 守卫

⚠️ 当编辑 .env 时，请确保所有字符串都 已修剪。

# Publish config file

php artisan vendor:publish  --provider="KeycloakGuard\KeycloakGuardServiceProvider"

✔️ realm_public_key

必需。

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

如何获取领域公钥？点击 "领域设置" > "密钥" > "算法 RS256（或定义在 token_encryption_algorithm 配置下）" 行 > "公钥" 按钮

✔️ token_encryption_algorithm

默认为 RS256。

Keycloak 使用的 JWT 令牌加密算法（字符串）。

✔️ load_user_from_database

必需。默认为 true。

如果您没有 users 表，则必须禁用此功能。

它从数据库中获取用户并将值填充到已认证的用户对象中。如果启用，它将与 user_provider_credential 和 token_principal_attribute 一起工作。

✔️ user_provider_custom_retrieve_method

默认为 null。

如果您有一个 users 表，并希望根据令牌对其进行更新（创建或更新用户），您可以在自定义的 UserProvider 上调用一个自定义方法，而不是调用 retrieveByCredentials，该方法将接收完整的解码令牌作为参数，而不仅仅是凭据（默认行为）。这将允许您自定义与数据库交互的方式，在匹配和交付经过验证的用户对象之前，所有包含在（有效的）访问令牌中的信息都将可用。有关自定义 UserProvider 的更多信息，请参阅Laravel 的文档。

显然，如果使用此功能，将忽略为 user_provider_credential 和 token_principal_attribute 定义的值。

✔️ user_provider_credential

必需。默认为 username。

包含用户唯一标识符的字段（例如，用户名、电子邮件、昵称）。在认证时，此字段将与 token_principal_attribute 属性进行对比。

✔️ token_principal_attribute

必需。默认为 preferred_username。

包含用户标识符的 JWT 令牌属性。在认证时，此属性将与 user_provider_credential 属性进行对比。

✔️ append_decoded_token

默认为 false。

将完整的解码 JWT 令牌附加到经过验证的用户（$user->token）。如果您需要了解 JWT 令牌中包含的角色、组和其他用户信息，则非常有用。即使选择 false，您也可以使用 Auth::token() 获取它，请参阅 API 部分。

✔️ allowed_resources

必需.

通常，您的 API 应该处理一个 resource_access。但如果您处理多个，请使用逗号分隔的列表，列出 API 接受的允许的资源。此属性将在认证时与 JWT 令牌中的 resource_access 属性进行对比。

✔️ ignore_resources_validation

默认为 false。.

完全禁用资源验证。它将忽略 allowed_resources 配置。

✔️ leeway

默认为 0。.

您可以为在签名服务器和验证服务器之间存在时钟偏差的时间添加容差。如果您遇到类似 "Cannot handle token prior to " 的问题，请尝试将其设置为 60（秒）。

✔️ input_key

默认为 null。

默认情况下，此包始终会首先查找 Bearer 令牌。此外，如果启用此选项，则它将尝试从自定义请求参数中获取令牌。

// keycloak.php
'input_key' => 'api_token'

// If there is no Bearer token on request it will use `api_token` request param
GET  $this->get("/foo/secret?api_token=xxxxx")
POST $this->post("/foo/secret", ["api_token" => "xxxxx"])

Laravel Auth

在 config/auth.php 中进行更改

...
'defaults' => [
        'guard' => 'api', # <-- For sure, i`m building an API
        'passwords' => 'users',
    ],

    ....

    'guards' => [
        # <!-----
        #     Make sure your "api" guard looks like this.
        #     Newer Laravel versions just removed this config block.
        #  ---->
        'api' => [
            'driver' => 'keycloak',
            'provider' => 'users',
        ],
    ],

Laravel 路由

只需在 routes/api.php 中保护一些端点即可完成！

// public endpoints
Route::get('/hello', function () {
    return ':)';
});

// protected endpoints
Route::group(['middleware' => 'auth:api'], function () {
    Route::get('/protected-endpoint', 'SecretController@index');
    // more endpoints ...
});

Lumen 路由

只需在 routes/web.php 中保护一些端点即可完成！

// public endpoints
$router->get('/hello', function () {
    return ':)';
});

// protected endpoints
$router->group(['middleware' => 'auth'], function () {
    $router->get('/protected-endpoint', 'SecretController@index');
    // more endpoints ...
});

API

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

默认 Laravel 方法

check()
guest()
user()
id()
validate()
setUser()

Keycloak Guard 方法

令牌

token() 从经过验证的用户返回完整的解码 JWT 令牌。

$token = Auth::token()  // or Auth::user()->token()

角色

hasResourceRole('some-resource', 'some-role') 检查经过验证的用户是否在 resource_access 上具有角色。

// Example decoded payload

'resource_access' => [
  'myapp-backend' => [
      'roles' => [
        'myapp-backend-role1',
        'myapp-backend-role2'
      ]
  ],
  'myapp-frontend' => [
    'roles' => [
      'myapp-frontend-role1',
      'myapp-frontend-role2'
    ]
  ]
]

Auth::hasResourceRole('myapp-backend', 'myapp-backend-role1') // true
Auth::hasResourceRole('myapp-frontend', 'myapp-frontend-role1') // true
Auth::hasResourceRole('myapp-backend', 'myapp-frontend-role1') // false

hasAnyResourceRole('some-resource', ['some-role1', 'some-role2']) 检查经过验证的用户是否在 resource_access 上具有任何角色。

Auth::hasAnyResourceRole('myapp-backend', ['myapp-backend-role1', 'myapp-backend-role3']) // true
Auth::hasAnyResourceRole('myapp-frontend', ['myapp-frontend-role1', 'myapp-frontend-role3']) // true
Auth::hasAnyResourceRole('myapp-backend', ['myapp-frontend-role1', 'myapp-frontend-role2']) // false

hasRealmRole('some-role') 检查经过验证的用户是否在 resource_access 上具有角色。

Auth::hasRealmRole('myapp-backend-role1') // true
Auth::hasRealmRole('myapp-frontend-role1') // true

hasAnyRealmRole(['some-role1', 'some-role2']) 检查经过验证的用户是否在 resource_access 上具有任何角色。

Auth::hasAnyRealmRole(['myapp-backend-role1', 'myapp-backend-role3']) // true
Auth::hasAnyRealmRole(['myapp-frontend-role1', 'myapp-frontend-role2']) // false

作用域

示例解码有效负载

{
    "scope": "scope-a scope-b scope-c",
}

scopes() 获取所有用户作用域。

array:3 [
  0 => "scope-a"
  1 => "scope-b"
  2 => "scope-c"
]

hasScope('some-scope') 检查经过验证的用户是否具有作用域。

Auth::hasScope('scope-a') // true
Auth::hasScope('scope-d') // false

hasAnyScope(['scope-a', 'scope-c']) 检查经过验证的用户是否具有任何作用域。

Auth::hasAnyScope(['scope-a', 'scope-c']) // true
Auth::hasAnyScope(['scope-a', 'scope-d']) // true
Auth::hasAnyScope(['scope-f', 'scope-k']) // false

在测试中作为 Keycloak 用户操作

类似于Laravel中的$this->actingAs($user)功能，使用此包，您可以在测试类中使用KeycloakGuard\ActingAsKeycloakUser特性，然后使用actingAsKeycloakUser()方法来模拟用户，并某种程度上跳过Keycloak认证。

use KeycloakGuard\ActingAsKeycloakUser;

public test_a_protected_route()
{
    $this->actingAsKeycloakUser()
        ->getJson('/api/somewhere')
        ->assertOk();
}

如果您没有使用keycloak.load_user_from_database选项，请为测试设置keycloak.preferred_username，并使用有效的preferred_username。

您还可以通过传递负载数组作为第二个参数来指定对令牌负载的确切期望。

use KeycloakGuard\ActingAsKeycloakUser;

public test_a_protected_route()
{
    $this->actingAsKeycloakUser($user, [
        'aud' => 'account',
        'exp' => 1715926026,
        'iss' => 'https://:8443/realms/master'
    ])->getJson('/api/somewhere')
      ->assertOk();
}

$user参数接收一个字符串标识符或Eloquent模型，其标识符预期为user_provider_credential配置中引用的属性。您在负载中传递的内容将覆盖默认声明，包括aud、iat、exp、iss、azp、resource_access以及sub或preferred_username，具体取决于token_principal_attribute配置。

另外，负载也可以作为类属性提供，这样就可以在多个测试中重复使用。

use KeycloakGuard\ActingAsKeycloakUser;

protected $tokenPayload = [
    'aud' => 'account',
    'exp' => 1715926026,
    'iss' => 'https://:8443/realms/master'
];

public test_a_protected_route()
{
    $payload = [
        'exp' => 1715914352
    ];
    $this->actingAsKeycloakUser($user, $payload)
        ->getJson('/api/somewhere')
        ->assertOk();
}

优先级赋予给作为参数传递的声明，因此它们将覆盖类属性中的声明。$user参数具有比token_principal_attribute配置中引用的声明更高的优先级。

贡献

您可以使用远程容器在VSCODE上运行此项目。确保您将使用内部VSCODE终端（在运行的容器内）。

composer install
composer test
composer test:coverage

联系

Twitter @robsontenorio

tecnical / laravel-keycloak-guard

维护者

详细信息