eSigner DocSignTool kommandoguide

DocSignTool är ett säkert, integritetsorienterat Java-kommandoradsverktyg med flera plattformar för fjärrsignering av PDF-filer med eSigner dokumentsigneringscertifikat. Hashes av dokumenten skickas till SSL.com för signering så att själva dokumentet inte skickas. Detta är idealiskt där känsliga dokument behöver undertecknas, men bör inte skickas över tråden för signering. DocSignTool är också idealiskt för automatiserade batchprocesser för signering av stora volymer eller integration i befintliga dokumentarbetsflöden.

Installation av DocSignTool

För att installera den aktuella versionen av DocSignTool, ladda ner och packa upp rätt fil för ditt operativsystem:

• Windows
• Linux och macOS

Observera att Windows-nedladdningen inkluderar Java-körning, men Linux / macOS-versionen kräver att Java-körning är installerad på din dator. Windows-versionen av kommandot är en batchfil (DocSignTool.bat) och Linux / macOS-versionen är ett skalskript (DocSignTool.sh).

DocSignTool Användningsöversikt

Användning: DocSignTool [-hV] [COMMAND] [PARAMETERS]

Alternativ:

• -h, --help: Visa hjälpmeddelande och avsluta.
• -V, --version: Visa versioninformation och avsluta.

kommandon:

• get_credential_ids: Mata ut listan över eSigners referens-ID som är associerade med en viss användare.
• credential_info: Utmatningsnyckel och certifikatinformation relaterat till ett referens-ID.
• sign: Tecken och tidsstämpel PDF filr.
• batch_sign: Signera och tidsstämpla flera PDF-filer med en OTP.
• hash: Förberäkna hash (er) för senare användning med batch_hash_sign kommando.
• batch_sign_hash: Sign hash (s) förberäknas med hash kommando.

Parametrar:

• -access_token=<TOKEN>: OAuth access token.
• -contact_info=<CONTACT_INFO>: Kontaktinformation.
• -credential_id=<CREDENTIAL_ID>: Inloggnings-ID för signeringscertifikat.
• -input_dir_path=<PATH>: Inmatningskatalog för PDF-filer som ska signeras, har hashberäknats eller välj osignerade filer och motsvarande hashes för signering.
• -input_file_path=<PATH>: Sökvägen till PDF-filen som ska signeras.
• -otp=<OTP>: OAuth OTP-värde från autentiseringsapp.
• -output_dir_path=<PATH>: Katalog där signerade PDF-filer skrivs.
• -page_no=<PAGE_NUMBER>: Sida i PDF-dokument där synlig signatur kommer att visas.
• -password=<PASSWORD>: SSL.com-kontolösenord.
• -sig_field_position=<X, Y, WIDTH, HEIGHT>: Position för synlig signatur på PDF.
• -signing_location=<SIGNING_LOCATION>: Plats där dokumentet är undertecknat.
• signing_reason=<SIGNING_REASON>: Anledning till signering.
• -totp_secret=<TOTP_SECRET>: OAuth TOTP-hemlighet
• -username=<USERNAME>: SSL.com-konto användarnamn

DocSignTool-kommandon

get_credential_ids

Mata ut listan över eSigners autentiserings-ID som är associerade med en viss användare. Parametrar -username och -password krävs.

Användning: DocSignTool [-hV] get_credential_ids -username=<USERNAME> -password=<PASSWORD>

Exempelvis:

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

Skriva DocSignTool get_credential_ids utan nödvändiga parametrar visar användningsinformation för kommandot.

credential_info

Utgångsnyckel och certifikatinformation relaterat till ett referens-ID. Parametrar -credential_id, -usernameoch -password krävs.

Användning: DocSignTool [-hV] credential_info -credential_id=<CREDENTIAL_ID> -username=<USERNAME> -password=<PASSWORD>

Exempelvis:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Undertecknande certifikat Ämneinformation: - Ämne=OJOHNS Corp. , L=Houston, ST=Texas, C=US - Certifikatets utgång: lör 11 feb 14:52:59 EST 2023 - Utfärdarens DN: CN=SSL.com Klientcertifikat Mellanliggande CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=US

Skriva DocSignTool credential_info utan nödvändiga parametrar visar användningsinformation för kommandot.

