eSigner DocSignTool-opdrachtgids

DocSignTool is een veilig, privacygericht Java-opdrachtregelhulpprogramma voor meerdere platforms voor het op afstand ondertekenen van PDF-bestanden met behulp van eSigner certificaten voor het ondertekenen van documenten. Hashes van de documenten worden ter ondertekening naar SSL.com verzonden, zodat het document zelf niet wordt verzonden. Dit is ideaal als gevoelige documenten moeten worden ondertekend, maar niet ter ondertekening via de kabel moeten worden verzonden. DocSignTool is ook ideaal voor geautomatiseerde batchprocessen voor ondertekening van grote aantallen of integratie in bestaande documentworkflows.

Als u DocSignTool wilt proberen met een demo-account en certificaat, lees dan: Inloggegevens en certificaten voor eSigner-demo voor referenties en configuratie-informatie.

Als u in plaats daarvan esigner wilt gebruiken om code en uitvoerbare bestanden te ondertekenen, alstublieft raadpleeg deze CodeSignTool-gids.

OTP-autorisatie is niet vereist bij het ondertekenen met een verzegeld certificaat voor het ondertekenen van documenten. Negeer alle OTP-parameters in de volgende handleiding als u een ondertekeningscertificaat voor verzegeling gebruikt. (Klanten met een bestaand Organisatie Validatie document ondertekening certificaat kan contact opnemen support@ssl.com om het te laten omzetten naar een eSealing-certificaat.)

DocSignTool-installatie

Om de huidige versie van DocSignTool te installeren, hoeft u alleen maar het juiste bestand voor uw besturingssysteem te downloaden en uit te pakken:

Merk op dat de Windows-download Java-runtime bevat, maar voor de Linux/macOS-versie moet Java-runtime op uw computer zijn geïnstalleerd. De Windows-versie van de opdracht is een batchbestand (DocSignTool.bat) en de Linux / macOS-versie is een shellscript (DocSignTool.sh).

DocSignTool-gebruiksoverzicht

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

Opties:

  • -h, --help: Help-bericht weergeven en afsluiten.
  • -V, --version: Versie-informatie weergeven en afsluiten.

commando's:

  • get_credential_ids: Voer de lijst uit met eSigner-referentie-ID's die aan een bepaalde gebruiker zijn gekoppeld.
  • credential_info: Uitvoersleutel en certificaatinformatie met betrekking tot een referentie-ID.
  • sign: Onderteken en tijdstempel PDF filr.
  • batch_sign: Onderteken en tijdstempel meerdere PDF-bestanden met één OTP.
  • hash: Pre-bereken hash(es) voor later gebruik met batch_hash_sign opdracht.
  • batch_sign_hash: teken hash(es) vooraf berekend met hash opdracht.

parameters:

  • -access_token=<TOKEN>: OAuth toegangstoken.
  • -contact_info=<CONTACT_INFO>: Contactgegevens.
  • -credential_id=<CREDENTIAL_ID>: Referentie-ID voor ondertekeningscertificaat.
  • -input_dir_path=<PATH>: Invoermap voor PDF-bestanden die moeten worden ondertekend, hashes laten berekenen of niet-ondertekende bestanden en bijbehorende hashes voor ondertekening kiezen.
  • -input_file_path=<PATH>: Pad van het te ondertekenen PDF-bestand.
  • -otp=<OTP>: OAuth OTP-waarde van authenticatie-app.
  • -output_dir_path=<PATH>: Directory waar ondertekende PDF-bestanden worden geschreven.
  • -page_no=<PAGE_NUMBER>: Pagina van PDF-document waar zichtbare handtekening zal verschijnen.
  • -password=<PASSWORD>: SSL.com-accountwachtwoord.
  • -sig_field_position=<X, Y, WIDTH, HEIGHT>: Positie van zichtbare handtekening op PDF.
  • -signing_location=<SIGNING_LOCATION>: Locatie waar het document is ondertekend.
  • signing_reason=<SIGNING_REASON>: Reden voor ondertekening.
  • -totp_secret=<TOTP_SECRET>: OAuth TOTP geheim
  • -username=<USERNAME>: gebruikersnaam van SSL.com-account
