Panduan Perintah eSigner DocSignTool

AlatTanda Dokumen adalah utilitas baris perintah Java multi-platform yang aman dan berorientasi privasi untuk menandatangani file PDF dari jarak jauh menggunakan penandatangan elektronik sertifikat penandatanganan dokumen. Hash dokumen dikirim ke SSL.com untuk ditandatangani sehingga dokumen itu sendiri tidak terkirim. Ini ideal jika dokumen sensitif perlu ditandatangani, namun tidak boleh dikirim melalui kawat untuk ditandatangani. DocSignTool juga ideal untuk proses batch otomatis untuk penandatanganan volume tinggi atau integrasi ke dalam alur kerja dokumen yang ada.

Jika Anda ingin mencoba DocSignTool dengan akun demo dan sertifikat, silakan baca Kredensial dan Sertifikat Demo eSigner untuk kredensial dan informasi konfigurasi.

Jika Anda ingin menggunakan esigner untuk menandatangani kode dan file yang dapat dieksekusi, silakan lihat panduan CodeSignTool ini.

Otorisasi OTP tidak diperlukan saat penandatanganan menggunakan sertifikat penandatanganan dokumen penyegelan. Abaikan semua parameter OTP dalam panduan berikut jika menggunakan sertifikat penandatanganan dokumen penyegelan. (Pelanggan dengan yang sudah ada Sertifikat penandatanganan dokumen Validasi Organisasi dapat menghubungi support@ssl.com untuk mengubahnya menjadi sertifikat eSealing.)

Instalasi DocSignTool

Untuk menginstal versi DocSignTool saat ini, cukup unduh dan unzip file yang benar untuk OS Anda:

Perhatikan bahwa unduhan Windows menyertakan runtime Java, tetapi versi Linux/macOS memerlukan runtime Java untuk diinstal di komputer Anda. Versi Windows dari perintah adalah file batch (DocSignTool.bat) dan versi Linux / macOS adalah skrip shell (DocSignTool.sh).

Ikhtisar Penggunaan DocSignTool

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

Pilihan:

  • -h, --help: Menampilkan pesan bantuan dan keluar.
  • -V, --version: Menampilkan informasi versi dan keluar.

Perintah:

  • get_credential_ids: Menampilkan daftar ID kredensial eSigner yang terkait dengan pengguna tertentu.
  • credential_info: Kunci keluaran dan informasi sertifikat yang terkait dengan ID kredensial.
  • sign: Masuk dan stempel waktu file PDF.
  • batch_sign: Masuk dan stempel waktu beberapa file PDF dengan satu OTP.
  • hash: Pra-komputasi hash untuk digunakan nanti dengan batch_hash_sign perintah.
  • batch_sign_hash: Tanda tangani hash yang telah dihitung sebelumnya dengan hash perintah.

Parameter:

  • -access_token=<TOKEN>: OAuth token akses.
  • -contact_info=<CONTACT_INFO>: Kontak informasi.
  • -credential_id=<CREDENTIAL_ID>: ID Kredensial untuk menandatangani sertifikat.
  • -input_dir_path=<PATH>: Masukkan direktori untuk file PDF yang akan ditandatangani, hash dihitung, atau pilih file yang tidak ditandatangani dan hash yang sesuai untuk ditandatangani.
  • -input_file_path=<PATH>: Jalur file PDF yang akan ditandatangani.
  • -otp=<OTP>: Nilai OTP OAuth dari aplikasi autentikasi.
  • -output_dir_path=<PATH>: Direktori tempat file PDF yang ditandatangani akan ditulis.
  • -page_no=<PAGE_NUMBER>: Halaman dokumen PDF di mana tanda tangan yang terlihat akan muncul.
  • -password=<PASSWORD>: kata sandi akun SSL.com.
  • -sig_field_position=<X, Y, WIDTH, HEIGHT>: Posisi tanda tangan yang terlihat pada PDF.
  • -signing_location=<SIGNING_LOCATION>: Lokasi di mana dokumen ditandatangani.
  • signing_reason=<SIGNING_REASON>: Alasan penandatanganan.
  • -totp_secret=<TOTP_SECRET>: OAuth Rahasia TOTP
  • -username=<USERNAME>: nama pengguna akun SSL.com
