Выполнение операций в командной строке - Документация для КриптоАРМ 6
Перейти к содержанию

Выполнение операций в командной строке


Общая информация

Данное руководство описывает выполнение криптографических операций через командную строку (Windows) или терминал (Unix-системы).

Для автоматизации операций рекомендуется использовать скрипты (.bat, .sh). Ознакомьтесь в примером автоматизации в инструкции.

Важные замечания

  • Убедитесь, что приложение настроено для работы с электронной подписью. Подробную информацию о настройке можно найти в инструкции Начало работы.
  • Перед вводом команды необходимо указать путь до исполняемого файла. После указания пути до исполняемого файла необходимо поставить пробел, затем вводить команды.
  • Все команды и параметры пишутся через пробел.

Синтаксис команд

  • -команда — команда пишется первой, после пути до исполняемого файла. Далее указываются значения переменных и параметры операции.
  • <текст> — указываются значения переменной, такие как Серийный номер сертификата, Путь до исходного файла, OID алгоритма шифрования и т.п.
  • [текст] — необязательные параметры, которые можно как задать, так и не задавать, тогда будут использоваться значения по умолчанию.

Пути к исполняемым файлам

Система Путь
Windows "C:\Program Files\CryptoARM 6\cryptoarm6.exe"
Linux /opt/cryptoarm6/cryptoarm6
macOS /Applications/cryptoarm6.app/Contents/MacOS/cryptoarm6

Операции

Подпись

Команды: sign или sig

Команда позволяет выполнить операцию подписи файла или нескольких файлов.

Если в исходном файле указать уже подписанный документ, то будет добавлена еще одна подпись к файлу.

Пример

sign  -cert <serial> [-enc DER|BASE64] [-detached] [-save-copy] [-pin <PIN>] [-ext <sign file extention>] [-sign-type <CadesT|CadesA|CadesXLT1> -tsp <tsp-addr> [-ocsp <ocsp-addr>] [-proxy <proxy-addresss> [-proxy-port <port>] [-proxy-login <login>] [-proxy-password <password>]]] <source-file-name>|<source-folder> <encrypted-file-path>|<folder-to-save-signed> 

Описание команды

Параметр Описание Значение по умолчанию
--cert <serial> Серийный номер сертификата подписи
--pades Использовать для PDF-документов встроенную подпись со стандартом PAdES Отключено
--stamp-on-all-pages Добавить копию изображения штампа на все страницы Отключено
--standard <type> Стандарт подписи (CAdES) "CAdES-BES"
--detached Отделённая подпись Отключено
--save-copy Сохранение копии результата в Архиве Отключено
--pin <pin-code> ПИН-код ключа сертификата подписи
--enc <DER\|BASE-64> Кодировка подписи "DER"
--ext <sig\|p7s\|sgn\|sign\|bin> Расширение файла подписи "sig"
--tsp <tsp-addr> Адрес службы TSP (метки времени)
--ocsp <ocsp-addr> Адрес службы OCSP (проверки сертификатов)
--proxy <proxy-address> Адрес прокси-сервера
--proxy-port <port> Порт прокси-сервера
--proxy-login <login> Логин для прокси-сервера
--proxy-password <password> Пароль для прокси-сервера
-f, --force Автоматическое согласие на использование недействительного сертификата Отключено
--logcrypto Включение лога trusted-crypto Отключено
--source-file <source-file-name> Путь к файлу для подписи
--source-folder <source-folder> Путь к папке с файлами для подписи
--signed-file-path <file-path-name> Путь для сохранения подписи
--folder-save-signed <folder-to-save-signed> Папка для сохранения подписанных файлов
-h, --help Вывод справки команды

Шифрование

Команды: encrypt или enc

Команда позволяет выполнить шифрование одного или нескольких файлов в адрес одного или нескольких сертификатов.

Пример

cryptoarm.exe encrypt --cert <серийный номер сертификата> [--enc DER|BASE64][--alg &lt;alg-oid>] [--delete-source][--save-copy] [--ext <encrypted file extension>] --source-file <путь к файлу>|--source-folder <путь к папке> --encrypted-file-path <путь к файлу c новым именем для сохранения результата>|--folder-save-encrypted <путь к папке для сохранения результата>

Описание команды

Параметр Описание Значение по умолчанию
--cert <serial...> Серийный номер сертификата подписи (можно указать несколько)
--alg <alg-oid> OID алгоритма шифрования "1.2.643.2.2.21"
--delete-source Удаление исходного файла после шифрования Отключено
--save-copy Сохранение копии результата в Архиве Отключено
--ext <enc\|p7m\|p7e\|pem> Расширение создаваемого шифрованного файла "enc"
--enc <DER\|BASE-64> Кодировка шифруемого файла "DER"
--logcrypto Включает лог trusted-crypto Отключено
-f, --force Автоматическое согласие на использование недействительных сертификатов Отключено
--source-file <path-file> Путь к файлу для шифрования
--encrypted-file-path <path-file> Путь к файлу для сохранения результата шифрования
--folder-save-encrypted <path-folder> Путь к папке для сохранения зашифрованных файлов
--source-folder <path-folder> Путь к папке с файлами для шифрования
-h, --help Вывод справки команды

Расшифрование

Команды: decrypt или dec

Команда позволяет выполнить расшифрование одного или нескольких зашифрованных файлов.

Пример

decrypt [-pin <PIN>] [-save-copy] <source-file-name>|<source-folder> <encrypted-file-path>|<folder-to-save-decrypted>

Описание команды

Параметр Описание Значение по умолчанию
--save-copy Сохранение копии результата в Архиве Отключено
--logcrypto Включает лог trusted-crypto Отключено
--pin <pin-code> Пин-код ключа расшифрования -
--source-file <path-file> Путь к файлу для расшифрования -
--source-folder <path-folder> Путь к папке с файлами для расшифрования -
--decrypted-file-path <path-file> Путь для сохранения расшифрованного файла -
--folder-save-decrypted <path-folder> Путь к папке для сохранения результатов расшифрования -
-h, --help Вывод справки команды -

Проверка подписи

Команды:

  • verify или ver
  • verify_ts или vts - проверка штампов времени из подписи

Команда позволяет выполнить проверку одной или нескольких подписей, либо штампов времени в файле подписи. Есть возможность сохранения отчёт о проверке в отдельный файл в формате pdf или json.

Примеры

verify [-save-report|-r [<report-file>]] <source-file-name>|<source-folder>
verify_ts [-save-report|-r [<report-file>]] <source-file-name>|<source-folder>

Пример. Проверка подписи файлов в папке C:\Foldername с сохранением отчета о проверке в формате pdf в папку с проверяемыми файлами.

"C:\Program Files\CryptoARM 6\cryptoarm6.exe" ver --source-folder C:\Foldername -r-pdf

Описание команды

Параметр Описание Значение по умолчанию
-r-pdf, --save-report-pdf [report-folder] Сохранение отчёта в формате PDF Отключено
-r-json, --save-report-json [report-file-path] Сохранение отчёта в формате JSON Отключено
--document <original-file> Путь к исходному файлу для откреплённой подписи -
--logcrypto Включение лога trusted-crypto Отключено
--source-file <source-file-path> Путь к файлу подписи для проверки -
--source-folder <source-folder-path> Путь к папке с подписями для проверки -
-h, --help Вывод справки по команде -

Для повышения удобства работы и хранения данных веб-сайт CRYPTOARM.RU использует файлы COOKIE. Продолжая работу с веб-сайтом, Вы даете свое согласие на работу с этими файлами.