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 ønsker å bruke esigner til å signere kode og excutables i stedet, vennligst se denne CodeSignTool-veiledningen.
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 medbatch_hash_sign
kommando.batch_sign_hash
: Tegn hash (er) forhåndsberegnet medhash
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
-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
, -username
og -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
, -password
og -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_no
og -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.
Eksempler:
Manuell OTP-oppføring med synlig signatur:
DocSignTool-tegn -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" -output_dir_path=signed -input_file_path=sig_100,pdf_position=sig_200 150, 70" -page_no=1 -signing_location="Houston, Texas" -signing_reason="dokumentgodkjenning" -contact_info="support@ssl.com" Angi OTP - Trykk enter for å fortsette: 884646 PDF signert vellykket: 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.
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
, -password
og -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_no
og -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_100,=output_dir_200 150" -page_no=70 -signing_location="Houston, Texas" -signing_reason="dokumentgodkjenning" -contact_info="support@ssl.com" Angi OTP - Trykk enter for å fortsette: 1 Batch sign-kommando utført. Utdatakatalog for signerte filer: utdata
Entering DocSignTool batch_sign
uten de nødvendige parametrene vil bruksinformasjon for kommandoen vises.
hash
- 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).
- 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_position
og -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
, -otp
og 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
- I DocSignTool-versjonen går du til
conf
mappe og åpnedoc_sign_tool.properties
fil - Kommenter de eksisterende egenskapene ved å legge til
#
symbol foran hver eiendom - Legg til følgende egenskaper i filen:
CLIENT_ID
=qOUeZCCzSqgA93acB3LYq6lBNjgZdiOxQc-KayC3UMwOAUTH2_ENDPOINT
=https://oauth-sandbox.ssl.com/oauth2/tokenCSC_API_ENDPOINT
=https://cs-try.ssl.comTSA_URL
=http://ts.ssl.com
- Lagre filen. Etter lagring kan DocSignTool nå brukes i sandkassemodus.
- 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:
- Klikk Mine ordre på toppmenyen til SSL.com-kontoen din.
- Finn sertifikatet ditt og klikk på nedlastings / detaljer kobling.
- Klikk på FJERN 2FA knapp.