Hướng dẫn lệnh eSigner DocSignTool

DocDấu hiệuCông cụ là một tiện ích dòng lệnh Java đa nền tảng bảo mật, hướng đến quyền riêng tư để ký các tệp PDF từ xa bằng cách sử dụng người ký điện tử chứng chỉ ký văn bản. Băm của tài liệu được gửi đến SSL.com để ký sao cho bản thân tài liệu không được gửi. Đây là giải pháp lý tưởng khi các tài liệu nhạy cảm cần được ký nhưng không được gửi qua đường dây để ký. DocSignTool cũng lý tưởng cho các quy trình hàng loạt tự động hóa để ký số lượng lớn hoặc tích hợp vào quy trình làm việc tài liệu hiện có.

Cài đặt DocSignTool

Để cài đặt phiên bản DocSignTool hiện tại, chỉ cần tải xuống và giải nén đúng tệp cho hệ điều hành của bạn:

• Windows
• Linux và macOS

Lưu ý rằng bản tải xuống Windows bao gồm thời gian chạy Java, nhưng phiên bản Linux / macOS yêu cầu cài đặt thời gian chạy Java trên máy tính của bạn. Phiên bản Windows của lệnh là một tệp hàng loạt (DocSignTool.bat) và phiên bản Linux / macOS là một tập lệnh shell (DocSignTool.sh).

Tổng quan về cách sử dụng DocSignTool

Cách sử dụng: DocSignTool [-hV] [COMMAND] [PARAMETERS]

Tùy chọn:

• -h, --help: Hiển thị thông báo trợ giúp và thoát.
• -V, --version: Thông tin phiên bản màn hình và thoát.

lệnh:

• get_credential_ids: Xuất danh sách ID thông tin xác thực eSigner được liên kết với một người dùng cụ thể.
• credential_info: Khóa đầu ra và thông tin chứng chỉ liên quan đến ID thông tin xác thực.
• sign: Ký và dấu thời gian PDF filr.
• batch_sign: Ký và đánh dấu thời gian cho nhiều tệp PDF bằng một OTP.
• hash: Tính toán trước (các) hàm băm để sử dụng sau này với batch_hash_sign chỉ huy.
• batch_sign_hash: Ký (các) băm được tính toán trước với hash chỉ huy.

Tham số:

• -access_token=<TOKEN>: OAuth mã thông báo truy cập.
• -contact_info=<CONTACT_INFO>: Thông tin liên lạc.
• -credential_id=<CREDENTIAL_ID>: ID thông tin xác thực để ký chứng chỉ.
• -input_dir_path=<PATH>: Thư mục đầu vào cho các tệp PDF sẽ được ký, có các hàm băm được tính toán hoặc chọn các tệp chưa được ký và các hàm băm tương ứng để ký.
• -input_file_path=<PATH>: Đường dẫn của tệp PDF sẽ được ký.
• -otp=<OTP>: Giá trị OTP OAuth từ ứng dụng xác thực.
• -output_dir_path=<PATH>: Thư mục nơi (các) tệp PDF đã ký sẽ được ghi.
• -page_no=<PAGE_NUMBER>: Trang của tài liệu PDF nơi chữ ký hiển thị sẽ xuất hiện.
• -password=<PASSWORD>: Mật khẩu tài khoản SSL.com.
• -sig_field_position=<X, Y, WIDTH, HEIGHT>: Vị trí của chữ ký hiển thị trên PDF.
• -signing_location=<SIGNING_LOCATION>: Vị trí nơi tài liệu được ký.
• signing_reason=<SIGNING_REASON>: Lý do ký kết.
• -totp_secret=<TOTP_SECRET>: OAuth TOTP bí mật
• -username=<USERNAME>: Tên người dùng tài khoản SSL.com

Lệnh DocSignTool

get_credential_ids

Xuất danh sách ID thông tin xác thực eSigner được liên kết với một người dùng cụ thể. Thông số -username và -password là bắt buộc.

Cách sử dụng: DocSignTool [-hV] get_credential_ids -username=<USERNAME> -password=<PASSWORD>

Ví dụ:

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

Nhập DocSignTool get_credential_ids nếu không có các tham số bắt buộc sẽ hiển thị thông tin sử dụng cho lệnh.

thông tin xác thực

Khóa đầu ra và thông tin chứng chỉ liên quan đến ID thông tin xác thực. Thông số -credential_id, -usernamevà -password là bắt buộc.

Cách sử dụng: DocSignTool [-hV] credential_info -credential_id=<CREDENTIAL_ID> -username=<USERNAME> -password=<PASSWORD>

Ví dụ:

DocSignTool credential_info -credential_id=fe537ace-e132-52a9-c2e7-egcd2ac3f1e6 -username=john.doe@example.com -password="P0z9@lxo41" Thông tin chủ đề chứng chỉ ký: - Chủ đề DN: CN=JOHN DOE, O=SSL Corp , L=Houston, ST=Texas, C=US - Hết hạn chứng chỉ: Thứ bảy ngày 11 tháng 14 52:59:2023 EST 2 - Tổ chức phát hành DN: CN=SSL.com Chứng chỉ ứng dụng khách trung gian CA RSA RXNUMX, O=SSL Corp, L=Houston , ST=Texas, C=Mỹ