Als uw wachtwoord speciale tekens bevat, plaats het dan tussen aanhalingstekens (bijv -password="P!@^^ssword12").

DocSignTool-opdrachten

get_credential_ids

Voer de lijst met eSigner-referentie-ID's uit die aan een bepaalde gebruiker zijn gekoppeld. Parameters: -username en -password nodig.

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

Voorbeeld:

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

Invoeren DocSignTool get_credential_ids zonder de vereiste parameters wordt gebruiksinformatie voor de opdracht weergegeven.

referentie_info

Uitvoersleutel en certificaatinformatie met betrekking tot een referentie-ID. Parameters: -credential_id, -username en -password nodig.

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

Voorbeeld:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Onderwerpinformatie ondertekening certificaat: - Onderwerp DN: CN=JOHN DOE, O=SSL Corp , L=Houston, ST=Texas, C=US - Certificaat verloopt: za 11 februari 14:52:59 EST 2023 - Uitgever DN: CN=SSL.com Cliëntcertificaat Intermediate CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=VS

Invoeren DocSignTool credential_info zonder de vereiste parameters wordt gebruiksinformatie voor de opdracht weergegeven.

teken

Onderteken en tijdstempel PDF-bestand. Parameters: -username, -password en -input_file_path nodig. -credential_id is alleen vereist voor gebruikers met meer dan één eSigner-certificaat voor documentondertekening. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_no en -totp_secret zijn optioneel.

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

Facultatieve parameters:

  • If -credential_id wordt weggelaten en de gebruiker slechts één eSigner-certificaat voor het ondertekenen van documenten heeft, zal DocSignTool daar standaard op gebruiken. Als de gebruiker meer dan één certificaat voor documentondertekening heeft, is deze parameter verplicht.
  • If -output_dir_path is weggelaten, het bestand gespecificeerd in -input_file_path wordt overschreven met het ondertekende bestand. DocSignTool zal de gebruiker vragen voordat het bestand wordt overschreven.
  • If -signing_location aanwezig is, wordt de opgegeven locatie toegevoegd aan de digitale handtekening.
  • If -signing_reason aanwezig is, wordt de opgegeven reden van ondertekening toegevoegd aan de digitale handtekening.
  • If -contact_info aanwezig is, wordt de opgegeven tekst toegevoegd aan de digitale handtekening. Hoewel deze informatie bij de handtekening wordt gevoegd, wordt deze niet opgenomen in de zichtbare handtekeningannotatie (indien aanwezig).
  • If -sig_field_position aanwezig is, wordt een zichtbare handtekeningannotatie toegevoegd aan het document op de pagina gespecificeerd door -page_no. De functie en handtekening moeten worden aangeleverd in het formaat "x, y, width, height".
  • -page_no is alleen vereist bij het maken van een zichtbare handtekening met -sig_field_position en specificeert de pagina van het document waarop de zichtbare handtekeningannotatie zal verschijnen.
  • If -totp_secret aanwezig is, berekent DocSignTool een op tijd gebaseerde OTP voor ondertekening, waardoor geautomatiseerd gebruik van de tool mogelijk is. Als deze parameter niet aanwezig is, wordt de gebruiker gevraagd om handmatige OTP-invoer.
Lees voor informatie over het inschrijven van een EV-certificaat voor het ondertekenen van documenten in eSigner en het instellen van tweefactorauthenticatie EV-codeondertekening op afstand met eSigner. Raadpleeg voor informatie over de geheime TOTP-waarde Automatiseer eSigner EV Code Signing.

Voorbeelden:

Handmatige OTP-invoer met zichtbare handtekening:

DocSignTool-teken -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" -output_dir_path=ondertekend -input_file_path=test.pdf -100, 200,field 150, 70" -page_no=1 -signing_location="Houston, Texas" -signing_reason="documentgoedkeuring" -contact_info="support@ssl.com" Voer de OTP in - Druk op enter om door te gaan: 884646 PDF succesvol ondertekend: output\test.pdf

Geautomatiseerde OTP-generatie, geen zichtbare handtekening:

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

Invoeren DocSignTool sign zonder de vereiste parameters wordt gebruiksinformatie voor de opdracht weergegeven.

