Руководство по команде eSigner DocSignTool

DocSignTool - это безопасная многоплатформенная утилита командной строки Java, ориентированная на конфиденциальность, для удаленной подписи PDF-файлов с помощью Электронная подпись сертификаты подписи документов. Хэши документов отправляются на SSL.com для подписи, чтобы сам документ не отправлялся. Это идеальный вариант, когда необходимо подписать конфиденциальные документы, но их не следует отправлять на подпись по проводам. DocSignTool также идеально подходит для автоматизированных пакетных процессов подписания больших объемов или интеграции в существующие рабочие процессы документов.

Установка DocSignTool

Чтобы установить текущую версию DocSignTool, просто загрузите и распакуйте нужный файл для вашей ОС:

• Windows
• Linux и macOS

Обратите внимание, что загрузка Windows включает среду выполнения Java, но для версии Linux / macOS требуется, чтобы на вашем компьютере была установлена ​​среда выполнения Java. Версия команды для Windows - это командный файл (DocSignTool.bat), а версия для Linux / macOS - это сценарий оболочки (DocSignTool.sh).

Обзор использования DocSignTool

Применение: DocSignTool [-hV] [COMMAND] [PARAMETERS]

Опции:

• -h, --help: Отобразить справочное сообщение и выйти.
• -V, --version: Отображение информации о версии и выход.

Команды:

• get_credential_ids: Вывести список идентификаторов учетных данных eSigner, связанных с конкретным пользователем.
• credential_info: Вывод информации о ключе и сертификате, относящейся к идентификатору учетных данных.
• sign: Подпись и отметка времени PDF filr.
• batch_sign: Подпись и отметка времени для нескольких файлов PDF с помощью одного OTP.
• hash: Предварительно вычислить хэши для последующего использования с batch_hash_sign команда.
• batch_sign_hash: Знаковые хэши, предварительно вычисленные с помощью hash команда.

Параметры:

• -access_token=<TOKEN>: ОАут маркер доступа.
• -contact_info=<CONTACT_INFO>: Контакты.
• -credential_id=<CREDENTIAL_ID>: Идентификатор учетных данных для подписи сертификата.
• -input_dir_path=<PATH>: Входной каталог для PDF-файлов, которые нужно подписать, для которых будут вычислены хэши или выбрать неподписанные файлы и соответствующие хэши для подписи.
• -input_file_path=<PATH>: Путь к PDF-файлу, который нужно подписать.
• -otp=<OTP>: OAuth OTP из приложения аутентификации.
• -output_dir_path=<PATH>: Каталог, в который будут записаны подписанные файлы PDF.
• -page_no=<PAGE_NUMBER>: Страница документа PDF, на которой появится видимая подпись.
• -password=<PASSWORD>: Пароль учетной записи SSL.com.
• -sig_field_position=<X, Y, WIDTH, HEIGHT>: Положение видимой подписи в PDF.
• -signing_location=<SIGNING_LOCATION>: Место, где подписан документ.
• signing_reason=<SIGNING_REASON>: Причина подписания.
• -totp_secret=<TOTP_SECRET>: ОАут Секрет TOTP
• -username=<USERNAME>: Имя пользователя учетной записи SSL.com

Команды DocSignTool

get_credential_ids

Выведите список идентификаторов учетных данных eSigner, связанных с конкретным пользователем. Параметры -username и -password необходимы.

Применение: DocSignTool [-hV] get_credential_ids -username=<USERNAME> -password=<PASSWORD>

Пример:

DocSignTool get_credential_ids -username=john.doe@example.com -password="P0z9@lxo41"
Credential ID(s):
- fe537ace-e132-52a9-c2e7-egcd2ac3f1e6

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

credential_info

Выведите информацию о ключе и сертификате, относящуюся к идентификатору учетных данных. Параметры -credential_id, -usernameкачества -password необходимы.

Применение: DocSignTool [-hV] credential_info -credential_id=<CREDENTIAL_ID> -username=<USERNAME> -password=<PASSWORD>

Пример:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Информация о субъекте сертификата подписи: - DN субъекта: CN=JOHN DOE, O=SSL Corp. , L=Houston, ST=Texas, C=US — Срок действия сертификата: сб, 11 февраля, 14:52:59 EST 2023 — DN эмитента: CN=SSL.com Client Certificate Intermediate CA RSA R2, O=SSL Corp, L=Houston , ST=Техас, C=США

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

подпись

Подпись и отметка времени в PDF-файле. Параметры -username, -passwordкачества -input_file_path необходимы. -credential_id требуется только для пользователей с более чем одним сертификатом подписи документа eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_noкачества -totp_secret являются необязательными.

