eSigner DocSignTool kommandovejledning

DocSignTool er et sikkert, fortrolighedsorienteret Java-kommandolinjeprogram til flere platforme til ekstern signering af PDF-filer ved hjælp af eSigner dokumentsigneringscertifikater. Hashes af dokumenterne sendes til SSL.com til underskrift, så selve dokumentet ikke sendes. Dette er ideelt, hvor følsomme dokumenter skal underskrives, men bør ikke sendes over ledningen til underskrift. DocSignTool er også ideel til automatiserede batch-processer til højvolumen signering eller integration i eksisterende dokumentarbejdsgange.

Hvis du vil prøve DocSignTool med en demo-konto og certifikat, skal du læse eSigner demo legitimationsoplysninger og certifikater for legitimationsoplysninger og konfigurationsoplysninger.

Hvis du ønsker at bruge esigner til at signere kode og excutables i stedet, så tak se denne CodeSignTool-vejledning.

OTP-autorisation er ikke påkrævet, når du signerer med et signeringscertifikat for eseling-dokument. Ignorer alle OTP-parametre i den følgende vejledning, hvis du bruger et underskriftscertifikat for eselling. (Kunder med en eksisterende Organisationens valideringsdokument underskrive certifikat kan kontakte support@ssl.com for at få det konverteret til et eSealing-certifikat.)

Installation af DocSignTool

For at installere den aktuelle version af DocSignTool skal du blot downloade og pakke den korrekte fil ud til dit operativsystem:

Bemærk, at Windows-download inkluderer Java-runtime, men Linux / macOS-versionen kræver, at Java-runtime er installeret på din computer. Windows-versionen af ​​kommandoen er en batchfil (DocSignTool.bat) og Linux / macOS-versionen er et shell-script (DocSignTool.sh).

Oversigt over brug af DocSignTool

Anvendelse: DocSignTool [-hV] [COMMAND] [PARAMETERS]

Valg:

  • -h, --help: Vis hjælpemeddelelse og afslut.
  • -V, --version: Vis versionoplysninger og afslut.

kommandoer:

  • get_credential_ids: Output listen over eSigner-legitimations-id'er, der er knyttet til en bestemt bruger.
  • credential_info: Outputnøgle og certifikatoplysninger relateret til et legitimations-id.
  • sign: Undertegn og tidsstempel PDF filr.
  • batch_sign: Underskriv og tidsstempler flere PDF-filer med en OTP.
  • hash: Forudberegne hash (r) til senere brug med batch_hash_sign kommando.
  • batch_sign_hash: Tegn hash (er) forudberegnet med hash kommando.

Parametre:

  • -access_token=<TOKEN>: OAuth adgangstoken.
  • -contact_info=<CONTACT_INFO>: Kontakt information.
  • -credential_id=<CREDENTIAL_ID>: Legitimations-id til underskrivelse af certifikat.
  • -input_dir_path=<PATH>: Indtastningsmappe til PDF-filer, der skal underskrives, har beregnet hashes, eller vælg ikke-signerede filer og tilsvarende hashes til signering.
  • -input_file_path=<PATH>: Stien til PDF-filen, der skal underskrives.
  • -otp=<OTP>: OAuth OTP-værdi fra godkendelsesapp.
  • -output_dir_path=<PATH>: Katalog hvor underskrevet PDF-fil (er) vil blive skrevet.
  • -page_no=<PAGE_NUMBER>: Side af PDF-dokument, hvor synlig signatur vises.
  • -password=<PASSWORD>: SSL.com-kontoadgangskode.
  • -sig_field_position=<X, Y, WIDTH, HEIGHT>: Placering af synlig signatur på PDF.
  • -signing_location=<SIGNING_LOCATION>: Placering, hvor dokumentet er underskrevet.
  • signing_reason=<SIGNING_REASON>: Årsag til underskrift.
  • -totp_secret=<TOTP_SECRET>: OAuth TOTP hemmelighed
  • -username=<USERNAME>: SSL.com-konto brugernavn
Hvis din adgangskode indeholder specialtegn, skal du lægge den i anførselstegn (f.eks -password="P!@^^ssword12").

DocSignTool-kommandoer

get_credential_ids

Output listen over eSigner-legitimations-id'er, der er knyttet til en bestemt bruger. Parametre -username og -password er krævet.

Anvendelse: DocSignTool [-hV] get_credential_ids -username=<USERNAME> -password=<PASSWORD>

Eksempel:

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

Indtastning DocSignTool get_credential_ids uden de krævede parametre vises brugsinformation for kommandoen.

legitimationsoplysninger

Outputnøgle og certifikatoplysninger relateret til et legitimations-id. Parametre -credential_id, -usernameog -password er krævet.

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

Eksempel:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Underskriftscertifikat Emneinformation:,=OJOHS Corp. , L=Houston, ST=Texas, C=US - Certifikatudløb: Lør 11. februar 14:52:59 EST 2023 - Udsteder-DN: CN=SSL.com Klientcertifikat mellem CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=US

Indtastning DocSignTool credential_info uden de krævede parametre vises brugsinformation for kommandoen.

