eSigner DocSignTool Guida ai comandi

DocSignStrumento è un'utilità della riga di comando Java multipiattaforma sicura e orientata alla privacy per la firma remota di file PDF utilizzando firmatario elettronico certificati di firma dei documenti. Gli hash dei documenti vengono inviati a SSL.com per la firma in modo che il documento stesso non venga inviato. Questo è l'ideale quando i documenti sensibili devono essere firmati, ma non devono essere inviati via cavo per la firma. DocSignTool è ideale anche per processi batch automatizzati per firme di grandi volumi o per l'integrazione in flussi di lavoro documentali esistenti.

Installazione di DocSignTool

Per installare la versione corrente di DocSignTool, è sufficiente scaricare e decomprimere il file corretto per il proprio sistema operativo:

• Windows
• Linux e macOS

Tieni presente che il download di Windows include Java runtime, ma la versione Linux/macOS richiede l'installazione di Java runtime sul tuo computer. La versione Windows del comando è un file batch (DocSignTool.bat) e la versione Linux / macOS è uno script di shell (DocSignTool.sh).

Panoramica sull'utilizzo di DocSignTool

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

Opzioni:

• -h, --help: Visualizza il messaggio della guida ed esce.
• -V, --version: Visualizza le informazioni sulla versione ed esce.

comandi:

• get_credential_ids: emette l'elenco degli ID delle credenziali eSigner associati a un determinato utente.
• credential_info: fornisce informazioni sulla chiave e sul certificato relative a un ID credenziale.
• sign: Firma e marca temporale PDF filr.
• batch_sign: Firma e contrassegna più file PDF con un'unica OTP.
• hash: Pre-calcolare hash per un uso successivo con batch_hash_sign comando.
• batch_sign_hash: Firma gli hash pre-calcolati con hash comando.

parametri:

• -access_token=<TOKEN>: OAut token di accesso.
• -contact_info=<CONTACT_INFO>: Informazioni sui contatti.
• -credential_id=<CREDENTIAL_ID>: ID credenziale per la firma del certificato.
• -input_dir_path=<PATH>: directory di input per i file PDF da firmare, per il calcolo degli hash o per selezionare i file non firmati e gli hash corrispondenti per la firma.
• -input_file_path=<PATH>: Percorso del file PDF da firmare.
• -otp=<OTP>: valore OAuth OTP dall'app di autenticazione.
• -output_dir_path=<PATH>: Directory in cui verranno scritti i file PDF firmati.
• -page_no=<PAGE_NUMBER>: Pagina del documento PDF in cui apparirà la firma visibile.
• -password=<PASSWORD>: password dell'account SSL.com.
• -sig_field_position=<X, Y, WIDTH, HEIGHT>: Posizione della firma visibile sul PDF.
• -signing_location=<SIGNING_LOCATION>: Luogo in cui viene firmato il documento.
• signing_reason=<SIGNING_REASON>: Motivo della firma.
• -totp_secret=<TOTP_SECRET>: OAut Segreto TOTP
• -username=<USERNAME>: nome utente dell'account SSL.com

Comandi DocSignTool

get_credential_ids

Emetti l'elenco degli ID delle credenziali eSigner associati a un particolare utente. Parametri -username e -password sono necessarie.

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

Esempio:

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

Entrando DocSignTool get_credential_ids senza i parametri richiesti verranno visualizzate le informazioni sull'utilizzo del comando.

credenziali_info

Informazioni sulla chiave e sul certificato di output relative a un ID credenziale. Parametri -credential_id, -usernamee -password sono necessarie.

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

Esempio:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Informazioni sul soggetto del certificato di firma: - DN soggetto: CN=JOHN DOE, O=SSL Corp , L=Houston, ST=Texas, C=US - Scadenza certificato: Sab Feb 11 14:52:59 EST 2023 - DN emittente: CN=SSL.com Client Certificate Intermediate CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=USA

Entrando DocSignTool credential_info senza i parametri richiesti verranno visualizzate le informazioni sull'utilizzo del comando.

