fr05t1k / esia
OpenID ESIA 验证
2.4.2
2022-02-10 16:23 UTC
Requires
- php: ^7.1|^8.0
- guzzlehttp/guzzle: ^6.1.0|^7.0
- 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-19 23:03:29 UTC
README
描述
组件用于在“国家服务”门户上进行认证。
注意!
获取令牌后,您可以执行任何API请求。该库不支持所有现有的API方法,而仅提供最基本的方法。该库的主要目标是获取令牌。
安装
使用composer
composer require --prefer-dist fr05t1k/esia
或者在composer.json中添加
"fr05t1k/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);