Jika kata sandi Anda mengandung karakter khusus, apit dengan tanda kutip (mis -password="P!@^^ssword12").

Perintah DocSignTool

get_credential_id

Keluarkan daftar ID kredensial eSigner yang terkait dengan pengguna tertentu. Parameter -username dan -password diperlukan.

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

Contoh:

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

Memasuki DocSignTool get_credential_ids tanpa parameter yang diperlukan akan menampilkan informasi penggunaan untuk perintah tersebut.

kredensial_info

Kunci keluaran dan informasi sertifikat yang terkait dengan ID kredensial. Parameter -credential_id, -username, dan -password diperlukan.

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

Contoh:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Menandatangani Sertifikat Informasi Subjek: - DN Subjek: CN=JOHN DOE, O=SSL Corp , L=Houston, ST=Texas, C=US - Kedaluwarsa Sertifikat: Sabtu 11 Feb 14:52:59 EST 2023 - DN Penerbit: CN=SSL.com Sertifikat Klien Menengah CA RSA R2, O=SSL Corp, L=Houston , ST=Texas, C=AS

Memasuki DocSignTool credential_info tanpa parameter yang diperlukan akan menampilkan informasi penggunaan untuk perintah tersebut.

menandatangani

Tanda tangani dan stempel waktu file PDF. Parameter -username, -password, dan -input_file_path diperlukan. -credential_id diperlukan hanya untuk pengguna dengan lebih dari satu sertifikat penandatanganan dokumen eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_no, dan -totp_secret bersifat opsional.

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

Parameter opsional:

  • If -credential_id dihilangkan dan pengguna hanya memiliki satu sertifikat penandatanganan dokumen eSigner, DocSignTool akan menjadi default untuk itu. Jika pengguna memiliki lebih dari satu sertifikat penandatanganan dokumen, parameter ini wajib.
  • If -output_dir_path dihilangkan, file ditentukan dalam -input_file_path akan ditimpa dengan file yang ditandatangani. DocSignTool akan meminta pengguna sebelum menimpa file.
  • If -signing_location hadir, lokasi yang ditentukan akan ditambahkan ke tanda tangan digital.
  • If -signing_reason hadir, alasan penandatanganan yang ditentukan akan ditambahkan ke tanda tangan digital.
  • If -contact_info hadir, teks yang ditentukan akan ditambahkan ke tanda tangan digital. Meskipun disertakan dengan tanda tangan, informasi ini tidak akan disertakan dalam anotasi tanda tangan yang terlihat (jika ada).
  • If -sig_field_position hadir, anotasi tanda tangan yang terlihat akan ditambahkan ke dokumen pada halaman yang ditentukan oleh -page_no. Posisi dan tanda tangan harus diberikan dalam format "x, y, width, height".
  • -page_no hanya diperlukan saat membuat tanda tangan yang terlihat dengan -sig_field_position dan menentukan halaman dokumen tempat anotasi tanda tangan yang terlihat akan muncul.
  • If -totp_secret hadir, DocSignTool akan menghitung OTP berbasis waktu untuk penandatanganan, memungkinkan penggunaan alat secara otomatis. Jika parameter ini tidak ada, pengguna akan diminta untuk memasukkan OTP manual.
Untuk informasi tentang mendaftarkan sertifikat penandatanganan dokumen EV di eSigner dan menyiapkan autentikasi dua faktor, harap baca Penandatanganan Kode EV Jarak Jauh dengan eSigner. Untuk informasi tentang nilai rahasia TOTP, silakan merujuk ke Otomatiskan Penandatanganan Kode EV eSigner.

contoh:

Entri OTP Manual dengan Tanda Tangan Terlihat:

Tanda DocSignTool -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -namapengguna=john.doe@example.com -password="P0z9@lxo41" -output_dir_path=ditandatangani -input_file_path=test.pdf -sig_field_position=" 100, 200" -page_no=150 -signing_location="Houston, Texas" -signing_reason="persetujuan dokumen" -contact_info="support@ssl.com" Masukkan OTP - Tekan enter untuk melanjutkan: 884646 PDF berhasil ditandatangani: output\test.pdf

Pembuatan OTP Otomatis, Tidak Ada Tanda Tangan yang Terlihat:

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

