Guía de comandos de eSigner DocSignTool

herramienta de firma de documentos es una utilidad de línea de comandos Java multiplataforma segura y orientada a la privacidad para firmar de forma remota archivos PDF utilizando firmante electrónico Certificados de firma de documentos. Los hashes de los documentos se envían a SSL.com para su firma, de modo que no se envíe el documento en sí. Esto es ideal cuando es necesario firmar documentos confidenciales, pero no deben enviarse por cable para su firma. DocSignTool también es ideal para procesos por lotes automatizados para firmas de gran volumen o integración en flujos de trabajo de documentos existentes.

Instalación de DocSignTool

Para instalar la versión actual de DocSignTool, simplemente descargue y descomprima el archivo correcto para su sistema operativo:

• Windows
• Linux y macOS

Tenga en cuenta que la descarga de Windows incluye el tiempo de ejecución de Java, pero la versión de Linux / macOS requiere que el tiempo de ejecución de Java esté instalado en su computadora. La versión de Windows del comando es un archivo por lotes (DocSignTool.bat) y la versión de Linux / macOS es un script de shell (DocSignTool.sh).

Descripción general del uso de DocSignTool

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

Opciones:

• -h, --help: Muestra el mensaje de ayuda y sale.
• -V, --version: Muestra la información de la versión y sale.

comandos:

• get_credential_ids: Muestra la lista de ID de credenciales de eSigner asociados con un usuario en particular.
• credential_info: Salida de información de clave y certificado relacionada con un ID de credencial.
• sign: Firmar y sellar el archivo PDF.
• batch_sign: Firme y marque la fecha y hora de varios archivos PDF con una sola OTP.
• hash: Calcule previamente los hash (s) para usarlos posteriormente con batch_hash_sign mando.
• batch_sign_hash: Sign hash (s) precalculados con hash mando.

parámetros:

• -access_token=<TOKEN>: OAuth Token de acceso.
• -contact_info=<CONTACT_INFO>: Información del contacto.
• -credential_id=<CREDENTIAL_ID>: ID de credencial para la firma del certificado.
• -input_dir_path=<PATH>: Directorio de entrada para los archivos PDF que se van a firmar, se calculan los hash o se seleccionan los archivos sin firmar y los hash correspondientes para firmar.
• -input_file_path=<PATH>: Ruta del archivo PDF a firmar.
• -otp=<OTP>: Valor de OAuth OTP de la aplicación de autenticación.
• -output_dir_path=<PATH>: Directorio donde se escribirán los archivos PDF firmados.
• -page_no=<PAGE_NUMBER>: Página del documento PDF donde aparecerá la firma visible.
• -password=<PASSWORD>: Contraseña de la cuenta SSL.com.
• -sig_field_position=<X, Y, WIDTH, HEIGHT>: Posición de la firma visible en PDF.
• -signing_location=<SIGNING_LOCATION>: Lugar donde se firma el documento.
• signing_reason=<SIGNING_REASON>: Razón de la firma.
• -totp_secret=<TOTP_SECRET>: OAuth Secreto de TOTP
• -username=<USERNAME>: Nombre de usuario de la cuenta SSL.com

Comandos de DocSignTool

get_credential_ids

Genere la lista de ID de credenciales de eSigner asociados con un usuario en particular. Parámetros -username y -password son requeridos.

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

Ejemplo:

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 sin los parámetros requeridos, se mostrará la información de uso del comando.

credencial_info

Salida de información de clave y certificado relacionada con un ID de credencial. Parámetros -credential_id, -usernamey -password son requeridos.

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

Ejemplo:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Información del asunto del certificado de firma: - DN del asunto: CN=JOHN DOE, O=SSL Corp , L=Houston, ST=Texas, C=US - Caducidad del certificado: sábado 11 de febrero a las 14:52:59 EST de 2023 - DN del emisor: CN=SSL.com Certificado de cliente intermedio CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=EE.UU.

Entrando DocSignTool credential_info sin los parámetros requeridos, se mostrará la información de uso del comando.

firmar

Firmar y sellar el archivo PDF. Parámetros -username, -passwordy -input_file_path son requeridos. -credential_id es necesario solo para usuarios con más de un certificado de firma de documentos eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_noy -totp_secret son opcionales

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

Parámetros opcionales:

• If -credential_id se omite y el usuario solo tiene un certificado de firma de documento eSigner, DocSignTool lo utilizará de forma predeterminada. Si el usuario tiene más de un certificado de firma de documentos, este parámetro es obligatorio.
• If -output_dir_path se omite, el archivo especificado en -input_file_path se sobrescribirá con el archivo firmado. DocSignTool le preguntará al usuario antes de sobrescribir el archivo.
• If -signing_location está presente, la ubicación especificada se agregará a la firma digital.
• If -signing_reason está presente, el motivo de la firma especificado se agregará a la firma digital.
• If -contact_info está presente, el texto especificado se agregará a la firma digital. Aunque se incluye con la firma, esta información no se incluirá en la anotación de firma visible (si está presente).
• If -sig_field_position está presente, se agregará una anotación de firma visible al documento en la página especificada por -page_no. El cargo y la firma deben proporcionarse en el formato "x, y, width, height".
• -page_no solo es necesario cuando se crea una firma visible con -sig_field_position y especifica la página del documento en la que aparecerá la anotación de firma visible.
• If -totp_secret está presente, DocSignTool calculará una OTP basada en el tiempo para la firma, lo que permitirá el uso automatizado de la herramienta. Si este parámetro no está presente, se le pedirá al usuario que ingrese manualmente la OTP.

Ejemplos:

Entrada manual de OTP con firma visible:

