Асинхронный JavaScript SDK для КриптоПРО ЭЦП Browser Plug-In
Go to file
2021-06-04 18:44:56 +03:00
dist 2.3.0 2021-06-04 18:44:56 +03:00
examples 2.3.0 2021-06-04 18:44:56 +03:00
resources Добавил ссылку на Jetbrains в рамках поддержки OpenSource проекта 2020-12-19 17:13:23 +03:00
src 2.3.0 2021-06-04 18:44:56 +03:00
types/cadesplugin 2.0.0 2020-03-28 21:11:00 +03:00
.editorconfig 2.0.0 2020-03-28 21:11:00 +03:00
.eslintrc.js 2.0.0 2020-03-28 21:11:00 +03:00
.gitignore для bower сборка добавлена под версионный контроль для возможности устанавливать пакет напрямую с github 2020-03-29 10:05:07 +03:00
.prettierrc.js 2.0.0 2020-03-28 21:11:00 +03:00
.travis.yml добавил конфиг для Travis CI 2020-03-29 12:41:12 +03:00
bower.json 2.0.0 2020-03-28 21:11:00 +03:00
definition-header.js 2.0.0 2020-03-28 21:11:00 +03:00
jest.config.js 2.0.0 2020-03-28 21:11:00 +03:00
LICENSE добавил файл с лицензией 2020-04-05 18:27:07 +03:00
package-lock.json 2.3.0 2021-06-04 18:44:56 +03:00
package.json 2.3.0 2021-06-04 18:44:56 +03:00
README.md 2.3.0 2021-06-04 18:44:56 +03:00
tsconfig-es5.json 2.0.0 2020-03-28 21:11:00 +03:00
tsconfig-esm.json 2.0.0 2020-03-28 21:11:00 +03:00
tsconfig.json 2.3.0 2021-06-04 18:44:56 +03:00
webpack.config.js 2.0.0 2020-03-28 21:11:00 +03:00

NPM version NPM downloads Build Status Coverage Status

cryptoPro

Единое, асинхронное API для взаимодействия с КриптоПРО ЭЦП Browser Plug-In

⚠️ Это форк проекта vgoma/crypto-pro

⚠️ API форка отличается от оригинала: внимательно читайте README

Chrome Firefox IE Opera
v45+ с расширением CryptoPro Extension for CAdES Browser Plug-in v43+. Начиная с версии 52, с расширением v9+ с установленным КриптоПро ЭЦП Browser plug-in v40+ с расширением CryptoPro Extension for CAdES Browser Plug-in

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

КриптоПРО ЭЦП Browser Plug-In доступен в разных браузерах в двух версиях. Асинхронной (в современных браузерах) и синхронной (в браузерах постарше). С помощью этого пакета можно не писать реализацию под каждую версию плагина дважды.

Установка

Для NPM:

npm install crypto-pro

Для Yarn:

yarn add crypto-pro

Для Bower:

bower install crypto-pro

Подключение пакета как UMD модуля через тэг script:

<script src="crypto-pro/dist/crypto-pro.min.js"></script>
<script>
window.cryptoPro.getUserCertificates()
  .then(function (certificates) {
    //...
  })
  .catch(function (error) {
    //...
  });
</script>

Подключение пакета как ES модуля с Typescript или JavaScript:

import { getUserCertificates, Certificate } from 'crypto-pro';

(async () => {
  let certificates: Certificate[];

  try {
    certificates = await getUserCertificates();
  } catch(error) {
    // ...
  }
})();

Список требуемых полифиллов (если необходимы, подключаются самостоятельно):

  • Promise
  • Array.prototype.find

API

Методы объекта cryptoPro

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

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

Сертификат предоставляет следущее API:

  • isValid - возвращает флаг действительности сертификата
  • getCadesProp - возвращает указанное внутренее свойство у сертификата в формате Cades
  • exportBase64 - возвращает сертификат в формате base64
  • getAlgorithm - возвращает информацию об алгоритме сертификата
  • getOwnerInfo - возвращает расшифрованную информацию о владельце сертификата
  • getIssuerInfo - возвращает расшифрованную информацию об издателе сертификата
  • getExtendedKeyUsage - возвращает ОИД'ы сертификата
  • getDecodedExtendedKeyUsage - возвращает расшифрованные ОИД'ы
  • hasExtendedKeyUsage - проверяет наличие ОИД'а (ОИД'ов) у сертификата

Поддерживаемые СКЗИ

КриптоПРО CSP (v4.0+)

Примеры

Для их запуска необходим NodeJS LTS.

Тэг script (UMD)

cd examples/script-tag
npm i
npm start

Angular (ES Modules + Typescript)

cd examples/angular
npm i

Запуск в режиме разработки:

npm start

Запуск в продакшн режиме:

npm run build
npm run serve

React (ES Modules + JavaScript)

cd examples/react
npm i

Запуск в режиме разработки:

npm start

Запуск в продакшн режиме:

npm run build
npm run serve

Тем, кто хочет помочь

Буду благодарен за расширение/улучшение/доработку API. Вам будут полезны примеры, предоставляемые Крипто ПРО.

Запуск режима разработки

Устанавливаем зависимости:

npm i

Во время работы с кодом необходим запущенный сборщик:

npm start

И пример, на котором можно тестировать изменения. Удобнее всего тестировать на примере с тэгом script, тк он отвязан от фреймворков и использует сборку в формате UMD из папки dist/, постоянно обновляемую пока работает сборщик. Запускаем его таким образом:

cd examples/script-tag
npm i
npm link ../../
npm start

После выполнения npm link ../../ в директории examples/script-tag/node_modules папка crypto-pro станет ярлыком, указывающим на папку содержащую локально собранный пакет.

Запуск тестов

Тесты написаны с использованием Jest:

npm test

Проверка работы примеров с React и Angular

React и Angular используют версию сборки пакета в формате ES модулей из директории lib/. Для их запуска необходимо сначала собрать пакет выполнив:

npm run build

После этого из папки examples/angular или examples/react залинковать пакет:

cd examples/angular
npm i
npm link ../../

И запустить пример в одном из двух режимов. В режиме разработки:

npm start

или в режиме продакшн:

npm run build
npm run serve

Проверка пакета перед публикацией в NPM

Необходимо протестировать работу в заявленных браузерах, сделав это на локально запакованной версии пакета. Для этого собираем пакет:

npm run package
mv package ..

Важно переместить папку package куда-нибудь выше для избежания конфликтов при линковке с текущим package.json.

Переходим в любую директорию с примером и создаем там ссылку на только что собранный пакет:

cd examples/script-tag
npm link ../../../package

Проверяем работу примеров в режимах разработки и продакшн.

После завершения экспериментов можно удалить глобальную ссылку из директории ../../../package таким образом:

cd ../../../package
npm unlink

Лицензия

MIT