eSigner DocSignTool kommandoguide

DocSignTool er et sikkert, personvernorientert Java-kommandolinjeprogram for flere plattformer for ekstern signering av PDF-filer ved hjelp av eSigner dokumentsigneringssertifikater. Hashes av dokumentene sendes til SSL.com for signering slik at selve dokumentet ikke sendes. Dette er ideelt der sensitive dokumenter må signeres, men ikke sendes over ledningen for signering. DocSignTool er også ideelt for automatiserte batch-prosesser for signering av store volum eller integrering i eksisterende dokumentarbeidsflyter.

Hvis du vil prøve DocSignTool med en demo-konto og sertifikat, kan du lese eSigner demo legitimasjon og sertifikater for legitimasjon og konfigurasjonsinformasjon.

Hvis du ønsker å bruke esigner til å signere kode og excutables i stedet, vennligst se denne CodeSignTool-veiledningen.

OTP-autorisasjon er ikke nødvendig når du signerer med et signeringssertifikat for eseling-dokument. Ignorer alle OTP-parametere i den følgende veiledningen hvis du bruker et signeringssertifikat for forsegling av dokument. (Kunder med en eksisterende Organisasjonsvalideringsdokument signeringssertifikat kan kontakte support@ssl.com for å få den konvertert til et eSealing-sertifikat.)

Installasjon av DocSignTool

For å installere den gjeldende versjonen av DocSignTool, laster du ned og pakker ut riktig fil for operativsystemet ditt:

Merk at Windows-nedlastingen inkluderer Java-kjøretid, men Linux / macOS-versjonen krever at Java-kjøretiden er installert på datamaskinen din. Windows-versjonen av kommandoen er en batchfil (DocSignTool.bat) og Linux / macOS-versjonen er et skallskript (DocSignTool.sh).

Oversikt over bruk av DocSignTool

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

Alternativer:

  • -h, --help: Vis hjelpemelding og avslutt.
  • -V, --version: Vis versjonsinformasjon og avslutt.

kommandoer:

  • get_credential_ids: Send ut listen over legitimasjons-IDer for eSigner som er knyttet til en bestemt bruker.
  • credential_info: Utgangsnøkkel og sertifikatinformasjon relatert til en legitimasjons-ID.
  • sign: Skilt og tidsstempel PDF filr.
  • batch_sign: Signer og tidsstempler flere PDF-filer med en OTP.
  • hash: Forhåndsberegne hash (er) for senere bruk med batch_hash_sign kommando.
  • batch_sign_hash: Tegn hash (er) forhåndsberegnet med hash kommando.

Parametere:

  • -access_token=<TOKEN>: OAuth tilgangstoken.
  • -contact_info=<CONTACT_INFO>: Kontaktinformasjon.
  • -credential_id=<CREDENTIAL_ID>: Legitimasjons-ID for signeringssertifikat.
  • -input_dir_path=<PATH>: Inndatakatalog for PDF-filer som skal signeres, hashberegnes, eller plukke usignerte filer og tilsvarende hashes for signering.
  • -input_file_path=<PATH>: Stien til PDF-filen som skal signeres.
  • -otp=<OTP>: OAuth OTP-verdi fra godkjenningsappen.
  • -output_dir_path=<PATH>: Katalog der signert PDF-fil (er) skal skrives.
  • -page_no=<PAGE_NUMBER>: Side av PDF-dokument der synlig signatur vises.
  • -password=<PASSWORD>: SSL.com-passord.
  • -sig_field_position=<X, Y, WIDTH, HEIGHT>: Posisjon av synlig signatur på PDF.
  • -signing_location=<SIGNING_LOCATION>: Plassering der dokumentet er signert.
  • signing_reason=<SIGNING_REASON>: Årsak til signering.
  • -totp_secret=<TOTP_SECRET>: OAuth TOTP hemmelighet
  • -username=<USERNAME>: SSL.com-konto brukernavn
Hvis passordet ditt inneholder spesialtegn, kan du legge det i anførselstegn (f.eks -password="P!@^^ssword12").

DocSignTool-kommandoer

get_credential_ids

Send ut listen over legitimasjons-IDer for eSigner som er knyttet til en bestemt bruker. Parametere -username og -password er påkrevd.

Bruk: 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

Entering DocSignTool get_credential_ids uten de nødvendige parametrene vil bruksinformasjon for kommandoen vises.

credential_info

Utgangsnøkkel og sertifikatinformasjon relatert til en legitimasjons-ID. Parametere -credential_id, -usernameog -password er påkrevd.

Bruk: 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" Emneinformasjon for signeringssertifikat: - CN=OJOHN Corp. , L=Houston, ST=Texas, C=US - Sertifikatutløp: Lør 11. februar 14:52:59 EST 2023 - Utsteder-DN: CN=SSL.com Klientsertifikat Mellomliggende CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=US

Entering DocSignTool credential_info uten de nødvendige parametrene vil bruksinformasjon for kommandoen vises.

undertegne

