README

从 zefy\laravelsso 分支而来

本包基于 Simple PHP SSO skeleton 包，并已适配Laravel框架。

需求

• Laravel 8+
• PHP 8.1+

词汇解释

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

它是如何工作的？

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

安装

服务器

使用Composer安装此包。

$ composer require eurechasherij/laravel-sso

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

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

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

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

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

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

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

$ php artisan sso:broker:create {name}

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

SSO_SERVER_TYPE=
SSO_USERNAME_COLUMN=

提示：服务器必须以生产模式运行，才能允许使用正确的密码登录（在另一种模式下，您可以使用任何密码登录）

代理

使用Composer安装此包。

$ composer require eurechasherij/laravel-sso

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

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

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

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

SSO_SERVER_URL=
SSO_SERVER_TYPE=
SSO_BROKER_NAME=
SSO_BROKER_SECRET=

SSO_SERVER_URL 是不带尾随斜杠的服务器HTTP URL。 SSO_BROKER_NAME 和 SSO_BROKER_SECRET 必须是您服务器 brokers 表中存在的数据。

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

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_SERVER_TYPE=broker
SSO_USERNAME_COLUMN=username
SSO_BROKER_NAME=site1
SSO_BROKER_SECRET=892asjdajsdksja74jh38kljk2929023