greenkey/esia

OpenID ESIA authenticating using Cryptopro signer and access to org data

3.1.3 2024-07-17 12:20 UTC

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

MIT

• OpenId
• esia
• egov

README

Fork cryptopro

Описание

Компонент для авторизации на портале "Госуслуги". Добавлен механизм подписания с помощью Crypto Pro, получение данных организации, механизм обновления токенов ЕСИА (пока экспериментально, тестируется) Добавлено получение данных об МЧД (машиночитаемая доверенность) пока в стадии тестов Спасибо fr05t1k/esia

Для работы необходимо установить cryptcp и сконфигурировать закрытый (секретный) ключ и сертфикат Выбор сертификата происходит по отпечатку (хэшу)

Описание установки и настройки cryptcp в процессе. Для формирования подписи используются механизмы Крипто Про (ГОСТ)

Внимание!

Получив токен вы можете выполнять любые 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

Токен - jwt токен которые вы получаете от ЕСИА для дальнейшего взаимодействия

oid - уникальный идентификатор владельца токена

Как получить oid?

Если 2 способа:

1. oid содержится в jwt токене, расшифровав его
2. После получения токена oid сохраняется в config и получить можно так

$esia->getConfig()->getOid();

Переиспользование Токена

Дополнительно укажите токен, рефреш и идентификатор в конфиге

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