Исправления и улучшения (#3)

* Переименовал класс с константами CADESCOM_ENCODE в CADESCOM_ENCODING_TYPE

* Добавил класс с константами CAPICOM_STORE_OPEN_MODE

* Добавил метод получения информации о криптопровайдере и плагине

* Добавил метод проверки соответствия установленных версий криптопровайдера и плагина

* Исправил используемые в классе константы
This commit is contained in:
Artem Vasilev 2022-11-15 12:52:55 +03:00 committed by GitHub
parent 612031c8dc
commit bdd545acf0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 144 additions and 21 deletions

14
composer.lock generated
View File

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically" "This file is @generated automatically"
], ],
"content-hash": "f3e18e3b232f3c425afb730e38714eea", "content-hash": "41cee9532212142277f16725a26986f3",
"packages": [], "packages": [],
"packages-dev": [ "packages-dev": [
{ {
@ -68,16 +68,16 @@
}, },
{ {
"name": "webmasterskaya/crypto-pro-php-stubs", "name": "webmasterskaya/crypto-pro-php-stubs",
"version": "1.0.3", "version": "1.0.4",
"source": { "source": {
"type": "git", "type": "git",
"url": "https://github.com/webmasterskaya/crypto-pro-php-stubs.git", "url": "https://github.com/webmasterskaya/crypto-pro-php-stubs.git",
"reference": "72a6e1160ab96c12888333d89e35059233cb9eb0" "reference": "0bf897d4a4d9b092999aa310e8ab2b8d26acd530"
}, },
"dist": { "dist": {
"type": "zip", "type": "zip",
"url": "https://api.github.com/repos/webmasterskaya/crypto-pro-php-stubs/zipball/72a6e1160ab96c12888333d89e35059233cb9eb0", "url": "https://api.github.com/repos/webmasterskaya/crypto-pro-php-stubs/zipball/0bf897d4a4d9b092999aa310e8ab2b8d26acd530",
"reference": "72a6e1160ab96c12888333d89e35059233cb9eb0", "reference": "0bf897d4a4d9b092999aa310e8ab2b8d26acd530",
"shasum": "" "shasum": ""
}, },
"require": { "require": {
@ -116,7 +116,7 @@
"issues": "https://github.com/webmasterskaya/crypto-pro-php-stubs/issues", "issues": "https://github.com/webmasterskaya/crypto-pro-php-stubs/issues",
"source": "https://github.com/webmasterskaya/crypto-pro-php-stubs" "source": "https://github.com/webmasterskaya/crypto-pro-php-stubs"
}, },
"time": "2022-11-10T08:45:00+00:00" "time": "2022-11-15T09:19:03+00:00"
} }
], ],
"aliases": [], "aliases": [],
@ -125,7 +125,7 @@
"prefer-stable": false, "prefer-stable": false,
"prefer-lowest": false, "prefer-lowest": false,
"platform": { "platform": {
"php": ">7.2 <8.0", "php": ">=7.2 <8.0",
"ext-mbstring": "*" "ext-mbstring": "*"
}, },
"platform-dev": [], "platform-dev": [],

View File

