Guia de Comandos do eSigner DocSignTool

Ferramenta DocSign é um utilitário de linha de comando Java multiplataforma, seguro e voltado para a privacidade, para assinar arquivos PDF remotamente usando Assinatura eletrônica certificados de assinatura de documentos. Os hashes dos documentos são enviados para SSL.com para assinatura, para que o documento em si não seja enviado. Isso é ideal quando documentos confidenciais precisam ser assinados, mas não devem ser enviados por transferência bancária para assinatura. DocSignTool também é ideal para processos em lote automatizados para assinaturas de alto volume ou integração em fluxos de trabalho de documentos existentes.

Instalação DocSignTool

Para instalar a versão atual do DocSignTool, basta baixar e descompactar o arquivo correto para o seu sistema operacional:

• Windows
• Linux e macOS

Observe que o download do Windows inclui Java Runtime, mas a versão Linux / macOS requer que o Java Runtime esteja instalado em seu computador. A versão do Windows do comando é um arquivo em lote (DocSignTool.bat) e a versão Linux / macOS é um script de shell (DocSignTool.sh).

Visão geral do uso do DocSignTool

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

opções:

• -h, --help: Exibe a mensagem de ajuda e sai.
• -V, --version: Exibe informações sobre a versão e sai.

comandos:

• get_credential_ids: Produz a lista de IDs de credenciais do eSigner associados a um determinado usuário.
• credential_info: Chave de saída e informações de certificado relacionadas a um ID de credencial.
• sign: Assinar e registrar a data e hora do arquivo em PDF.
• batch_sign: Assine e registre a data e hora de vários arquivos PDF com um OTP.
• hash: Pré-computar hash (s) para uso posterior com batch_hash_sign comando.
• batch_sign_hash: Sinal de hash (s) pré-calculado com hash comando.

parâmetros:

• -access_token=<TOKEN>: OAuth token de acesso.
• -contact_info=<CONTACT_INFO>: Informações de Contato.
• -credential_id=<CREDENTIAL_ID>: ID de credencial para assinar o certificado.
• -input_dir_path=<PATH>: Diretório de entrada para arquivos PDF a serem assinados, ter hashes computados ou escolher arquivos não assinados e hashes correspondentes para assinatura.
• -input_file_path=<PATH>: Caminho do arquivo PDF a ser assinado.
• -otp=<OTP>: Valor OAuth OTP do aplicativo de autenticação.
• -output_dir_path=<PATH>: Diretório onde os arquivos PDF assinados serão gravados.
• -page_no=<PAGE_NUMBER>: Página do documento PDF onde aparecerá a assinatura visível.
• -password=<PASSWORD>: Senha da conta SSL.com.
• -sig_field_position=<X, Y, WIDTH, HEIGHT>: Posição da assinatura visível no PDF.
• -signing_location=<SIGNING_LOCATION>: Local onde o documento é assinado.
• signing_reason=<SIGNING_REASON>: Motivo da assinatura.
• -totp_secret=<TOTP_SECRET>: OAuth Segredo TOTP
• -username=<USERNAME>: Nome de usuário da conta SSL.com

Comandos DocSignTool

get_credential_ids

Produza a lista de IDs de credenciais do eSigner associados a um determinado usuário. Parâmetros -username e -password é requerido.

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

Exemplo:

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 sem os parâmetros necessários exibirá informações de uso para o comando.

credencial_info

Chave de saída e informações de certificado relacionadas a um ID de credencial. Parâmetros -credential_id, -username e -password é requerido.

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

Exemplo:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Assinatura do certificado Informações do assunto: - DN do assunto: CN=JOHN DOE, O=SSL Corp , L=Houston, ST=Texas, C=US - Expiração do certificado: Sáb 11 de fevereiro 14:52:59 EST 2023 - DN do emissor: CN=SSL.com Certificado de cliente intermediário CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=EUA

entrando DocSignTool credential_info sem os parâmetros necessários exibirá informações de uso para o comando.

assinar

Arquivo PDF de assinatura e carimbo de data / hora. Parâmetros -username, -password e -input_file_path é requerido. -credential_id é necessário apenas para usuários com mais de um certificado de assinatura de documento eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_no e -totp_secret são opcionais.

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 opcionais:

• If -credential_id é omitido e o usuário tem apenas um certificado de assinatura de documento eSigner, o DocSignTool assumirá como padrão. Se o usuário tiver mais de um certificado de assinatura de documento, este parâmetro é obrigatório.
• If -output_dir_path é omitido, o arquivo especificado em -input_file_path será substituído pelo arquivo assinado. DocSignTool solicitará ao usuário antes de sobrescrever o arquivo.
• If -signing_location estiver presente, o local especificado será adicionado à assinatura digital.
• If -signing_reason estiver presente, o motivo da assinatura especificado será adicionado à assinatura digital.
• If -contact_info estiver presente, o texto especificado será adicionado à assinatura digital. Embora incluídas com a assinatura, essas informações não serão incluídas na anotação de assinatura visível (se houver).
• If -sig_field_position estiver presente, uma anotação de assinatura visível será adicionada ao documento na página especificada por -page_no. A posição e a assinatura devem ser fornecidas no formato "x, y, width, height".
• -page_no só é necessário ao criar uma assinatura visível com -sig_field_position e especifica a página do documento em que a anotação de assinatura visível aparecerá.
• If -totp_secret estiver presente, o DocSignTool calculará uma OTP baseada no tempo para assinatura, permitindo o uso automatizado da ferramenta. Se este parâmetro não estiver presente, o usuário será solicitado a inserir manualmente o OTP.

