Narzędzie DocSign to bezpieczne, zorientowane na prywatność, wieloplatformowe narzędzie wiersza poleceń Java do zdalnego podpisywania plików PDF za pomocą e-podpisujący certyfikaty podpisywania dokumentów. Hashe dokumentów są wysyłane do SSL.com w celu podpisania, dzięki czemu sam dokument nie jest wysyłany. Jest to idealne rozwiązanie, gdy należy podpisać wrażliwe dokumenty, ale nie należy ich przesyłać drogą elektroniczną w celu podpisania. DocSignTool idealnie nadaje się również do zautomatyzowanych procesów wsadowych w przypadku podpisywania dużej liczby dokumentów lub integracji z istniejącymi przepływami dokumentów.
Jeśli zamiast tego chcesz używać programu esigner do podpisywania kodu i plików wykonywalnych, proszę zapoznaj się z tym przewodnikiem CodeSignTool.
Instalacja DocSignTool
Aby zainstalować aktualną wersję DocSignTool, po prostu pobierz i rozpakuj plik odpowiedni dla Twojego systemu operacyjnego:
Zwróć uwagę, że plik do pobrania dla systemu Windows zawiera środowisko wykonawcze Java, ale wersja dla systemu Linux/macOS wymaga zainstalowania środowiska wykonawczego Java na komputerze. Wersja polecenia dla systemu Windows jest plikiem wsadowym (DocSignTool.bat
), a wersja dla systemu Linux / macOS to skrypt powłoki (DocSignTool.sh
).
Omówienie korzystania z narzędzia DocSignTool
Stosowanie: DocSignTool [-hV] [COMMAND] [PARAMETERS]
Opcje:
-h
,--help
: Wyświetla komunikat pomocy i wychodzi.-V
,--version
: Wyświetl informacje o wersji i zakończ.
polecenia:
get_credential_ids
: wyślij listę identyfikatorów poświadczeń eSigner powiązanych z określonym użytkownikiem.credential_info
: Dane wyjściowe klucza i certyfikatu związane z identyfikatorem poświadczeń.sign
: Podpisz i sygnatury czasowej filtr PDF.batch_sign
: Podpisz i oznacz czasowo wiele plików PDF za pomocą jednego OTP.hash
: Wstępnie oblicz skrót(y) do późniejszego użycia zbatch_hash_sign
dowództwo.batch_sign_hash
: Podpisz hash(y) wstępnie obliczone za pomocąhash
dowództwo.
Parametry:
-access_token=<TOKEN>
: Autoryzacja OAuth token dostępu.-contact_info=<CONTACT_INFO>
: Informacje kontaktowe.-credential_id=<CREDENTIAL_ID>
: Identyfikator poświadczeń do podpisywania certyfikatu.-input_dir_path=<PATH>
: Katalog wejściowy dla plików PDF do podpisania, obliczenia skrótów lub wybranie niepodpisanych plików i odpowiednich skrótów do podpisania.-input_file_path=<PATH>
: Ścieżka pliku PDF do podpisania.-otp=<OTP>
: wartość OAuth OTP z aplikacji uwierzytelniającej.-output_dir_path=<PATH>
: Katalog, w którym zostaną zapisane podpisane pliki PDF.-page_no=<PAGE_NUMBER>
: Strona dokumentu PDF, na której pojawi się widoczny podpis.-password=<PASSWORD>
: Hasło do konta SSL.com.-sig_field_position=<X, Y, WIDTH, HEIGHT>
: Pozycja widocznego podpisu w pliku PDF.-signing_location=<SIGNING_LOCATION>
: Miejsce podpisania dokumentu.signing_reason=<SIGNING_REASON>
: Powód podpisania.-totp_secret=<TOTP_SECRET>
: Autoryzacja OAuth Sekret TOTP-username=<USERNAME>
: Nazwa użytkownika konta SSL.com
-password="P!@^^ssword12"
).Polecenia DocSignTool
get_credential_ids
Wyświetl listę identyfikatorów poświadczeń eSigner powiązanych z określonym użytkownikiem. Parametry -username
i -password
są wymagane.
Stosowanie: DocSignTool [-hV] get_credential_ids -username=<USERNAME> -password=<PASSWORD>
Przykład:
DocSignTool get_credential_ids -username=john.doe@example.com -password="P0z9@lxo41" Credential ID(s): - fe537ace-e132-52a9-c2e7-egcd2ac3f1e6
Wprowadzanie DocSignTool get_credential_ids
bez wymaganych parametrów wyświetli informacje o użyciu dla polecenia.
dane_dane uwierzytelniające
Wyprowadź informacje o kluczu i certyfikacie związane z identyfikatorem poświadczeń. Parametry -credential_id
, -username
, -password
są wymagane.
Stosowanie: DocSignTool [-hV] credential_info -credential_id=<CREDENTIAL_ID> -username=<USERNAME> -password=<PASSWORD>
Przykład:
DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Podpisywanie informacji o podmiocie certyfikatu: - DN podmiotu: CN=JOHN DOE, O=SSL Corp , L=Houston, ST=Texas, C=US — Data wygaśnięcia certyfikatu: Sobota 11 lutego 14:52:59 EST 2023 — Nazwa wyróżniająca wystawcy: CN=SSL.com Certyfikat klienta Intermediate CA RSA R2, O=SSL Corp, L=Houston , ST=Teksas, C=USA
Wprowadzanie DocSignTool credential_info
bez wymaganych parametrów wyświetli informacje o użyciu dla polecenia.
znak
Podpisz i sygnaturę czasową pliku PDF. Parametry -username
, -password
, -input_file_path
są wymagane. -credential_id
jest wymagane tylko dla użytkowników z więcej niż jednym certyfikatem do podpisywania dokumentów eSigner. -output_dir_path
, -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, -page_no
, -totp_secret
są opcjonalne.
Stosowanie: 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>]
Parametry opcjonalne:
- If
-credential_id
zostanie pominięty, a użytkownik ma tylko jeden certyfikat do podpisywania dokumentów eSigner, DocSignTool domyślnie to zrobi. Jeśli użytkownik ma więcej niż jeden certyfikat do podpisywania dokumentów, ten parametr jest obowiązkowy. - If
-output_dir_path
jest pominięty, plik określony w-input_file_path
zostanie nadpisany podpisanym plikiem. DocSignTool wyświetli monit przed nadpisaniem pliku. - If
-signing_location
jest obecny, określona lokalizacja zostanie dodana do podpisu cyfrowego. - If
-signing_reason
jest obecny, podany powód podpisania zostanie dodany do podpisu cyfrowego. - If
-contact_info
jest obecny, określony tekst zostanie dodany do podpisu cyfrowego. Chociaż są dołączone do podpisu, informacje te nie zostaną uwzględnione w widocznej adnotacji podpisu (jeśli jest obecny). - If
-sig_field_position
jest obecny, widoczna adnotacja podpisu zostanie dodana do dokumentu na stronie określonej przez-page_no
. Stanowisko i podpis należy podać w formacie"x, y, width, height"
. -page_no
jest wymagane tylko przy tworzeniu widocznego podpisu za pomocą-sig_field_position
i określa stronę dokumentu, na której pojawi się widoczna adnotacja podpisu.- If
-totp_secret
jest obecny, DocSignTool obliczy czas OTP do podpisywania, umożliwiając zautomatyzowane korzystanie z narzędzia. Jeśli ten parametr nie jest obecny, użytkownik zostanie poproszony o ręczne wprowadzenie OTP.
Przykłady:
Ręczny wpis OTP z widocznym podpisem:
Znak DocSignTool -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=jan.doe@example.com -password="P0z9@lxo41" -output_dir_path=signed -input_file_path=test.pdf -100, 200, pozycja_ 150, 70" -page_no=1 -signing_location="Houston, Teksas" -signing_reason="zatwierdzenie dokumentu" -contact_info="support@ssl.com" Wprowadź OTP - naciśnij enter, aby kontynuować: 884646 PDF podpisany pomyślnie: output\test.pdf
Automatyczne generowanie OTP, brak widocznego podpisu:
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
Wprowadzanie DocSignTool sign
bez wymaganych parametrów wyświetli informacje o użyciu dla polecenia.
Error: invalid otp
podczas próby podpisania pliku może to być spowodowane co najmniej jednym z następujących problemów:
- Kod QR zeskanowany do aplikacji uwierzytelniającej nie pasuje do nazwy użytkownika, hasła i / lub identyfikatora poświadczenia z polecenia. Może się to zdarzyć, jeśli:
- Masz wiele kont skonfigurowanych dla 2FA na swoim urządzeniu i wybrałeś niewłaściwe.
- Próbujesz użyć swoich danych logowania do domeny wspólny certyfikat, ale zeskanował kod QR udostępniony przez członka zespołu z jego konta.
- Podane hasło jednorazowe już wygasło.
- Twoje polecenie zawiera nieprawidłowy sekret TOTP.
znak_wsadu
Podpisz i oznacz czasowo do 100 plików PDF za pomocą jednego OTP. Parametry -username
, -password
, -input_dir_path
są wymagane. -credential_id
jest wymagane tylko dla użytkowników z więcej niż jednym certyfikatem do podpisywania dokumentów eSigner. -output_dir_path
, -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, -page_no
, -totp_secret
są opcjonalne.
Stosowanie: 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>]
Parametry opcjonalne:
- If
-credential_id
zostanie pominięty, a użytkownik ma tylko jeden certyfikat do podpisywania dokumentów eSigner, DocSignTool domyślnie to zrobi. Jeśli użytkownik ma więcej niż jeden certyfikat do podpisywania dokumentów, ten parametr jest obowiązkowy. - If
-output_dir_path
pominięto, pliki określone w-input_dir_path
zostaną zastąpione podpisanymi plikami. DocSignTool wyświetli monit przed nadpisaniem plików. - If
-signing_location
jest obecny, określona lokalizacja zostanie dodana do podpisów cyfrowych. - If
-signing_reason
jest obecny, podany powód podpisania zostanie dodany do podpisów cyfrowych. - If
-contact_info
jest obecny, określony tekst zostanie dodany do sygnatur cyfrowych. Chociaż są dołączone do podpisu, informacje te nie zostaną uwzględnione w widocznych adnotacjach podpisu (jeśli są obecne). - If
-sig_field_position
jest obecny, widoczna adnotacja podpisu zostanie dodana do dokumentów na stronie określonej przez-page_no
. Stanowisko i podpis należy podać w formacie"x, y, width, height"
. -page_no
jest wymagane tylko przy tworzeniu widocznego podpisu za pomocą-sig_field_position
i określa stronę dokumentów, na której pojawią się widoczne adnotacje podpisu.- If
-totp_secret
jest obecny, DocSignTool obliczy czas OTP do podpisywania, umożliwiając zautomatyzowane korzystanie z narzędzia. Jeśli ten parametr nie jest obecny, użytkownik zostanie poproszony o ręczne wprowadzenie OTP.
Przykład:
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" Wprowadź OTP - naciśnij enter, aby kontynuować: 455145 Polecenie podpisywania wsadowego wykonane pomyślnie. Katalog wyjściowy dla podpisanych plików: wyjście
Wprowadzanie DocSignTool batch_sign
bez wymaganych parametrów wyświetli informacje o użyciu dla polecenia.
haszysz
- Do manipulowania plikiem PDF w celu wprowadzenia skrótu i późniejszego osadzenia PKCS#7 w dokumencie PDF potrzebna jest biblioteka PDF. (np. ApachePDFBox w Javie).
- Biblioteka Crypto do tworzenia PKCS#7 z surowych podpisów otrzymanych z API eSigner (np. BouncyCastle w Javie).
Wstępnie oblicz skrót(y) do późniejszego użycia z batch_hash_sign
Komenda. Parametry -access_token
i -input_dir_path
są wymagane. -credential_id
jest wymagane tylko dla użytkowników z więcej niż jednym certyfikatem do podpisywania dokumentów eSigner. -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, -page_no
, są opcjonalne.
Stosowanie: 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>]
Parametry opcjonalne:
- If
-program_name
jest obecny podczas podpisywania instalatora MSI, wartość zostanie wyświetlona w oknie dialogowym potwierdzenia jako nazwa programu. - If
-signing_location
jest obecny, określona lokalizacja zostanie dodana do podpisów cyfrowych podczas ich generowania. - If
-signing_reason
jest obecny, określony powód podpisania zostanie dodany do podpisów cyfrowych podczas ich generowania. - If
-contact_info
jest obecny, określony tekst zostanie dodany do sygnatur cyfrowych podczas ich generowania. Chociaż są dołączone do podpisu, informacje te nie zostaną uwzględnione w widocznych adnotacjach podpisu (jeśli są obecne). - If
-sig_field_position
jest obecny, widoczna adnotacja podpisu zostanie dodana do dokumentów na stronie określonej przez-page_no
kiedy podpisy są generowane. Stanowisko i podpis należy podać w formacie"x, y, width, height"
. -page_no
jest wymagane tylko przy tworzeniu widocznego podpisu za pomocą-sig_field_position
i określa stronę dokumentów, na których widoczne będą adnotacje podpisu podczas ich generowania.
Przykład:
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
Wprowadzanie DocSignTool hash
bez wymaganych parametrów wyświetli informacje o użyciu dla polecenia.
wsadowy_znak_hash
Podpisz hash(y) wstępnie obliczone za pomocą hash
Komenda. Parametry -access_token
, input_dir_path
, -otp
, output_dir_path
są wymagane. -credential_id
jest wymagane tylko dla użytkowników z więcej niż jednym certyfikatem do podpisywania dokumentów eSigner.
Stosowanie: DocSignTool [-hV] batch_sign_hash -access_token=<ACCESS_TOKEN> [-credential_id=<CREDENTIAL_ID>] -input_dir_path=<PATH> -output_dir_path=<PATH> -otp=<OTP>
Parametry opcjonalne:
- If
-credential_id
zostanie pominięty, a użytkownik ma tylko jeden certyfikat do podpisywania dokumentów eSigner, DocSignTool domyślnie to zrobi. Jeśli użytkownik ma więcej niż jeden certyfikat do podpisywania dokumentów, ten parametr jest obowiązkowy.
Przykład:
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
Wprowadzanie DocSignTool batch_sign_hash
bez wymaganych parametrów wyświetli informacje o użyciu dla polecenia.
Jak przetestować DocSignTool w trybie piaskownicy
- W wersji DocSignTool przejdź do
conf
folder i otwórzdoc_sign_tool.properties
filet - Skomentuj istniejące właściwości, dodając
#
symbol przed każdą właściwością - Dodaj następujące właściwości w pliku:
CLIENT_ID
=qOUeZCCzSqgA93acB3LYq6lBNjgZdiOxQc-KayC3UMwOAUTH2_ENDPOINT
=https://oauth-sandbox.ssl.com/oauth2/tokenCSC_API_ENDPOINT
=https://cs-try.ssl.comTSA_URL
=http://ts.ssl.com
- Zapisz plik. Po zapisaniu DocSignTool może być teraz używany w trybie piaskownicy.
- Aby wrócić do trybu produkcyjnego, odkomentuj istniejące właściwości i usuń właściwości piaskownicy.
Opcjonalnie: Przekonwertuj swój certyfikat podpisywania dokumentu OV na certyfikat zapieczętowania
Uwaga: Ta sekcja jest przeznaczona tylko dla użytkowników, którzy chcą wykonać zapieczętowanie. Aby zautomatyzować podpisywanie dokumentów i uniknąć monitów o hasła jednorazowe (OTP), użytkownicy samodzielnie konwertują swój certyfikat podpisywania dokumentów OV (Organization Validation) na certyfikat zapieczętowania na swoich kontach SSL.com. Instrukcje znajdują się poniżej:
- Kliknij Zamówienia w górnym menu Twojego konta SSL.com.
- Znajdź swój certyfikat i kliknij przycisk pobierz / szczegóły łącze.
- Kliknij USUŃ 2FA przycisk.