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

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

Важно. Прежде чем подписывать документы, убедитесь, что на вашем компьютере установлен криптопровайдер КриптоПро CSP. Также для подписи документов необходима лицензия на КриптоАРМ и КриптоПро CSP.

Для выполнения команд в консоли необходимо придерживаться определенного синтаксиса при написании команды.

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

Все команды и параметры пишутся через пробел.

Важно. Перед вводом команды необходимо указать путь до исполняемого файла. После указания пути до исполняемого файла необходимо поставить пробел, затем вводить команды.

В зависимости от ОС путь до исполняемого файла может отличаться:

В ОС Windows: "C:\Program Files\CryptoARM 6\cryptoarm6.exe".
В Unix-подобных ОС семейства 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>`	Серийный номер сертификата подписи
`--standard <type>`	Расширение создаваемого файла подписи (choices: "CAdES-T", "CAdES-A", "CAdES-XLT1", "CAdES-BES", default: "CAdES-BES")
`--detached`	Отделённая подпись
`--save-copy`	Сохранение копии результата в Архиве
`--pin <pin-code>`	ПИН код ключа сертификата подписи
`--enc <DER\\|BASE-64>`	Кодировка в которой будет сохранён подписанный файл, DER или BASE-64 (default: "DER")
`--ext <sig\\|p7s\\|sgn\\|sign\\|bin>`	Адрес службы TSP. Для Windows нужно указывать URL в одинарных кавычках. Пример: `--tsp 'https://example.com/tsp/tsp.srf'`
`--ocsp <ocsp-addr>`	Адрес службы OCSP. Для Windows нужно указывать URL в одинарных кавычках. Пример: `--ocsp 'https://example.com/ocsp/ocsp.srf'`
`--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

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

Пример

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

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

Команда	Описание
`--cert, <serial...>`	Серийный номер сертификата подписи
`--alg <alg-oid>`	OID алгоритма шифрования (default: "1.2.643.2.2.21")
`--delete-source`	Удаление исходного файла после шифрования
`--save-copy`	Сохранение копии результата в Архиве
`--ext <enc\\|p7m\\|p7e\\|pem>`	Расширение создаваемого шифрованного файла (default: "enc")
`--enc <DER\\|BASE-64>`	Кодировка шифруемого файла, DER или BASE-64 (default: "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`	Cохранение копии результата в Архиве
`-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`	Сохранение отчета о проверке в формате pdf в папку с проверяемым файлом
`--save-report-pdf [report-folder]`	Сохранение отчета о проверке в формате pdf в указанную папку
`-r-json`	Сохранение отчета о проверке в 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`	Вывод справки команды