DocSignツール は、を使用してPDFファイルにリモート署名するための安全なプライバシー指向のマルチプラットフォームJavaコマンドラインユーティリティです。 電子署名者 文書署名証明書。文書自体は送信されないように、文書のハッシュは署名のために SSL.com に送信されます。これは、機密文書に署名する必要があるが、署名のためにネットワーク経由で送信すべきではない場合に最適です。 DocSignTool は、大量の署名や既存の文書ワークフローへの統合のための自動バッチ プロセスにも最適です。
代わりに、esignerを使用してコードとexcutablesに署名することを検討している場合は、 このCodeSignToolガイドを参照してください.
DocSignToolのインストール
DocSignToolの現在のバージョンをインストールするには、OSに適したファイルをダウンロードして解凍するだけです。
Windows のダウンロードには Java ランタイムが含まれていますが、Linux/macOS バージョンでは Java ランタイムがコンピューターにインストールされている必要があることに注意してください。 コマンドの Windows バージョンはバッチ ファイル (DocSignTool.bat
)およびLinux / macOSバージョンはシェルスクリプトです(DocSignTool.sh
).
DocSignToolの使用法の概要
使用法: DocSignTool [-hV] [COMMAND] [PARAMETERS]
オプション:
-h
,--help
:ヘルプメッセージを表示して終了します。-V
,--version
:バージョン情報を表示して終了します。
コマンド:
get_credential_ids
: 特定のユーザーに関連付けられている eSigner クレデンシャル ID のリストを出力します。credential_info
: クレデンシャル ID に関連するキーと証明書の情報を出力します。sign
:PDFファイルに署名してタイムスタンプを付けます。batch_sign
:XNUMXつのOTPで複数のPDFファイルに署名してタイムスタンプを付けます。hash
: 後で使用するためにハッシュを事前に計算しますbatch_hash_sign
batch_sign_hash
: 事前に計算されたハッシュに署名しますhash
パラメーター:
-access_token=<TOKEN>
:OAuth アクセストークン.-contact_info=<CONTACT_INFO>
: 連絡先。-credential_id=<CREDENTIAL_ID>
: 証明書に署名するための資格 ID。-input_dir_path=<PATH>
:署名するPDFファイルの入力ディレクトリ、ハッシュを計算する、または署名されていないファイルと対応するハッシュを選択して署名します。-input_file_path=<PATH>
:署名するPDFファイルのパス。-otp=<OTP>
: 認証アプリからの OAuth OTP 値。-output_dir_path=<PATH>
:署名されたPDFファイルが書き込まれるディレクトリ。-page_no=<PAGE_NUMBER>
:目に見える署名が表示されるPDFドキュメントのページ。-password=<PASSWORD>
: SSL.com アカウントのパスワード。-sig_field_position=<X, Y, WIDTH, HEIGHT>
:PDF上の表示可能な署名の位置。-signing_location=<SIGNING_LOCATION>
:文書が署名されている場所。signing_reason=<SIGNING_REASON>
:署名の理由。-totp_secret=<TOTP_SECRET>
:OAuth TOTPシークレット-username=<USERNAME>
: SSL.comアカウントのユーザー名
-password="P!@^^ssword12"
).DocSignToolコマンド
get_credential_ids
特定のユーザーに関連付けられている eSigner クレデンシャル ID のリストを出力します。 パラメーター -username
と -password
必要とされます。
使用法: DocSignTool [-hV] get_credential_ids -username=<USERNAME> -password=<PASSWORD>
例:
DocSignTool get_credential_ids -username=john.doe@example.com -password="P0z9@lxo41" Credential ID(s): - fe537ace-e132-52a9-c2e7-egcd2ac3f1e6
入力します DocSignTool get_credential_ids
必要なパラメーターがないと、コマンドの使用法情報が表示されます。
資格情報
クレデンシャル ID に関連するキーと証明書の情報を出力します。 パラメーター -credential_id
, -username
, -password
必要とされます。
使用法: DocSignTool [-hV] credential_info -credential_id=<CREDENTIAL_ID> -username=<USERNAME> -password=<PASSWORD>
例:
DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" 署名証明書の件名情報: - 件名 DN: CN=JOHN DOE、O=SSL Corp 、L=ヒューストン、ST=テキサス、C=US - 証明書の有効期限: 11 年 14 月 52 日土曜日 59:2023:2 EST - 発行者 DN: CN=SSL.com クライアント証明書中間 CA RSA RXNUMX、O=SSL Corp、L=ヒューストン、ST=テキサス、C=米国
入力します DocSignTool credential_info
必要なパラメーターがないと、コマンドの使用法情報が表示されます。
符号
PDFファイルに署名してタイムスタンプを付けます。 パラメーター -username
, -password
, -input_file_path
必要とされます。 -credential_id
複数のeSignerドキュメント署名証明書を持つユーザーにのみ必要です。 -output_dir_path
, -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, -page_no
, -totp_secret
オプションです。
使用法: 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>]
オプションのパラメータ:
- If
-credential_id
が省略され、ユーザーがeSignerドキュメント署名証明書をXNUMXつしか持っていない場合、DocSignToolはデフォルトでそれを使用します。 ユーザーが複数のドキュメント署名証明書を持っている場合、このパラメーターは必須です。 - If
-output_dir_path
で指定されたファイルは省略されます-input_file_path
署名されたファイルで上書きされます。 DocSignToolは、ファイルを上書きする前にユーザーにプロンプトを表示します。 - If
-signing_location
が存在する場合、指定された場所がデジタル署名に追加されます。 - If
-signing_reason
が存在する場合、指定された署名の理由がデジタル署名に追加されます。 - If
-contact_info
が存在する場合、指定されたテキストがデジタルシグマチュアに追加されます。 署名には含まれていますが、この情報は表示される署名注釈には含まれません(存在する場合)。 - If
-sig_field_position
が存在する場合、表示される署名注釈が、で指定されたページのドキュメントに追加されます。-page_no
。 位置と署名は次の形式で提供する必要があります"x, y, width, height"
. -page_no
で表示可能な署名を作成する場合にのみ必要です-sig_field_position
表示される署名注釈が表示されるドキュメントのページを指定します。- If
-totp_secret
が存在する場合、DocSignToolは署名用の時間ベースのOTPを計算し、ツールの自動使用を可能にします。 このパラメータが存在しない場合、ユーザーは手動でOTPを入力するように求められます。
例:
目に見える署名付きの手動OTP入力:
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="document authorization" -contact_info="support@ssl.com" OTP を入力してください - Enter キーを押して続行します: 884646 PDF が正常に署名されました: output\test.pdf
自動化されたOTP生成、目に見える署名なし:
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
入力します DocSignTool sign
必要なパラメーターがないと、コマンドの使用法情報が表示されます。
Error: invalid otp
ファイルに署名しようとすると、次のXNUMXつ以上の問題が原因である可能性があります。
- 認証アプリにスキャンしたQRコードが、コマンドのユーザー名、パスワード、クレデンシャルIDと一致しません。 これは、次の場合に発生する可能性があります。
- デバイスに2FA用に構成された複数のアカウントがあり、間違ったアカウントを選択しました。
- ログインクレデンシャルを次の目的で使用しようとしています 共有証明書、ただし、チームメートが共有するQRコードをアカウントからスキャンしました。
- 入力したOTPはすでに期限切れになっています。
- コマンドに無効なTOTPシークレットが含まれています。
バッチサイン
100つのOTPで最大XNUMX個のPDFファイルに署名してタイムスタンプを付けます。 パラメーター -username
, -password
, -input_dir_path
必要とされます。 -credential_id
複数のeSignerドキュメント署名証明書を持つユーザーにのみ必要です。 -output_dir_path
, -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, -page_no
, -totp_secret
オプションです。
使用法: 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>]
オプションのパラメータ:
- If
-credential_id
が省略され、ユーザーがeSignerドキュメント署名証明書をXNUMXつしか持っていない場合、DocSignToolはデフォルトでそれを使用します。 ユーザーが複数のドキュメント署名証明書を持っている場合、このパラメーターは必須です。 - If
-output_dir_path
を省略すると、で指定されたファイル-input_dir_path
署名されたファイルで上書きされます。 DocSignToolは、ファイルを上書きする前にユーザーにプロンプトを表示します。 - If
-signing_location
が存在する場合、指定された場所がデジタル署名に追加されます。 - If
-signing_reason
が存在する場合、指定された署名の理由がデジタル署名に追加されます。 - If
-contact_info
が存在する場合、指定されたテキストがデジタルシグマチュアに追加されます。 署名には含まれていますが、この情報は表示される署名注釈には含まれません(存在する場合)。 - If
-sig_field_position
が存在する場合、表示される署名注釈が、で指定されたページのドキュメントに追加されます。-page_no
。 位置と署名は次の形式で提供する必要があります"x, y, width, height"
. -page_no
で表示可能な署名を作成する場合にのみ必要です-sig_field_position
表示される署名注釈が表示されるドキュメントのページを指定します。- If
-totp_secret
が存在する場合、DocSignToolは署名用の時間ベースのOTPを計算し、ツールの自動使用を可能にします。 このパラメータが存在しない場合、ユーザーは手動でOTPを入力するように求められます。
例:
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 authorization" -contact_info="support@ssl.com" OTP を入力してください - 続行するには Enter キーを押してください: 455145 バッチ署名コマンドが正常に実行されました。署名済みファイルの出力ディレクトリ: output
入力します DocSignTool batch_sign
必要なパラメーターがないと、コマンドの使用法情報が表示されます。
ハッシュ
- PDF ライブラリは、ハッシュ入力用に PDF を操作し、後で PDF ドキュメントに PKCS#7 を埋め込むために必要です。 (例: Java の ApachePDFBox)。
- eSigner API (例: Java の BouncyCastle) から受け取った生の署名から PKCS#7 を作成するための暗号ライブラリ。
後で使用するためにハッシュを事前に計算します batch_hash_sign
コマンド。 パラメーター -access_token
と -input_dir_path
必要とされます。 -credential_id
複数のeSignerドキュメント署名証明書を持つユーザーにのみ必要です。 -signing_location
, -signing-reason
, -contact_info
, -sig_field_position
, -page_no
、はオプションです。
使用法: 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>]
オプションのパラメータ:
- If
-program_name
MSIインストーラーに署名するときにが存在する場合、値はプログラム名として確認ダイアログに表示されます。 - If
-signing_location
が存在する場合、指定された場所は、デジタル署名が生成されるときにデジタル署名に追加されます。 - If
-signing_reason
が存在する場合、指定された署名の理由は、デジタル署名が生成されるときに追加されます。 - If
-contact_info
が存在する場合、指定されたテキストは、生成時にデジタルシグマチュアに追加されます。 署名には含まれていますが、この情報は表示される署名注釈には含まれません(存在する場合)。 - If
-sig_field_position
が存在する場合、表示される署名注釈が、で指定されたページのドキュメントに追加されます。-page_no
署名が生成されたとき。 位置と署名は次の形式で提供する必要があります"x, y, width, height"
. -page_no
で表示可能な署名を作成する場合にのみ必要です-sig_field_position
表示される署名注釈が生成されたときに表示されるドキュメントのページを指定します。
例:
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
入力します DocSignTool hash
必要なパラメーターがないと、コマンドの使用法情報が表示されます。
バッチ署名ハッシュ
で事前計算された署名ハッシュ hash
コマンド。 パラメーター -access_token
, input_dir_path
, -otp
, output_dir_path
必要とされます。 -credential_id
複数のeSignerドキュメント署名証明書を持つユーザーにのみ必要です。
使用法: DocSignTool [-hV] batch_sign_hash -access_token=<ACCESS_TOKEN> [-credential_id=<CREDENTIAL_ID>] -input_dir_path=<PATH> -output_dir_path=<PATH> -otp=<OTP>
オプションのパラメータ:
- If
-credential_id
が省略され、ユーザーがeSignerドキュメント署名証明書をXNUMXつしか持っていない場合、DocSignToolはデフォルトでそれを使用します。 ユーザーが複数のドキュメント署名証明書を持っている場合、このパラメーターは必須です。
例:
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
入力します DocSignTool batch_sign_hash
必要なパラメーターがないと、コマンドの使用法情報が表示されます。
サンドボックス モードで DocSignTool をテストする方法
- DocSignTool リリースでは、次の場所に移動します。
conf
フォルダを開いてdoc_sign_tool.properties
file - を追加して既存のプロパティをコメントアウトします。
#
すべてのプロパティの前の記号 - ファイルに次のプロパティを追加します。
CLIENT_ID
=qOUeZCCzSqgA93acB3LYq6lBNjgZdiOxQc-KayC3UMwOAUTH2_ENDPOINT
=https://oauth-sandbox.ssl.com/oauth2/tokenCSC_API_ENDPOINT
=https://cs-try.ssl.comTSA_URL
=http://ts.ssl.com
- ファイルを保存します。 保存後、DocSignTool をサンドボックス モードで使用できるようになります。
- 運用モードに戻すには、既存のプロパティのコメントを解除し、サンドボックス プロパティを削除します。
オプション: OV ドキュメント署名証明書をシール証明書に変換します。
ご注意: このセクションはシーリングを希望するユーザーのみを対象としています。。ドキュメントの署名を自動化し、ワンタイム パスワード (OTP) によるプロンプトを表示しないようにするには、ユーザーは組織検証 (OV) ドキュメント署名証明書を SSL.com アカウントのシール証明書に自己変換します。手順は以下のとおりです。
- クリック 注文 SSL.com アカウントのトップメニューにあります。
- 証明書を見つけて、 ダウンロード/詳細 リンクをクリックします。
- クリック 2FA の削除