КриптоАРМ. Возможности по интеграции и автоматизации¶
Что такое КриптоАРМ API и SDK? Отличия и возможности¶
КриптоАРМ предлагает два инструмента для интеграции и автоматизации: API и SDK. Оба варианта упрощают автоматизацию криптографических операций, но имеют различную сферу применения.
КриптоАРМ API — это программный интерфейс, который позволяет интегрировать КриптоАРМ с другими информационными системами или приложениями. С его помощью можно вызывать функции КриптоАРМ с заданными параметрами. API доступно в двух вариантах: через веб-протокол (похожий на JSON-RPC 2.0) и через локальное API для вызовов из консольных приложений. КриптоАРМ устанавливается на клиентском устройстве, и пользователь подтверждает операции.
Основное преимущество использования API — отсутствие необходимости разработки кода для криптографических операций. Вы просто передаете параметры операции и получаете результаты через контроллер. API работает на всех операционных системах, включая мобильные устройства.
Пример использования КриптоАРМ API: Ваш портал выставляет счета, и требуется организовать юридически значимый электронный документооборот (ЭДО). С помощью API можно добавить кнопку «Подписать» в личный кабинет контрагента. КриптоАРМ API запустит мастер подписи с уже подготовленными документами, и пользователю останется только подписать их. Документы автоматически отправятся обратно в вашу систему.
Для 1С-Битрикс есть готовый бесплатный модуль: КриптоАРМ Документы.
КриптоАРМ SDK — это набор модулей для разработки нового сервиса или продукта. Чаще всего используется на сервере. SDK не содержит пользовательского интерфейса (UI) и требует написания скриптов на TypeScript/JavaScript. SDK идеально подходит для создания автоматизированных решений, где требуется обезличенная подпись документов или их проверка.
Пример использования КриптоАРМ SDK: Ваш интернет-магазин должен автоматически подписывать счета. С помощью SDK вы можете написать код для автоматической подписи, используя простые верхнеуровневые методы. Это избавляет вас от необходимости разбираться в сложных криптографических стандартах.
Функционал КриптоАРМ API и SDK: Что доступно?¶
Через КриптоАРМ API можно выполнить любую операцию, которые уже доступны в графическом интерфейсе КриптоАРМ.
Операции:
- подписать один или несколько файлов;
- создать копию с визуальным штампом;
- встроить подпись в PDF-документ;
- проверить действительность электронной подписи одного или нескольких файлов;
- зашифровать файлы;
- расшифровать файлы;
- создать запрос на получение сертификата;
- сгенерировать ключевую пару;
- экспортировать сертификат или сертификаты;
- импортировать сертификат или сертификаты;
- показать информацию о сертификате;
- выполнить диагностику рабочего места;
- сформировать новое письмо.
КриптоАРМ SDK состоит из модулей для Node.js:
- trusted-crypto — подпись, проверка, шифрование и расшифрование, работа с сертификатами;
- trusted-curl — защищенное сидение с поддержкой ГОСТ TLS;
- trusted-mailcore2 — сбор и разбор писем, протоколы IMAP и SMTP;
- trusted-pdf — преобразование PDF в PDF-A, сертификация PDF с разметкой областей для оттисков подписи, подпись и проверка подписи встроенной в PDF.
В каких версиях КриптоАРМ есть API или SDK?¶
Продукт | API | SDK |
---|---|---|
КриптоАРМ ГОСТ 2.2.4 (сертифицирован) | Нет | Нет |
КриптоАРМ ГОСТ 2.5 (desktop) | Да | Да |
КриптоАРМ 2 (mobile) | Да | Нет |
КриптоАРМ ГОСТ 3 (desktop) (сертифицирован) | Да (+ локальное API) | Да |
КриптоАРМ ГОСТ 3 (mobile) (сертифицирован) | Да | Нет |
КриптоАРМ 6 (desktop) | Да (+ локальное API) | Да |
КриптоАРМ 1.0 Mobile | Да | Нет |
КриптоАРМ 1.0 Mobile для Aurora OS | Нет | Нет |
Требуется ли оценка влияния?¶
Для использования КриптоАРМ в некоторых сценариях может потребоваться проведение исследований по оценке влияния (СФ).
В КриптоАРМ ГОСТ 3 возможны следующие варианты применения:
-
Использование графических интерфейсов СКЗИ.
В данном варианте использования СКЗИ дополнительных исследований не требуется.
-
Программный вызов КриптоАРМ API.
В данном варианте использования СКЗИ требуется проведение исследований по оценке влияния СФ на СКЗИ.
-
Использование КриптоАРМ SDK рассматривается как встраивание СКЗИ во вновь разрабатываемое или существующее прикладное программное обеспечение, программно-аппаратные и аппаратные решения. В данном случае требуется проведение тематических исследований СФ со встроенным СКЗИ как самостоятельного шифровального (криптографического) средства.
Если вам требуется помощь в оценке влияния, оставьте заявку на sales@cryptoarm.ru.
Какие лицензии на продукты нужны?¶
Для использования КриптоАРМ SDK необходима серверная лицензия. КриптоАРМ API может работать как с клиентскими, так и серверными лицензиями на КриптоАРМ.
Для API будет доступен дополнительный вариант лицензирования — транзакционный. В этом случае оператор ИС приобретает пакет лицензий и распространяет своим клиентам клиентские лицензии вместе с параметрами операции. Пользователю не надо покупать КриптоАРМ или вручную вводить лицензии.
Так же требуется действующая лицензия на криптопровайдер КриптоПро CSP.
Где посмотреть документацию и примеры для API или SDK?¶
Ознакомьтесь с документацией КриптоАРМ API и КриптоАРМ SDK.
Пример по вызову API реализован на этом стенде, его исходный код - ссылка.
В качестве примера использования КриптоАРМ SDK мы реализовали сервис по проверке подписи и постановке визуальных штампов. Сервис доступен по ссылке, его исходный код открыт - ссылка.
Мы готовы помочь вам с интеграцией API и SDK в вашу систему, по всем вопросам обращайтесь на sales@cryptoarm.ru.