Nhập DocSignTool credential_info nếu không có các tham số bắt buộc sẽ hiển thị thông tin sử dụng cho lệnh.

đăng ký

Tệp PDF ký tên và dấu thời gian. Thông số -username, -passwordvà -input_file_path là bắt buộc. -credential_id chỉ bắt buộc đối với người dùng có nhiều hơn một chứng chỉ ký tài liệu eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_novà -totp_secret là tùy chọn.

Cách sử dụng: 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>]

Các thông số tùy chọn:

• If -credential_id bị bỏ qua và người dùng chỉ có một chứng chỉ ký tài liệu eSigner, DocSignTool sẽ mặc định điều đó. Nếu người dùng có nhiều hơn một chứng chỉ ký tài liệu, thì tham số này là bắt buộc.
• If -output_dir_path bị bỏ qua, tệp được chỉ định trong -input_file_path sẽ được ghi đè bằng tệp đã ký. DocSignTool sẽ nhắc người dùng trước khi ghi đè tệp.
• If -signing_location hiện tại, vị trí được chỉ định sẽ được thêm vào chữ ký điện tử.
• If -signing_reason hiện tại, lý do ký xác định sẽ được thêm vào chữ ký điện tử.
• If -contact_info hiện tại, văn bản được chỉ định sẽ được thêm vào ký hiệu kỹ thuật số. Mặc dù có kèm theo chữ ký, nhưng thông tin này sẽ không được đưa vào chú thích chữ ký hiển thị (nếu có).
• If -sig_field_position hiện có, chú thích chữ ký hiển thị sẽ được thêm vào tài liệu trên trang được chỉ định bởi -page_no. Vị trí và chữ ký phải được cung cấp theo định dạng "x, y, width, height".
• -page_no chỉ được yêu cầu khi tạo chữ ký hiển thị với -sig_field_position và chỉ định trang của tài liệu mà chú thích chữ ký hiển thị sẽ xuất hiện trên đó.
• If -totp_secret hiện tại, DocSignTool sẽ tính toán OTP dựa trên thời gian để ký, cho phép sử dụng công cụ tự động. Nếu không có thông số này, người dùng sẽ được nhắc nhập OTP thủ công.

Ví dụ:

Nhập OTP thủ công với chữ ký có thể nhìn thấy:

DocSignTool đăng nhập -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" Nhập OTP - Nhấn enter để tiếp tục: 884646 Đã ký PDF thành công: output\test.pdf

Tạo OTP tự động, không có chữ ký nhìn thấy:

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

Nhập DocSignTool sign nếu không có các tham số bắt buộc sẽ hiển thị thông tin sử dụng cho lệnh.

lô_sign

Ký và đánh dấu thời gian lên đến 100 tệp PDF bằng một OTP. Thông số -username, -passwordvà -input_dir_path là bắt buộc. -credential_id chỉ bắt buộc đối với người dùng có nhiều hơn một chứng chỉ ký tài liệu eSigner. -output_dir_path, -signing_location, -signing-reason, -contact_info,  -sig_field_position, -page_novà -totp_secret là tùy chọn.

Cách sử dụng: 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>]

Các thông số tùy chọn:

• If -credential_id bị bỏ qua và người dùng chỉ có một chứng chỉ ký tài liệu eSigner, DocSignTool sẽ mặc định điều đó. Nếu người dùng có nhiều hơn một chứng chỉ ký tài liệu, thì tham số này là bắt buộc.
• If -output_dir_path bị bỏ qua, các tệp được chỉ định trong -input_dir_path sẽ được ghi đè bằng các tệp đã ký. DocSignTool sẽ nhắc người dùng trước khi ghi đè lên các tệp.
• If -signing_location hiện tại, vị trí được chỉ định sẽ được thêm vào chữ ký điện tử.
• If -signing_reason hiện tại, lý do ký xác định sẽ được thêm vào chữ ký điện tử.
• If -contact_info hiện tại, văn bản được chỉ định sẽ được thêm vào các ký hiệu kỹ thuật số. Mặc dù có kèm theo chữ ký, nhưng thông tin này sẽ không được đưa vào chú thích chữ ký hiển thị (nếu có).
• If -sig_field_position hiện tại, chú thích chữ ký hiển thị sẽ được thêm vào các tài liệu trên trang được chỉ định bởi -page_no. Vị trí và chữ ký phải được cung cấp theo định dạng "x, y, width, height".
• -page_no chỉ được yêu cầu khi tạo chữ ký hiển thị với -sig_field_position và chỉ định trang của tài liệu mà chú thích chữ ký hiển thị sẽ xuất hiện trên đó.
• If -totp_secret hiện tại, DocSignTool sẽ tính toán OTP dựa trên thời gian để ký, cho phép sử dụng công cụ tự động. Nếu không có thông số này, người dùng sẽ được nhắc nhập OTP thủ công.

