Jasny SSO for PHP 技术文档

1. 安装指南

使用 Composer 安装

要安装 Jasny SSO for PHP，请在终端中运行以下命令：

composer require jasny/sso

运行演示

Jasny SSO 提供了一个演示服务器和两个演示代理（一个使用普通重定向，另一个使用 JSONP/AJAX）。为了验证其工作原理，建议设置服务器和多个代理，每个代理位于不同的机器和子域上。不过，您也可以在本地机器上运行服务器和代理进行测试。

在 *nix 系统（Linux/Unix/OSX）上运行以下命令：

php -S localhost:8000 -t demo/server/
export SSO_SERVER=http://localhost:8000/attach.php SSO_BROKER_ID=Alice SSO_BROKER_SECRET=8iwzik1bwd; php -S localhost:8001 -t demo/broker/
export SSO_SERVER=http://localhost:8000/attach.php SSO_BROKER_ID=Greg SSO_BROKER_SECRET=7pypoox2pc; php -S localhost:8002 -t demo/broker/
export SSO_SERVER=http://localhost:8000/attach.php SSO_BROKER_ID=Julius SSO_BROKER_SECRET=ceda63kmhp; php -S localhost:8003 -t demo/ajax-broker/

然后打开多个标签页并访问以下地址：

• http://localhost:8001
• http://localhost:8002
• http://localhost:8003

用户名和密码如下：

用户名	密码
jackie	jackie123
john	john123

注意：登录后，您需要在其他代理上刷新页面以查看效果。

2. 项目使用说明

服务器端

初始化服务器

服务器类 Server 的构造函数接受两个参数：

1. 一个回调函数，用于根据代理 ID 查找代理的密钥。
2. 一个 PSR-16 兼容的缓存对象，用于存储代理令牌和客户端会话之间的链接。

示例代码：

use Jasny\SSO\Server\Server;

$brokers = [
    'foo' => ['secret' => '8OyRi6Ix1x', 'domains' => ['example.com']],
    // ...
];

$server = new Server(
    fn($id) => $brokers[$id] ?? null, // 每个代理的唯一密钥和允许的域名
    new Cache()                       // 任何 PSR-16 兼容的缓存
);

附加会话

客户端需要通过 HTTP 请求将代理令牌附加到会话 ID。可以通过调用 attach() 方法来处理此请求。

$verificationCode = $server->attach();

如果无法附加（例如校验和不正确），将抛出异常。

处理代理 API 请求

在客户端会话附加到代理令牌后，代理可以代表客户端发送 API 请求。调用 startBrokerSession() 方法将基于承载令牌启动客户端会话。

$server->startBrokerSession();

代理端

初始化代理

创建 Broker 实例时，需要传递服务器 URL、代理 ID 和代理密钥。代理 ID 和密钥必须与服务器上注册的密钥匹配。

use Jasny\SSO\Broker\Broker;

$broker = new Broker(
    getenv('SSO_SERVER'),
    getenv('SSO_BROKER_ID'),
    getenv('SSO_BROKER_SECRET')
);

附加会话

在代理可以代表客户端发送 API 请求之前，客户端需要将代理令牌附加到客户端会话。可以通过 getAttachUrl() 方法生成附加 URL。

if (!$broker->isAttached()) {
    $returnUrl = (!empty($_SERVER['HTTPS']) ? 'https://' : 'http://') . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'];
    $attachUrl = $broker->getAttachUrl(['return_url' => $returnUrl]);

    header("Location: $attachUrl", true, 303);
    echo "You're redirected to <a href='$attachUrl'>$attachUrl</a>";
    exit();
}

验证

在验证过程中，SSO 服务器将返回一个验证码（作为查询参数或在 JSON 响应中）。该代码用于计算校验和。

if (isset($_GET['sso_verify'])) {
    $broker->verify($_GET['sso_verify']);
}

API 请求

附加后，代理可以代表客户端发送 API 请求。可以通过 request() 方法或使用 Guzzle 等 HTTP 客户端来实现。

$user = $broker->request('GET', '/user');

3. 项目 API 使用文档

服务器端 API

attach()

处理客户端的附加请求，返回验证码。

startBrokerSession()

启动基于承载令牌的客户端会话。

代理端 API

getAttachUrl()

生成用于附加会话的 URL。

verify()

验证从服务器返回的验证码。

request()

发送 API 请求，使用承载令牌进行身份验证。

4. 项目安装方式

通过 Composer 安装：

composer require jasny/sso

安装后，您可以按照上述使用说明配置和运行服务器和代理。