sbwerewolf/esia-connector

OpenID ESIA 认证

v1.0.2 2023-08-11 09:19 UTC

This package is auto-updated.

Last update: 2024-09-26 00:29:51 UTC


README

描述

这是一个用于在“国家服务”门户进行授权和数据获取的组件。

该库基于 fr05t1k/esia,通过HTTP请求添加了订阅者。

因此,对于此订阅者,签名任意文本不需要私有密钥(签名在Web服务上完成),因此配置对象不需要私有密钥和证书的路径。

作为外部订阅者,可以使用 CryptoPro

注意!

该库的主要目标是获取令牌。获取令牌后,您可以执行任何API请求。该库仅提供获取数据的最低限度的请求。

安装

使用 composer

composer require sbwerewolf/esia-connector

使用示例

test.php 中的使用示例

预先

  • 部署 CryptoPro 网络签名服务
  • 相应地启动,默认情况下,以便在地址 https://:3037/cryptopro/sign 处处理对任意文本签名的POST请求,调用签名的方式为 {"text": "$message"}(使用JSON格式)

如何启动

  • cd ./example/
  • php -S localhost:8000 test.php
  • 在浏览器中打开 localhost:8000
  • 点击 通过国家服务门户登录
  • 在国家服务门户上执行认证
  • 授权您的组织访问用户(国家服务)数据
  • 将重定向到 localhost:8000
  • 页面上将显示从国家服务获取的数据

如何使用

获取授权链接的示例

<?php 
$config = new \Esia\ConfigWithoutKeyPair([
    'clientId' => 'U407501', /* Код вашей организации в ЕСИА */
    'redirectUrl' => 'https://:8000/',
    'portalUrl' => 'https://esia-portal1.test.gosuslugi.ru/',
    'scope' => [
        'fullname', /* Просмотр вашей фамилии, имени и отчества */
    ],
]);

$signer = new HttpSigner(
    'https://:3037/cryptopro/sign',
    [
        'Content-Type' => 'application/json',
        'accept' => '*/*',
    ],
    'POST',
);

$esia = new \Esia\OpenIdWithoutSigner($config, null, $signer);

<a href="<?=$esia->buildUrl()?>">Войти через портал госуслуги</a>

在重定向到您的 redirectUrl 后,您将在 $_GET['code'] 中获得用于获取令牌的代码

获取令牌和用户信息的示例

$esia = new \Esia\OpenIdWithoutSigner($config);

// Вы можете использовать токен в дальнейшем вместе с oid 
$token = $esia->getToken($_GET['code']);

$personInfo = $esia->getPersonInfo();

配置

clientId - 您应用程序的ID。

redirectUrl - 包含代码的响应将被重定向到的URL。

portalUrl - 默认值:https://esia-portal1.test.gosuslugi.ru/。用于授权的门户域(仅域名)。

codeUrlPath - 默认值:aas/oauth2/ac。获取代码的URL。

tokenUrlPath - 默认值:aas/oauth2/te。获取令牌的URL。

scope - 默认值:fullname birthdate gender email mobile id_doc snils inn。请求给用户的权限。

privateKeyPath - 私有密钥的路径。

privateKeyPassword - 私有密钥的密码。

certPath - 证书的路径。

tmpPath - 进行签名操作的目录的路径(必须可写)。

令牌和oid

令牌 - 从ESIA获取的jwt令牌,用于后续交互。

oid - 令牌所有者的唯一标识符。

如何获取oid?

有两种方法

  1. oid包含在jwt令牌中,通过解密它获取
  2. 在获取令牌后,oid保存在config中,可以通过以下方式获取
$esia->getConfig()->getOid();

重用令牌

在配置中额外指定令牌和标识符

$config->setToken($jwt);
$config->setOid($oid);