crypto-pro-php/README.md

КриптоПРО PHP SDK

PHP SDK для работы с API расширения КриптоПро (libphpcades), аналогичный КриптоПро ЭЦП Browser plug-in

• КриптоПРО PHP SDK
  • Зачем нужен этот пакет?
  • Установка
  • API
    • Методы класса CryptoPro
    • Методы объекта сертификата
  • Поддерживаемые СКЗИ
  • Примеры
    • Тэг script (UMD)
• Тем, кто хочет помочь
  • Запуск режима разработки
  • Запуск тестов
  • Проверка пакета перед публикацией в NPM
• Лицензия

Зачем нужен этот пакет?

Этот паект призван упроостить взаимодействие с абсолютно не документированным расширением КриптоПро для PHP. Пакет реализует упрощённый доступ к следующим операциям:

• работа с сертификатами;
• создание и проверка подписи;
• шифрование и расшифрование данных.

Немаловажным фактором, в выборе этого пакета, является полное соответсвие набора методов, с КриптоПРО JS SDK

Установка

Установка осуществляется через Composer.

composer require webmasterskaya/crypto-pro-php

API

Методы класса СryptoPro

• СryptoPro::getUserCertificates() - возвращает список сертификатов, доступных пользователю в системе
• СryptoPro::getAllUserCertificates() - возвращает список всех сертификатов, доступных пользователю в системе, в том числе, просроченные и без закрытого ключа
• СryptoPro::getContainerCertificates() - возвращает список сертификатов, из закрытых ключей и/или сертификаты не установленные всистеме*
• СryptoPro::getAllContainerCertificates() - возвращает список всех сертификатов, из закрытых ключей и/или сертификаты не установленные всистеме*, в том числе, просроченные и без закрытого ключа
• СryptoPro::getCertificate() - возвращает сертификат по отпечатку
• СryptoPro::createAttachedSignature() - создает совмещенную (присоединенную) подпись сообщения
• СryptoPro::createDetachedSignature() - создает отсоединенную (открепленную) подпись сообщения
• СryptoPro::addAttachedSignature() - добавляет совмещенную (присоединенную) подпись к раннее подписанному документу (реализует метод coSign)
• СryptoPro::addDetachedSignature() - добавляет отсоединенную (открепленную) подпись к раннее подписанному документу (реализует метод coSign)
• СryptoPro::createHash() - создает хеш сообщения по ГОСТ Р 34.11-2012 256 бит
• СryptoPro::getSystemInfo() - возвращает информацию о CSP и плагине
• СryptoPro::isValidSystemSetup() - возвращает флаг корректности настроек ЭП на машине

Методы объекта сертификата