segno

Firma e marca il file PDF. Parametri -username, -passworde -input_file_path sono necessarie. -credential_id è richiesto solo per gli utenti con più di un certificato di firma del documento eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_noe -totp_secret sono opzionali.

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

Parametri opzionali:

• If -credential_id viene omesso e l'utente dispone di un solo certificato di firma del documento eSigner, DocSignTool lo utilizzerà per impostazione predefinita. Se l'utente dispone di più di un certificato di firma del documento, questo parametro è obbligatorio.
• If -output_dir_path viene omesso, il file specificato in -input_file_path verrà sovrascritto con il file firmato. DocSignTool chiederà all'utente prima di sovrascrivere il file.
• If -signing_location è presente, la posizione specificata verrà aggiunta alla firma digitale.
• If -signing_reason è presente, il motivo della firma specificato verrà aggiunto alla firma digitale.
• If -contact_info è presente, il testo specificato verrà aggiunto alla firma digitale. Sebbene incluse con la firma, queste informazioni non saranno incluse nell'annotazione della firma visibile (se presente).
• If -sig_field_position è presente, verrà aggiunta un'annotazione di firma visibile al documento nella pagina specificata da -page_no. La posizione e la firma devono essere fornite nel formato "x, y, width, height".
• -page_no è richiesto solo quando si crea una firma visibile con -sig_field_position e specifica la pagina del documento su cui apparirà l'annotazione della firma visibile.
• If -totp_secret è presente, DocSignTool calcolerà un OTP basato sul tempo per la firma, consentendo l'uso automatizzato dello strumento. Se questo parametro non è presente, all'utente verrà richiesto di immettere manualmente l'OTP.

Esempi:

Inserimento manuale OTP con firma visibile:

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 -sig_field_position="100, 200, 150, 70" -page_no=1 -signing_location="Houston, Texas" -signing_reason="approvazione documento" -contact_info="support@ssl.com" Inserisci l'OTP - Premi invio per continuare: 884646 PDF firmato con successo: output\test.pdf

Generazione automatizzata di OTP, nessuna firma visibile:

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

Entrando DocSignTool sign senza i parametri richiesti verranno visualizzate le informazioni sull'utilizzo del comando.

segno_batch

Firma e contrassegna fino a 100 file PDF con una OTP. Parametri -username, -passworde -input_dir_path sono necessarie. -credential_id è richiesto solo per gli utenti con più di un certificato di firma del documento eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_noe -totp_secret sono opzionali.

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

Parametri opzionali:

• If -credential_id viene omesso e l'utente dispone di un solo certificato di firma del documento eSigner, DocSignTool lo utilizzerà per impostazione predefinita. Se l'utente dispone di più di un certificato di firma del documento, questo parametro è obbligatorio.
• If -output_dir_path viene omesso, i file specificati in -input_dir_path verrà sovrascritto con i file firmati. DocSignTool chiederà all'utente prima di sovrascrivere i file.
• If -signing_location è presente, la posizione specificata verrà aggiunta alle firme digitali.
• If -signing_reason è presente, il motivo della firma specificato verrà aggiunto alle firme digitali.
• If -contact_info è presente, il testo specificato verrà aggiunto alle firme digitali. Sebbene incluse con la firma, queste informazioni non saranno incluse nelle annotazioni della firma visibili (se presenti).
• If -sig_field_position è presente, verrà aggiunta un'annotazione di firma visibile ai documenti nella pagina specificata da -page_no. La posizione e la firma devono essere fornite nel formato "x, y, width, height".
• -page_no è richiesto solo quando si crea una firma visibile con -sig_field_position e specifica la pagina dei documenti su cui appariranno le annotazioni di firma visibili.
• If -totp_secret è presente, DocSignTool calcolerà un OTP basato sul tempo per la firma, consentendo l'uso automatizzato dello strumento. Se questo parametro non è presente, all'utente verrà richiesto di immettere manualmente l'OTP.