Memasuki DocSignTool sign tanpa parameter yang diperlukan akan menampilkan informasi penggunaan untuk perintah tersebut.

Jika Anda mendapatkan pesan kesalahan, Error: invalid otp ketika mencoba untuk menandatangani file, itu bisa disebabkan oleh satu atau beberapa masalah berikut:

  • Kode QR yang Anda pindai ke dalam aplikasi otentikasi Anda tidak cocok dengan nama pengguna, kata sandi, dan / atau ID kredensial dari perintah Anda. Ini bisa terjadi jika:
    • Anda memiliki beberapa akun yang dikonfigurasi untuk 2FA di perangkat Anda dan memilih yang salah.
    • Anda mencoba menggunakan kredensial login Anda untuk a sertifikat bersama, tetapi memindai kode QR yang dibagikan oleh rekan satu tim dari akun mereka.
  • OTP yang Anda masukkan sudah kedaluwarsa.
  • Perintah Anda menyertakan rahasia TOTP yang tidak valid.

tanda_batch

Masuk dan stempel waktu hingga 100 file PDF dengan satu OTP. Parameter -username, -password, dan -input_dir_path diperlukan. -credential_id diperlukan hanya untuk pengguna dengan lebih dari satu sertifikat penandatanganan dokumen eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info-sig_field_position, -page_no, dan -totp_secret bersifat opsional.

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

Parameter opsional:

  • If -credential_id dihilangkan dan pengguna hanya memiliki satu sertifikat penandatanganan dokumen eSigner, DocSignTool akan menjadi default untuk itu. Jika pengguna memiliki lebih dari satu sertifikat penandatanganan dokumen, parameter ini wajib.
  • If -output_dir_path dihilangkan, file yang ditentukan dalam -input_dir_path akan ditimpa dengan file yang ditandatangani. DocSignTool akan meminta pengguna sebelum menimpa file.
  • If -signing_location hadir, lokasi yang ditentukan akan ditambahkan ke tanda tangan digital.
  • If -signing_reason hadir, alasan penandatanganan yang ditentukan akan ditambahkan ke tanda tangan digital.
  • If -contact_info hadir, teks yang ditentukan akan ditambahkan ke tanda tangan digital. Meskipun disertakan dengan tanda tangan, informasi ini tidak akan disertakan dalam anotasi tanda tangan yang terlihat (jika ada).
  • If -sig_field_position hadir, anotasi tanda tangan yang terlihat akan ditambahkan ke dokumen pada halaman yang ditentukan oleh -page_no. Posisi dan tanda tangan harus diberikan dalam format "x, y, width, height".
  • -page_no hanya diperlukan saat membuat tanda tangan yang terlihat dengan -sig_field_position dan menentukan halaman dokumen tempat anotasi tanda tangan yang terlihat akan muncul.
  • If -totp_secret hadir, DocSignTool akan menghitung OTP berbasis waktu untuk penandatanganan, memungkinkan penggunaan alat secara otomatis. Jika parameter ini tidak ada, pengguna akan diminta untuk memasukkan OTP manual.

Contoh:

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" Masukkan OTP - Tekan enter untuk melanjutkan: 455145 Perintah tanda batch berhasil dijalankan. Direktori keluaran untuk file yang ditandatangani: keluaran

Memasuki DocSignTool batch_sign tanpa parameter yang diperlukan akan menampilkan informasi penggunaan untuk perintah tersebut.

hash

Algoritma SHA 256 harus digunakan untuk menghitung hash dokumen PDF. 

  1. Pustaka PDF diperlukan untuk memanipulasi PDF untuk input hash dan kemudian menyematkan PKCS#7 dalam dokumen PDF. (mis. ApachePDFBox di Java). 
  2. Pustaka Kripto untuk membuat PKCS#7 dari tanda tangan mentah yang diterima dari eSigner API (mis. BouncyCastle di Java).

Pra-komputasi hash untuk digunakan nanti dengan batch_hash_sign perintah. Parameter -access_token dan -input_dir_path diperlukan. -credential_id diperlukan hanya untuk pengguna dengan lebih dari satu sertifikat penandatanganan dokumen eSigner. -signing_location, -signing-reason, -contact_info-sig_field_position, dan -page_no, adalah opsional.

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