Signer og tidsstempel PDF-fil. Parametere -username, -passwordog -input_file_path er påkrevd. -credential_id kreves bare for brukere med mer enn ett eSigner-dokumentsigneringssertifikat. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_noog -totp_secret er valgfrie.

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

Valgfrie parametere:

  • If -credential_id er utelatt, og brukeren har bare ett eSigner-dokument signeringssertifikat, vil DocSignTool som standard være det. Hvis brukeren har mer enn ett dokumentsigneringssertifikat, er denne parameteren obligatorisk.
  • If -output_dir_path er utelatt, er filen spesifisert i -input_file_path blir overskrevet med den signerte filen. DocSignTool vil be brukeren om å overskrive filen.
  • If -signing_location er til stede, vil den spesifiserte plasseringen bli lagt til den digitale signaturen.
  • If -signing_reason er til stede vil årsaken til den angitte signeringen bli lagt til den digitale signaturen.
  • If -contact_info er til stede, vil den spesifiserte teksten legges til den digitale signaturen. Selv om den er inkludert i signaturen, vil ikke denne informasjonen bli inkludert i den synlige signaturkommentaren (hvis den finnes).
  • If -sig_field_position er til stede, vil en synlig signaturkommentar legges til dokumentet på siden spesifisert av -page_no. Posisjonen og signaturen skal leveres i formatet "x, y, width, height".
  • -page_no er bare nødvendig når du oppretter en synlig signatur med -sig_field_position og spesifiserer siden i dokumentet som den synlige signaturmerknaden skal vises på.
  • If -totp_secret er til stede, vil DocSignTool beregne en tidsbasert OTP for signering, slik at automatisk bruk av verktøyet muliggjøres. Hvis denne parameteren ikke er til stede, blir brukeren bedt om manuell OTP-oppføring.
For informasjon om registrering av et EV-dokumentsigneringssertifikat i eSigner og konfigurering av tofaktorautentisering, vennligst les Ekstern signering av EV-kode med eSigner. For informasjon om TOTP-hemmelige verdi, se Automatiser eSigner EV-kodesignering.

Eksempler:

Manuell OTP-oppføring med synlig signatur:

DocSignTool-skilt -credential_id = fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -brukernavn=john.doe@example.com -passord = "P0z9 @ lxo41" -output_dir_path = signert -input_file_path = test.pdf -sig_field_ 100, 200 "-page_no = 150 -signing_location =" Houston, Texas "-signing_reason =" dokumentgodkjenning "-contact_info ="support@ssl.com"Skriv inn OTP - trykk enter for å fortsette: 884646 PDF signert med hell: output \ test.pdf

Automatisert 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

Entering DocSignTool sign uten de nødvendige parametrene vil bruksinformasjon for kommandoen vises.

Hvis du får feilmeldingen, Error: invalid otp når du prøver å signere en fil, kan det være forårsaket av ett eller flere av disse problemene:

  • QR-koden du skannet til godkjenningsappen din, samsvarer ikke med brukernavnet, passordet og / eller legitimasjons-ID-en fra kommandoen din. Dette kan skje hvis:
    • Du har flere kontoer konfigurert for 2FA på enheten din og valgte feil.
    • Du prøver å bruke påloggingsinformasjonen din for en delt sertifikat, men skannet en QR-kode som deles av en lagkamerat fra kontoen deres.
  • OTP-en du skrev inn, har allerede utløpt.
  • Kommandoen din inneholder en ugyldig TOTP-hemmelighet.

batch_sign

Signer og tidsstempler opptil 100 PDF-filer med en OTP. Parametere -username, -passwordog -input_dir_path er påkrevd. -credential_id kreves bare for brukere med mer enn ett eSigner-dokumentsigneringssertifikat. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_noog -totp_secret er valgfrie.

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

Valgfrie parametere:

  • If -credential_id er utelatt, og brukeren har bare ett eSigner-dokument signeringssertifikat, vil DocSignTool som standard være det. Hvis brukeren har mer enn ett dokumentsigneringssertifikat, er denne parameteren obligatorisk.
  • If -output_dir_path er utelatt, filene spesifisert i -input_dir_path vil bli overskrevet med de signerte filene. DocSignTool vil spørre brukeren før filene overskrives.
  • If -signing_location er til stede, vil den spesifiserte plasseringen bli lagt til de digitale signaturene.
  • If -signing_reason er til stede, vil årsaken til den spesifiserte signeringen bli lagt til de digitale signaturene.
  • If -contact_info er til stede, vil den spesifiserte teksten legges til de digitale signaturene. Selv om den er inkludert i signaturen, vil ikke denne informasjonen bli inkludert i de synlige signaturkommentarene (hvis de er til stede).
  • If -sig_field_position er til stede, vil en synlig signaturkommentar legges til dokumentene på siden spesifisert av -page_no. Posisjonen og signaturen skal leveres i formatet "x, y, width, height".
  • -page_no er bare nødvendig når du oppretter en synlig signatur med -sig_field_position og spesifiserer siden med dokumentene som de synlige signaturkommentarene vil vises på.
  • If -totp_secret er til stede, vil DocSignTool beregne en tidsbasert OTP for signering, slik at automatisk bruk av verktøyet muliggjøres. Hvis denne parameteren ikke er til stede, blir brukeren bedt om manuell OTP-oppføring.

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"Angi OTP - Trykk enter for å fortsette: 455145 Batch sign-kommando utført vellykket. Utdatakatalog for signerte filer: output