@ -5,7 +5,7 @@ namespace Webmasterskaya\CryptoPro\Constants;
/** /**
* Тип перечисления CADESCOM_ENCODING_TYPE указывает используемый тип кодирования. * Тип перечисления CADESCOM_ENCODING_TYPE указывает используемый тип кодирования.
*/ */
class CADESCOM_ENCODE class CADESCOM_ENCODING_TYPE
{ {
/** /**
* Данные сохраняются в виде строки в кодировке Base64. * Данные сохраняются в виде строки в кодировке Base64.

View File

@ -0,0 +1,36 @@
<?php
namespace Webmasterskaya\CryptoPro\Constants;
/**
* Тип перечисления CAPICOM_STORE_OPEN_MODE используется с методом \CPStore->Open() для указания способа открытия хранилища сертификатов.
*/
class CAPICOM_STORE_OPEN_MODE
{
/**
* Откройте хранилище в режиме только для чтения.
*/
const READ_ONLY = 0;
/**
* Откройте хранилище в режиме чтения и записи.
*/
const READ_WRITE = 1;
/**
* Откройте хранилище в режиме чтения и записи, если у пользователя есть разрешения на чтение и запись.
* Если у пользователя нет разрешений на чтение и запись, откройте хранилище в режиме только для чтения.
*/
const MAXIMUM_ALLOWED = 2;
/**
* Открывать только существующие магазины; не создавайте новое хранилище.
*/
const EXISTING_ONLY = 128;
/**
* Включите архивные сертификаты при использовании хранилища.
*/
const INCLUDE_ARCHIVED = 256;
}

View File

@ -5,12 +5,13 @@ namespace Webmasterskaya\CryptoPro;
use Webmasterskaya\CryptoPro\Constants\CADESCOM_ATTRIBUTE; use Webmasterskaya\CryptoPro\Constants\CADESCOM_ATTRIBUTE;
use Webmasterskaya\CryptoPro\Constants\CADESCOM_CADES_TYPE; use Webmasterskaya\CryptoPro\Constants\CADESCOM_CADES_TYPE;
use Webmasterskaya\CryptoPro\Constants\CADESCOM_CONTENT_ENCODING_TYPE; use Webmasterskaya\CryptoPro\Constants\CADESCOM_CONTENT_ENCODING_TYPE;
use Webmasterskaya\CryptoPro\Constants\CADESCOM_ENCODE; use Webmasterskaya\CryptoPro\Constants\CADESCOM_ENCODING_TYPE;
use Webmasterskaya\CryptoPro\Constants\CADESCOM_HASH_ALGORITHM; use Webmasterskaya\CryptoPro\Constants\CADESCOM_HASH_ALGORITHM;
use Webmasterskaya\CryptoPro\Constants\CADESCOM_STORE_LOCATION; use Webmasterskaya\CryptoPro\Constants\CADESCOM_STORE_LOCATION;
use Webmasterskaya\CryptoPro\Constants\CAPICOM_CERTIFICATE_FIND_TYPE; use Webmasterskaya\CryptoPro\Constants\CAPICOM_CERTIFICATE_FIND_TYPE;
use Webmasterskaya\CryptoPro\Constants\CAPICOM_CERTIFICATE_INCLUDE_OPTION; use Webmasterskaya\CryptoPro\Constants\CAPICOM_CERTIFICATE_INCLUDE_OPTION;
use Webmasterskaya\CryptoPro\Constants\CAPICOM_PROPID; use Webmasterskaya\CryptoPro\Constants\CAPICOM_PROPID;
use Webmasterskaya\CryptoPro\Constants\CAPICOM_STORE_OPEN_MODE;
use Webmasterskaya\CryptoPro\Helpers\CertificateHelper; use Webmasterskaya\CryptoPro\Helpers\CertificateHelper;
use Webmasterskaya\CryptoPro\Helpers\ErrorMessageHelper; use Webmasterskaya\CryptoPro\Helpers\ErrorMessageHelper;
@ -54,7 +55,7 @@ class CryptoPro
{ {
$certificates = self::getCertificatesFromStore( $certificates = self::getCertificatesFromStore(
CADESCOM_STORE_LOCATION::CURRENT_USER_STORE, CADESCOM_STORE_LOCATION::CURRENT_USER_STORE,
self::CP_MY_STORE, static::CP_MY_STORE,
false false
); );
} }
@ -98,7 +99,7 @@ class CryptoPro
{ {
$certificates = self::getCertificatesFromStore( $certificates = self::getCertificatesFromStore(
CADESCOM_STORE_LOCATION::CONTAINER_STORE, CADESCOM_STORE_LOCATION::CONTAINER_STORE,
self::CP_MY_STORE, static::CP_MY_STORE,
false false
); );
} }
@ -298,7 +299,7 @@ class CryptoPro
$cadesSigner, $cadesSigner,
CADESCOM_CADES_TYPE::PKCS7_TYPE, CADESCOM_CADES_TYPE::PKCS7_TYPE,
false, false,
CADESCOM_ENCODE::BASE64 CADESCOM_ENCODING_TYPE::BASE64
); );
} }
catch (\Throwable $e) catch (\Throwable $e)
@ -362,7 +363,6 @@ class CryptoPro
$cadesAuthAttrs->Add($cadesAttrs); $cadesAuthAttrs->Add($cadesAttrs);
$cadesSigner->set_Options(CAPICOM_CERTIFICATE_INCLUDE_OPTION::WHOLE_CHAIN); $cadesSigner->set_Options(CAPICOM_CERTIFICATE_INCLUDE_OPTION::WHOLE_CHAIN);
} }
catch (\Throwable $e) catch (\Throwable $e)
{ {
@ -372,8 +372,10 @@ class CryptoPro
try try
{ {
$cadesHashedData->set_Algorithm(CADESCOM_HASH_ALGORITHM::HASH_CP_GOST_3411_2012_256); $cadesHashedData->set_Algorithm(CADESCOM_HASH_ALGORITHM::HASH_CP_GOST_3411_2012_256);
$cadesHashedData->set_DataEncoding(CADESCOM_CONTENT_ENCODING_TYPE::BASE64_TO_BINARY);
$cadesHashedData->SetHashValue($messageHash); $cadesHashedData->SetHashValue($messageHash);
$cadesSignedData->set_ContentEncoding(CADESCOM_CONTENT_ENCODING_TYPE::BASE64_TO_BINARY);
// Для получения объекта отсоединенной (открепленной) подписи, необходимо задать любой контент. // Для получения объекта отсоединенной (открепленной) подписи, необходимо задать любой контент.
// Этот баг описан на форуме. // Этот баг описан на форуме.
// https://www.cryptopro.ru/forum2/default.aspx?g=posts&m=78553#post78553 // https://www.cryptopro.ru/forum2/default.aspx?g=posts&m=78553#post78553
@ -391,7 +393,7 @@ class CryptoPro
$cadesHashedData, $cadesHashedData,
$cadesSigner, $cadesSigner,
CADESCOM_CADES_TYPE::PKCS7_TYPE, CADESCOM_CADES_TYPE::PKCS7_TYPE,
CADESCOM_ENCODE::BASE64 CADESCOM_ENCODING_TYPE::BASE64
); );
} }
catch (\Throwable $e) catch (\Throwable $e)
@ -476,7 +478,7 @@ class CryptoPro
$signature = $cadesSignedData->CoSignCades( $signature = $cadesSignedData->CoSignCades(
$cadesSigner, $cadesSigner,
CADESCOM_CADES_TYPE::PKCS7_TYPE, CADESCOM_CADES_TYPE::PKCS7_TYPE,
CADESCOM_ENCODE::BASE64 CADESCOM_ENCODING_TYPE::BASE64
); );
} }
catch (\Throwable $e) catch (\Throwable $e)
@ -550,8 +552,10 @@ class CryptoPro
try try
{ {
$cadesHashedData->set_Algorithm(CADESCOM_HASH_ALGORITHM::HASH_CP_GOST_3411_2012_256); $cadesHashedData->set_Algorithm(CADESCOM_HASH_ALGORITHM::HASH_CP_GOST_3411_2012_256);
$cadesHashedData->set_DataEncoding(CADESCOM_CONTENT_ENCODING_TYPE::BASE64_TO_BINARY);
$cadesHashedData->SetHashValue($messageHash); $cadesHashedData->SetHashValue($messageHash);
$cadesSignedData->set_ContentEncoding(CADESCOM_CONTENT_ENCODING_TYPE::BASE64_TO_BINARY);
// Для получения объекта отсоединенной (открепленной) подписи, необходимо задать любой контент. // Для получения объекта отсоединенной (открепленной) подписи, необходимо задать любой контент.
// Этот баг описан на форуме. // Этот баг описан на форуме.
// https://www.cryptopro.ru/forum2/default.aspx?g=posts&m=78553#post78553 // https://www.cryptopro.ru/forum2/default.aspx?g=posts&m=78553#post78553
@ -574,7 +578,7 @@ class CryptoPro
$cadesSigner, $cadesSigner,
$cadesHashedData, $cadesHashedData,
CADESCOM_CADES_TYPE::PKCS7_TYPE, CADESCOM_CADES_TYPE::PKCS7_TYPE,
CADESCOM_ENCODE::BASE64 CADESCOM_ENCODING_TYPE::BASE64
); );
} }
catch (\Throwable $e) catch (\Throwable $e)
@ -609,7 +613,7 @@ class CryptoPro
try try
{ {
$cadesHashedData->set_Algorithm(CADESCOM_HASH_ALGORITHM::HASH_CP_GOST_3411_2012_256); $cadesHashedData->set_Algorithm(CADESCOM_HASH_ALGORITHM::HASH_CP_GOST_3411_2012_256);
$cadesHashedData->set_DataEncoding(BASE64_TO_BINARY); $cadesHashedData->set_DataEncoding(CADESCOM_CONTENT_ENCODING_TYPE::BASE64_TO_BINARY);
$cadesHashedData->Hash($messageBase64); $cadesHashedData->Hash($messageBase64);
} }
catch (\Throwable $e) catch (\Throwable $e)
@ -630,12 +634,95 @@ class CryptoPro
} }
/** /**
* возвращает информацию о CSP и плагине * Возвращает информацию о CSP и плагине
* *
* @return void * @throws \Exception
* @return array
*/ */
public static function getSystemInfo() public static function getSystemInfo()
{ {
try
{
$about = new \About();
}
catch (\Throwable $e)
{
throw new \Exception(ErrorMessageHelper::getErrorMessage($e, 'Ошибка при получении информации о системе'));
}
try
{
$cadesVersion = $about->PluginVersion();
if ($cadesVersion instanceof \Version)
{
$cadesVersion = $cadesVersion->toString();
}
if (!$cadesVersion)
{
$cadesVersion = $about->get_Version();
}
}
catch (\Throwable $e)
{
throw new \Exception(ErrorMessageHelper::getErrorMessage($e, 'Ошибка при получении информации о плагине'));
}
try
{
$cspVersion = $about->CSPVersion();
$cspVersion = $cspVersion->toString();
}
catch (\Throwable $e)
{
throw new \Exception(ErrorMessageHelper::getErrorMessage($e, 'Ошибка при получении информации о CSP'));
}
return [
'cadesVersion' => $cadesVersion,
'cspVersion' => $cspVersion,
];
}
/**
* Проверяет корректность настроек средств ЭП
*
* @throws \Exception
* @return true
*/
public static function isValidSystemSetup()
{
$systemInfo = static::getSystemInfo();
$extractedCadesVersion = [];
if (!preg_match('/(\d+)\.(\d+)\.(\d+)/', $systemInfo['cadesVersion'], $extractedCadesVersion))
{
throw new \Exception('Ошибка чтеня версии плагина');
}
list(, $cadesVersionMajor, $cadesVersionMinor, $cadesVersionPatch) = $extractedCadesVersion;
if ((int) $cadesVersionMajor < 2
|| ((int) $cadesVersionMajor === 2 && (int) $cadesVersionMinor === 0 && (int) $cadesVersionPatch < 12438))
{
throw new \Exception('Не поддерживаемая версия плагина');
}
if (!preg_match('/(\d+)\.(\d+)\.(\d+)/', $systemInfo['cspVersion'], $extractedCSPVersion))
{
throw new \Exception('Ошибка чтеня версии CSP');
}
list(, $cspVersionMajor, $cspVersionMinor, $cspVersionPatch) = $extractedCSPVersion;
if ((int) $cspVersionMajor < 4)
{
throw new \Exception('Не поддерживаемая версия CSP');
}
return true;
} }
/** /**
@ -679,7 +766,7 @@ class CryptoPro
try try
{ {
$cadesStore->Open($storeLocation, $storeName, STORE_OPEN_MAXIMUM_ALLOWED); $cadesStore->Open($storeLocation, $storeName, CAPICOM_STORE_OPEN_MODE::MAXIMUM_ALLOWED);
} }
catch (\Throwable $e) catch (\Throwable $e)
{ {
@ -772,7 +859,7 @@ class CryptoPro
try try
{ {
$cadesStore->Open($storeLocation, $storeName, STORE_OPEN_MAXIMUM_ALLOWED); $cadesStore->Open($storeLocation, $storeName, CAPICOM_STORE_OPEN_MODE::MAXIMUM_ALLOWED);
} }
catch (\Throwable $e) catch (\Throwable $e)
{ {