Применение: DocSignTool sign [-hV] [-credential_id=<CREDENTIAL_ID>] -username=<USERNAME> -password=<PASSWORD> -input_file_path=<PATH> [-output_dir_path=<PATH>] [-signing_location=<SIGNING_LOCATION>] [-signing_reason=<SIGNING_REASON>] [-contact_info=<CONTACT_INFO>] [-sig_field_position=<X, Y, WIDTH, HEIGHT>][-page_no=<PAGE_NUMBER>] [-totp_secret=<TOTP_SECRET>]

Необязательные параметры:

• If -credential_id опущено, и у пользователя есть только один сертификат подписи документа eSigner, DocSignTool будет использовать его по умолчанию. Если у пользователя есть несколько сертификатов для подписи документов, этот параметр является обязательным.
• If -output_dir_path опущен, файл, указанный в -input_file_path будет перезаписан подписанным файлом. DocSignTool предложит пользователю перед перезаписью файла.
• If -signing_location присутствует, указанное место будет добавлено к цифровой подписи.
• If -signing_reason присутствует, указанная причина подписания будет добавлена ​​к электронной подписи.
• If -contact_info присутствует, указанный текст будет добавлен к цифровой подписи. Несмотря на то, что эта информация включена в подпись, эта информация не будет включена в видимую аннотацию подписи (если она есть).
• If -sig_field_position присутствует, видимая аннотация подписи будет добавлена ​​к документу на странице, указанной -page_no. Должность и подпись должны быть предоставлены в формате "x, y, width, height".
• -page_no требуется только при создании видимой подписи с -sig_field_position и указывает страницу документа, на которой будет отображаться видимая аннотация подписи.
• If -totp_secret присутствует, DocSignTool будет вычислять основанный на времени OTP для подписи, позволяя автоматизировать использование инструмента. Если этот параметр отсутствует, пользователю будет предложено ввести одноразовый пароль вручную.

Примеры:

Ручной ввод OTP с видимой подписью:

Знак DocSignTool -credential_id = fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password = "P0z9 @ lxo41" -output_dir_path = подписанный -input_file_path = 100_position, 200, 150 "-page_no = 70 -signing_location =" Хьюстон, Техас "-signing_reason =" утверждение документа "-contact_info ="support@ssl.com"Введите одноразовый пароль. Для продолжения нажмите" Ввод ": 884646 PDF-файл успешно подписан: output \ test.pdf

Автоматическая генерация одноразового пароля, без видимой подписи:

DocSignTool sign -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" -output_dir_path=signed -input_file_path=test.pdf -totp_secret=ii5gVvZ9G+WkxB3FauAnoL/z14AXSMistcE0jZMWWNSjQDlql2kt2D6Z+l8=
PDF signed successfully: output\test.pdf

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

пакетный_знак

Подпишите и отметьте время до 100 файлов PDF с помощью одного OTP. Параметры -username, -passwordкачества -input_dir_path необходимы. -credential_id требуется только для пользователей с более чем одним сертификатом подписи документа eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_noкачества -totp_secret являются необязательными.

Применение: DocSignTool [-hV] batch_sign [-hV] [-credential_id=<CREDENTIAL_ID>] -username=<USERNAME> -password=<PASSWORD> -input_dir_path=<PATH> [-output_dir_path=<PATH>] [-signing_location=<SIGNING_LOCATION>] [-signing_reason=<SIGNING_REASON>] [-contact_info=<CONTACT_INFO>] [-sig_field_position=<X, Y, WIDTH, HEIGHT>][-page_no=<PAGE_NUMBER>] [-totp_secret=<TOTP_SECRET>]

Необязательные параметры:

• If -credential_id опущено, и у пользователя есть только один сертификат подписи документа eSigner, DocSignTool будет использовать его по умолчанию. Если у пользователя есть несколько сертификатов для подписи документов, этот параметр является обязательным.
• If -output_dir_path опущено, файлы, указанные в -input_dir_path будут перезаписаны подписанными файлами. DocSignTool предложит пользователю перед перезаписью файлов.
• If -signing_location присутствует, указанное место будет добавлено к цифровым подписям.
• If -signing_reason присутствует, указанная причина подписания будет добавлена ​​к электронным подписям.
• If -contact_info присутствует, указанный текст будет добавлен к цифровым подписям. Несмотря на то, что эта информация включена в подпись, эта информация не будет включена в видимые аннотации подписи (если они есть).
• If -sig_field_position присутствует, видимая аннотация подписи будет добавлена ​​к документам на странице, указанной -page_no. Должность и подпись должны быть предоставлены в формате "x, y, width, height".
• -page_no требуется только при создании видимой подписи с -sig_field_position и указывает страницу документов, на которой будут отображаться видимые аннотации подписи.
• If -totp_secret присутствует, DocSignTool будет вычислять основанный на времени OTP для подписи, позволяя автоматизировать использование инструмента. Если этот параметр отсутствует, пользователю будет предложено ввести одноразовый пароль вручную.

