Guide de commande eSigner DocSignTool

DocSignTool est un utilitaire de ligne de commande Java multiplateforme sécurisé et axé sur la confidentialité pour signer à distance des fichiers PDF à l'aide e-signataire certificats de signature de documents. Les hachages des documents sont envoyés à SSL.com pour signature afin que le document lui-même ne soit pas envoyé. C'est idéal lorsque des documents sensibles doivent être signés, mais ne doivent pas être envoyés par fil pour signature. DocSignTool est également idéal pour les processus automatisés par lots pour les signatures à volume élevé ou l'intégration dans les flux de travail documentaires existants.

Si vous souhaitez essayer DocSignTool avec un compte démo et un certificat, veuillez lire Informations d'identification et certificats de démonstration eSigner pour les informations d'identification et de configuration.

Si vous cherchez à utiliser esigner pour signer du code et des exécutables à la place, veuillez reportez-vous à ce guide CodeSignTool.

L'autorisation OTP n'est pas requise lors de la signature à l'aide d'un certificat de signature de document esealing. Ignorez tous les paramètres OTP dans le guide suivant si vous utilisez un certificat de signature de document scellé. (Clients ayant un compte existant Certificat de signature de document de validation d'organisation peut contacter support@ssl.com pour le convertir en certificat eSealing.)

Installation de DocSignTool

Pour installer la version actuelle de DocSignTool, téléchargez et décompressez simplement le fichier approprié pour votre système d'exploitation :

Notez que le téléchargement de Windows inclut le runtime Java, mais la version Linux/macOS nécessite que le runtime Java soit installé sur votre ordinateur. La version Windows de la commande est un fichier batch (DocSignTool.bat) et la version Linux / macOS est un script shell (DocSignTool.sh).

Présentation de l'utilisation de DocSignTool

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

Options:

  • -h, --help: Afficher le message d'aide et quitter.
  • -V, --version: Afficher les informations de version et quitter.

commandes:

  • get_credential_ids: affiche la liste des identifiants d'identification eSigner associés à un utilisateur particulier.
  • credential_info : informations de clé et de certificat de sortie liées à un identifiant d'identification.
  • sign: Signer et horodater le fichier PDF.
  • batch_sign: Signez et horodatez plusieurs fichiers PDF avec un seul OTP.
  • hash: pré-calculer le(s) hachage(s) pour une utilisation ultérieure avec batch_hash_sign commander.
  • batch_sign_hash : hachage(s) de signe pré-calculé avec hash commander.

Paramètres:

  • -access_token=<TOKEN>: OAuth jeton d'accès.
  • -contact_info=<CONTACT_INFO>: Informations de contact.
  • -credential_id=<CREDENTIAL_ID>: Identifiant d'identification pour la signature du certificat.
  • -input_dir_path=<PATH>: répertoire d'entrée pour les fichiers PDF à signer, faire calculer les hachages ou sélectionner les fichiers non signés et les hachages correspondants pour la signature.
  • -input_file_path=<PATH>: Chemin du fichier PDF à signer.
  • -otp=<OTP>: valeur OAuth OTP de l'application d'authentification.
  • -output_dir_path=<PATH>: Répertoire où seront écrits les fichiers PDF signés.
  • -page_no=<PAGE_NUMBER>: Page du document PDF où la signature visible apparaîtra.
  • -password=<PASSWORD>: mot de passe du compte SSL.com.
  • -sig_field_position=<X, Y, WIDTH, HEIGHT>: Position de la signature visible sur PDF.
  • -signing_location=<SIGNING_LOCATION>: Emplacement où le document est signé.
  • signing_reason=<SIGNING_REASON>: Raison de la signature.
  • -totp_secret=<TOTP_SECRET>: OAuth Secret TOTP
  • -username=<USERNAME>: nom d'utilisateur du compte SSL.com
Si votre mot de passe contient des caractères spéciaux, mettez-le entre guillemets (par exemple -password="P!@^^ssword12").

Commandes DocSignTool

get_credential_ids

Sortir la liste des identifiants d'identification eSigner associés à un utilisateur particulier. Paramètres -username et de -password sont obligatoires.

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

Mise en situation :

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

Saisie DocSignTool get_credential_ids sans les paramètres requis affichera les informations d'utilisation de la commande.

informations_identifiants

Sortez les informations de clé et de certificat liées à un identifiant d'identification. Paramètres -credential_id, -usernameet une -password sont obligatoires.

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

Mise en situation :

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Informations sur l'objet du certificat de signature : - DN de l'objet : CN=JOHN DOE, O=SSL Corp , L=Houston, ST=Texas, C=US - Expiration du certificat : Sam Feb 11 14:52:59 EST 2023 - DN de l'émetteur : CN=SSL.com Client Certificate Intermediate CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=États-Unis

Saisie DocSignTool credential_info sans les paramètres requis affichera les informations d'utilisation de la commande.

signer

Signez et horodatez le fichier PDF. Paramètres -username, -passwordet une -input_file_path sont obligatoires. -credential_id est requis uniquement pour les utilisateurs disposant de plusieurs certificats de signature de document eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_noet une -totp_secret sont optionnels.

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

Paramètres facultatifs:

  • If -credential_id est omis et que l'utilisateur n'a qu'un seul certificat de signature de document eSigner, DocSignTool le choisira par défaut. Si l'utilisateur dispose de plusieurs certificats de signature de document, ce paramètre est obligatoire.
  • If -output_dir_path est omis, le fichier spécifié dans -input_file_path sera écrasé par le fichier signé. DocSignTool demandera à l'utilisateur avant d'écraser le fichier.
  • If -signing_location est présent, l'emplacement spécifié sera ajouté à la signature numérique.
  • If -signing_reason est présent, le motif de signature spécifié sera ajouté à la signature numérique.
  • If -contact_info est présent, le texte spécifié sera ajouté à la signature numérique. Bien qu'elles soient incluses avec la signature, ces informations ne seront pas incluses dans l'annotation de signature visible (le cas échéant).
  • If -sig_field_position est présent, une annotation de signature visible sera ajoutée au document sur la page spécifiée par -page_no. La position et la signature doivent être fournies dans le format "x, y, width, height".
  • -page_no n'est requis que lors de la création d'une signature visible avec -sig_field_position et spécifie la page du document sur laquelle l'annotation de signature visible apparaîtra.
  • If -totp_secret est présent, DocSignTool calculera un OTP basé sur le temps pour la signature, permettant une utilisation automatisée de l'outil. Si ce paramètre n'est pas présent, l'utilisateur sera invité à saisir manuellement l'OTP.
Pour plus d'informations sur l'inscription d'un certificat de signature de document EV dans eSigner et la configuration de l'authentification à deux facteurs, veuillez lire Signature de code EV à distance avec eSigner. Pour plus d'informations sur la valeur secrète TOTP, veuillez consulter Automatisez la signature de code eSigner EV.

Exemples :

Saisie OTP manuelle avec signature visible :

Signe DocSignTool -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" -output_dir_path=signed -input_file_path=test.pdf -100, 200,field_position = " 150, 70" -page_no=1 -signing_location="Houston, Texas" -signing_reason="approbation du document" -contact_info="support@ssl.com" Entrez l'OTP - Appuyez sur Entrée pour continuer : 884646 PDF signé avec succès : output\test.pdf

Génération OTP automatisée, aucune signature visible :

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

Saisie DocSignTool sign sans les paramètres requis affichera les informations d'utilisation de la commande.

Si vous obtenez le message d'erreur, Error: invalid otp lors de la tentative de signature d'un fichier, cela peut être dû à un ou plusieurs de ces problèmes:

  • Le code QR que vous avez scanné dans votre application d'authentification ne correspond pas au nom d'utilisateur, au mot de passe et / ou à l'ID d'identification de votre commande. Cela peut arriver si:
    • Vous avez plusieurs comptes configurés pour 2FA sur votre appareil et vous avez choisi le mauvais.
    • Vous essayez d'utiliser vos identifiants de connexion pour un certificat partagé, mais a scanné un code QR partagé par un coéquipier à partir de son compte.
  • L'OTP que vous avez entré a déjà expiré.
  • Votre commande comprend un secret TOTP non valide.

signe_lot

Signez et horodatez jusqu'à 100 fichiers PDF avec un seul OTP. Paramètres -username, -passwordet une -input_dir_path sont obligatoires. -credential_id est requis uniquement pour les utilisateurs disposant de plusieurs certificats de signature de document eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_noet une -totp_secret sont optionnels.

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

Paramètres facultatifs:

  • If -credential_id est omis et que l'utilisateur n'a qu'un seul certificat de signature de document eSigner, DocSignTool le choisira par défaut. Si l'utilisateur dispose de plusieurs certificats de signature de document, ce paramètre est obligatoire.
  • If -output_dir_path est omis, les fichiers spécifiés dans -input_dir_path seront écrasés par les fichiers signés. DocSignTool demandera à l'utilisateur avant d'écraser les fichiers.
  • If -signing_location est présent, l'emplacement spécifié sera ajouté aux signatures numériques.
  • If -signing_reason est présent, le motif de signature spécifié sera ajouté aux signatures numériques.
  • If -contact_info est présent, le texte spécifié sera ajouté aux signatures numériques. Bien qu'elles soient incluses avec la signature, ces informations ne seront pas incluses dans les annotations de signature visibles (le cas échéant).
  • If -sig_field_position est présent, une annotation de signature visible sera ajoutée aux documents sur la page spécifiée par -page_no. La position et la signature doivent être fournies dans le format "x, y, width, height".
  • -page_no n'est requis que lors de la création d'une signature visible avec -sig_field_position et spécifie la page des documents sur laquelle les annotations de signature visibles apparaîtront.
  • If -totp_secret est présent, DocSignTool calculera un OTP basé sur le temps pour la signature, permettant une utilisation automatisée de l'outil. Si ce paramètre n'est pas présent, l'utilisateur sera invité à saisir manuellement l'OTP.

Mise en situation :

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" Entrez l'OTP - Appuyez sur Entrée pour continuer : 455145 Commande de signature de lot exécutée avec succès. Répertoire de sortie pour les fichiers signés : sortie

Saisie DocSignTool batch_sign sans les paramètres requis affichera les informations d'utilisation de la commande.

hachage

L'algorithme SHA 256 doit être utilisé pour calculer le hachage du document PDF. 

  1. Une bibliothèque PDF est nécessaire pour manipuler le PDF pour la saisie de hachage et intégrer ultérieurement le PKCS#7 dans le document PDF. (ex. ApachePDFBox en Java). 
  2. Une bibliothèque Crypto pour créer PKCS#7 à partir de signatures brutes reçues de l'API eSigner (ex. BouncyCastle en Java).

Pré-calculer le(s) hachage(s) pour une utilisation ultérieure avec batch_hash_sign commander. Paramètres -access_token et de -input_dir_path sont obligatoires. -credential_id est requis uniquement pour les utilisateurs disposant de plusieurs certificats de signature de document eSigner. -signing_location, -signing-reason, -contact_info-sig_field_positionet une -page_no, sont facultatifs.

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

Paramètres facultatifs:

  • If -program_name est présent lors de la signature d'un programme d'installation MSI, la valeur sera affichée dans la boîte de dialogue de confirmation en tant que nom du programme.
  • If -signing_location est présent, l'emplacement spécifié sera ajouté aux signatures numériques lorsqu'elles seront générées.
  • If -signing_reason est présent, le motif de signature spécifié sera ajouté aux signatures numériques lorsqu'elles seront générées.
  • If -contact_info est présent, le texte spécifié sera ajouté aux signatures numériques lorsqu'elles seront générées. Bien qu'elles soient incluses avec la signature, ces informations ne seront pas incluses dans les annotations de signature visibles (le cas échéant).
  • If -sig_field_position est présent, une annotation de signature visible sera ajoutée aux documents sur la page spécifiée par -page_no lorsque les signatures sont générées. La position et la signature doivent être fournies dans le format "x, y, width, height".
  • -page_no n'est requis que lors de la création d'une signature visible avec -sig_field_position et spécifie la page des documents sur laquelle les annotations de signature visibles apparaîtront lorsqu'elles seront générées.

Mise en situation :

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

Saisie DocSignTool hash sans les paramètres requis affichera les informations d'utilisation de la commande.

batch_sign_hash

Signez le(s) hachage(s) pré-calculé(s) avec hash commander. Paramètres -access_token, input_dir_path, -otpet une output_dir_path sont obligatoires. -credential_id est requis uniquement pour les utilisateurs disposant de plusieurs certificats de signature de document eSigner.

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

Paramètres facultatifs:

  • If -credential_id est omis et que l'utilisateur n'a qu'un seul certificat de signature de document eSigner, DocSignTool le choisira par défaut. Si l'utilisateur dispose de plusieurs certificats de signature de document, ce paramètre est obligatoire.

Mise en situation :

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

Saisie DocSignTool batch_sign_hash sans les paramètres requis affichera les informations d'utilisation de la commande.

Comment tester DocSignTool en mode sandbox

  1. Dans la version DocSignTool, accédez à conf dossier et ouvrez doc_sign_tool.properties filet
  2. Commentez les propriétés existantes en ajoutant # symbole devant chaque propriété
  3. Ajoutez les propriétés suivantes dans le fichier :
  4. Enregistrez le fichier. Après l'enregistrement, DocSignTool peut désormais être utilisé en mode sandbox.
  5. Pour revenir en mode production, décommentez les propriétés existantes et supprimez les propriétés du bac à sable.

Facultatif : convertissez votre certificat de signature de document OV en certificat e-sealing

Remarque: Cette section est réservée aux utilisateurs qui souhaitent faire du esealing. Pour automatiser la signature de documents et ne pas être invité par les mots de passe à usage unique (OTP), les utilisateurs convertissent eux-mêmes leur certificat de signature de document de validation d'organisation (OV) en un certificat e-sealing sur leurs comptes SSL.com. Les instructions sont ci-dessous :

  1. Cliquez Mes Commandes dans le menu supérieur de votre compte SSL.com. 
  2. Localisez votre certificat et cliquez sur le téléchargement / détails lien.
  3. Cliquez SUPPRIMER 2FA .
Merci d'avoir choisi SSL.com! Si vous avez des questions, veuillez nous contacter par e-mail à Support@SSL.com, appel 1-877-SSL-SECURE, ou cliquez simplement sur le lien de discussion en bas à droite de cette page. Vous pouvez également trouver des réponses à de nombreuses questions d'assistance courantes dans notre knowledgebase.
Twitter
Facebook
LinkedIn
Reddit
Email

Restez informé et en sécurité

SSL.com est un leader mondial de la cybersécurité, PKI et les certificats numériques. Inscrivez-vous pour recevoir les dernières nouvelles de l'industrie, des conseils et des annonces de produits de SSL.com.

Nous aimerions recevoir vos commentaires

Répondez à notre enquête et faites-nous part de votre avis sur votre récent achat.