ateam-group / laravel-sso
为 Laravel 简单的 PHP SSO 集成
Requires
- php: >=7.1.3
- guzzlehttp/guzzle: ^6.3
- laravel/framework: ^5.5
- zefy/php-simple-sso: ^1.0
README
此包是从 https://github.com/zefy/laravel-sso 分支而来,进行了一些修改。
此包基于 Simple PHP SSO 骨架 包,并使其适合 Laravel 框架。
需求
- Laravel 5.5+
- PHP 7.1+
单词含义
- SSO - 单点登录。
- 服务器 - 作为 SSO 服务器工作,处理认证,存储所有会话数据。
- 代理 - 您的页面,由客户端/用户访问。
- 客户端/用户 - 您的每一位访问者。
它如何工作?
客户端访问代理,生成一个唯一的令牌。当生成新的令牌时,我们需要将客户端会话附加到代理的会话中,这样他就会被重定向到服务器,然后回到代理。此时,服务器将创建一个新的会话并与其在代理页面中的客户端会话相关联。当客户端访问其他代理时,将执行相同的步骤,除了当客户端被重定向到服务器时,他已使用他的旧会话和与代理#1相关联的相同会话 ID。
安装
服务器
使用 composer 安装此包。
$ composer require ateam-group/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 中间件并添加 sessions 中间件来编辑。这是必要的,因为我们需要在 API 路由中使用会话,而 throttle 中间件可能会阻止我们需要的连接。
'api' => [ 'bindings', \Illuminate\Session\Middleware\StartSession::class, ],
现在您应该创建代理。您可以使用以下 Artisan CLI 命令创建新的代理
$ php artisan sso:broker:create {name}
代理
使用 composer 安装此包。
$ composer require ateam-group/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_SERVER_URL_PUBLIC= SSO_BROKER_NAME= SSO_BROKER_SECRET=
SSO_SERVER_URL 是不带尾随斜杠的服务器 http URL。《code>SSO_BROKER_NAME 和 SSO_BROKER_SECRET 必须是您的服务器 brokers 表中存在的数据。
通过将 \Zefy\LaravelSSO\Middleware\SSOAutoLogin::class 中间件添加到 web 中间件组来编辑您的 app/Http/Kernel.php 文件。它应该看起来像这样
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_URL_PUBLIC=https://server.com SSO_BROKER_NAME=site1 SSO_BROKER_SECRET=892asjdajsdksja74jh38kljk2929023