Пример:

DocSignTool batch_sign -username=john.doe@example.com -password="P0z9@lxo41" -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -input_dir_path=input -output_dir_path=output -sig_field_position="100, 200, 150, 70" -page_no=1 -signing_location="Houston, Texas" -signing_reason="document approval" -contact_info="support@ssl.com"Введите OTP - нажмите" Ввод ", чтобы продолжить: 455145 Команда подписи пакета успешно выполнена. Каталог вывода для подписанных файлов: output

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

хэш

Предварительно вычислить хэши для последующего использования с batch_hash_sign команда. Параметры -access_token и -input_dir_path необходимы. -credential_id требуется только для пользователей с более чем одним сертификатом подписи документа eSigner. -signing_location, -signing-reason, -contact_info,  -sig_field_positionкачества -page_no, являются необязательными.

Применение: DocSignTool [-hV] hash -access_token=<ACCESS_TOKEN> -input_dir_path=<PATH> [-signing_location=<SIGNING_LOCATION>] [-signing_reason=<SIGNING_REASON>] [-contact_info=<CONTACT_INFO>] [-sig_field_position=<X, Y, WIDTH, HEIGHT>][-page_no=<PAGE_NUMBER>]

Необязательные параметры:

• If -program_name присутствует при подписании установщика MSI, значение будет отображаться в диалоговом окне подтверждения как имя программы.
• If -signing_location присутствует, указанное местоположение будет добавлено к цифровым подписям при их создании.
• If -signing_reason присутствует, указанная причина подписи будет добавлена ​​к цифровым подписям при их создании.
• If -contact_info присутствует, указанный текст будет добавлен к цифровым подписям при их создании. Несмотря на то, что эта информация включена в подпись, эта информация не будет включена в видимые аннотации подписи (если они есть).
• If -sig_field_position присутствует, видимая аннотация подписи будет добавлена ​​к документам на странице, указанной -page_no когда подписи сгенерированы. Должность и подпись должны быть предоставлены в формате "x, y, width, height".
• -page_no требуется только при создании видимой подписи с -sig_field_position и указывает страницу документов, на которой будут отображаться видимые аннотации подписи при их создании.

Пример:

DocSignTool hash -access_token=eyJraWQiOiJmUE1yYUdlbXVMWGUtcG9JWUtLem1CMEYwYXlFczktUEpiN29lTWFlY2I0IiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJTU 0wuY29tIEF1dGhlbnRpY2F0aW9uIFNlcnZpY2UiLCJleHAiOjE2MTQ4OTcxNDIsImlhdCI6MTYxNDg5MzU0MiwianRpIjoiZmI2OTZlNDUtMTIzOS00ZGE4LW I1MmYtODNkZDE2MTY3ZTM3IiwidXNlciI6eyJ1c2VyX2lkIjoxMzIyODU4LCJ1c2VyX2VtYWlsIjoiYWFyb24uZS5ydXNzZWxsQGdtYWlsLmNvbSIsInNzbF9 hY2NvdW50X2lkIjo0NzQzMDJ9LCJjbGllbnQiOnsiaWQiOiJmUE1yYUdlbXVMWGUtcG9JWUtLem1CMEYwYXlFczktUEpiN29lTWFlY2I0In19.fCKDs1igjsI UDG2sUN_2OTb90Jw1nKNPHcD1MyEUR6sHCv_aJmcvcaFRne_eKLHzeQ9WtT5y3Fb2ppc50kMnjPG6JgX5gnFMptMn-ySsI277CtKbkSn3u-WSDSovn51jPm82 4wTeJmuXEzdv9clRjTwp6VoM9eqHCIaDAd3MP2xpMaa35cZbDaaAFKQ7jxWo9dUuTZY7DsKK0p1LloUEnmNxtNimQ3GDwkj_M600WB1zYrhDL9_3oZKaXcUx9 qzHcBCLzGgeaZ0xdpZtADxmXDUCcmkZi20yQ53bxqVL2w00sJ73efKB7JGeGWVehO-ZlGs3PUQwooox1JgEgcsA -credential_id=fe537ace-e132-52a9 -c2e7-egcd2ac3f1e6 -input_dir_path=input
Hash command executed successfully. Hash files created at: input

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

