eSigner DocSignTool Командно ръководство

DocSignTool е сигурна, ориентирана към поверителността мултиплатформена Java помощна програма за команден ред за дистанционно подписване на PDF файлове с помощта eSigner удостоверения за подписване на документи. Хешовете на документите се изпращат на SSL.com за подписване, така че самият документ да не бъде изпратен. Това е идеално, когато чувствителните документи трябва да бъдат подписани, но не трябва да се изпращат по кабела за подпис. DocSignTool също е идеален за автоматизирани групови процеси за подписване на голям обем или интегриране в съществуващи работни процеси на документи.

Инсталиране на DocSignTool

За да инсталирате текущата версия на DocSignTool, просто изтеглете и разархивирайте правилния файл за вашата операционна система:

• Windows
• Linux и macOS

Имайте предвид, че изтеглянето на Windows включва Java runtime, но версията на Linux / macOS изисква Java runtime да бъде инсталиран на вашия компютър. Версията на командата за 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>: OAuth знак за достъп.
• -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>: OAuth 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_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=Хюстън, ST=Тексас, C=САЩ - Изтичане на сертификата: събота, 11 февруари 14:52:59 EST 2023 г. - DN на издателя: CN=SSL.com Клиентски сертификат Междинен CA RSA R2, O=SSL Corp, L=Хюстън , 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.

Примери:

Ръчно въвеждане на OTP с видим подпис:

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 -sig_field_position="100, 200, 150, 70" -page_no=1 -signing_location="Хюстън, Тексас" -signing_reason="одобрение на документ" -contact_info="support@ssl.com" Въведете OTP - Натиснете enter, за да продължите: 884646 PDF е подписан успешно: изход\тест .pdf

Автоматизирано генериране на OTP, без видим подпис:

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 за подписване, което позволява автоматизирано използване на инструмента. Ако този параметър не присъства, потребителят ще бъде подканен за ръчно въвеждане на 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="Хюстън, Тексас" -signing_reason="одобрение на документ" -contact_info="support@ssl.com" Въведете OTP - Натиснете enter, за да продължите: 455145 Командата за пакетно подписване е изпълнена успешно. Изходна директория за подписани файлове: изход

Въвеждане 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 без необходимите параметри ще се покаже информация за използването на командата.

партиден_знак_хеш

Хеш (и) на знака, изчислен предварително 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. Щракнете върху ПРЕМАХНЕТЕ 2FA бутон.