signera

Underteckna och tidsstämpla PDF-fil. Parametrar -username, -passwordoch -input_file_path krävs. -credential_id krävs endast för användare med mer än ett eSigner-signeringscertifikat. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_nooch -totp_secret är valfria.

Användning: 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>]

Valfria parametrar:

• If -credential_id har utelämnats och användaren har bara ett eSigner-dokumentsigneringscertifikat kommer DocSignTool att vara standard. Om användaren har mer än ett dokumentsigneringscertifikat är denna parameter obligatorisk.
• If -output_dir_path utelämnas, anges filen i -input_file_path skrivs över med den signerade filen. DocSignTool kommer att uppmana användaren innan filen skrivs över.
• If -signing_location är närvarande kommer den angivna platsen att läggas till i den digitala signaturen.
• If -signing_reason är närvarande kommer anledningen till den angivna signeringen att läggas till i den digitala signaturen.
• If -contact_info är närvarande kommer den angivna texten att läggas till i den digitala signaturen. Även om den ingår i signaturen kommer denna information inte att inkluderas i den synliga signaturanteckningen (om den finns).
• If -sig_field_position är närvarande, läggs en synlig signaturanteckning till dokumentet på den sida som anges av -page_no. Positionen och signaturen ska anges i formatet "x, y, width, height".
• -page_no krävs endast när du skapar en synlig signatur med -sig_field_position och specificerar den sida i dokumentet som den synliga signaturanteckningen kommer att visas på.
• If -totp_secret är närvarande kommer DocSignTool att beräkna en tidsbaserad OTP för signering, vilket möjliggör automatisk användning av verktyget. Om denna parameter inte finns kommer användaren att uppmanas att manuellt skriva in OTP.

Exempel:

Manuell OTP-inmatning med synlig signatur:

DocSignTool-tecken -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -användarnamn=john.doe@example.com -password="P0z9@lxo41" -output_dir_path=signed -input_file_position=sig_100,pdf_position=sig_200 150, 70" -page_no=1 -signing_location="Houston, Texas" -signing_reason="dokumentgodkännande" -contact_info="support@ssl.com" Ange OTP - Tryck på enter för att fortsätta: 884646 PDF signerad framgångsrikt: output\test .pdf

Automatiserad OTP-generering, ingen synlig signatur:

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

Skriva DocSignTool sign utan nödvändiga parametrar visar användningsinformation för kommandot.

batch_sign

Signera och tidsstämpla upp till 100 PDF-filer med en OTP. Parametrar -username, -passwordoch -input_dir_path krävs. -credential_id krävs endast för användare med mer än ett eSigner-signeringscertifikat. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_nooch -totp_secret är valfria.

Användning: 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>]

Valfria parametrar:

• If -credential_id har utelämnats och användaren har bara ett eSigner-dokumentsigneringscertifikat kommer DocSignTool att vara standard. Om användaren har mer än ett dokumentsigneringscertifikat är denna parameter obligatorisk.
• If -output_dir_path utelämnas, filerna som anges i -input_dir_path kommer att skrivas över med de signerade filerna. DocSignTool kommer att fråga användaren innan filerna skrivs över.
• If -signing_location är närvarande kommer den angivna platsen att läggas till de digitala signaturerna.
• If -signing_reason är närvarande kommer anledningen till den angivna signeringen att läggas till de digitala signaturerna.
• If -contact_info är närvarande kommer den angivna texten att läggas till de digitala signaturerna. Även om den ingår i signaturen kommer denna information inte att inkluderas i de synliga signaturanteckningarna (om de finns).
• If -sig_field_position är närvarande, läggs en synlig signaturanteckning till dokumenten på den sida som anges av -page_no. Positionen och signaturen ska anges i formatet "x, y, width, height".
• -page_no krävs endast när du skapar en synlig signatur med -sig_field_position och specificerar sidan med de dokument som de synliga signaturanteckningarna kommer att visas på.
• If -totp_secret är närvarande kommer DocSignTool att beräkna en tidsbaserad OTP för signering, vilket möjliggör automatisk användning av verktyget. Om denna parameter inte finns kommer användaren att uppmanas att manuellt skriva in OTP.

