DocSignTool je bezpečný multiplatformní nástroj příkazového řádku Java zaměřený na soukromí pro vzdálené podepisování souborů PDF pomocí eSigner certifikáty pro podepisování dokumentů. Hashe dokumentů se odesílají na SSL.com k podpisu, aby nebyl odeslán samotný dokument. To je ideální tam, kde je třeba podepsat citlivé dokumenty, ale neměly by se k podpisu posílat po drátě. DocSignTool je také ideální pro automatizované dávkové procesy pro velkoobjemové podepisování nebo integraci do stávajících pracovních toků dokumentů.
Pokud chcete místo toho použít esigner k podepisování kódu a spustitelných souborů, prosím viz tento průvodce CodeSignTool.
Instalace DocSignTool
Chcete-li nainstalovat aktuální verzi DocSignTool, jednoduše stáhněte a rozbalte správný soubor pro váš operační systém:
Stahování systému Windows zahrnuje prostředí Java runtime, ale verze pro systémy Linux / macOS vyžaduje, aby byl v počítači nainstalován prostředí Java runtime. Verze příkazu pro Windows je dávkový soubor (DocSignTool.bat
) a verze pro Linux / macOS je shell skript (DocSignTool.sh
).
Přehled použití DocSignTool
Použití: DocSignTool [-hV] [COMMAND] [PARAMETERS]
Varianty:
-h
,--help
: Zobrazení nápovědy a ukončení.-V
,--version
: Zobrazení informací o verzi a ukončení.
příkazy:
get_credential_ids
: Vytvoří seznam ID identifikačních údajů eSigneru přidružených ke konkrétnímu uživateli.credential_info
: Výstupní klíč a informace o certifikátu související s ID pověření.sign
: Podpis a časové razítko PDF filr.batch_sign
: Podepisujte a časová razítka více souborů PDF pomocí jednoho OTP.hash
: Předpočítané hodnoty hash pro pozdější použití sbatch_hash_sign
příkaz.batch_sign_hash
: Podepsat hash předpočítaný pomocíhash
příkaz.
parametry:
-access_token=<TOKEN>
: OAuth přístupový token.-contact_info=<CONTACT_INFO>
: Kontaktní informace.-credential_id=<CREDENTIAL_ID>
: ID pověření pro podpis certifikátu.-input_dir_path=<PATH>
: Vstupní adresář pro soubory PDF, které mají být podepsány, které mají vypočítané hodnoty hash, nebo vybrat nepodepsané soubory a odpovídající hodnoty hash pro podpis.-input_file_path=<PATH>
: Cesta k souboru PDF, který má být podepsán.-otp=<OTP>
: Hodnota OTP protokolu OAuth z ověřovací aplikace.-output_dir_path=<PATH>
: Adresář, do kterého budou zapsány podepsané soubory PDF.-page_no=<PAGE_NUMBER>
: Stránka dokumentu PDF, na které se objeví viditelný podpis.-password=<PASSWORD>
: Heslo účtu SSL.com.-sig_field_position=<X, Y, WIDTH, HEIGHT>
: Poloha viditelného podpisu v PDF.-signing_location=<SIGNING_LOCATION>
: Místo, kde je dokument podepsán.signing_reason=<SIGNING_REASON>
: Důvod podpisu.-totp_secret=<TOTP_SECRET>
: OAuth TOTP tajemství-username=<USERNAME>
: Uživatelské jméno účtu SSL.com
-password="P!@^^ssword12"
).Příkazy DocSignTool
get_credential_ids
Výstup seznamu identifikátorů pověření eSigner přidružených ke konkrétnímu uživateli. Parametry -username
a -password
jsou povinné.
Použití: DocSignTool [-hV] get_credential_ids -username=<USERNAME> -password=<PASSWORD>
Příklad:
DocSignTool get_credential_ids -username=john.doe@example.com -password="P0z9@lxo41" Credential ID(s): - fe537ace-e132-52a9-c2e7-egcd2ac3f1e6
Zadání DocSignTool get_credential_ids
bez požadovaných parametrů zobrazí informace o použití příkazu.
pověření_info
Výstupní klíč a informace o certifikátu související s ID pověření. Parametry -credential_id
, -username
, a -password
jsou povinné.
Použití: DocSignTool [-hV] credential_info -credential_id=<CREDENTIAL_ID> -username=<USERNAME> -password=<PASSWORD>
Příklad:
DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Informace o předmětu podpisového certifikátu: - Subject DN: DOECN,=OJOHN , L=Houston, ST=Texas, C=US – Vypršení platnosti certifikátu: So 11. února 14:52:59 EST 2023 – DN vydavatele: CN=SSL.com Zprostředkující klientský certifikát CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=US
Zadání DocSignTool credential_info
bez požadovaných parametrů zobrazí informace o použití příkazu.
podepsat
Podepsat a časově označit soubor PDF. Parametry -username
, -password
, a -input_file_path
jsou povinné. -credential_id
je vyžadováno pouze pro uživatele s více než jedním certifikátem pro podepisování dokumentů eSigner. -output_dir_path
, -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, -page_no
, a -totp_secret
jsou volitelné.
Použití: 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>]
Volitelné parametry:
- If
-credential_id
je vynechán a uživatel má pouze jeden podpisový certifikát dokumentu eSigner, DocSignTool to nastaví jako výchozí. Pokud má uživatel více než jeden certifikát pro podepisování dokumentů, je tento parametr povinný. - If
-output_dir_path
je vynechán, soubor uvedený v-input_file_path
bude přepsán podepsaným souborem. DocSignTool vyzve uživatele před přepsáním souboru. - If
-signing_location
je k dispozici, bude k digitálnímu podpisu přidáno zadané umístění. - If
-signing_reason
je přítomen, do digitálního podpisu bude přidán specifikovaný důvod podpisu. - If
-contact_info
je k dispozici, bude zadaný text přidán k digitálnímu podpisu. Ačkoli jsou tyto informace součástí podpisu, nebudou zahrnuty do viditelné anotace podpisu (je-li k dispozici). - If
-sig_field_position
je k dispozici, bude k dokumentu na stránce určené uživatelem přidána viditelná anotace podpisu-page_no
. Pozice a podpis by měly být dodány ve formátu"x, y, width, height"
. -page_no
je vyžadováno pouze při vytváření viditelného podpisu pomocí-sig_field_position
a určuje stránku dokumentu, na které se objeví poznámka viditelného podpisu.- If
-totp_secret
DocSignTool vypočítá časově závislé OTP pro podepisování, což umožní automatické použití nástroje. Pokud tento parametr není k dispozici, bude uživatel vyzván k ručnímu zadání OTP.
Příklady:
Ruční zadání OTP s viditelným podpisem:
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 = "test.pdf-test" 100, 200 "-page_no = 150 -signing_location =" Houston, Texas "-signing_reason =" schválení dokumentu "-contact_info ="support@ssl.com"Zadejte OTP - pokračujte stisknutím klávesy Enter: 884646 PDF podepsáno úspěšně: output \ test.pdf
Automatizované generování OTP, bez viditelného 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
Zadání DocSignTool sign
bez požadovaných parametrů zobrazí informace o použití příkazu.
Error: invalid otp
při pokusu o podepsání souboru to může být způsobeno jedním nebo více z těchto problémů:
- QR kód, který jste naskenovali do své ověřovací aplikace, se neshoduje s uživatelským jménem, heslem nebo ID pověření z vašeho příkazu. K tomu může dojít, pokud:
- Ve svém zařízení máte nakonfigurováno více účtů pro 2FA a vybrali jste nesprávný.
- Pokoušíte se použít své přihlašovací údaje pro a sdílený certifikát, ale naskenovali QR kód sdílený týmovým kolegou ze svého účtu.
- Zadané OTP již vypršelo.
- Váš příkaz obsahuje neplatné tajemství TOTP.
batch_sign
Podepisujte a časová razítka až 100 souborů PDF pomocí jednoho OTP. Parametry -username
, -password
, a -input_dir_path
jsou povinné. -credential_id
je vyžadováno pouze pro uživatele s více než jedním certifikátem pro podepisování dokumentů eSigner. -output_dir_path
, -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, -page_no
, a -totp_secret
jsou volitelné.
Použití: 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>]
Volitelné parametry:
- If
-credential_id
je vynechán a uživatel má pouze jeden podpisový certifikát dokumentu eSigner, DocSignTool to nastaví jako výchozí. Pokud má uživatel více než jeden certifikát pro podepisování dokumentů, je tento parametr povinný. - If
-output_dir_path
je vynechán, soubory uvedené v-input_dir_path
bude přepsán podepsanými soubory. DocSignTool vyzve uživatele před přepsáním souborů. - If
-signing_location
je k dispozici, bude zadané umístění přidáno k digitálním podpisům. - If
-signing_reason
je přítomen, k digitálním podpisům bude přidán specifikovaný důvod podpisu. - If
-contact_info
je k dispozici, bude zadaný text přidán k digitálním podpisům. Přestože jsou tyto informace součástí podpisu, nebudou zahrnuty do viditelných anotací podpisu (jsou-li k dispozici). - If
-sig_field_position
je k dispozici, bude k dokumentům na stránce určené uživatelem přidána viditelná anotace podpisu-page_no
. Pozice a podpis by měly být dodány ve formátu"x, y, width, height"
. -page_no
je vyžadováno pouze při vytváření viditelného podpisu pomocí-sig_field_position
a určuje stránku dokumentů, na kterých se objeví viditelné poznámky podpisu.- If
-totp_secret
DocSignTool vypočítá časově závislé OTP pro podepisování, což umožní automatické použití nástroje. Pokud tento parametr není k dispozici, bude uživatel vyzván k ručnímu zadání OTP.
Příklad:
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"Zadejte OTP - pokračujte stisknutím klávesy enter: 455145 Příkaz dávkového podpisu byl úspěšně proveden. Výstupní adresář pro podepsané soubory: výstup
Zadání DocSignTool batch_sign
bez požadovaných parametrů zobrazí informace o použití příkazu.
hašiš
- K manipulaci s PDF pro vstup hash a pozdějšímu vložení PKCS#7 do dokumentu PDF je potřeba knihovna PDF. (např. ApachePDFBox v Javě).
- Knihovna Crypto pro vytváření PKCS#7 z nezpracovaných podpisů přijatých z eSigner API (např. BouncyCastle v Javě).
Předběžně vypočítat hash pro pozdější použití s batch_hash_sign
příkaz. Parametry -access_token
a -input_dir_path
jsou povinné. -credential_id
je vyžadováno pouze pro uživatele s více než jedním certifikátem pro podepisování dokumentů eSigner. -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, a -page_no
, jsou volitelné.
Použití: 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>]
Volitelné parametry:
- If
-program_name
je k dispozici při podepisování instalačního programu MSI, hodnota se zobrazí v potvrzovacím dialogu jako název programu. - If
-signing_location
je k dispozici, bude zadané umístění přidáno k digitálním podpisům, jakmile budou vytvořeny. - If
-signing_reason
je přítomen, přidaný důvod podpisu bude přidán k digitálním podpisům při jejich generování. - If
-contact_info
je k dispozici, bude zadaný text přidán k digitálním podpisům, jakmile budou generovány. Ačkoli jsou tyto informace součástí podpisu, nebudou zahrnuty do viditelných anotací podpisu (jsou-li k dispozici). - If
-sig_field_position
je k dispozici, bude k dokumentům na stránce určené uživatelem přidána viditelná anotace podpisu-page_no
při generování podpisů. Pozice a podpis by měly být dodány ve formátu"x, y, width, height"
. -page_no
je vyžadováno pouze při vytváření viditelného podpisu pomocí-sig_field_position
a určuje stránku dokumentů, na kterých se při generování budou zobrazovat poznámky viditelného podpisu.
Příklad:
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
Zadání DocSignTool hash
bez požadovaných parametrů zobrazí informace o použití příkazu.
batch_sign_hash
Podepsat hash předpočítaný pomocí hash
příkaz. Parametry -access_token
, input_dir_path
, -otp
, a output_dir_path
jsou povinné. -credential_id
je vyžadováno pouze pro uživatele s více než jedním certifikátem pro podepisování dokumentů eSigner.
Použití: DocSignTool [-hV] batch_sign_hash -access_token=<ACCESS_TOKEN> [-credential_id=<CREDENTIAL_ID>] -input_dir_path=<PATH> -output_dir_path=<PATH> -otp=<OTP>
Volitelné parametry:
- If
-credential_id
je vynechán a uživatel má pouze jeden podpisový certifikát dokumentu eSigner, DocSignTool to nastaví jako výchozí. Pokud má uživatel více než jeden certifikát pro podepisování dokumentů, je tento parametr povinný.
Příklad:
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
Zadání DocSignTool batch_sign_hash
bez požadovaných parametrů zobrazí informace o použití příkazu.
Jak otestovat DocSignTool v režimu sandbox
- Ve verzi DocSignTool přejděte na
conf
a otevřetedoc_sign_tool.properties
soubor - Přidáním okomentujte stávající vlastnosti
#
symbol před každou nemovitostí - Přidejte do souboru následující vlastnosti:
CLIENT_ID
=qOUeZCCzSqgA93acB3LYq6lBNjgZdiOxQc-KayC3UMwOAUTH2_ENDPOINT
=https://oauth-sandbox.ssl.com/oauth2/tokenCSC_API_ENDPOINT
=https://cs-try.ssl.comTSA_URL
=http://ts.ssl.com
- Uložte soubor. Po uložení lze nyní DocSignTool používat v režimu sandbox.
- Chcete-li přepnout zpět do produkčního režimu, odkomentujte stávající vlastnosti a odstraňte vlastnosti karantény.
Volitelné: Převeďte svůj certifikát podpisu dokumentů OV na certifikát esealing
Poznámka: Tato sekce je pouze pro uživatele, kteří chtějí provádět těsnění. Aby uživatelé automatizovali podepisování dokumentů a nemuseli být vyzváni k zadání jednorázových hesel (OTP), uživatelé sami převedou svůj certifikát pro podepisování dokumentů pro ověření organizace (OV) na certifikát esealing na svých účtech SSL.com. Pokyny jsou uvedeny níže:
- klikněte Objednávky v horní nabídce vašeho účtu SSL.com.
- Najděte svůj certifikát a klikněte na stáhnout / podrobnosti odkaz.
- Klepněte na tlačítko ODSTRANIT 2FA .