Entering DocSignTool batch_sign uten de nødvendige parametrene vil bruksinformasjon for kommandoen vises.

hash

SHA 256-algoritmen bør brukes til å beregne hashen til PDF-dokumentet. 

  1. Et PDF-bibliotek er nødvendig for å manipulere PDF-en for hash-inndata og senere bygge inn PKCS#7 i PDF-dokumentet. (eks. ApachePDFBox i Java). 
  2. Et kryptobibliotek for å lage PKCS#7 ut av rå signaturer mottatt fra eSigner API (eks. BouncyCastle i Java).

Forhåndsberegne hash (er) for senere bruk med batch_hash_sign kommando. Parametere -access_token og -input_dir_path er påkrevd. -credential_id kreves bare for brukere med mer enn ett eSigner-dokumentsigneringssertifikat. -signing_location, -signing-reason, -contact_info-sig_field_positionog -page_no, er valgfrie.

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

Valgfrie parametere:

  • If -program_name er til stede når du signerer et MSI-installatør, vises verdien i bekreftelsesdialogen som programnavnet.
  • If -signing_location er til stede, vil den spesifiserte plasseringen bli lagt til de digitale signaturene når de genereres.
  • If -signing_reason er til stede, vil årsaken til den angitte signeringen bli lagt til de digitale signaturene når de genereres.
  • If -contact_info er til stede, vil den spesifiserte teksten legges til de digitale signaturene når de genereres. Selv om den er inkludert i signaturen, vil ikke denne informasjonen bli inkludert i de synlige signaturkommentarene (hvis de er til stede).
  • If -sig_field_position er til stede, vil en synlig signaturkommentar legges til dokumentene på siden spesifisert av -page_no når signaturene genereres. Posisjonen og signaturen skal leveres i formatet "x, y, width, height".
  • -page_no er bare nødvendig når du oppretter en synlig signatur med -sig_field_position og spesifiserer siden med dokumentene som de synlige signaturkommentarene vil 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

Entering DocSignTool hash uten de nødvendige parametrene vil bruksinformasjon for kommandoen vises.

batch_sign_hash

Tegn hash (er) forhåndsberegnet med hash kommando. Parametere -access_token, input_dir_path, -otpog output_dir_path er påkrevd. -credential_id kreves bare for brukere med mer enn ett eSigner-dokumentsigneringssertifikat.

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

Valgfrie parametere:

  • If -credential_id er utelatt, og brukeren har bare ett eSigner-dokument signeringssertifikat, vil DocSignTool som standard være det. Hvis brukeren har mer enn ett dokumentsigneringssertifikat, er denne parameteren 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

Entering DocSignTool batch_sign_hash uten de nødvendige parametrene vil bruksinformasjon for kommandoen vises.

Hvordan teste DocSignTool i sandkassemodus

  1. I DocSignTool-versjonen går du til conf mappe og åpne doc_sign_tool.properties fil
  2. Kommenter de eksisterende egenskapene ved å legge til # symbol foran hver eiendom
  3. Legg til følgende egenskaper i filen:
  4. Lagre filen. Etter lagring kan DocSignTool nå brukes i sandkassemodus.
  5. For å bytte tilbake til produksjonsmodus, fjern kommentarene til de eksisterende egenskapene og slett sandkasseegenskapene.

Valgfritt: Konverter signeringssertifikatet for OV-dokumenter til et forseglingssertifikat

OBS: Denne delen er kun for brukere som ønsker å forsegle. For å automatisere dokumentsignering og ikke bli spurt av One Time Passwords (OTP), konverterer brukere selv Organisasjonsvalidering (OV) dokumentsigneringssertifikatet til et eseleringssertifikat på SSL.com-kontoene sine. Instruksjonene er nedenfor:

  1. Klikk Mine ordre på toppmenyen til SSL.com-kontoen din. 
  2. Finn sertifikatet ditt og klikk på nedlastings / detaljer kobling.
  3. Klikk på FJERN 2FA knapp.
Takk for at du valgte SSL.com! Hvis du har spørsmål, kan du kontakte oss via e-post på Support@SSL.com, anrop 1-877-SSL-SECURE, eller bare klikk chat-lenken nederst til høyre på denne siden. Du kan også finne svar på mange vanlige støttespørsmål i vår kunnskapsbase.
Twitter
Facebook
Linkedin
Reddit
Epost

Hold deg informert og sikker

SSL.com er en global leder innen cybersikkerhet, PKI og digitale sertifikater. Registrer deg for å motta de siste bransjenyhetene, tipsene og produktkunngjøringene fra SSL.com.

Vi vil gjerne ha tilbakemeldinger

Ta vår spørreundersøkelse og fortell oss dine tanker om ditt nylige kjøp.