Exempelvis:

DocSignTool batch_sign -username=john.doe@example.com -password="P0z9@lxo41" -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -input_dir_path=input -output_dir_100,=output_dir_200,=output_dir_150,=output_dir_70 1" -page_no=455145 -signing_location="Houston, Texas" -signing_reason="dokumentgodkännande" -contact_info="support@ssl.com" Ange OTP - Tryck på enter för att fortsätta: XNUMX Batch sign-kommando utfördes framgångsrikt. Utdatakatalog för signerade filer: output

Skriva DocSignTool batch_sign utan nödvändiga parametrar visar användningsinformation för kommandot.

hash

Förberäkna hash (er) för senare användning med batch_hash_sign kommando. Parametrar -access_token och -input_dir_path krävs. -credential_id krävs endast för användare med mer än ett eSigner-signeringscertifikat. -signing_location, -signing-reason, -contact_info,  -sig_field_positionoch -page_no, är valfria.

Användning: 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>]

Valfria parametrar:

• If -program_name är närvarande när du signerar ett MSI-installationsprogram, kommer värdet att visas i bekräftelsedialogen som programnamn.
• If -signing_location är närvarande kommer den angivna platsen att läggas till de digitala signaturerna när de genereras.
• If -signing_reason är närvarande kommer anledningen till den angivna signeringen att läggas till de digitala signaturerna när de genereras.
• If -contact_info är närvarande kommer den angivna texten att läggas till de digitala signaturerna när de genereras. Även om den ingår i signaturen kommer denna information inte att inkluderas i de synliga signaturanteckningarna (om de finns).
• If -sig_field_position är närvarande, läggs en synlig signaturanteckning till dokumenten på den sida som anges av -page_no när signaturerna genereras. Positionen och signaturen ska anges i formatet "x, y, width, height".
• -page_no krävs endast när du skapar en synlig signatur med -sig_field_position och specificerar sidan med de dokument som de synliga signaturanteckningarna kommer att visas på när de genereras.

Exempelvis:

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

Skriva DocSignTool hash utan nödvändiga parametrar visar användningsinformation för kommandot.

batch_sign_hash

Tecken hash (s) förberäknas med hash kommando. Parametrar -access_token, input_dir_path, -otpoch output_dir_path krävs. -credential_id krävs endast för användare med mer än ett eSigner-signeringscertifikat.

Användning: DocSignTool [-hV] batch_sign_hash -access_token=<ACCESS_TOKEN> [-credential_id=<CREDENTIAL_ID>] -input_dir_path=<PATH> -output_dir_path=<PATH> -otp=<OTP>

Valfria parametrar:

• If -credential_id har utelämnats och användaren har bara ett eSigner-dokumentsigneringscertifikat kommer DocSignTool att vara standard. Om användaren har mer än ett dokumentsigneringscertifikat är denna parameter obligatorisk.

Exempelvis:

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

Skriva DocSignTool batch_sign_hash utan nödvändiga parametrar visar användningsinformation för kommandot.

Hur man testar DocSignTool i sandlådeläge

1. I DocSignTool-versionen, gå till conf mapp och öppen doc_sign_tool.properties fil
2. Kommentera de befintliga egenskaperna genom att lägga till # symbol före varje fastighet
3. Lägg till följande egenskaper i filen:
   • 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. Spara filen. Efter att du har sparat kan DocSignTool nu användas i sandlådeläge.
5. För att växla tillbaka till produktionsläge, avkommenterar du de befintliga egenskaperna och tar bort sandlådeegenskaperna.

Valfritt: Konvertera ditt OV-dokumentsigneringscertifikat till ett förseglingscertifikat

Notera: Det här avsnittet är endast för användare som vill göra försegling. För att automatisera dokumentsignering och inte bli tillfrågad av One Time Passwords (OTP), konverterar användare själv sitt certifikat för organisationsvalidering (OV)-dokumentsigneringscertifikat till ett e-sealing-certifikat på sina SSL.com-konton. Instruktioner finns nedan:

1. Klicka Beställningar på toppmenyn på ditt SSL.com-konto. 
2. Leta upp ditt certifikat och klicka på download / detaljer länken.
3. Klicka på BORT 2FA knapp.