danielalbiol/laravel-sso

Laravel的简单PHP单点登录集成

1.0 2021-02-04 15:38 UTC

This package is auto-updated.

Last update: 2024-09-04 23:59:58 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License Scrutinizer Code Quality Build Status Code Intelligence Status

本包基于Simple PHP SSO骨架包,并适合Laravel框架。

要求

  • Laravel 5.5+
  • PHP 7.1+

词汇含义

  • SSO - 单点登录。
  • 服务器 - 作为SSO服务器工作的页面,处理认证,存储所有会话数据。
  • 代理 - 被客户端/用户访问的您的页面。
  • 客户端/用户 - 您的每一位访客。

它是如何工作的?

客户端访问代理,生成唯一令牌。当生成新令牌时,我们需要将客户端会话附加到代理中的会话,以便将其重定向到服务器,然后返回代理。此时,服务器中将创建新的会话,并与代理页面的客户端会话关联。当客户端访问其他代理时,将执行相同的步骤,除了当客户端被重定向到服务器时,他已使用其旧会话和与代理#1关联的相同会话ID。

安装

服务器

使用Composer安装此包。

$ composer require zefy/laravel-sso

将配置文件复制到Laravel项目的config/文件夹。

$ php artisan vendor:publish --provider="Zefy\LaravelSSO\SSOServiceProvider"

创建一个表,其中将保存所有代理。

$ php artisan migrate --path=vendor/zefy/laravel-sso/database/migrations

编辑您的app/Http/Kernel.php,通过从api中间件数组中删除throttle中间件并添加session中间件来编辑。这是必要的,因为我们需要在API路由中使用会话,而throttle中间件可能会阻止所需的连接。

'api' => [
    'bindings',
    \Illuminate\Session\Middleware\StartSession::class,
],

现在您应该创建代理。您可以使用以下Artisan CLI命令创建新的代理

$ php artisan sso:broker:create {name}

代理

使用Composer安装此包。

$ composer require zefy/laravel-sso

将配置文件复制到Laravel项目的config/文件夹。

$ php artisan vendor:publish --provider="Zefy\LaravelSSO\SSOServiceProvider"

config/laravel-sso.php文件中的type值从server更改为broker

在您的.env文件中设置3个新选项

SSO_SERVER_URL=
SSO_BROKER_NAME=
SSO_BROKER_SECRET=

SSO_SERVER_URL是您的服务器的http URL,不带尾随斜杠。SSO_BROKER_NAMESSO_BROKER_SECRET必须是存在于服务器brokers表中的数据。

编辑您的app/Http/Kernel.php,将\Zefy\LaravelSSO\Middleware\SSOAutoLogin::class中间件添加到web中间件组。它应该看起来像这样

protected $middlewareGroups = [
        'web' => [
            ...
            \Zefy\LaravelSSO\Middleware\SSOAutoLogin::class,
        ],

        'api' => [
            ...
        ],
    ];

最后但同样重要的是,您需要编辑app/Http/Controllers/Auth/LoginController.php。您应该在LoginController类中添加两个函数,这些函数将通过SSO服务器而不是您的代理页面来验证您的客户端。

protected function attemptLogin(Request $request)
{
    $broker = new \Zefy\LaravelSSO\LaravelSSOBroker;
    
    $credentials = $this->credentials($request);
    return $broker->login($credentials[$this->username()], $credentials['password']);
}

public function logout(Request $request)
{
    $broker = new \Zefy\LaravelSSO\LaravelSSOBroker;
    
    $broker->logout();
    
    $this->guard()->logout();
    
    $request->session()->invalidate();
    
    return redirect('/');
}

这就完成了。对于其他代理页面,您应该从开始重复所有内容,只需更改配置文件中的代理名称和密钥。

示例.env选项

SSO_SERVER_URL=https://server.test
SSO_BROKER_NAME=site1
SSO_BROKER_SECRET=892asjdajsdksja74jh38kljk2929023