Als u de foutmelding krijgt, Error: invalid otp wanneer u een bestand probeert te ondertekenen, kan dit worden veroorzaakt door een of meer van deze problemen:

  • De QR-code die u in uw authenticatie-app hebt gescand, komt niet overeen met de gebruikersnaam, het wachtwoord en / of de referentie-ID van uw opdracht. Dit kan gebeuren als:
    • Je hebt meerdere accounts geconfigureerd voor 2FA op je apparaat en je hebt het verkeerde gekozen.
    • U probeert uw inloggegevens te gebruiken voor een gedeeld certificaat, maar een QR-code gescand die door een teamgenoot werd gedeeld vanuit hun account.
  • De OTP die u heeft ingevoerd, is al verlopen.
  • Uw opdracht bevat een ongeldig TOTP-geheim.

batch_teken

Onderteken en tijdstempel tot 100 PDF-bestanden met één OTP. Parameters: -username, -password en -input_dir_path nodig. -credential_id is alleen vereist voor gebruikers met meer dan één eSigner-certificaat voor documentondertekening. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_no en -totp_secret zijn optioneel.

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

Facultatieve parameters:

  • If -credential_id wordt weggelaten en de gebruiker slechts één eSigner-certificaat voor het ondertekenen van documenten heeft, zal DocSignTool daar standaard op gebruiken. Als de gebruiker meer dan één certificaat voor documentondertekening heeft, is deze parameter verplicht.
  • If -output_dir_path wordt weggelaten, worden de bestanden gespecificeerd in -input_dir_path worden overschreven met de ondertekende bestanden. DocSignTool zal de gebruiker vragen voordat de bestanden worden overschreven.
  • If -signing_location aanwezig is, wordt de opgegeven locatie toegevoegd aan de digitale handtekeningen.
  • If -signing_reason aanwezig is, wordt de opgegeven reden van ondertekening toegevoegd aan de digitale handtekeningen.
  • If -contact_info aanwezig is, wordt de opgegeven tekst toegevoegd aan de digitale handtekeningen. Hoewel deze informatie bij de handtekening wordt gevoegd, wordt deze niet opgenomen in de zichtbare handtekeningannotaties (indien aanwezig).
  • If -sig_field_position aanwezig is, wordt een zichtbare handtekeningaantekening toegevoegd aan de documenten op de pagina gespecificeerd door -page_no. De functie en handtekening moeten worden aangeleverd in het formaat "x, y, width, height".
  • -page_no is alleen vereist bij het maken van een zichtbare handtekening met -sig_field_position en specificeert de pagina van de documenten waarop de zichtbare handtekeningannotaties zullen verschijnen.
  • If -totp_secret aanwezig is, berekent DocSignTool een op tijd gebaseerde OTP voor ondertekening, waardoor geautomatiseerd gebruik van de tool mogelijk is. Als deze parameter niet aanwezig is, wordt de gebruiker gevraagd om handmatige OTP-invoer.

Voorbeeld:

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" Voer de OTP in - Druk op enter om door te gaan: 455145 Batchtekenopdracht succesvol uitgevoerd. Uitvoermap voor ondertekende bestanden: uitvoer

Invoeren DocSignTool batch_sign zonder de vereiste parameters wordt gebruiksinformatie voor de opdracht weergegeven.

hachee

Het SHA 256-algoritme moet worden gebruikt om de hash van het PDF-document te berekenen. 

  1. Er is een PDF-bibliotheek nodig om de PDF te manipuleren voor hash-invoer en later de PKCS#7 in het PDF-document in te sluiten. (bijvoorbeeld ApachePDFBox in Java). 
  2. Een cryptobibliotheek voor het maken van PKCS#7 op basis van onbewerkte handtekeningen ontvangen van de eSigner API (bijv. BouncyCastle in Java).

Pre-bereken hash(es) voor later gebruik met batch_hash_sign opdracht. Parameters: -access_token en -input_dir_path nodig. -credential_id is alleen vereist voor gebruikers met meer dan één eSigner-certificaat voor documentondertekening. -signing_location, -signing-reason, -contact_info-sig_field_position en -page_no, zijn optioneel.

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