Batch_sign_hash

Знаковые хэши, предварительно вычисленные с помощью hash команда. Параметры -access_token, input_dir_path, -otpкачества output_dir_path необходимы. -credential_id требуется только для пользователей с более чем одним сертификатом подписи документа eSigner.

Применение: DocSignTool [-hV] batch_sign_hash -access_token=<ACCESS_TOKEN> [-credential_id=<CREDENTIAL_ID>] -input_dir_path=<PATH> -output_dir_path=<PATH> -otp=<OTP>

Необязательные параметры:

• If -credential_id опущено, и у пользователя есть только один сертификат подписи документа eSigner, DocSignTool будет использовать его по умолчанию. Если у пользователя есть несколько сертификатов для подписи документов, этот параметр является обязательным.

Пример:

DocSignTool batch_sign_hash -access_token=eyJraWQiOiJmUE1yYUdlbXVMWGUtcG9JWUtLem1CMEYwYXlFczktUEpiN29lTWFlY2I0IiwiYWxnIjoiUlMyNTYifQ.eyJpc3MiOiJTU
0wuY29tIEF1dGhlbnRpY2F0aW9uIFNlcnZpY2UiLCJleHAiOjE2MTQ4OTcxNDIsImlhdCI6MTYxNDg5MzU0MiwianRpIjoiZmI2OTZlNDUtMTIzOS00ZGE4LW
I1MmYtODNkZDE2MTY3ZTM3IiwidXNlciI6eyJ1c2VyX2lkIjoxMzIyODU4LCJ1c2VyX2VtYWlsIjoiYWFyb24uZS5ydXNzZWxsQGdtYWlsLmNvbSIsInNzbF9
hY2NvdW50X2lkIjo0NzQzMDJ9LCJjbGllbnQiOnsiaWQiOiJmUE1yYUdlbXVMWGUtcG9JWUtLem1CMEYwYXlFczktUEpiN29lTWFlY2I0In19.fCKDs1igjsI
UDG2sUN_2OTb90Jw1nKNPHcD1MyEUR6sHCv_aJmcvcaFRne_eKLHzeQ9WtT5y3Fb2ppc50kMnjPG6JgX5gnFMptMn-ySsI277CtKbkSn3u-WSDSovn51jPm82
4wTeJmuXEzdv9clRjTwp6VoM9eqHCIaDAd3MP2xpMaa35cZbDaaAFKQ7jxWo9dUuTZY7DsKK0p1LloUEnmNxtNimQ3GDwkj_M600WB1zYrhDL9_3oZKaXcUx9
qzHcBCLzGgeaZ0xdpZtADxmXDUCcmkZi20yQ53bxqVL2w00sJ73efKB7JGeGWVehO-ZlGs3PUQwooox1JgEgcsA -credential_id=fe537ace-e132-52a9
-c2e7-egcd2ac3f1e6 -input_dir_path=input -output_dir_path=output -otp=142392
Batch sign hash command executed successfully. Output directory for signed files: output

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

Как протестировать DocSignTool в режиме песочницы

1. В выпуске DocSignTool перейдите к conf папку и открыть doc_sign_tool.properties файл
2. Закомментируйте существующие свойства, добавив # символ перед каждым свойством
3. Добавьте в файл следующие свойства:
   • CLIENT_ID=qOUeZCCzSqgA93acB3LYq6lBNjgZdiOxQc-KayC3UMw
   • OAUTH2_ENDPOINT=https://oauth-sandbox.ssl.com/oauth2/token
   • CSC_API_ENDPOINT=https://cs-try.ssl.com
   • TSA_URL=http://ts.ssl.com
4. Сохраните файл. После сохранения DocSignTool теперь можно использовать в режиме песочницы.
5. Чтобы вернуться в производственный режим, раскомментируйте существующие свойства и удалите свойства песочницы.

Необязательно: преобразуйте сертификат подписи документа OV в сертификат с печатью.

Примечание: Этот раздел предназначен только для пользователей, которые хотят сделать герметизацию. Чтобы автоматизировать подписание документов и избежать запроса одноразовых паролей (OTP), пользователи самостоятельно преобразуют свой сертификат подписи документа проверки организации (OV) в запечатанный сертификат в своих учетных записях SSL.com. Инструкции ниже:

1. Нажмите Заказы в верхнем меню вашей учетной записи SSL.com. 
2. Найдите свой сертификат и нажмите кнопку скачать / подробнее ссылку.
3. Нажмите УДАЛИТЬ 2ФА .