Ví dụ:

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" Nhập OTP - Nhấn enter để tiếp tục: 455145 Lệnh ký hàng loạt đã được thực thi thành công. Thư mục đầu ra cho các tệp đã ký: output

Nhập DocSignTool batch_sign nếu không có các tham số bắt buộc sẽ hiển thị thông tin sử dụng cho lệnh.

băm

Tính toán trước (các) hàm băm để sử dụng sau này với batch_hash_sign chỉ huy. Thông số -access_token và -input_dir_path là bắt buộc. -credential_id chỉ bắt buộc đối với người dùng có nhiều hơn một chứng chỉ ký tài liệu eSigner. -signing_location, -signing-reason, -contact_info,  -sig_field_positionvà -page_no, là tùy chọn.

Cách sử dụng: 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>]

Các thông số tùy chọn:

• If -program_name hiện diện khi ký trình cài đặt MSI, giá trị sẽ được hiển thị trong hộp thoại xác nhận dưới dạng tên chương trình.
• If -signing_location hiện tại, vị trí được chỉ định sẽ được thêm vào chữ ký điện tử khi chúng được tạo.
• If -signing_reason hiện tại, lý do ký xác định sẽ được thêm vào chữ ký điện tử khi chúng được tạo.
• If -contact_info hiện tại, văn bản được chỉ định sẽ được thêm vào các ký hiệu kỹ thuật số khi chúng được tạo. Mặc dù có kèm theo chữ ký, nhưng thông tin này sẽ không được đưa vào chú thích chữ ký hiển thị (nếu có).
• If -sig_field_position hiện tại, chú thích chữ ký hiển thị sẽ được thêm vào các tài liệu trên trang được chỉ định bởi -page_no khi các chữ ký được tạo ra. Vị trí và chữ ký phải được cung cấp theo định dạng "x, y, width, height".
• -page_no chỉ được yêu cầu khi tạo chữ ký hiển thị với -sig_field_position và chỉ định trang của tài liệu mà chú thích chữ ký hiển thị sẽ xuất hiện khi chúng được tạo.

Ví dụ:

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

Nhập DocSignTool hash nếu không có các tham số bắt buộc sẽ hiển thị thông tin sử dụng cho lệnh.

batch_sign_hash

Ký (các) băm được tính toán trước với hash chỉ huy. Thông số -access_token, input_dir_path, -otpvà output_dir_path là bắt buộc. -credential_id chỉ bắt buộc đối với người dùng có nhiều hơn một chứng chỉ ký tài liệu eSigner.

Cách sử dụng: DocSignTool [-hV] batch_sign_hash -access_token=<ACCESS_TOKEN> [-credential_id=<CREDENTIAL_ID>] -input_dir_path=<PATH> -output_dir_path=<PATH> -otp=<OTP>

Các thông số tùy chọn:

• If -credential_id bị bỏ qua và người dùng chỉ có một chứng chỉ ký tài liệu eSigner, DocSignTool sẽ mặc định điều đó. Nếu người dùng có nhiều hơn một chứng chỉ ký tài liệu, thì tham số này là bắt buộc.

Ví dụ:

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

Nhập DocSignTool batch_sign_hash nếu không có các tham số bắt buộc sẽ hiển thị thông tin sử dụng cho lệnh.

Cách kiểm tra DocSignTool ở chế độ sandbox

1. Trong bản phát hành DocSignTool, hãy đi tới conf thư mục và mở doc_sign_tool.properties hồ sơ
2. Nhận xét các thuộc tính hiện có bằng cách thêm # ký hiệu trước mỗi thuộc tính
3. Thêm các thuộc tính sau vào tệp:
   • 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. Lưu các tập tin. Sau khi lưu, DocSignTool hiện có thể được sử dụng ở chế độ hộp cát.
5. Để chuyển về chế độ sản xuất, hãy bỏ ghi chú các thuộc tính hiện có và xóa thuộc tính hộp cát.

Tùy chọn: Chuyển đổi chứng chỉ ký tài liệu OV của bạn thành chứng chỉ niêm phong

Lưu ý: Phần này chỉ dành cho người dùng muốn thực hiện eealing. Để tự động ký tài liệu và không bị nhắc nhở bởi Mật khẩu một lần (OTP), người dùng tự chuyển đổi chứng chỉ ký tài liệu Xác thực Tổ chức (OV) của họ thành chứng chỉ niêm phong trên tài khoản SSL.com của họ. Hướng dẫn dưới đây:

1. Nhấp chuột Đơn Đặt Hàng trên menu trên cùng của tài khoản SSL.com của bạn. 
2. Xác định vị trí chứng chỉ của bạn và nhấp vào tải về / chi tiết liên kết.
3. Nhấn vào XÓA 2FA .