underskrive

Undertegn og tidsstempel PDF-fil. Parametre -username, -passwordog -input_file_path er krævet. -credential_id kræves kun for brugere med mere end et eSigner-dokumentunderskrivelsescertifikat. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_noog -totp_secret er valgfri.

Anvendelse: 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>]

Valgfri parametre:

  • If -credential_id udelades, og brugeren har kun ét eSigner-dokumentunderskrivelsescertifikat, vil DocSignTool som standard være det. Hvis brugeren har mere end et dokumentsigneringscertifikat, er denne parameter obligatorisk.
  • If -output_dir_path er udeladt, er filen angivet i -input_file_path overskrives med den underskrevne fil. DocSignTool vil bede brugeren om, før filen overskrives.
  • If -signing_location er til stede, føjes den angivne placering til den digitale signatur.
  • If -signing_reason er til stede, vil årsagen til den specificerede underskrift føjes til den digitale signatur.
  • If -contact_info er til stede, tilføjes den angivne tekst til den digitale underskrift. Selvom de er inkluderet i signaturen, vil disse oplysninger ikke blive inkluderet i den synlige signaturannotation (hvis den findes).
  • If -sig_field_position er til stede, tilføjes en synlig signaturannotation til dokumentet på den side, der er specificeret af -page_no. Positionen og signaturen skal leveres i formatet "x, y, width, height".
  • -page_no kræves kun, når du opretter en synlig signatur med -sig_field_position og specificerer den side i dokumentet, som den synlige signaturanmærkning vises på.
  • If -totp_secret er til stede, beregner DocSignTool en tidsbaseret OTP til signering, hvilket tillader automatisk brug af værktøjet. Hvis denne parameter ikke er til stede, bliver brugeren bedt om manuel OTP-indtastning.
For information om tilmelding af et EV-dokumentunderskrivelsescertifikat i eSigner og opsætning af tofaktorautentificering, skal du læse Fjern EV-kodesignering med eSigner. For information om TOTP-hemmelige værdi henvises til Automatiser eSigner EV-kodesignering.

eksempler:

Manuel OTP-indtastning med synlig signatur:

DocSignTool-tegn -credential_id = fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -brugernavn=john.doe@example.com -password = "P0z9 @ lxo41" -output_dir_path = signeret -input_file_path = test.pdf -sig_field_ 100, 200 "-page_no = 150 -signing_location =" Houston, Texas "-signing_reason =" dokumentgodkendelse "-contact_info ="support@ssl.com"Indtast OTP - tryk på enter for at fortsætte: 884646 PDF blev signeret med succes: output \ test.pdf

Automatiseret 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

Indtastning DocSignTool sign uden de krævede parametre vises brugsinformation for kommandoen.

Hvis du får fejlmeddelelsen, Error: invalid otp når du forsøger at underskrive en fil, kan det være forårsaget af et eller flere af disse problemer:

  • QR-koden, du scannede i din godkendelsesapp, svarer ikke til brugernavnet, adgangskoden og / eller legitimations-ID fra din kommando. Dette kan ske, hvis:
    • Du har konfigureret flere konti til 2FA på din enhed og valgt den forkerte.
    • Du forsøger at bruge dine loginoplysninger til en delt certifikat, men scannede en QR-kode, der deles af en holdkammerat fra deres konto.
  • Den indtastede OTP er allerede udløbet.
  • Din kommando indeholder en ugyldig TOTP-hemmelighed.

batch_tegn

Underskriv og tidsstempel op til 100 PDF-filer med en OTP. Parametre -username, -passwordog -input_dir_path er krævet. -credential_id kræves kun for brugere med mere end et eSigner-dokumentunderskrivelsescertifikat. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_noog -totp_secret er valgfri.

Anvendelse: 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>]

Valgfri parametre:

  • If -credential_id udelades, og brugeren har kun ét eSigner-dokumentunderskrivelsescertifikat, vil DocSignTool som standard være det. Hvis brugeren har mere end et dokumentsigneringscertifikat, er denne parameter obligatorisk.
  • If -output_dir_path udelades, er filerne specificeret i -input_dir_path vil blive overskrevet med de underskrevne filer. DocSignTool vil bede brugeren om, før filerne overskrives.
  • If -signing_location er til stede, tilføjes den angivne placering til de digitale signaturer.
  • If -signing_reason er til stede, vil årsagen til den angivne underskrift føjes til de digitale signaturer.
  • If -contact_info er til stede, tilføjes den angivne tekst til de digitale underskrifter. Selvom de er inkluderet i signaturen, vil disse oplysninger ikke blive inkluderet i de synlige signaturanmærkninger (hvis de findes).
  • If -sig_field_position er til stede, tilføjes en synlig signaturannotering til dokumenterne på den side, der er specificeret af -page_no. Positionen og signaturen skal leveres i formatet "x, y, width, height".
  • -page_no kræves kun, når du opretter en synlig signatur med -sig_field_position og specificerer den side med de dokumenter, som de synlige signaturanmærkninger vises på.
  • If -totp_secret er til stede, beregner DocSignTool en tidsbaseret OTP til signering, hvilket tillader automatisk brug af værktøjet. Hvis denne parameter ikke er til stede, bliver brugeren bedt om manuel OTP-indtastning.