Facultatieve parameters:

  • If -program_name aanwezig is bij het ondertekenen van een MSI-installatieprogramma, wordt de waarde weergegeven in het bevestigingsvenster als de programmanaam.
  • If -signing_location aanwezig is, wordt de opgegeven locatie toegevoegd aan de digitale handtekeningen wanneer deze worden gegenereerd.
  • If -signing_reason aanwezig is, wordt de opgegeven reden voor ondertekening toegevoegd aan de digitale handtekeningen wanneer deze worden gegenereerd.
  • If -contact_info aanwezig is, wordt de gespecificeerde tekst toegevoegd aan de digitale handtekeningen wanneer deze worden gegenereerd. Hoewel deze informatie bij de handtekening wordt gevoegd, wordt deze niet opgenomen in de zichtbare handtekeningannotaties (indien aanwezig).
  • If -sig_field_position aanwezig is, wordt een zichtbare handtekeningaantekening toegevoegd aan de documenten op de pagina gespecificeerd door -page_no wanneer de handtekeningen worden gegenereerd. De functie en handtekening moeten worden aangeleverd in het formaat "x, y, width, height".
  • -page_no is alleen vereist bij het maken van een zichtbare handtekening met -sig_field_position en specificeert de pagina van de documenten waarop de zichtbare handtekeningannotaties zullen verschijnen wanneer ze worden gegenereerd.

Voorbeeld:

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

Invoeren DocSignTool hash zonder de vereiste parameters wordt gebruiksinformatie voor de opdracht weergegeven.

batch_sign_hash

Teken hash(es) vooraf berekend met hash opdracht. Parameters: -access_token, input_dir_path, -otp en output_dir_path nodig. -credential_id is alleen vereist voor gebruikers met meer dan één eSigner-certificaat voor documentondertekening.

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

Facultatieve parameters:

  • If -credential_id wordt weggelaten en de gebruiker slechts één eSigner-certificaat voor het ondertekenen van documenten heeft, zal DocSignTool daar standaard op gebruiken. Als de gebruiker meer dan één certificaat voor documentondertekening heeft, is deze parameter verplicht.

Voorbeeld:

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

Invoeren DocSignTool batch_sign_hash zonder de vereiste parameters wordt gebruiksinformatie voor de opdracht weergegeven.

DocSignTool testen in sandboxmodus

  1. Ga in de DocSignTool-release naar conf map en open doc_sign_tool.properties filet
  2. Geef commentaar op de bestaande eigenschappen door toe te voegen # symbool vóór elke eigenschap
  3. Voeg de volgende eigenschappen toe aan het bestand:
  4. Bewaar het bestand. Na het opslaan kan DocSignTool nu in de sandboxmodus worden gebruikt.
  5. Als u wilt terugschakelen naar de productiemodus, verwijdert u de opmerkingen bij de bestaande eigenschappen en verwijdert u de sandbox-eigenschappen.

Optioneel: Converteer uw OV-documentondertekeningscertificaat naar een zegelcertificaat

Opmerking: Deze sectie is alleen bedoeld voor gebruikers die willen sealen. Om het ondertekenen van documenten te automatiseren en niet te worden gevraagd door eenmalige wachtwoorden (OTP), converteren gebruikers zelf hun Organization Validation (OV) documentondertekeningscertificaat naar een verzegelingscertificaat op hun SSL.com-accounts. Instructies vindt u hieronder:

  1. Klik Bestellingen in het bovenste menu van uw SSL.com-account. 
  2. Zoek uw certificaat en klik op de download / details link.
  3. Klik op de VERWIJDER 2FA knop.
Bedankt voor het kiezen van SSL.com! Als u vragen heeft, neem dan contact met ons op via e-mail op Support@SSL.com, bel 1-877-SSL-SECURE, of klik gewoon op de chatlink rechtsonder op deze pagina. U kunt ook antwoorden op veel voorkomende ondersteuningsvragen vinden in onze kennis basis.
Twitter
Facebook
LinkedIn
Reddit
E-mail

Blijf geïnformeerd en veilig

SSL.com is een wereldleider op het gebied van cyberbeveiliging, PKI en digitale certificaten. Meld u aan om het laatste branchenieuws, tips en productaankondigingen te ontvangen van SSL.com.

We willen graag uw feedback

Vul onze enquête in en laat ons uw mening over uw recente aankoop weten.