README

Cometa Keycloak

一个简单的用于在SSO keycloak中进行“认证/授权”的库，使用openid-connect协议。

授权仅适用于基于作用域或基于资源的权限，欲了解更多，请访问Keycloak授权服务

LARAVEL安装

• 使用composer安装：composer require grupo-cometa/keycloak

• 发布配置文件：在终端中运行以下代码php artisan vendor:publish --tag=config，这将在config/中创建配置文件。如果这没有按预期执行，则需要手动执行此操作。只需将_vendor/cometa-keycloack/config/keyCloack.php复制到config/中。

• 注册中间件：在app/Http/Kenel.php中向$routeMiddleware数组添加两个项

   $routerMiddleware = [
       'auth' => GrupoCometa\Keycloak\Middlewares\Authenticate::class,
       'permission' => GrupoCometa\Keycloak\Middlewares\Authorization::class
       ...
   ];

• 配置config/auth.php：更改guards键

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

LUMEN安装

• 使用composer安装：composer require grupo-cometa/keycloak
• 发布配置
  • 将vendor/grupo-cometa/keycloak/config/keycloak.php复制到config/。
  • 复制vendor/grupo-cometa/keycloak/config/auth.php到config/。如果auth文件已经存在，则根据需要合并信息，以下结构和键应保持如下形式。

// config/auth.php
    [
        'defaults' => [
            'guard' => 'api',
            'passwords' => 'users',
        ],

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

        'providers' => [
            'users' => [
                'driver' => 'eloquent',
                'model' => User::class
            ]
        ]
    ];

• 注册环境变量
  • realm_public_key
  • signature_algorithm

• 更改用户模型

  • 在bootstrap/app.php中取消这些行的注释

  // $app->withFacades();
  
  // $app->withEloquent();
  

  • 将vendor/grupo-cometa/keycloak/config/User.php复制到app/Models/User.php。

• 注册认证控制器

  • 将vendor/grupo-cometa/keycloak/config/AuthController.php复制到app/Http/Controllers/AuthController.php。

• 注册用户注册路由

$router->post('/', [
    'uses' => 'AuthController@store'
]);

• 注册提供者：在bootstrap/app.php中添加行

$app->register(GrupoCometa\Keycloak\Providers\KeycloakServiceProvider::class);

• 注册中间件authorization和authentication：在bootstrap/app.php中添加行

$app->routeMiddleware([
   'auth' => GrupoCometa\Keycloak\Middlewares\Authenticate::class,
   'permission' => GrupoCometa\Keycloak\Middlewares\Authorization::class
]);

使用

如果您正确地遵循了所有步骤，只需在您的路由中调用中间件即可。中间件permission接受一个参数route#scoped，要了解更多关于使用keycloak进行访问控制的信息，请访问Keycloak

$router->get('/keycloak', [
    'uses' => "KeycloakController@index",
    'middleware' => ['auth', 'permission:users#list-all']
]);

示例

• 捕获已认证的用户

    /**
     * @return \Illuminate\Contracts\Auth\Authenticatable|null
     **/
    Illuminate\Support\Facades\Auth::user();

• 检查登录用户是否具有角色

    /**
     * @param  array<App\Model\Role>| Role
     * @return bool
     **/
     Illuminate\Support\Facades\Auth::hasRoles(Role::admin);
     ## OR
     Illuminate\Support\Facades\Auth::hasRoles([Role::admin, Role::gestor]);

• 返回登录用户的全部权限

    /**
     * @return array
     **/
    Illuminate\Support\Facades\Auth::allPermission();

• 返回全部角色

    /**
     * @return array
     **/
    Illuminate\Support\Facades\Auth::getRoles();

• 返回token中的属性

    /**
     * @param string
     * @return mixed
     **/
    Illuminate\Support\Facades\Auth::getAttribute("name");