greenkey / esia
使用 Cryptopro 签署者进行 OpenID ESIA 验证并访问组织数据
Requires
- php: ^7.4|^8.0
- ext-json: *
- guzzlehttp/guzzle: ^6.1.0|^7.3
- psr/http-client: ^1.0
- psr/http-message: ^1.0
- psr/log: ^1.0
Requires (Dev)
- codeception/codeception: ^4.0
- codeception/module-asserts: ^1.3
- roave/security-advisories: dev-latest
Suggests
- ext-openssl: SignerPKCS7 support
This package is auto-updated.
Last update: 2024-09-17 12:42:04 UTC
README
分支 cryptopro
描述
“国家服务”门户的授权组件。添加了使用 Crypto Pro 进行签名的机制,获取组织数据,更新 ESIA 令牌的机制(目前处于实验性测试阶段)。添加了获取机器可读授权书(MЧД)的数据,目前处于测试阶段。感谢 fr05t1k/esia
为了运行,需要安装 cryptcp 并配置私钥和证书。证书选择通过哈希(指纹)进行。
在安装和配置过程中描述了 cryptcp。用于签名的是 Crypto Pro(GOST)的机制。
注意!
获得令牌后,您可以执行任何 API 请求。库不支持 API 中所有现有的方法,而仅提供最基本的方法。库的主要目标是获取令牌。添加了获取用户所在的组织的数据的机制,以及使用 Crypto Pro 工具进行请求签名的功能。
安装
使用 composer
composer require --prefer-dist greenkey/esia
或者在 composer.json 中添加
"greenkey/esia" : "^2.0"
如何使用
获取授权链接的示例
<?php $config = new \Esia\Config([ 'clientId' => 'INSP03211', 'redirectUrl' => 'http://my-site.com/response.php', 'portalUrl' => 'https://esia-portal1.test.gosuslugi.ru/', 'scope' => ['fullname', 'birthdate'], ]); $esia = new \Esia\OpenId($config); $esia->setSigner(new \Esia\Signer\SignerPKCS7( 'my-site.com.pem', 'my-site.com.pem', 'password', '/tmp' )); ?> <a href="<?=$esia->buildUrl()?>">Войти через портал госуслуги</a>
重定向到您的 redirectUrl
后,您将在 $_GET['code']
中获得获取令牌的代码
获取令牌和用户信息的示例
$esia = new \Esia\OpenId($config); // Вы можете использовать токен в дальнейшем вместе с oid $token = $esia->getToken($_GET['code']); $personInfo = $esia->getPersonInfo(); $addressInfo = $esia->getAddressInfo(); $contactInfo = $esia->getContactInfo(); $documentInfo = $esia->getDocInfo();
配置
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?
有两种方法
- oid 包含在 jwt 令牌中,通过解密它来获取
- 获取令牌后,oid 被保存在 config 中,可以按以下方式获取
$esia->getConfig()->getOid();
令牌的重用
在配置中额外指定令牌、刷新和标识符
$config->setToken($jwt); $config->setOid($oid); $config->setRefresh($refresh);