Exemplos:

Entrada manual de OTP com assinatura visível:

Assinatura do 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 -sig_field_position="100, 200, 150, 70" -page_no=1 -signing_location="Houston, Texas" -signing_reason="document approval" -contact_info="support@ssl.com" Insira o OTP - Pressione Enter para continuar: 884646 PDF assinado com sucesso: output\test.pdf

Geração de OTP automatizada, sem assinatura visível:

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 sem os parâmetros necessários exibirá informações de uso para o comando.

lote_sign

Assine e registre a data e hora de até 100 arquivos PDF com um OTP. Parâmetros -username, -password e -input_dir_path é requerido. -credential_id é necessário apenas para usuários com mais de um certificado de assinatura de documento eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_no e -totp_secret são opcionais.

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 opcionais:

• If -credential_id é omitido e o usuário tem apenas um certificado de assinatura de documento eSigner, o DocSignTool assumirá como padrão. Se o usuário tiver mais de um certificado de assinatura de documento, este parâmetro é obrigatório.
• If -output_dir_path é omitido, os arquivos especificados em -input_dir_path será sobrescrito com os arquivos assinados. DocSignTool solicitará ao usuário antes de sobrescrever os arquivos.
• If -signing_location estiver presente, o local especificado será adicionado às assinaturas digitais.
• If -signing_reason estiver presente, o motivo da assinatura especificado será adicionado às assinaturas digitais.
• If -contact_info estiver presente, o texto especificado será adicionado às assinaturas digitais. Embora incluídas com a assinatura, essas informações não serão incluídas nas anotações de assinatura visíveis (se houver).
• If -sig_field_position estiver presente, uma anotação de assinatura visível será adicionada aos documentos na página especificada por -page_no. A posição e a assinatura devem ser fornecidas no formato "x, y, width, height".
• -page_no só é necessário ao criar uma assinatura visível com -sig_field_position e especifica a página dos documentos em que as anotações de assinatura visíveis aparecerão.
• If -totp_secret estiver presente, o DocSignTool calculará uma OTP baseada no tempo para assinatura, permitindo o uso automatizado da ferramenta. Se este parâmetro não estiver presente, o usuário será solicitado a inserir manualmente o OTP.

Exemplo:

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" Insira o OTP - Pressione Enter para continuar: 455145 Comando de assinatura em lote executado com sucesso. Diretório de saída para arquivos assinados: output

entrando DocSignTool batch_sign sem os parâmetros necessários exibirá informações de uso para o comando.

hash

Pré-computar hash (s) para uso posterior com batch_hash_sign comando. Parâmetros -access_token e -input_dir_path é requerido. -credential_id é necessário apenas para usuários com mais de um certificado de assinatura de documento eSigner. -signing_location, -signing-reason, -contact_info,  -sig_field_position e -page_no, são opcionais.

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 opcionais:

• If -program_name estiver presente ao assinar um instalador MSI, o valor será exibido na caixa de diálogo de confirmação como o nome do programa.
• If -signing_location estiver presente, o local especificado será adicionado às assinaturas digitais quando forem geradas.
• If -signing_reason estiver presente, o motivo da assinatura especificado será adicionado às assinaturas digitais quando forem geradas.
• If -contact_info estiver presente, o texto especificado será adicionado às assinaturas digitais quando forem geradas. Embora incluídas com a assinatura, essas informações não serão incluídas nas anotações de assinatura visíveis (se houver).
• If -sig_field_position estiver presente, uma anotação de assinatura visível será adicionada aos documentos na página especificada por -page_no quando as assinaturas são geradas. A posição e a assinatura devem ser fornecidas no formato "x, y, width, height".
• -page_no só é necessário ao criar uma assinatura visível com -sig_field_position e especifica a página dos documentos em que as anotações de assinatura visíveis aparecerão quando forem geradas.

Exemplo:

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 sem os parâmetros necessários exibirá informações de uso para o comando.

batch_sign_hash

Assinar hash (s) pré-computado (s) com hash comando. Parâmetros -access_token, input_dir_path, -otp e output_dir_path é requerido. -credential_id é necessário apenas para usuários com mais de um certificado de assinatura de 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>

Parâmetros opcionais:

• If -credential_id é omitido e o usuário tem apenas um certificado de assinatura de documento eSigner, o DocSignTool assumirá como padrão. Se o usuário tiver mais de um certificado de assinatura de documento, este parâmetro é obrigatório.

Exemplo:

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 sem os parâmetros necessários exibirá informações de uso para o comando.

Como testar o DocSignTool no modo sandbox

1. Na versão DocSignTool, vá para conf pasta e abrir doc_sign_tool.properties lima
2. Comente as propriedades existentes adicionando # símbolo antes de cada propriedade
3. Adicione as seguintes propriedades no arquivo:
   • 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. Salve o arquivo. Depois de salvar, o DocSignTool agora pode ser usado no modo sandbox.
5. Para voltar ao modo de produção, remova o comentário das propriedades existentes e exclua as propriedades do sandbox.

Opcional: Converta seu certificado de assinatura de documento OV em um certificado de selagem

Nota: Esta seção é apenas para usuários que desejam fazer selagem. Para automatizar a assinatura de documentos e não serem solicitados por senhas de uso único (OTP), os usuários convertem automaticamente seu certificado de assinatura de documento de validação da organização (OV) em um certificado esealing em suas contas SSL.com. As instruções estão abaixo:

1. Clique Encomendas no menu superior da sua conta SSL.com. 
2. Localize seu certificado e clique no botão download / detalhes link.
3. Clique na REMOVER 2FA botão.