Parameter opsional:

  • If -program_name hadir saat menandatangani penginstal MSI, nilainya akan ditampilkan di dialog konfirmasi sebagai nama program.
  • If -signing_location ada, lokasi yang ditentukan akan ditambahkan ke tanda tangan digital saat dibuat.
  • If -signing_reason hadir, alasan penandatanganan yang ditentukan akan ditambahkan ke tanda tangan digital saat dibuat.
  • If -contact_info hadir, teks yang ditentukan akan ditambahkan ke tanda tangan digital saat dibuat. Meskipun disertakan dengan tanda tangan, informasi ini tidak akan disertakan dalam anotasi tanda tangan yang terlihat (jika ada).
  • If -sig_field_position hadir, anotasi tanda tangan yang terlihat akan ditambahkan ke dokumen pada halaman yang ditentukan oleh -page_no saat tanda tangan dibuat. Posisi dan tanda tangan harus diberikan dalam format "x, y, width, height".
  • -page_no hanya diperlukan saat membuat tanda tangan yang terlihat dengan -sig_field_position dan menentukan halaman dokumen tempat anotasi tanda tangan yang terlihat akan muncul saat dibuat.

Contoh:

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

Memasuki DocSignTool hash tanpa parameter yang diperlukan akan menampilkan informasi penggunaan untuk perintah tersebut.

batch_sign_hash

Tanda tangani hash yang telah dihitung sebelumnya dengan hash perintah. Parameter -access_token, input_dir_path, -otp, dan output_dir_path diperlukan. -credential_id diperlukan hanya untuk pengguna dengan lebih dari satu sertifikat penandatanganan dokumen eSigner.

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

Parameter opsional:

  • If -credential_id dihilangkan dan pengguna hanya memiliki satu sertifikat penandatanganan dokumen eSigner, DocSignTool akan menjadi default untuk itu. Jika pengguna memiliki lebih dari satu sertifikat penandatanganan dokumen, parameter ini wajib.

Contoh:

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

Memasuki DocSignTool batch_sign_hash tanpa parameter yang diperlukan akan menampilkan informasi penggunaan untuk perintah tersebut.

Cara menguji DocSignTool dalam mode kotak pasir

  1. Dalam rilis DocSignTool, buka conf folder dan buka doc_sign_tool.properties fillet
  2. Komentari properti yang ada dengan menambahkan # simbol sebelum setiap properti
  3. Tambahkan properti berikut dalam file:
  4. Simpan berkasnya. Setelah disimpan, DocSignTool kini dapat digunakan dalam mode sandbox.
  5. Untuk beralih kembali ke mode produksi, hapus komentar pada properti yang ada dan hapus properti sandbox.

Opsional: Konversikan sertifikat penandatanganan dokumen OV Anda menjadi sertifikat penyegelan

Catatan: Bagian ini hanya diperuntukkan bagi pengguna yang ingin melakukan esealing. Untuk mengotomatiskan penandatanganan dokumen dan tidak diminta oleh One Time Passwords (OTP), pengguna mengonversi sendiri sertifikat penandatanganan dokumen Validasi Organisasi (OV) mereka menjadi sertifikat penyegelan di akun SSL.com mereka. Petunjuknya ada di bawah:

  1. Klik Pesanan di menu atas akun SSL.com Anda. 
  2. Temukan sertifikat Anda dan klik unduh / detail link.
  3. klik HAPUS 2FA .
Terima kasih telah memilih SSL.com! Jika Anda memiliki pertanyaan, silakan hubungi kami melalui email di Support@SSL.com, panggil 1-877-SSL-SECURE, atau cukup klik tautan obrolan di kanan bawah halaman ini. Anda juga dapat menemukan jawaban atas banyak pertanyaan dukungan umum di kami dasar pengetahuan.
Twitter
Facebook
LinkedIn
Reddit
Email

Tetap Terinformasi dan Aman

SSL.com adalah pemimpin global dalam keamanan siber, PKI dan sertifikat digital. Daftar untuk menerima berita industri terkini, tips, dan pengumuman produk dari SSL.com.

Kami sangat menantikan tanggapan Anda

Ikuti survei kami dan beri tahu kami pendapat Anda tentang pembelian terakhir Anda.