Eksempel:

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"Indtast OTP - Tryk på enter for at fortsætte: 455145 Batch-tegnkommando udført med succes. Outputmappe til signerede filer: output

Indtastning DocSignTool batch_sign uden de krævede parametre vises brugsinformation for kommandoen.

hash

SHA 256-algoritmen skal bruges til at beregne hashen i PDF-dokumentet. 

  1. Et PDF-bibliotek er nødvendigt for at manipulere PDF'en til hash-input og senere indlejre PKCS#7 i PDF-dokumentet. (eks. ApachePDFBox i Java). 
  2. Et kryptobibliotek til at skabe PKCS#7 ud af rå signaturer modtaget fra eSigner API (f.eks. BouncyCastle i Java).

Forudberegn hash (er) til senere brug med batch_hash_sign kommando. Parametre -access_token og -input_dir_path er krævet. -credential_id kræves kun for brugere med mere end et eSigner-dokumentunderskrivelsescertifikat. -signing_location, -signing-reason, -contact_info-sig_field_positionog -page_no, er valgfri.

Anvendelse: 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>]

Valgfri parametre:

  • If -program_name er til stede, når du underskriver et MSI-installationsprogram, vises værdien i bekræftelsesdialogen som programnavnet.
  • If -signing_location er til stede, vil den angivne placering føjes til de digitale signaturer, når de genereres.
  • If -signing_reason er til stede, vil årsagen til den specificerede underskrift føjes til de digitale signaturer, når de genereres.
  • If -contact_info er til stede, tilføjes den angivne tekst til de digitale signaturer, når de genereres. Selvom de er inkluderet i signaturen, vil disse oplysninger ikke blive inkluderet i de synlige signaturanmærkninger (hvis de findes).
  • If -sig_field_position er til stede, tilføjes en synlig signaturannotering til dokumenterne på den side, der er specificeret af -page_no når underskrifterne genereres. Positionen og signaturen skal leveres i formatet "x, y, width, height".
  • -page_no kræves kun, når du opretter en synlig signatur med -sig_field_position og specificerer siden med de dokumenter, som de synlige signaturanmærkninger vises på, når de genereres.

Eksempel:

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

Indtastning DocSignTool hash uden de krævede parametre vises brugsinformation for kommandoen.

batch_sign_hash

Tegn hash (er) forudberegnet med hash kommando. Parametre -access_token, input_dir_path, -otpog output_dir_path er krævet. -credential_id kræves kun for brugere med mere end et eSigner-dokumentunderskrivelsescertifikat.

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

Valgfri parametre:

  • If -credential_id udelades, og brugeren har kun ét eSigner-dokumentunderskrivelsescertifikat, vil DocSignTool som standard være det. Hvis brugeren har mere end et dokumentsigneringscertifikat, er denne parameter obligatorisk.

Eksempel:

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

Indtastning DocSignTool batch_sign_hash uden de krævede parametre vises brugsinformation for kommandoen.

Sådan testes DocSignTool i sandkassetilstand

  1. I DocSignTool-udgivelsen skal du gå til conf mappe og åben doc_sign_tool.properties fil
  2. Kommenter de eksisterende egenskaber ved at tilføje # symbol foran hver ejendom
  3. Tilføj følgende egenskaber i filen:
  4. Gem filen. Efter lagring kan DocSignTool nu bruges i sandkassetilstand.
  5. For at skifte tilbage til produktionstilstand skal du fjerne kommentarer til de eksisterende egenskaber og slette sandkasseegenskaberne.

Valgfrit: Konverter dit OV-dokumentsigneringscertifikat til et plomberingscertifikat

Bemærk: Denne sektion er kun for brugere, der ønsker at udføre forsegling. For at automatisere dokumentsignering og ikke blive bedt om af One Time Passwords (OTP), konverterer brugere selv deres Organization Validation (OV) dokumentsigneringscertifikat til et eseling-certifikat på deres SSL.com-konti. Instruktioner er nedenfor:

  1. Klik Mine Ordrer i topmenuen på din SSL.com-konto. 
  2. Find dit certifikat, og klik på download / detaljer .
  3. Klik på knappen FJERN 2FA .
Tak for at du valgte SSL.com! Hvis du har spørgsmål, bedes du kontakte os via e-mail på Support@SSL.com, opkald 1-877-SSL-SECURE, eller bare klik på chatlinket nederst til højre på denne side. Du kan også finde svar på mange almindelige supportspørgsmål i vores vidensbase.
Twitter
Facebook
LinkedIn
Reddit
E-mail

Hold dig informeret og sikker

SSL.com er en global leder inden for cybersikkerhed, PKI og digitale certifikater. Tilmeld dig for at modtage de seneste industrinyheder, tips og produktmeddelelser fra SSL.com.

Vi vil meget gerne have din feedback

Tag vores undersøgelse og fortæl os dine tanker om dit seneste køb.