DocSignTool sign -credential_id = fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password = "P0z9 @ lxo41" -output_dir_path = firmado -input_file_path = test.pdf -sig_100, field 200 150, 70 "-page_no = 1 -signing_location =" Houston, Texas "-signing_reason =" aprobación del documento "-contact_info ="support@ssl.com"Ingrese la OTP - Presione enter para continuar: 884646 PDF firmado correctamente: output \ test.pdf

Generación automatizada de OTP, sin firma 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

Entrando DocSignTool sign sin los parámetros requeridos, se mostrará la información de uso del comando.

lote_sign

Firme y marque la hora hasta 100 archivos PDF con una OTP. Parámetros -username, -passwordy -input_dir_path son requeridos. -credential_id es necesario solo para usuarios con más de un certificado de firma de documentos eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_noy -totp_secret son opcionales

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

Parámetros opcionales:

• If -credential_id se omite y el usuario solo tiene un certificado de firma de documento eSigner, DocSignTool lo utilizará de forma predeterminada. Si el usuario tiene más de un certificado de firma de documentos, este parámetro es obligatorio.
• If -output_dir_path se omite, los archivos especificados en -input_dir_path se sobrescribirá con los archivos firmados. DocSignTool le preguntará al usuario antes de sobrescribir los archivos.
• If -signing_location está presente, la ubicación especificada se agregará a las firmas digitales.
• If -signing_reason está presente, el motivo de la firma especificado se agregará a las firmas digitales.
• If -contact_info está presente, el texto especificado se agregará a las firmas digitales. Aunque se incluye con la firma, esta información no se incluirá en las anotaciones visibles de la firma (si están presentes).
• If -sig_field_position está presente, se agregará una anotación de firma visible a los documentos en la página especificada por -page_no. El cargo y la firma deben proporcionarse en el formato "x, y, width, height".
• -page_no solo es necesario cuando se crea una firma visible con -sig_field_position y especifica la página de los documentos en la que aparecerán las anotaciones de firmas visibles.
• If -totp_secret está presente, DocSignTool calculará una OTP basada en el tiempo para la firma, lo que permitirá el uso automatizado de la herramienta. Si este parámetro no está presente, se le pedirá al usuario que ingrese manualmente la OTP.

Ejemplo:

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"Ingrese la OTP - Presione enter para continuar: 455145 Comando de firma por lotes ejecutado exitosamente. Directorio de salida para archivos firmados: salida

Entrando DocSignTool batch_sign sin los parámetros requeridos, se mostrará la información de uso del comando.

hachís

Calcule previamente los hash (s) para usarlos posteriormente con batch_hash_sign mando. Parámetros -access_token y -input_dir_path son requeridos. -credential_id es necesario solo para usuarios con más de un certificado de firma de documentos eSigner. -signing_location, -signing-reason, -contact_info,  -sig_field_positiony -page_no, son opcionales.

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

Parámetros opcionales:

• If -program_name está presente al firmar un instalador MSI, el valor se mostrará en el cuadro de diálogo de confirmación como el nombre del programa.
• If -signing_location está presente, la ubicación especificada se agregará a las firmas digitales cuando se generen.
• If -signing_reason está presente, el motivo de firma especificado se agregará a las firmas digitales cuando se generen.
• If -contact_info está presente, el texto especificado se agregará a las firmas digitales cuando se generen. Aunque se incluye con la firma, esta información no se incluirá en las anotaciones visibles de la firma (si están presentes).
• If -sig_field_position está presente, se agregará una anotación de firma visible a los documentos en la página especificada por -page_no cuando se generan las firmas. El cargo y la firma deben proporcionarse en el formato "x, y, width, height".
• -page_no solo es necesario cuando se crea una firma visible con -sig_field_position y especifica la página de los documentos en la que aparecerán las anotaciones de firma visibles cuando se generen.

Ejemplo:

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 sin los parámetros requeridos, se mostrará la información de uso del comando.

lote_sign_hash

Sign hash (s) precalculados con hash mando. Parámetros -access_token, input_dir_path, -otpy output_dir_path son requeridos. -credential_id es necesario solo para usuarios con más de un certificado de firma de documentos 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>

Parámetros opcionales:

• If -credential_id se omite y el usuario solo tiene un certificado de firma de documento eSigner, DocSignTool lo utilizará de forma predeterminada. Si el usuario tiene más de un certificado de firma de documentos, este parámetro es obligatorio.

Ejemplo:

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 sin los parámetros requeridos, se mostrará la información de uso del comando.

Cómo probar DocSignTool en modo sandbox

1. En la versión DocSignTool, vaya a conf carpeta y abrir doc_sign_tool.properties presentar
2. Comente las propiedades existentes agregando # símbolo antes de cada propiedad
3. Agregue las siguientes propiedades en el archivo:
   • 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. Guarda el archivo. Después de guardar, DocSignTool ahora se puede utilizar en modo sandbox.
5. Para volver al modo de producción, descomente las propiedades existentes y elimine las propiedades del espacio aislado.

Opcional: convierta su certificado de firma de documentos OV en un certificado de sellado

Nota: Esta sección es sólo para usuarios que quieran realizar eselling.. Para automatizar la firma de documentos y no recibir solicitudes de contraseñas de un solo uso (OTP), los usuarios autoconvierten su certificado de firma de documentos de Validación de organización (OV) en un certificado de sellado en sus cuentas SSL.com. Las instrucciones están a continuación:

1. Haz Clic Mis Pedidos en el menú superior de su cuenta SSL.com. 
2. Localice su certificado y haga clic en descarga / detalles .
3. Haga clic en el QUITAR 2FA del botón.