Esempio:

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" Immettere l'OTP - Premere invio per continuare: 455145 Comando di firma batch eseguito correttamente. Directory di output per i file firmati: output

Entrando DocSignTool batch_sign senza i parametri richiesti verranno visualizzate le informazioni sull'utilizzo del comando.

hash

Pre-calcolare hash per un uso successivo con batch_hash_sign comando. Parametri -access_token e -input_dir_path sono necessarie. -credential_id è richiesto solo per gli utenti con più di un certificato di firma del documento eSigner. -signing_location, -signing-reason, -contact_info,  -sig_field_positione -page_no, sono facoltativi.

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

Parametri opzionali:

• If -program_name è presente quando si firma un programma di installazione MSI, il valore verrà visualizzato nella finestra di dialogo di conferma come nome del programma.
• If -signing_location è presente, la posizione specificata verrà aggiunta alle firme digitali quando vengono generate.
• If -signing_reason è presente, il motivo della firma specificato verrà aggiunto alle firme digitali quando vengono generate.
• If -contact_info è presente, il testo specificato verrà aggiunto alle firme digitali quando vengono generate. Sebbene incluse con la firma, queste informazioni non saranno incluse nelle annotazioni della firma visibili (se presenti).
• If -sig_field_position è presente, verrà aggiunta un'annotazione di firma visibile ai documenti nella pagina specificata da -page_no quando vengono generate le firme. La posizione e la firma devono essere fornite nel formato "x, y, width, height".
• -page_no è richiesto solo quando si crea una firma visibile con -sig_field_position e specifica la pagina dei documenti su cui appariranno le annotazioni di firma visibili quando vengono generate.

Esempio:

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

Entrando DocSignTool hash senza i parametri richiesti verranno visualizzate le informazioni sull'utilizzo del comando.

batch_sign_hash

Firma hash(es) pre-calcolato con hash comando. Parametri -access_token, input_dir_path, -otpe output_dir_path sono necessarie. -credential_id è richiesto solo per gli utenti con più di un certificato di firma del documento eSigner.

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

Parametri opzionali:

• If -credential_id viene omesso e l'utente dispone di un solo certificato di firma del documento eSigner, DocSignTool lo utilizzerà per impostazione predefinita. Se l'utente dispone di più di un certificato di firma del documento, questo parametro è obbligatorio.

Esempio:

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

Entrando DocSignTool batch_sign_hash senza i parametri richiesti verranno visualizzate le informazioni sull'utilizzo del comando.

Come testare DocSignTool in modalità sandbox

1. Nella versione DocSignTool, vai a conf cartella e aperto doc_sign_tool.properties filetto
2. Commentare le proprietà esistenti aggiungendo # simbolo prima di ogni proprietà
3. Aggiungi le seguenti proprietà nel file:
   • CLIENT_ID=qOUeZCCzSqgA93acB3LYq6lBNjgZdiOxQc-KayC3UMw
   • OAUTH2_ENDPOINT=https://oauth-sandbox.ssl.com/oauth2/token
   • CSC_API_ENDPOINT=https://cs-try.ssl.com
   • TSA_URL=http://ts.ssl.com
4. Salvare il file. Dopo il salvataggio, DocSignTool può ora essere utilizzato in modalità sandbox.
5. Per tornare alla modalità di produzione, rimuovere il commento dalle proprietà esistenti ed eliminare le proprietà sandbox.

Facoltativo: converti il ​​tuo certificato di firma del documento OV in un certificato di sigillatura

Nota: Questa sezione è riservata solo agli utenti che desiderano eseguire la sigillatura. Per automatizzare la firma dei documenti e non ricevere richieste da One Time Password (OTP), gli utenti convertono automaticamente il proprio certificato di firma dei documenti di convalida dell'organizzazione (OV) in un certificato di sigillatura sui propri account SSL.com. Le istruzioni sono di seguito:

1. Clicchi Ordini nel menu in alto del tuo account SSL.com. 
2. Individua il tuo certificato e fai clic su scaricare / dettagli collegamento.
3. Clicca su RIMUOVERE 2FA pulsante.