Struct securepdf::PDFSign

Properties   Methods   Events   Config Settings   Errors  

The PDFSign struct signs PDF documents.

Syntax

securepdf::PDFSign

Remarks

The PDFSign struct can sign PDF documents in accordance with a selection of PDF and PAdES signature standards, including basic Adobe signatures (ISO 32000) and PAdES signatures (ETSI EN 319 142-1).

Preparing the Signature

To configure PDFSign to produce the desired signature, first provide the input document as a file (input_file), byte array (input_data), or stream (set_input_stream) and assign your signing certificate to the signing_cert property. Then indicate where to save the output document by setting output_file or calling set_output_stream.

Optionally, specify the Signature* properties and the timestamp_server property, and adjust any chain validation parameters as necessary (please see the Chain Validation Setup section for more details). Finally, call sign.

PDFSign also provides means to customize the appearance of the signature widget to be shown on the document page. You can create your own signatures (e.g., in the form of your company's logo) by adjusting the widget properties available in the set_widget_property method. Alternatively, you can choose not to associate any widget with your signature by setting the Invisible widget property to true. Please see this article for more details about customizing the signature widget.

The Signing Process

Depending on the configuration, the signing process may be as straightforward as calculating the document hash and signing it with the private key, or it may involve the advanced chain validation routine. During the latter process, the struct may contact external revocation (i.e., CRL and OCSP endpoints) and trust sources to establish the validity of the signing certificate.

If an external TSA server was provided by the timestamp_server property, the struct also contacts it to timestamp the new signature.

During signing, PDFSign may fire events to notify your code about certain conditions. For example, if the input document is encrypted but no decryption parameters were found in the password or decryption_cert properties, the struct fires either the on_password or on_recipient_info event to tell your code that it needs decryption information to be able to continue with the signing. Additionally, the on_ssl_server_authentication event fires if one of the HTTP endpoints involved during the operation (which may be a TSA, CRL, OCSP, or Trusted List service) operates over TLS and needs its certificate to be validated.

Remote Signing

PDFSign can also be configured to sign with external keys. In such scenarios, the struct handles every aspect of the signing routine except the actual signing operation - including the document hash calculation, preparation of signature objects, and CRL/OCSP retrieval. Instead of calculating the signature by itself, the struct requests it from your code and later incorporates it into the document.

To enable this mode, set the remote_signature_method property to either rsmPKCS1 or rsmPKCS7 and call sign. The struct outputs a "pre-signed" document, which encapsulates any signature and widget settings, and populates the remote_signature_digest property with the raw data to be signed.

Which remote signing method to use depends on the specifics of your remote signing engine. With PKCS#1, the public copy of the signing certificate is needed on the first step because it is included in the PKCS#7 structure prepared by the struct. With PKCS#7 on the other hand, only the document hash is calculated, which does not require the certificate.

Once your remote signing engine signs the hashed data with the private key, pass the resulting signed data back to the struct via the remote_signature_data property to embed it into the document.

The following code shows the full PKCS#1 remote signing process: // Step 1: Pre-sign pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "presigned.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPublicKeyFile, "cert.cer", "", "*"); // Configure signature and/or widget properties as desired pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmPKCS1; pdfsign.Sign(); string toBeSigned = pdfsign.RemoteSignatureDigest; // Step 2: Pass to remote signing engine byte[] signedData = SignData(toBeSigned); // Step 3: Finalize pdfsign.Reset(); pdfsign.InputFile = "presigned.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.RemoteSignatureData = HexEncode(signedData); pdfsign.Sign(); In the PKCS#7 method, the struct can additionally act as the remote signer. To implement this side of the scheme, provide a binary hash of the PDF as input and set remote_signature_method to rsmDigest. After sign completes, the output will contain a signed binary PKCS#7 structure over the hash that can then be embedded into the pre-signed document.

The following code shows the full PKCS#7 remote signing process using PDFSign on both sides: // Step 1: Pre-sign pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "presigned.pdf"; // Configure signature and/or widget properties as desired pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmPKCS7; pdfsign.Sign(); string toBeSigned = pdfsign.RemoteSignatureDigest; // Step 2: Sign the hash pdfsign.Reset(); pdfsign.InputData = HexDecode(toBeSigned); pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.RemoteSignatureMethod = PDFSignRemoteSignatureMethods.rsmDigest; pdfsign.Sign(); byte[] signedData = pdfsign.OutputData; // Step 3: Finalize pdfsign.Reset(); pdfsign.InputFile = "presigned.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.RemoteSignatureData = HexEncode(signedData); pdfsign.Sign();

Basic Adobe Signatures

A basic (also known as legacy) Adobe signature is an original Adobe Acrobat document signature. This is an outdated form of PDF signature; although PAdES is loosely built on it, this signature type does not support extended features and is not compliant with PAdES. Unless the recipient of your signed documents expects you to specifically use this kind of signature, it is unlikely that you will ever need it.

PAdES Signatures and Profiles

In PAdES, a given signature's profile describes the level of "completeness" of the validation material (i.e., certificates, CRLs, and OCSP responses) included in the signature. For example, signatures compliant with the PAdES B-B or PAdES B-T profiles do not require any validation material at all, whereas signatures compliant with the PAdES B-LTA profile must contain complete validation material.

PAdES B-B

The PAdES B-B profile is the baseline profile that uses the PAdES-BES signature level by default, meaning the signature contains only the signing time and signer information.

Use the following code to create a B-B signature: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineB; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); PAdES-EPES

To instead create a PAdES-EPES signature that includes the signature-policy-identifier attribute, set the PolicyHash, PolicyHashAlgorithm, and PolicyId configuration settings before calling sign.

This profile, in both the BES and EPES settings, creates a basic signature that remains valid as long as the signing certificate has not expired or been revoked. Signatures at this level need not contain any validation material.

PAdES B-T

The PAdES B-T profile extends the basic BES or EPES signature by adding a signature timestamp. This timestamp certifies that the signature was created at a specific moment in time. Similar to the B-B profile, signatures at this level need not contain any validation material.

Use the following code to create a B-T signature: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); PAdES B-LTA

The PAdES B-LTA profile is used to achieve signatures that are equipped with long-term archival (LTA) or long-term validation (LTV) capabilities. It incorporates into the signature all the material required to validate the signature, including signing certificates, timestamping certificates, and revocation information. It also adds a document timestamp, which certifies the integrity of both the document and the complete validation material at a specific moment in time. This guarantees that no relevant certificates were expired or revoked at the signature creation time, and enables the signature to be verified offline.

Creating a B-LTA signature with PDFSign is a two-step process. First sign the document and add a signature timestamp, setting signature_profile appropriately. Then update the signature to take care of the rest (collect and embed the validation material, and add a document timestamp): pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureProfile = PDFSignSignatureProfiles.pfBaselineT; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.ValidationPolicy = PDFSignValidationPolicies.vpNone; pdfsign.Sign(); // Update the signature to LTV - this retrieves the necessary revocation // elements, embeds them into the document, and adds a document timestamp pdfsign.Reset(); pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "updated.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.Update(); Validation material "completeness" can be subjective and depends on several factors, including the following:

• The working environment. For example, your organization may explicitly trust its own self-signed TSA certificate. Signatures timestamped with this certificate will be considered B-LTA by your organization, but for any external bodies, those signatures would be rendered as B-LT or even B-B, as they do not know or trust the custom TSA certificate.
• The time that has passed since the last document timestamp. If an archived (B-LTA) document is not re-timestamped before its last timestamp expires, it will drop back to a lower signature level.

Chain Validation Setup

Chain validation is a sophisticated, multifaceted procedure that involves a lot of variables. Depending on the configuration of your operating environment, the specifics of the PKI framework being used, and the validation policy you need to follow, you may want to adjust your chain validation parameters to best fit your requirements. A summary of these parameters is given below.

NOTE: These parameters apply to sign and update in PDFSign as well as verify in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled).

Validation Policy

The validation_policy property dictates how thoroughly the chain is validated. It includes options to control which checks the struct performs, allowing you to tailor the validation process to meet your specific security needs. For example, if it is not essential to check each certificate's revocation status, set this property to vpFullNoRevocation.

Revocation

The revocation aspect of chain validation is controlled by the revocation_check property, which allows you to choose between and prioritize revocation origins.

NOTE: OCSP sources are often preferred to CRL endpoints because of their real-time capability and the smaller size of the responses they produce.

Trust

The trust aspect of chain validation is controlled by the trust_sources property, which allows you to specify the locations in which the struct searches for trust anchors. Local system stores, your own trusted root certificates (through the trusted_certs property), and Trusted Lists (through the trusted_lists property) are all supported.

Offline Mode

The offline_mode property provides the ability to sign or verify the document without contacting online sources. If this property is enabled, the struct only uses known_certs, trusted_certs, data structures within the document, and revocation and Trusted List data that it previously saved to its internal cache when looking for missing validation material.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecurePDF. Due to this, the PDFSign struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PDFSign when you have finished using the instance.

Property List

---

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

attachment_count property (PDFSign Struct)

The number of records in the Attachment arrays.

Syntax

fn attachment_count(&self ) -> Result<i32, SecurePDFError> 
fn set_attachment_count(&self, value : i32) ->  Option<SecurePDFError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attachment_content_type
• attachment_creation_date
• attachment_data
• attachment_description
• attachment_file_name
• attachment_modification_date
• attachment_name
• attachment_size

The array indices start at 0 and end at attachment_count - 1.

Data Type

i32

attachment_content_type property (PDFSign Struct)

The content type of the attachment.

Syntax

fn attachment_content_type(&self , AttachmentIndex : i32) -> Result<String, SecurePDFError> 
fn set_attachment_content_type(&self, AttachmentIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_attachment_content_type_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The content type of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

String

attachment_creation_date property (PDFSign Struct)

The creation date of the attachment.

Syntax

fn attachment_creation_date(&self , AttachmentIndex : i32) -> Result<String, SecurePDFError> 
fn set_attachment_creation_date(&self, AttachmentIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_attachment_creation_date_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The creation date of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

String

attachment_data property (PDFSign Struct)

The raw data of the attachment.

Syntax

fn attachment_data(&self , AttachmentIndex : i32) -> Result<Vec<u8>, SecurePDFError> 
fn set_attachment_data(&self, AttachmentIndex : i32, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_attachment_data_ref(&self, AttachmentIndex : i32, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The raw data of the attachment.

If attachment_output_stream is not set to a valid stream, the struct writes to this property when an empty string is passed to save_attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

Vec

attachment_description property (PDFSign Struct)

A textual description of the attachment.

Syntax

fn attachment_description(&self , AttachmentIndex : i32) -> Result<String, SecurePDFError> 
fn set_attachment_description(&self, AttachmentIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_attachment_description_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

A textual description of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

String

attachment_file_name property (PDFSign Struct)

The path and filename of the attachment.

Syntax

fn attachment_file_name(&self , AttachmentIndex : i32) -> Result<String, SecurePDFError> 
fn set_attachment_file_name(&self, AttachmentIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_attachment_file_name_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The path and filename of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

String

attachment_modification_date property (PDFSign Struct)

The date and time of the file's last modification.

Syntax

fn attachment_modification_date(&self , AttachmentIndex : i32) -> Result<String, SecurePDFError> 
fn set_attachment_modification_date(&self, AttachmentIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_attachment_modification_date_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The date and time of the file's last modification.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

String

attachment_name property (PDFSign Struct)

The name of the attachment.

Syntax

fn attachment_name(&self , AttachmentIndex : i32) -> Result<String, SecurePDFError> 
fn set_attachment_name(&self, AttachmentIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_attachment_name_ref(&self, AttachmentIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The name of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

Data Type

String

attachment_size property (PDFSign Struct)

The attachment's size in bytes.

Syntax

fn attachment_size(&self , AttachmentIndex : i32) -> Result<i64, SecurePDFError> 

Default Value

0

Remarks

The attachment's size in bytes.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only.

Data Type

i64

blocked_cert_count property (PDFSign Struct)

The number of records in the BlockedCert arrays.

Syntax

fn blocked_cert_count(&self ) -> Result<i32, SecurePDFError> 
fn set_blocked_cert_count(&self, value : i32) ->  Option<SecurePDFError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• blocked_cert_effective_date
• blocked_cert_encoded
• blocked_cert_expiration_date
• blocked_cert_extended_key_usage
• blocked_cert_fingerprint
• blocked_cert_fingerprint_sha1
• blocked_cert_fingerprint_sha256
• blocked_cert_issuer
• blocked_cert_private_key
• blocked_cert_private_key_available
• blocked_cert_private_key_container
• blocked_cert_public_key
• blocked_cert_public_key_algorithm
• blocked_cert_public_key_length
• blocked_cert_serial_number
• blocked_cert_signature_algorithm
• blocked_cert_store
• blocked_cert_store_password
• blocked_cert_store_type
• blocked_cert_subject
• blocked_cert_subject_alt_names
• blocked_cert_thumbprint_md5
• blocked_cert_thumbprint_sha1
• blocked_cert_thumbprint_sha256
• blocked_cert_usage
• blocked_cert_usage_flags
• blocked_cert_version

The array indices start at 0 and end at blocked_cert_count - 1.

Data Type

i32

blocked_cert_effective_date property (PDFSign Struct)

The date on which this certificate becomes valid.

Syntax

fn blocked_cert_effective_date(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_expiration_date property (PDFSign Struct)

The date on which the certificate expires.

Syntax

fn blocked_cert_expiration_date(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_extended_key_usage property (PDFSign Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn blocked_cert_extended_key_usage(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_fingerprint property (PDFSign Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn blocked_cert_fingerprint(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_fingerprint_sha1 property (PDFSign Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn blocked_cert_fingerprint_sha1(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_fingerprint_sha256 property (PDFSign Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn blocked_cert_fingerprint_sha256(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_issuer property (PDFSign Struct)

The issuer of the certificate.

Syntax

fn blocked_cert_issuer(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_private_key property (PDFSign Struct)

The private key of the certificate (if available).

Syntax

fn blocked_cert_private_key(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The blocked_cert_private_key may be available but not exportable. In this case, blocked_cert_private_key returns an empty string.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_private_key_available property (PDFSign Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn blocked_cert_private_key_available(&self , BlockedCertIndex : i32) -> Result<bool, SecurePDFError> 

Default Value

false

Remarks

Whether a blocked_cert_private_key is available for the selected certificate. If blocked_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

bool

blocked_cert_private_key_container property (PDFSign Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn blocked_cert_private_key_container(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The name of the blocked_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_public_key property (PDFSign Struct)

The public key of the certificate.

Syntax

fn blocked_cert_public_key(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_public_key_algorithm property (PDFSign Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn blocked_cert_public_key_algorithm(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_public_key_length property (PDFSign Struct)

The length of the certificate's public key (in bits).

Syntax

fn blocked_cert_public_key_length(&self , BlockedCertIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

i32

blocked_cert_serial_number property (PDFSign Struct)

The serial number of the certificate encoded as a string.

Syntax

fn blocked_cert_serial_number(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_signature_algorithm property (PDFSign Struct)

The text description of the certificate's signature algorithm.

Syntax

fn blocked_cert_signature_algorithm(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_store property (PDFSign Struct)

The name of the certificate store for the client certificate.

Syntax

fn blocked_cert_store(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecurePDFError> 
fn set_blocked_cert_store(&self, BlockedCertIndex : i32, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_blocked_cert_store_ref(&self, BlockedCertIndex : i32, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The blocked_cert_store_type property denotes the type of the certificate store specified by blocked_cert_store. If the store is password-protected, specify the password in blocked_cert_store_password.

blocked_cert_store is used in conjunction with the blocked_cert_subject property to specify client certificates. If blocked_cert_store has a value, and blocked_cert_subject or blocked_cert_encoded is set, a search for a certificate is initiated. Please see the blocked_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

Data Type

Vec

blocked_cert_store_password property (PDFSign Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn blocked_cert_store_password(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 
fn set_blocked_cert_store_password(&self, BlockedCertIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_blocked_cert_store_password_ref(&self, BlockedCertIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

Data Type

String

blocked_cert_store_type property (PDFSign Struct)

The type of certificate store for this certificate.

Syntax

fn blocked_cert_store_type(&self , BlockedCertIndex : i32) -> Result<i32, SecurePDFError> 
fn set_blocked_cert_store_type(&self, BlockedCertIndex : i32, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

Data Type

i32

blocked_cert_subject_alt_names property (PDFSign Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn blocked_cert_subject_alt_names(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_thumbprint_md5 property (PDFSign Struct)

The MD5 hash of the certificate.

Syntax

fn blocked_cert_thumbprint_md5(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_thumbprint_sha1 property (PDFSign Struct)

The SHA-1 hash of the certificate.

Syntax

fn blocked_cert_thumbprint_sha1(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_thumbprint_sha256 property (PDFSign Struct)

The SHA-256 hash of the certificate.

Syntax

fn blocked_cert_thumbprint_sha256(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_usage property (PDFSign Struct)

The text description of UsageFlags .

Syntax

fn blocked_cert_usage(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of blocked_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_usage_flags property (PDFSign Struct)

The flags that show intended use for the certificate.

Syntax

fn blocked_cert_usage_flags(&self , BlockedCertIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of blocked_cert_usage_flags is a combination of the following flags:

Please see the blocked_cert_usage property for a text representation of blocked_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

i32

blocked_cert_version property (PDFSign Struct)

The certificate's version number.

Syntax

fn blocked_cert_version(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is read-only.

Data Type

String

blocked_cert_subject property (PDFSign Struct)

The subject of the certificate used for client authentication.

Syntax

fn blocked_cert_subject(&self , BlockedCertIndex : i32) -> Result<String, SecurePDFError> 
fn set_blocked_cert_subject(&self, BlockedCertIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_blocked_cert_subject_ref(&self, BlockedCertIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

Data Type

String

blocked_cert_encoded property (PDFSign Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn blocked_cert_encoded(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecurePDFError> 
fn set_blocked_cert_encoded(&self, BlockedCertIndex : i32, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_blocked_cert_encoded_ref(&self, BlockedCertIndex : i32, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The blocked_cert_store and blocked_cert_subject properties also may be used to specify a certificate.

When blocked_cert_encoded is set, a search is initiated in the current blocked_cert_store for the private key of the certificate. If the key is found, blocked_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, blocked_cert_subject is set to an empty string.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

Data Type

Vec

decryption_cert_effective_date property (PDFSign Struct)

The date on which this certificate becomes valid.

Syntax

fn decryption_cert_effective_date(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

decryption_cert_expiration_date property (PDFSign Struct)

The date on which the certificate expires.

Syntax

fn decryption_cert_expiration_date(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

decryption_cert_extended_key_usage property (PDFSign Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn decryption_cert_extended_key_usage(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

decryption_cert_fingerprint property (PDFSign Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn decryption_cert_fingerprint(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

decryption_cert_fingerprint_sha1 property (PDFSign Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn decryption_cert_fingerprint_sha1(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

decryption_cert_fingerprint_sha256 property (PDFSign Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn decryption_cert_fingerprint_sha256(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

decryption_cert_issuer property (PDFSign Struct)

The issuer of the certificate.

Syntax

fn decryption_cert_issuer(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

decryption_cert_private_key property (PDFSign Struct)

The private key of the certificate (if available).

Syntax

fn decryption_cert_private_key(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The decryption_cert_private_key may be available but not exportable. In this case, decryption_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

decryption_cert_private_key_available property (PDFSign Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn decryption_cert_private_key_available(&self ) -> Result<bool, SecurePDFError> 

Default Value

false

Remarks

Whether a decryption_cert_private_key is available for the selected certificate. If decryption_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

decryption_cert_private_key_container property (PDFSign Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn decryption_cert_private_key_container(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The name of the decryption_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

decryption_cert_public_key property (PDFSign Struct)

The public key of the certificate.

Syntax

fn decryption_cert_public_key(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

decryption_cert_public_key_algorithm property (PDFSign Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn decryption_cert_public_key_algorithm(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

decryption_cert_public_key_length property (PDFSign Struct)

The length of the certificate's public key (in bits).

Syntax

fn decryption_cert_public_key_length(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

decryption_cert_serial_number property (PDFSign Struct)

The serial number of the certificate encoded as a string.

Syntax

fn decryption_cert_serial_number(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

decryption_cert_signature_algorithm property (PDFSign Struct)

The text description of the certificate's signature algorithm.

Syntax

fn decryption_cert_signature_algorithm(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

decryption_cert_store property (PDFSign Struct)

The name of the certificate store for the client certificate.

Syntax

fn decryption_cert_store(&self ) -> Result<Vec<u8>, SecurePDFError> 
fn set_decryption_cert_store(&self, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_decryption_cert_store_ref(&self, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The decryption_cert_store_type property denotes the type of the certificate store specified by decryption_cert_store. If the store is password-protected, specify the password in decryption_cert_store_password.

decryption_cert_store is used in conjunction with the decryption_cert_subject property to specify client certificates. If decryption_cert_store has a value, and decryption_cert_subject or decryption_cert_encoded is set, a search for a certificate is initiated. Please see the decryption_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

decryption_cert_store_password property (PDFSign Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn decryption_cert_store_password(&self ) -> Result<String, SecurePDFError> 
fn set_decryption_cert_store_password(&self, value : &str) ->  Option<SecurePDFError> 
fn set_decryption_cert_store_password_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

decryption_cert_store_type property (PDFSign Struct)

The type of certificate store for this certificate.

Syntax

fn decryption_cert_store_type(&self ) -> Result<i32, SecurePDFError> 
fn set_decryption_cert_store_type(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

decryption_cert_subject_alt_names property (PDFSign Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn decryption_cert_subject_alt_names(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

decryption_cert_thumbprint_md5 property (PDFSign Struct)

The MD5 hash of the certificate.

Syntax

fn decryption_cert_thumbprint_md5(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

decryption_cert_thumbprint_sha1 property (PDFSign Struct)

The SHA-1 hash of the certificate.

Syntax

fn decryption_cert_thumbprint_sha1(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

decryption_cert_thumbprint_sha256 property (PDFSign Struct)

The SHA-256 hash of the certificate.

Syntax

fn decryption_cert_thumbprint_sha256(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

decryption_cert_usage property (PDFSign Struct)

The text description of UsageFlags .

Syntax

fn decryption_cert_usage(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of decryption_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

decryption_cert_usage_flags property (PDFSign Struct)

The flags that show intended use for the certificate.

Syntax

fn decryption_cert_usage_flags(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of decryption_cert_usage_flags is a combination of the following flags:

Please see the decryption_cert_usage property for a text representation of decryption_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

decryption_cert_version property (PDFSign Struct)

The certificate's version number.

Syntax

fn decryption_cert_version(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

decryption_cert_subject property (PDFSign Struct)

The subject of the certificate used for client authentication.

Syntax

fn decryption_cert_subject(&self ) -> Result<String, SecurePDFError> 
fn set_decryption_cert_subject(&self, value : &str) ->  Option<SecurePDFError> 
fn set_decryption_cert_subject_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

decryption_cert_encoded property (PDFSign Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn decryption_cert_encoded(&self ) -> Result<Vec<u8>, SecurePDFError> 
fn set_decryption_cert_encoded(&self, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_decryption_cert_encoded_ref(&self, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The decryption_cert_store and decryption_cert_subject properties also may be used to specify a certificate.

When decryption_cert_encoded is set, a search is initiated in the current decryption_cert_store for the private key of the certificate. If the key is found, decryption_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, decryption_cert_subject is set to an empty string.

Data Type

Vec

document_cert_count property (PDFSign Struct)

The number of records in the DocumentCert arrays.

Syntax

fn document_cert_count(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• document_cert_effective_date
• document_cert_encoded
• document_cert_expiration_date
• document_cert_extended_key_usage
• document_cert_fingerprint
• document_cert_fingerprint_sha1
• document_cert_fingerprint_sha256
• document_cert_issuer
• document_cert_private_key
• document_cert_private_key_available
• document_cert_private_key_container
• document_cert_public_key
• document_cert_public_key_algorithm
• document_cert_public_key_length
• document_cert_serial_number
• document_cert_signature_algorithm
• document_cert_store
• document_cert_store_password
• document_cert_store_type
• document_cert_subject
• document_cert_subject_alt_names
• document_cert_thumbprint_md5
• document_cert_thumbprint_sha1
• document_cert_thumbprint_sha256
• document_cert_usage
• document_cert_usage_flags
• document_cert_version

The array indices start at 0 and end at document_cert_count - 1.

This property is read-only.

Data Type

i32

document_cert_effective_date property (PDFSign Struct)

The date on which this certificate becomes valid.

Syntax

fn document_cert_effective_date(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_expiration_date property (PDFSign Struct)

The date on which the certificate expires.

Syntax

fn document_cert_expiration_date(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_extended_key_usage property (PDFSign Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn document_cert_extended_key_usage(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_fingerprint property (PDFSign Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn document_cert_fingerprint(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_fingerprint_sha1 property (PDFSign Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn document_cert_fingerprint_sha1(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_fingerprint_sha256 property (PDFSign Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn document_cert_fingerprint_sha256(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_issuer property (PDFSign Struct)

The issuer of the certificate.

Syntax

fn document_cert_issuer(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_private_key property (PDFSign Struct)

The private key of the certificate (if available).

Syntax

fn document_cert_private_key(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The document_cert_private_key may be available but not exportable. In this case, document_cert_private_key returns an empty string.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_private_key_available property (PDFSign Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn document_cert_private_key_available(&self , DocumentCertIndex : i32) -> Result<bool, SecurePDFError> 

Default Value

false

Remarks

Whether a document_cert_private_key is available for the selected certificate. If document_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

bool

document_cert_private_key_container property (PDFSign Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn document_cert_private_key_container(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The name of the document_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_public_key property (PDFSign Struct)

The public key of the certificate.

Syntax

fn document_cert_public_key(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_public_key_algorithm property (PDFSign Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn document_cert_public_key_algorithm(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_public_key_length property (PDFSign Struct)

The length of the certificate's public key (in bits).

Syntax

fn document_cert_public_key_length(&self , DocumentCertIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

i32

document_cert_serial_number property (PDFSign Struct)

The serial number of the certificate encoded as a string.

Syntax

fn document_cert_serial_number(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_signature_algorithm property (PDFSign Struct)

The text description of the certificate's signature algorithm.

Syntax

fn document_cert_signature_algorithm(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_store property (PDFSign Struct)

The name of the certificate store for the client certificate.

Syntax

fn document_cert_store(&self , DocumentCertIndex : i32) -> Result<Vec<u8>, SecurePDFError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The document_cert_store_type property denotes the type of the certificate store specified by document_cert_store. If the store is password-protected, specify the password in document_cert_store_password.

document_cert_store is used in conjunction with the document_cert_subject property to specify client certificates. If document_cert_store has a value, and document_cert_subject or document_cert_encoded is set, a search for a certificate is initiated. Please see the document_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

Vec

document_cert_store_password property (PDFSign Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn document_cert_store_password(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_store_type property (PDFSign Struct)

The type of certificate store for this certificate.

Syntax

fn document_cert_store_type(&self , DocumentCertIndex : i32) -> Result<i32, SecurePDFError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

i32

document_cert_subject_alt_names property (PDFSign Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn document_cert_subject_alt_names(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_thumbprint_md5 property (PDFSign Struct)

The MD5 hash of the certificate.

Syntax

fn document_cert_thumbprint_md5(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_thumbprint_sha1 property (PDFSign Struct)

The SHA-1 hash of the certificate.

Syntax

fn document_cert_thumbprint_sha1(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_thumbprint_sha256 property (PDFSign Struct)

The SHA-256 hash of the certificate.

Syntax

fn document_cert_thumbprint_sha256(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_usage property (PDFSign Struct)

The text description of UsageFlags .

Syntax

fn document_cert_usage(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of document_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_usage_flags property (PDFSign Struct)

The flags that show intended use for the certificate.

Syntax

fn document_cert_usage_flags(&self , DocumentCertIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of document_cert_usage_flags is a combination of the following flags:

Please see the document_cert_usage property for a text representation of document_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

i32

document_cert_version property (PDFSign Struct)

The certificate's version number.

Syntax

fn document_cert_version(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_subject property (PDFSign Struct)

The subject of the certificate used for client authentication.

Syntax

fn document_cert_subject(&self , DocumentCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

String

document_cert_encoded property (PDFSign Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn document_cert_encoded(&self , DocumentCertIndex : i32) -> Result<Vec<u8>, SecurePDFError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The document_cert_store and document_cert_subject properties also may be used to specify a certificate.

When document_cert_encoded is set, a search is initiated in the current document_cert_store for the private key of the certificate. If the key is found, document_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, document_cert_subject is set to an empty string.

The DocumentCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DocumentCertCount property.

This property is read-only.

Data Type

Vec

firewall_auto_detect property (PDFSign Struct)

Whether to automatically detect and use firewall system settings, if available.

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, SecurePDFError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<SecurePDFError> 

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

bool

firewall_type property (PDFSign Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, SecurePDFError> 
fn set_firewall_type(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // None
1   // Tunnel
2   // SOCKS4
3   // SOCKS5
10   // SOCKS4A

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

i32

firewall_host property (PDFSign Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, SecurePDFError> 
fn set_firewall_host(&self, value : &str) ->  Option<SecurePDFError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the struct fails with an error.

Data Type

String

firewall_password property (PDFSign Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, SecurePDFError> 
fn set_firewall_password(&self, value : &str) ->  Option<SecurePDFError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error.

Data Type

String

firewall_port property (PDFSign Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, SecurePDFError> 
fn set_firewall_port(&self, value : i32) ->  Option<SecurePDFError> 

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

NOTE: This property is set automatically when firewall_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (PDFSign Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, SecurePDFError> 
fn set_firewall_user(&self, value : &str) ->  Option<SecurePDFError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the struct fails with an error.

Data Type

String

input_data property (PDFSign Struct)

A byte array containing the PDF document to process.

Syntax

fn input_data(&self ) -> Result<Vec<u8>, SecurePDFError> 
fn set_input_data(&self, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_input_data_ref(&self, value : &[u8]) ->  Option<SecurePDFError> 

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

Data Type

Vec

input_file property (PDFSign Struct)

The PDF file to process.

Syntax

fn input_file(&self ) -> Result<String, SecurePDFError> 
fn set_input_file(&self, value : &str) ->  Option<SecurePDFError> 
fn set_input_file_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to provide a path to the PDF document to be processed.

Data Type

String

known_cert_count property (PDFSign Struct)

The number of records in the KnownCert arrays.

Syntax

fn known_cert_count(&self ) -> Result<i32, SecurePDFError> 
fn set_known_cert_count(&self, value : i32) ->  Option<SecurePDFError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_cert_effective_date
• known_cert_encoded
• known_cert_expiration_date
• known_cert_extended_key_usage
• known_cert_fingerprint
• known_cert_fingerprint_sha1
• known_cert_fingerprint_sha256
• known_cert_issuer
• known_cert_private_key
• known_cert_private_key_available
• known_cert_private_key_container
• known_cert_public_key
• known_cert_public_key_algorithm
• known_cert_public_key_length
• known_cert_serial_number
• known_cert_signature_algorithm
• known_cert_store
• known_cert_store_password
• known_cert_store_type
• known_cert_subject
• known_cert_subject_alt_names
• known_cert_thumbprint_md5
• known_cert_thumbprint_sha1
• known_cert_thumbprint_sha256
• known_cert_usage
• known_cert_usage_flags
• known_cert_version

The array indices start at 0 and end at known_cert_count - 1.

Data Type

i32

known_cert_effective_date property (PDFSign Struct)

The date on which this certificate becomes valid.

Syntax

fn known_cert_effective_date(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_expiration_date property (PDFSign Struct)

The date on which the certificate expires.

Syntax

fn known_cert_expiration_date(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_extended_key_usage property (PDFSign Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn known_cert_extended_key_usage(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_fingerprint property (PDFSign Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn known_cert_fingerprint(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_fingerprint_sha1 property (PDFSign Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn known_cert_fingerprint_sha1(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_fingerprint_sha256 property (PDFSign Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn known_cert_fingerprint_sha256(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_issuer property (PDFSign Struct)

The issuer of the certificate.

Syntax

fn known_cert_issuer(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_private_key property (PDFSign Struct)

The private key of the certificate (if available).

Syntax

fn known_cert_private_key(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The known_cert_private_key may be available but not exportable. In this case, known_cert_private_key returns an empty string.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_private_key_available property (PDFSign Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn known_cert_private_key_available(&self , KnownCertIndex : i32) -> Result<bool, SecurePDFError> 

Default Value

false

Remarks

Whether a known_cert_private_key is available for the selected certificate. If known_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

bool

known_cert_private_key_container property (PDFSign Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn known_cert_private_key_container(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The name of the known_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_public_key property (PDFSign Struct)

The public key of the certificate.

Syntax

fn known_cert_public_key(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_public_key_algorithm property (PDFSign Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn known_cert_public_key_algorithm(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_public_key_length property (PDFSign Struct)

The length of the certificate's public key (in bits).

Syntax

fn known_cert_public_key_length(&self , KnownCertIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

i32

known_cert_serial_number property (PDFSign Struct)

The serial number of the certificate encoded as a string.

Syntax

fn known_cert_serial_number(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_signature_algorithm property (PDFSign Struct)

The text description of the certificate's signature algorithm.

Syntax

fn known_cert_signature_algorithm(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_store property (PDFSign Struct)

The name of the certificate store for the client certificate.

Syntax

fn known_cert_store(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecurePDFError> 
fn set_known_cert_store(&self, KnownCertIndex : i32, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_known_cert_store_ref(&self, KnownCertIndex : i32, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The known_cert_store_type property denotes the type of the certificate store specified by known_cert_store. If the store is password-protected, specify the password in known_cert_store_password.

known_cert_store is used in conjunction with the known_cert_subject property to specify client certificates. If known_cert_store has a value, and known_cert_subject or known_cert_encoded is set, a search for a certificate is initiated. Please see the known_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

Vec

known_cert_store_password property (PDFSign Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn known_cert_store_password(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 
fn set_known_cert_store_password(&self, KnownCertIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_known_cert_store_password_ref(&self, KnownCertIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

String

known_cert_store_type property (PDFSign Struct)

The type of certificate store for this certificate.

Syntax

fn known_cert_store_type(&self , KnownCertIndex : i32) -> Result<i32, SecurePDFError> 
fn set_known_cert_store_type(&self, KnownCertIndex : i32, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

i32

known_cert_subject_alt_names property (PDFSign Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn known_cert_subject_alt_names(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_thumbprint_md5 property (PDFSign Struct)

The MD5 hash of the certificate.

Syntax

fn known_cert_thumbprint_md5(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_thumbprint_sha1 property (PDFSign Struct)

The SHA-1 hash of the certificate.

Syntax

fn known_cert_thumbprint_sha1(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_thumbprint_sha256 property (PDFSign Struct)

The SHA-256 hash of the certificate.

Syntax

fn known_cert_thumbprint_sha256(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_usage property (PDFSign Struct)

The text description of UsageFlags .

Syntax

fn known_cert_usage(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of known_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_usage_flags property (PDFSign Struct)

The flags that show intended use for the certificate.

Syntax

fn known_cert_usage_flags(&self , KnownCertIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of known_cert_usage_flags is a combination of the following flags:

Please see the known_cert_usage property for a text representation of known_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

i32

known_cert_version property (PDFSign Struct)

The certificate's version number.

Syntax

fn known_cert_version(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is read-only.

Data Type

String

known_cert_subject property (PDFSign Struct)

The subject of the certificate used for client authentication.

Syntax

fn known_cert_subject(&self , KnownCertIndex : i32) -> Result<String, SecurePDFError> 
fn set_known_cert_subject(&self, KnownCertIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_known_cert_subject_ref(&self, KnownCertIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

String

known_cert_encoded property (PDFSign Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn known_cert_encoded(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecurePDFError> 
fn set_known_cert_encoded(&self, KnownCertIndex : i32, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_known_cert_encoded_ref(&self, KnownCertIndex : i32, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The known_cert_store and known_cert_subject properties also may be used to specify a certificate.

When known_cert_encoded is set, a search is initiated in the current known_cert_store for the private key of the certificate. If the key is found, known_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, known_cert_subject is set to an empty string.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

Data Type

Vec

offline_mode property (PDFSign Struct)

Whether the struct is operating in offline mode.

Syntax

fn offline_mode(&self ) -> Result<bool, SecurePDFError> 
fn set_offline_mode(&self, value : bool) ->  Option<SecurePDFError> 

Default Value

false

Remarks

This property indicates whether the struct should operate in offline mode.

In offline mode, the struct restricts itself from accessing online Trusted Lists and revocation information sources such as CRLs or OCSP responders. It may be useful to set this property to true if there is a need to verify the completeness of the validation information included within the signature or provided via known_certs.

Data Type

bool

output_data property (PDFSign Struct)

A byte array containing the PDF document after processing.

Syntax

fn output_data(&self ) -> Result<Vec<u8>, SecurePDFError> 

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It is only set if an output file and output stream have not been assigned via output_file and set_output_stream respectively.

This property is read-only.

Data Type

Vec

output_file property (PDFSign Struct)

The path to a local file where the output is written.

Syntax

fn output_file(&self ) -> Result<String, SecurePDFError> 
fn set_output_file(&self, value : &str) ->  Option<SecurePDFError> 
fn set_output_file_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to provide a path where the resulting PDF document is saved after the operation has completed.

Data Type

String

overwrite property (PDFSign Struct)

Whether the struct should overwrite files.

Syntax

fn overwrite(&self ) -> Result<bool, SecurePDFError> 
fn set_overwrite(&self, value : bool) ->  Option<SecurePDFError> 

Default Value

false

Remarks

This property indicates whether the struct overwrites output_file. If set to false, an error is thrown whenever output_file exists before an operation.

Data Type

bool

password property (PDFSign Struct)

The password to decrypt the document with.

Syntax

fn password(&self ) -> Result<String, SecurePDFError> 
fn set_password(&self, value : &str) ->  Option<SecurePDFError> 
fn set_password_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

Data Type

String

proxy_auth_scheme property (PDFSign Struct)

The type of authorization to perform when connecting to the proxy.

Syntax

fn proxy_auth_scheme(&self ) -> Result<i32, SecurePDFError> 
fn set_proxy_auth_scheme(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // Basic
1   // Digest
2   // Proprietary
3   // None
4   // Ntlm
5   // Negotiate

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the struct will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

Data Type

i32

proxy_auto_detect property (PDFSign Struct)

Whether to automatically detect and use proxy system settings, if available.

Syntax

fn proxy_auto_detect(&self ) -> Result<bool, SecurePDFError> 
fn set_proxy_auto_detect(&self, value : bool) ->  Option<SecurePDFError> 

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

bool

proxy_password property (PDFSign Struct)

A password if authentication is to be used for the proxy.

Syntax

fn proxy_password(&self ) -> Result<String, SecurePDFError> 
fn set_proxy_password(&self, value : &str) ->  Option<SecurePDFError> 
fn set_proxy_password_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

proxy_port property (PDFSign Struct)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fn proxy_port(&self ) -> Result<i32, SecurePDFError> 
fn set_proxy_port(&self, value : i32) ->  Option<SecurePDFError> 

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

Data Type

i32

proxy_server property (PDFSign Struct)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fn proxy_server(&self ) -> Result<String, SecurePDFError> 
fn set_proxy_server(&self, value : &str) ->  Option<SecurePDFError> 
fn set_proxy_server_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

proxy_ssl property (PDFSign Struct)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fn proxy_ssl(&self ) -> Result<i32, SecurePDFError> 
fn set_proxy_ssl(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // Automatic
1   // Always
2   // Never
3   // Tunnel

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

i32

proxy_user property (PDFSign Struct)

A username if authentication is to be used for the proxy.

Syntax

fn proxy_user(&self ) -> Result<String, SecurePDFError> 
fn set_proxy_user(&self, value : &str) ->  Option<SecurePDFError> 
fn set_proxy_user_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

Data Type

String

remote_signature_data property (PDFSign Struct)

The signature data obtained from a remote signer.

Syntax

fn remote_signature_data(&self ) -> Result<String, SecurePDFError> 
fn set_remote_signature_data(&self, value : &str) ->  Option<SecurePDFError> 
fn set_remote_signature_data_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to specify the hex-encoded signature data obtained from a remote signer. Use it to pass the remote_signature_digest back to the struct (after it has been processed appropriately and signed) to complete the signature.

Data Type

String

remote_signature_digest property (PDFSign Struct)

The digest to be signed remotely.

Syntax

fn remote_signature_digest(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

This property is used to read the hex-encoded digest that should be passed to a remote signer to be signed. Note that in the PKCS#1 method, this value is the raw data of the PKCS#7 signed-attributes field, whereas in the PKCS#7 method, it is the document hash.

This property is read-only.

Data Type

String

remote_signature_method property (PDFSign Struct)

The remote signing method.

Syntax

fn remote_signature_method(&self ) -> Result<i32, SecurePDFError> 
fn set_remote_signature_method(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // None
1   // PKCS1
2   // PKCS7
3   // Digest
4   // Blob

Default Value

0

Remarks

This property is used to specify whether and how the new signature is intended to be created remotely. If set to rsmPKCS1, rsmPKCS7, or rsmBlob before sign is called, the struct does not perform the low-level signing operation itself but instead delegates it to an external or remote signer.

Possible values are:

Data Type

i32

revocation_check property (PDFSign Struct)

The kind(s) of revocation check to perform for all chain certificates.

Syntax

fn revocation_check(&self ) -> Result<i32, SecurePDFError> 
fn set_revocation_check(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // AllCRL
1   // AllOCSP
2   // AllCRLAndOCSP
3   // AnyCRL
4   // AnyOCSP
5   // AnyCRLOrOCSP
6   // AnyOCSPOrCRL

Default Value

6

Remarks

This property is used to specify the revocation sources and preferences the struct uses during chain validation. Revocation checking is necessary to ensure the integrity of the chain and to obtain up-to-date certificate validity and trust information.

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate has not been revoked by the Certificate Authority (CA) at the time of use. Depending on the circumstances and security policy requirements, either one or both of the revocation information source types may be used.

Possible values are:

This property controls the way revocation checks are performed for every certificate in the chain. Typically, certificates come with two types of revocation information sources: CRLs (Certificate Revocation Lists) and OCSP responses. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally a delay between the time at which a certificate was revoked and the time at which the subsequent CRL mentioning that revocation is published. The benefits of CRLs are that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This property allows the validation course to be adjusted by including or excluding certain types of revocation sources from the validation process. The rcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The rcAll* modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check is considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

i32

signature_author_name property (PDFSign Struct)

The human-readable name of the signer.

Syntax

fn signature_author_name(&self ) -> Result<String, SecurePDFError> 
fn set_signature_author_name(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_author_name_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to specify the human-readable name of the signer.

NOTE: This property only applies when creating a new signature.

Data Type

String

signature_claimed_signing_time property (PDFSign Struct)

The signature's creation time.

Syntax

fn signature_claimed_signing_time(&self ) -> Result<String, SecurePDFError> 
fn set_signature_claimed_signing_time(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_claimed_signing_time_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to specify the signature creation time from the signer's computer. The time should be provided in UTC in yyyyMMddHHmmssZ format.

If this property is empty when a new signature is created, the struct uses the current UTC time.

NOTE: This property only applies when creating a new signature.

Data Type

String

signature_field property (PDFSign Struct)

The index of the empty signature field to sign.

Syntax

fn signature_field(&self ) -> Result<i32, SecurePDFError> 
fn set_signature_field(&self, value : i32) ->  Option<SecurePDFError> 

Default Value

-1

Remarks

This property is used to specify the empty signature field that should be signed. If the default value of -1 is assigned to this property, a new signature field is created.

Example: pdfsign.InputFile = "input.pdf"; pdfsign.OutputFile = "emptyfield.pdf"; pdfsign.SignatureType = PDFSignSignatureTypes.stEmptyField; pdfsign.Sign(); // Later pdfsign.Reset(); pdfsign.InputFile = "emptyfield.pdf"; pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); pdfsign.SignatureField = 0; // Configure signature properties as desired pdfsign.Sign();

Data Type

i32

signature_hash_algorithm property (PDFSign Struct)

The hash algorithm to be used for signing.

Syntax

fn signature_hash_algorithm(&self ) -> Result<String, SecurePDFError> 
fn set_signature_hash_algorithm(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_hash_algorithm_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

"SHA256"

Remarks

This property is used to specify the hash algorithm to be used for signing.

Possible values are:

• SHA1
• SHA224
• SHA256
• SHA384
• SHA512
• MD5

NOTE: This property only applies when creating a new signature.

Data Type

String

signature_profile property (PDFSign Struct)

The PAdES profile to apply when creating the signature.

Syntax

fn signature_profile(&self ) -> Result<i32, SecurePDFError> 
fn set_signature_profile(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // None
1   // BaselineB
2   // BaselineT
3   // BaselineLT
4   // BaselineLTA

Default Value

0

Remarks

This property is used to specify a pre-defined PAdES profile to apply when creating the signature, as defined by ETSI.

Advanced signatures come in many variants, and they are often defined by parties that need to process them or by local standards. Profiles are sets of pre-defined configurations that correspond to particular signature variants. Specifying a profile pre-configures the struct to make it produce the signature that matches the configuration corresponding to that profile.

Possible values are:

To apply a custom profile that is not defined by ETSI, set CustomProfile.

NOTE: This property only applies when creating a new signature.

Data Type

i32

signature_reason property (PDFSign Struct)

The reason for signing.

Syntax

fn signature_reason(&self ) -> Result<String, SecurePDFError> 
fn set_signature_reason(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_reason_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to specify the reason for signing.

NOTE: This property only applies when creating a new signature.

Data Type

String

pdf_signature_count property (PDFSign Struct)

The number of records in the PDFSignature arrays.

Syntax

fn pdf_signature_count(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• pdf_signature_author_name
• pdf_signature_chain_validation_details
• pdf_signature_chain_validation_result
• pdf_signature_claimed_signing_time
• pdf_signature_coverage_ends_at
• pdf_signature_hash_algorithm
• pdf_signature_profile
• pdf_signature_reason
• pdf_signature_signer_cert_index
• pdf_signature_timestamp_cert_index
• pdf_signature_timestamped
• pdf_signature_type
• pdf_signature_validated_signing_time
• pdf_signature_validation_result
• pdf_signature_widget_height
• pdf_signature_widget_offset_x
• pdf_signature_widget_offset_y
• pdf_signature_widget_pages
• pdf_signature_widget_width

The array indices start at 0 and end at pdf_signature_count - 1.

This property is read-only.

Data Type

i32

pdf_signature_author_name property (PDFSign Struct)

The human-readable name of the signer.

Syntax

fn pdf_signature_author_name(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The human-readable name of the signer.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_chain_validation_details property (PDFSign Struct)

The details of the certificate chain validation outcome.

Syntax

fn pdf_signature_chain_validation_details(&self , PDFSignatureIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The details of the certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result in pdf_signature_chain_validation_result.

The value of this property is a bitmask of the following flags:

Subscribe to the on_log event to access the detailed validation log. This property is also available as a parameter of the on_signature_processed event.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

i32

pdf_signature_chain_validation_result property (PDFSign Struct)

The outcome of the certificate chain validation routine.

Syntax

fn pdf_signature_chain_validation_result(&self , PDFSignatureIndex : i32) -> Result<i32, SecurePDFError> 

Possible Values

0   // Unknown
1   // Valid
2   // ValidButUntrusted
3   // Invalid
4   // CantBeEstablished

Default Value

0

Remarks

The outcome of the certificate chain validation routine.

Possible values are:

Subscribe to the on_log event to access the detailed validation log. This property is also available as a parameter of the on_signature_processed event.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

i32

pdf_signature_claimed_signing_time property (PDFSign Struct)

The signature's creation time in UTC.

Syntax

fn pdf_signature_claimed_signing_time(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The signature's creation time in UTC.

Use this property to get the signature creation time from the signer's computer. Note that the claimed time, unlike pdf_signature_validated_signing_time, does not originate from a trusted TSA and may be forged or wrong.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_coverage_ends_at property (PDFSign Struct)

The byte offset in the PDF file where the signature coverage ends.

Syntax

fn pdf_signature_coverage_ends_at(&self , PDFSignatureIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The byte offset in the PDF file where the signature coverage ends.

PDF generators often use incremental updates to make changes in documents. This may result in the signature only covering a part of the document (one of the past revisions), but not the subsequent changes.

Use this property to identify the offset where the signature coverage ends. One option is to compare it to the length of the whole document to ensure that the signature covers the entire document. Alternatively, use get_signed_version to extract the exact revision that was signed.

A value of 0 indicates that the struct could not determine the coverage offset.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

i32

pdf_signature_hash_algorithm property (PDFSign Struct)

The hash algorithm that was used for signing.

Syntax

fn pdf_signature_hash_algorithm(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

"SHA256"

Remarks

The hash algorithm that was used for signing.

Possible values are:

• SHA1
• SHA224
• SHA256
• SHA384
• SHA512
• MD5

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_profile property (PDFSign Struct)

The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI.

Syntax

fn pdf_signature_profile(&self , PDFSignatureIndex : i32) -> Result<i32, SecurePDFError> 

Possible Values

0   // None
1   // BaselineB
2   // BaselineT
3   // BaselineLT
4   // BaselineLTA

Default Value

0

Remarks

The pre-defined PAdES profile that was applied when creating the signature, as defined by ETSI.

Advanced signatures come in many variants, and they are often defined by parties that need to process them or by local standards. Profiles are sets of pre-defined configurations that correspond to particular signature variants.

Possible values are:

Note that when verifying a signature, the LTV modifier may be affected by the validation settings. These include offline_mode (set it to true to obtain the clean LTV capability) and CacheRevocationInfo (set it to false to prevent earlier validations from affecting the current validation).

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

i32

pdf_signature_reason property (PDFSign Struct)

The reason for signing.

Syntax

fn pdf_signature_reason(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The reason for signing.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_type property (PDFSign Struct)

The type of the signature that was created.

Syntax

fn pdf_signature_type(&self , PDFSignatureIndex : i32) -> Result<i32, SecurePDFError> 

Possible Values

0   // Legacy
1   // Advanced
2   // DTS
3   // EmptyField

Default Value

0

Remarks

The type of the signature that was created.

Possible values are:

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

i32

pdf_signature_signer_cert_index property (PDFSign Struct)

The index of the signer certificate in the DocumentCerts collection.

Syntax

fn pdf_signature_signer_cert_index(&self , PDFSignatureIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

-1

Remarks

The index of the signer certificate in the document_certs collection.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

i32

pdf_signature_timestamp_cert_index property (PDFSign Struct)

The index of the timestamping certificate in the DocumentCerts collection (if applicable).

Syntax

fn pdf_signature_timestamp_cert_index(&self , PDFSignatureIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

-1

Remarks

The index of the timestamping certificate in the document_certs collection (if applicable).

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

i32

pdf_signature_timestamped property (PDFSign Struct)

Whether the signature contains an embedded timestamp.

Syntax

fn pdf_signature_timestamped(&self , PDFSignatureIndex : i32) -> Result<bool, SecurePDFError> 

Default Value

false

Remarks

Whether the signature contains an embedded timestamp.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

bool

pdf_signature_validated_signing_time property (PDFSign Struct)

The certified signing time in UTC.

Syntax

fn pdf_signature_validated_signing_time(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The certified signing time in UTC.

Use this property to obtain the signing time as certified by a timestamp from a trusted timestamping authority. This property is only non-empty if there is a valid timestamp included in the signature.

Note that the validated time, unlike pdf_signature_claimed_signing_time, is the trusted signing time.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_validation_result property (PDFSign Struct)

The outcome of the cryptographic signature validation.

Syntax

fn pdf_signature_validation_result(&self , PDFSignatureIndex : i32) -> Result<i32, SecurePDFError> 

Possible Values

0   // Unknown
1   // Valid
2   // Corrupted
3   // SignerNotFound
4   // Failure

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

Possible values are:

This property is also available as the signature_validation_result parameter of the on_signature_processed event.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

i32

pdf_signature_widget_height property (PDFSign Struct)

The height of the signature widget in points.

Syntax

fn pdf_signature_widget_height(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

"70"

Remarks

The height of the signature widget in points.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_widget_offset_x property (PDFSign Struct)

The signature widget offset from the left-hand page border in points.

Syntax

fn pdf_signature_widget_offset_x(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

"0"

Remarks

The signature widget offset from the left-hand page border in points.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_widget_offset_y property (PDFSign Struct)

The signature widget offset from the bottom page border in points.

Syntax

fn pdf_signature_widget_offset_y(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

"0"

Remarks

The signature widget offset from the bottom page border in points.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_widget_pages property (PDFSign Struct)

The pages that the signature and its widget are placed on.

Syntax

fn pdf_signature_widget_pages(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The pages that the signature and its widget are placed on.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

pdf_signature_widget_width property (PDFSign Struct)

The width of the signature widget in points.

Syntax

fn pdf_signature_widget_width(&self , PDFSignatureIndex : i32) -> Result<String, SecurePDFError> 

Default Value

"70"

Remarks

The width of the signature widget in points.

The PDFSignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PDFSignatureCount property.

This property is read-only.

Data Type

String

signature_type property (PDFSign Struct)

The type of signature to create.

Syntax

fn signature_type(&self ) -> Result<i32, SecurePDFError> 
fn set_signature_type(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // Legacy
1   // Advanced
2   // DTS
3   // EmptyField

Default Value

0

Remarks

This property is used to specify the type of the signature. For PAdES signatures, use signature_profile to specify the PAdES profile.

Possible values are:

NOTE: This property only applies when creating a new signature.

Data Type

i32

signature_widget_height property (PDFSign Struct)

The height of the signature widget.

Syntax

fn signature_widget_height(&self ) -> Result<String, SecurePDFError> 
fn set_signature_widget_height(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_widget_height_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

"70"

Remarks

This property is used to specify the height of the signature widget in points. Both integer and decimal values are supported.

NOTE: This property only applies when creating a new signature.

Data Type

String

signature_widget_offset_x property (PDFSign Struct)

The signature widget offset from the left-hand page border.

Syntax

fn signature_widget_offset_x(&self ) -> Result<String, SecurePDFError> 
fn set_signature_widget_offset_x(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_widget_offset_x_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

"0"

Remarks

This property is used to specify the signature widget offset from the left-hand page border in points. Both integer and decimal values are supported.

NOTE: This property only applies when creating a new signature.

Data Type

String

signature_widget_offset_y property (PDFSign Struct)

The signature widget offset from the bottom page border.

Syntax

fn signature_widget_offset_y(&self ) -> Result<String, SecurePDFError> 
fn set_signature_widget_offset_y(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_widget_offset_y_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

"0"

Remarks

This property is used to specify the signature widget offset from the bottom page border in points. Both integer and decimal values are supported.

NOTE: This property only applies when creating a new signature.

Data Type

String

signature_widget_pages property (PDFSign Struct)

The pages to place the signature and its widget on.

Syntax

fn signature_widget_pages(&self ) -> Result<String, SecurePDFError> 
fn set_signature_widget_pages(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_widget_pages_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to specify the pages on which the signature and its widget are placed.

A variety of syntaxes are supported:

• A single page index (zero-based): 3
• A comma-separated list of page indices (zero-based): 1,2,5,7
• The asterisk character (*) indicates that the widget should be placed on all pages in the document.
• The first and last placeholders specify that the signature should be placed on the respective page, independently of its number.

NOTE: If no valid pages are specified, the struct places the widget on the first page by default.

NOTE: This property only applies when creating a new signature.

Data Type

String

signature_widget_width property (PDFSign Struct)

The width of the signature widget.

Syntax

fn signature_widget_width(&self ) -> Result<String, SecurePDFError> 
fn set_signature_widget_width(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signature_widget_width_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

"70"

Remarks

This property is used to specify the width of the signature widget in points. Both integer and decimal values are supported.

NOTE: This property only applies when creating a new signature.

Data Type

String

signing_cert_effective_date property (PDFSign Struct)

The date on which this certificate becomes valid.

Syntax

fn signing_cert_effective_date(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

signing_cert_expiration_date property (PDFSign Struct)

The date on which the certificate expires.

Syntax

fn signing_cert_expiration_date(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

signing_cert_extended_key_usage property (PDFSign Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn signing_cert_extended_key_usage(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

signing_cert_fingerprint property (PDFSign Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn signing_cert_fingerprint(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

signing_cert_fingerprint_sha1 property (PDFSign Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn signing_cert_fingerprint_sha1(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

signing_cert_fingerprint_sha256 property (PDFSign Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn signing_cert_fingerprint_sha256(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

signing_cert_issuer property (PDFSign Struct)

The issuer of the certificate.

Syntax

fn signing_cert_issuer(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

signing_cert_private_key property (PDFSign Struct)

The private key of the certificate (if available).

Syntax

fn signing_cert_private_key(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The signing_cert_private_key may be available but not exportable. In this case, signing_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

signing_cert_private_key_available property (PDFSign Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn signing_cert_private_key_available(&self ) -> Result<bool, SecurePDFError> 

Default Value

false

Remarks

Whether a signing_cert_private_key is available for the selected certificate. If signing_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

signing_cert_private_key_container property (PDFSign Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn signing_cert_private_key_container(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The name of the signing_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

signing_cert_public_key property (PDFSign Struct)

The public key of the certificate.

Syntax

fn signing_cert_public_key(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

signing_cert_public_key_algorithm property (PDFSign Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn signing_cert_public_key_algorithm(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

signing_cert_public_key_length property (PDFSign Struct)

The length of the certificate's public key (in bits).

Syntax

fn signing_cert_public_key_length(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

signing_cert_serial_number property (PDFSign Struct)

The serial number of the certificate encoded as a string.

Syntax

fn signing_cert_serial_number(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

signing_cert_signature_algorithm property (PDFSign Struct)

The text description of the certificate's signature algorithm.

Syntax

fn signing_cert_signature_algorithm(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

signing_cert_store property (PDFSign Struct)

The name of the certificate store for the client certificate.

Syntax

fn signing_cert_store(&self ) -> Result<Vec<u8>, SecurePDFError> 
fn set_signing_cert_store(&self, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_signing_cert_store_ref(&self, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The signing_cert_store_type property denotes the type of the certificate store specified by signing_cert_store. If the store is password-protected, specify the password in signing_cert_store_password.

signing_cert_store is used in conjunction with the signing_cert_subject property to specify client certificates. If signing_cert_store has a value, and signing_cert_subject or signing_cert_encoded is set, a search for a certificate is initiated. Please see the signing_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

signing_cert_store_password property (PDFSign Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn signing_cert_store_password(&self ) -> Result<String, SecurePDFError> 
fn set_signing_cert_store_password(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signing_cert_store_password_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

signing_cert_store_type property (PDFSign Struct)

The type of certificate store for this certificate.

Syntax

fn signing_cert_store_type(&self ) -> Result<i32, SecurePDFError> 
fn set_signing_cert_store_type(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

signing_cert_subject_alt_names property (PDFSign Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn signing_cert_subject_alt_names(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

signing_cert_thumbprint_md5 property (PDFSign Struct)

The MD5 hash of the certificate.

Syntax

fn signing_cert_thumbprint_md5(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

signing_cert_thumbprint_sha1 property (PDFSign Struct)

The SHA-1 hash of the certificate.

Syntax

fn signing_cert_thumbprint_sha1(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

signing_cert_thumbprint_sha256 property (PDFSign Struct)

The SHA-256 hash of the certificate.

Syntax

fn signing_cert_thumbprint_sha256(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

signing_cert_usage property (PDFSign Struct)

The text description of UsageFlags .

Syntax

fn signing_cert_usage(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of signing_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

signing_cert_usage_flags property (PDFSign Struct)

The flags that show intended use for the certificate.

Syntax

fn signing_cert_usage_flags(&self ) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of signing_cert_usage_flags is a combination of the following flags:

Please see the signing_cert_usage property for a text representation of signing_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

signing_cert_version property (PDFSign Struct)

The certificate's version number.

Syntax

fn signing_cert_version(&self ) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

signing_cert_subject property (PDFSign Struct)

The subject of the certificate used for client authentication.

Syntax

fn signing_cert_subject(&self ) -> Result<String, SecurePDFError> 
fn set_signing_cert_subject(&self, value : &str) ->  Option<SecurePDFError> 
fn set_signing_cert_subject_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

signing_cert_encoded property (PDFSign Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn signing_cert_encoded(&self ) -> Result<Vec<u8>, SecurePDFError> 
fn set_signing_cert_encoded(&self, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_signing_cert_encoded_ref(&self, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The signing_cert_store and signing_cert_subject properties also may be used to specify a certificate.

When signing_cert_encoded is set, a search is initiated in the current signing_cert_store for the private key of the certificate. If the key is found, signing_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, signing_cert_subject is set to an empty string.

Data Type

Vec

timestamp_server property (PDFSign Struct)

The address of the timestamping server.

Syntax

fn timestamp_server(&self ) -> Result<String, SecurePDFError> 
fn set_timestamp_server(&self, value : &str) ->  Option<SecurePDFError> 
fn set_timestamp_server_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to specify the address of the TSA (Timestamping Authority) server to use for timestamping the signature (normal signing) or the document (LTV update).

If the timestamping service enforces credential-based user authentication (basic or digest), the credentials can be provided in the same URL. For example: pdfsign.TimestampServer = "http://user:password@timestamp.server.com/TsaService"; If the TSA requires TLS client authentication, provide the client certificate via TSATLSClientCertStoreType, TSATLSClientCertStore, TSATLSClientCertStorePassword, and TSATLSClientCertSubject.

Data Type

String

trusted_cert_count property (PDFSign Struct)

The number of records in the TrustedCert arrays.

Syntax

fn trusted_cert_count(&self ) -> Result<i32, SecurePDFError> 
fn set_trusted_cert_count(&self, value : i32) ->  Option<SecurePDFError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• trusted_cert_effective_date
• trusted_cert_encoded
• trusted_cert_expiration_date
• trusted_cert_extended_key_usage
• trusted_cert_fingerprint
• trusted_cert_fingerprint_sha1
• trusted_cert_fingerprint_sha256
• trusted_cert_issuer
• trusted_cert_private_key
• trusted_cert_private_key_available
• trusted_cert_private_key_container
• trusted_cert_public_key
• trusted_cert_public_key_algorithm
• trusted_cert_public_key_length
• trusted_cert_serial_number
• trusted_cert_signature_algorithm
• trusted_cert_store
• trusted_cert_store_password
• trusted_cert_store_type
• trusted_cert_subject
• trusted_cert_subject_alt_names
• trusted_cert_thumbprint_md5
• trusted_cert_thumbprint_sha1
• trusted_cert_thumbprint_sha256
• trusted_cert_usage
• trusted_cert_usage_flags
• trusted_cert_version

The array indices start at 0 and end at trusted_cert_count - 1.

Data Type

i32

trusted_cert_effective_date property (PDFSign Struct)

The date on which this certificate becomes valid.

Syntax

fn trusted_cert_effective_date(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_expiration_date property (PDFSign Struct)

The date on which the certificate expires.

Syntax

fn trusted_cert_expiration_date(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_extended_key_usage property (PDFSign Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn trusted_cert_extended_key_usage(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_fingerprint property (PDFSign Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn trusted_cert_fingerprint(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_fingerprint_sha1 property (PDFSign Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn trusted_cert_fingerprint_sha1(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_fingerprint_sha256 property (PDFSign Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn trusted_cert_fingerprint_sha256(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_issuer property (PDFSign Struct)

The issuer of the certificate.

Syntax

fn trusted_cert_issuer(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_private_key property (PDFSign Struct)

The private key of the certificate (if available).

Syntax

fn trusted_cert_private_key(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The trusted_cert_private_key may be available but not exportable. In this case, trusted_cert_private_key returns an empty string.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_private_key_available property (PDFSign Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn trusted_cert_private_key_available(&self , TrustedCertIndex : i32) -> Result<bool, SecurePDFError> 

Default Value

false

Remarks

Whether a trusted_cert_private_key is available for the selected certificate. If trusted_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

bool

trusted_cert_private_key_container property (PDFSign Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn trusted_cert_private_key_container(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The name of the trusted_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_public_key property (PDFSign Struct)

The public key of the certificate.

Syntax

fn trusted_cert_public_key(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_public_key_algorithm property (PDFSign Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn trusted_cert_public_key_algorithm(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_public_key_length property (PDFSign Struct)

The length of the certificate's public key (in bits).

Syntax

fn trusted_cert_public_key_length(&self , TrustedCertIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

i32

trusted_cert_serial_number property (PDFSign Struct)

The serial number of the certificate encoded as a string.

Syntax

fn trusted_cert_serial_number(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_signature_algorithm property (PDFSign Struct)

The text description of the certificate's signature algorithm.

Syntax

fn trusted_cert_signature_algorithm(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_store property (PDFSign Struct)

The name of the certificate store for the client certificate.

Syntax

fn trusted_cert_store(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecurePDFError> 
fn set_trusted_cert_store(&self, TrustedCertIndex : i32, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_trusted_cert_store_ref(&self, TrustedCertIndex : i32, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The trusted_cert_store_type property denotes the type of the certificate store specified by trusted_cert_store. If the store is password-protected, specify the password in trusted_cert_store_password.

trusted_cert_store is used in conjunction with the trusted_cert_subject property to specify client certificates. If trusted_cert_store has a value, and trusted_cert_subject or trusted_cert_encoded is set, a search for a certificate is initiated. Please see the trusted_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

Vec

trusted_cert_store_password property (PDFSign Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn trusted_cert_store_password(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 
fn set_trusted_cert_store_password(&self, TrustedCertIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_trusted_cert_store_password_ref(&self, TrustedCertIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

String

trusted_cert_store_type property (PDFSign Struct)

The type of certificate store for this certificate.

Syntax

fn trusted_cert_store_type(&self , TrustedCertIndex : i32) -> Result<i32, SecurePDFError> 
fn set_trusted_cert_store_type(&self, TrustedCertIndex : i32, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

i32

trusted_cert_subject_alt_names property (PDFSign Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn trusted_cert_subject_alt_names(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_thumbprint_md5 property (PDFSign Struct)

The MD5 hash of the certificate.

Syntax

fn trusted_cert_thumbprint_md5(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_thumbprint_sha1 property (PDFSign Struct)

The SHA-1 hash of the certificate.

Syntax

fn trusted_cert_thumbprint_sha1(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_thumbprint_sha256 property (PDFSign Struct)

The SHA-256 hash of the certificate.

Syntax

fn trusted_cert_thumbprint_sha256(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_usage property (PDFSign Struct)

The text description of UsageFlags .

Syntax

fn trusted_cert_usage(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The text description of trusted_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_usage_flags property (PDFSign Struct)

The flags that show intended use for the certificate.

Syntax

fn trusted_cert_usage_flags(&self , TrustedCertIndex : i32) -> Result<i32, SecurePDFError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of trusted_cert_usage_flags is a combination of the following flags:

Please see the trusted_cert_usage property for a text representation of trusted_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

i32

trusted_cert_version property (PDFSign Struct)

The certificate's version number.

Syntax

fn trusted_cert_version(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is read-only.

Data Type

String

trusted_cert_subject property (PDFSign Struct)

The subject of the certificate used for client authentication.

Syntax

fn trusted_cert_subject(&self , TrustedCertIndex : i32) -> Result<String, SecurePDFError> 
fn set_trusted_cert_subject(&self, TrustedCertIndex : i32, value : &str) ->  Option<SecurePDFError> 
fn set_trusted_cert_subject_ref(&self, TrustedCertIndex : i32, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

String

trusted_cert_encoded property (PDFSign Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn trusted_cert_encoded(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecurePDFError> 
fn set_trusted_cert_encoded(&self, TrustedCertIndex : i32, value : Vec<u8>) ->  Option<SecurePDFError> 
fn set_trusted_cert_encoded_ref(&self, TrustedCertIndex : i32, value : &[u8]) ->  Option<SecurePDFError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The trusted_cert_store and trusted_cert_subject properties also may be used to specify a certificate.

When trusted_cert_encoded is set, a search is initiated in the current trusted_cert_store for the private key of the certificate. If the key is found, trusted_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, trusted_cert_subject is set to an empty string.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

Data Type

Vec

trusted_lists property (PDFSign Struct)

A list of known Trusted Lists for chain validation.

Syntax

fn trusted_lists(&self ) -> Result<String, SecurePDFError> 
fn set_trusted_lists(&self, value : &str) ->  Option<SecurePDFError> 
fn set_trusted_lists_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

"%EUTL%"

Remarks

This property is used to supply a semicolon-separated list of URLs or paths of known Trusted Lists to the struct for chain validation.

A Trusted List is an XML document that contains a government-issued list of CAs that have passed regulated compliance checks. When validating the chain, the struct consults the Trusted List to establish certificate trust, ensuring that the CA is legitimate and entitled to issue certificates of the kind being checked.

The default value is the special %EUTL% macro, which, if applicable, instructs the struct to check the root certificate against up-to-date versions of the primary EU Trusted Lists from the EU LOTL. Custom values can be appended: component.TrustedLists = "%EUTL%;http://my.company/tsl;c:\tsls\mytsl.xml"; NOTE: The struct caches all Trusted Lists it downloads and uses during chain validation. This cache is shared between struct instances within the same process. If this property contains a URL that is also present in the cache, the struct retrieves the cached data and reuses it in the current validation. If the data is invalid, the struct downloads a fresh Trusted List and adds it to the cache.

Data Type

String

trust_sources property (PDFSign Struct)

The trust sources to use during chain validation.

Syntax

fn trust_sources(&self ) -> Result<i32, SecurePDFError> 
fn set_trust_sources(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // Manual
1   // Local
2   // TrustedLists
3   // LocalAndTrustedLists

Default Value

3

Remarks

This property is used to specify the sources the struct uses to establish certificate trust during chain validation.

Establishing trust for a particular certificate, when either signing or verifying, involves building a chain up to a valid trust anchor. This trust anchor is a root certificate that typically resides on the local system. If the certificate does not eventually chain up to a valid trust anchor, the chain is considered untrusted and therefore invalid.

Possible values are:

Data Type

i32

validation_flags property (PDFSign Struct)

Additional chain validation settings.

Syntax

fn validation_flags(&self ) -> Result<i32, SecurePDFError> 
fn set_validation_flags(&self, value : i32) ->  Option<SecurePDFError> 

Default Value

0

Remarks

This property is used to specify additional settings that affect the overall flow of the chain validation.

Its value should be provided as a bitmask of the following flags:

Data Type

i32

validation_policy property (PDFSign Struct)

The level at which to perform chain validation.

Syntax

fn validation_policy(&self ) -> Result<i32, SecurePDFError> 
fn set_validation_policy(&self, value : i32) ->  Option<SecurePDFError> 

Possible Values

0   // None
1   // Full
2   // FullNoTrust
3   // FullNoRevocation
4   // BestEffort

Default Value

1

Remarks

This property is used to specify the overall validation policy the struct follows.

Possible values are:

Validation Policy Heuristics

The choice of validation policy depends on the scenario for which the chain is validated.

Creating a new signature:

• For a basic signature with or without a timestamp, chain validation is not required, so it is recommended to use vpNone. This policy may also be used in test environments or on offline systems.
• For an LTV signature, use vpFull or vpFullNoTrust depending on whether trust checks are necessary in the current environment. If the signature is being created in an environment that does not match the prospective validation environment, consider vpFullNoTrust to validate the chain properly and fully without expecting good trust.

Updating or extending an existing signature:

• When updating a basic signature to LTV, similarly use vpFull or vpFullNoTrust as above.
• When extending an LTV signature, similarly use vpFull or vpFullNoTrust as above.

Validating an existing signature:

• For basic signature validation, use vpFullNoRevocation if trust checks, but not revocation checks, are necessary in the current environment. This policy may also be used on offline systems if the trust anchor is already available to the struct.
• For archival validation, use vpFull to validate the chain properly and fully. This policy expects the trust anchor and all the revocation material to be available.

Data Type

i32

validation_time property (PDFSign Struct)

The time point at which the signature should be validated.

Syntax

fn validation_time(&self ) -> Result<String, SecurePDFError> 
fn set_validation_time(&self, value : &str) ->  Option<SecurePDFError> 
fn set_validation_time_ref(&self, value : &String) ->  Option<SecurePDFError> 

Default Value

""

Remarks

This property is used to specify the moment in time at which the signature validity should be established. The time should be provided in UTC in yyyyMMddHHmmssZ format.

Leave this property empty to stick to the default time point. The struct then prioritizes:

• The signature creation time if the signature contains a signature timestamp (), or
• The local time included in the signature by the signer ().

NOTE: The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times.

Data Type

String

add_attachment method (PDFSign Struct)

Adds an attachment to the document.

Syntax

fn add_attachment(&self, file_name : &str, description : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to add an attachment (embedded file) to the document and to the attachments properties.

file_name and description specify the filename and description of the attachment respectively.

Example: component.InputFile = "input.pdf"; component.OutputFile = "input_with_attachment.pdf"; component.Open(); component.AddAttachment("foo.txt", "desc"); // Alternatively, create a PDFAttachment object and add it to Attachments manually: PDFAttachment attachment = new PDFAttachment(); attachment.FileName = "foo.txt"; // or attachment.DataB = new byte[] { ... }; // or attachment.InputStream = new FileStream(...); attachment.Description = "desc"; component.Attachments.Add(attachment); // Or using one of the constructors: component.Attachments.Add(new PDFAttachment("foo.txt", "desc")); component.Close(); The full list of attachments is contained in the attachments properties.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

add_timestamp method (PDFSign Struct)

Adds a document timestamp to the document.

Syntax

fn add_timestamp(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to obtain a document timestamp and embed it into the document.

A document timestamp is a fully independent signature that is added to the PDF document after the initial signature. Unlike the main signature, the document timestamp is made by a TSA, and its purpose is to preserve the document's long-term validity. Typically, adding a document timestamp is done close to the expiration date of the certificate that produced the last timestamp (which is either embedded in the main signature, or is a previous document timestamp). An LTV document therefore contains a chain of document timestamps updated periodically to keep its long-term status.

Example: pdfsign.InputFile = "signed.pdf"; pdfsign.OutputFile = "signed_with_dts.pdf"; pdfsign.TimestampServer = "http://time.certum.pl"; pdfsign.AddTimestamp(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

close method (PDFSign Struct)

Closes the opened document.

Syntax

fn close(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to close the previously opened document. It should always be preceded by a call to open.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); If any changes are made to the document, they are saved automatically to output_file, output_data, or the stream set in set_output_stream when this method is called. To configure this saving behavior, set SaveChanges.

config method (PDFSign Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecurePDFError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

encrypted method (PDFSign Struct)

Checks whether the document is encrypted.

Syntax

fn encrypted(&self) ->  Result<bool, SecurePDFError>

Remarks

This method is used to determine whether the document is encrypted. It returns false if the document is pseudo-encrypted with an empty password.

Example: component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

get_page_property method (PDFSign Struct)

Returns the value of a page property.

Syntax

fn get_page_property(&self, page_index : i32, page_property : &str) ->  Result<String, SecurePDFError>

Remarks

This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details.

page_index specifies the page to read information about (with a valid range from 0 to page_count - 1), and page_property specifies the page property to read. Possible values are:

Example: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; i < pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); NOTE: Each page property is only populated once the document has been loaded, which is reported by the on_document_info event.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

get_widget_property method (PDFSign Struct)

Returns the value of a signature widget property.

Syntax

fn get_widget_property(&self, signature_index : i32, widget_property : &str) ->  Result<String, SecurePDFError>

Remarks

This method is used to obtain the value of a signature widget property. Together with set_widget_property, this method provides an extensible way of managing the widget settings that are not available through the primary properties of the struct. The list of settings below may be extended in the future.

signature_index is the index of the signature of interest in the signatures collection, and widget_property specifies the widget property to read. Possible values are:

Example: pdfsign.InputFile = "signed.pdf"; pdfsign.Open(); bool invisible = bool.Parse(pdfsign.GetWidgetProperty(0, "Invisible")); pdfsign.Close(); NOTE: Each widget property is only populated after the document has been signed and the signature widget has been generated.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

interrupt method (PDFSign Struct)

Interrupts the current action.

Syntax

fn interrupt(&self) -> Result<(), SecurePDFError>

Remarks

This method interrupts the current action. It can be used, for example, within the on_chain_cert event to abort the chain validation procedure.

If there is no action in progress, this method simply returns, doing nothing.

open method (PDFSign Struct)

Opens the document for processing.

Syntax

fn open(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to open the document specified in input_file, input_data, or set_input_stream before performing some operation on it, such as signing or updating. When finished, call close to complete or discard the operation.

It is recommended to use this method (alongside close) when performing multiple operations on the document at once.

NOTE: This method populates the attachments, document_certs, and signatures collections with any corresponding objects found in the document.

Automatic Decryption Functionality

If this method is called on an encrypted document, the on_password or on_recipient_info event fires (depending on the encryption type) as a notification that the document must be decrypted before processing can continue.

Once the correct decryption material is supplied, the struct then attempts to decrypt the document automatically within this method. When this occurs, the decrypted content is kept in memory so that the document's encrypted status is preserved when it is saved later. Use decrypt to save a decrypted copy of the document instead.

remove_attachment method (PDFSign Struct)

Removes an attachment from the document.

Syntax

fn remove_attachment(&self, index : i32) -> Result<(), SecurePDFError>

Remarks

This method is used to remove an attachment from the document and from the attachments collection.

index is the index of the attachment in the attachments collection to be removed.

Example: pdfsign.InputFile = "input_with_attachment.pdf"; pdfsign.OutputFile = "attachment_removed.pdf"; pdfsign.Open(); pdfsign.RemoveAttachment(0); // Alternatively, remove an attachment from Attachments manually: PDFAttachment attachment = pdfsign.Attachments[0]; pdfsign.Attachments.Remove(attachment); pdfsign.Close(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

reset method (PDFSign Struct)

Resets the struct.

Syntax

fn reset(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to reset the struct's properties and configuration settings to their default values.

save_attachment method (PDFSign Struct)

Saves a PDF attachment to a file.

Syntax

fn save_attachment(&self, index : i32, file_name : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to retrieve the contents of an attachment from the document and save it to a file. It does not modify the contents of the attachments collection.

index is the index of the attachment in the attachments collection to be saved.

file_name specifies the filename that the attachment will be saved to.

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); Example (saving to a stream): component.InputFile = "input_with_attachment.pdf"; component.Attachments[0].OutputStream = myStream; component.SaveAttachment(0, null); // null means use the OutputStream property if it's set NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

set_widget_property method (PDFSign Struct)

Sets the value of a signature widget property.

Syntax

fn set_widget_property(&self, widget_property : &str, value : &str) -> Result<(), SecurePDFError>

Remarks

This method is used to adjust the look of the signature widget when creating a signature. Together with get_widget_property, this method provides an extensible way of managing the widget settings that are not available through the primary properties of the struct. The list of settings below may be extended in the future.

widget_property and value specify the widget property and value to set respectively. Possible values for the former are:

Example: pdfsign.SetWidgetProperty("Width", "100"); pdfsign.SetWidgetProperty("Height", "100"); pdfsign.SetWidgetProperty("ShowDate", "false"); pdfsign.SetWidgetProperty("SignerInfo", "Hello\r\nworld!"); pdfsign.SetWidgetProperty("TitleFontSize", "11"); pdfsign.Sign();

sign method (PDFSign Struct)

Signs the data.

Syntax

fn sign(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to sign the document or its hash. If remote_signature_method is set to rsmNone or rsmDigest, the input data is signed directly with signing_cert. Otherwise, if it is set to rsmPKCS1 or rsmPKCS7, the document is "pre-signed" with the configured signature settings and remote_signature_digest is populated with the data to be signed remotely.

Use the following properties to adjust new signature settings:

• signature_author_name
• signature_claimed_signing_time
• signature_hash_algorithm
• signature_profile
• signature_reason
• signature_type
• signature_widget_height
• signature_widget_offset_x
• signature_widget_offset_y
• signature_widget_pages
• signature_widget_width

Use the following properties to adjust chain validation parameters:

• blocked_certs
• known_certs
• offline_mode
• revocation_check
• trusted_certs
• trusted_lists
• trust_sources
• validation_flags
• validation_policy
• validation_time

During signing, the chain validation log is available via the on_log event if applicable.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

signed method (PDFSign Struct)

Checks whether the document is signed.

Syntax

fn signed(&self) ->  Result<bool, SecurePDFError>

Remarks

This method is used to determine whether the document is signed. It returns false if the document contains only empty signature fields.

Example: pdfsign.InputFile = "input.pdf"; if (!pdfsign.Signed()) { pdfsign.OutputFile = "signed.pdf"; pdfsign.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "cert.pfx", "password", "*"); // Configure signature-related properties as desired pdfsign.Sign(); } NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

update method (PDFSign Struct)

Updates the most recent signature.

Syntax

fn update(&self) -> Result<(), SecurePDFError>

Remarks

This method is used to update the most recent signature by embedding newer or missing revocation information into the signed document.

Updating a signature starts with its cryptographic validation. Before any new validation material is inserted, the signature's integrity must be validated. If the signature is found to be correct, the struct proceeds with chain validation and the retrieval of any missing chain elements. If the signature is cryptographically wrong, the struct throws an exception.

The update approach is typically used to extend the validity of an LTV signature. For LTA signatures, updating is typically accompanied with a document timestamping operation. Set timestamp_server to have the struct obtain and embed a document timestamp automatically.

Further validation material and document timestamps may be added to a document over time to maintain its authenticity and integrity.

Use the following properties to adjust chain validation parameters:

• blocked_certs
• known_certs
• offline_mode
• revocation_check
• trusted_certs
• trusted_lists
• trust_sources
• validation_flags
• validation_policy
• validation_time

NOTE: To choose a different signature to update, set UpdateIndex.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

on_chain_cert event (PDFSign Struct)

Fired when the struct encounters a chain certificate.

Syntax

// PDFSignChainCertEventArgs carries the PDFSign ChainCert event's parameters.
pub struct PDFSignChainCertEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn validation_time(&self) -> &String
  fn validation_result(&self) -> i32
  fn set_validation_result(&self, value : i32)
  fn validation_details(&self) -> i32
  fn set_validation_details(&self, value : i32)
}

// PDFSignChainCertEvent defines the signature of the PDFSign ChainCert event's handler function.
pub trait PDFSignChainCertEvent {
  fn on_chain_cert(&self, sender : PDFSign, e : &mut PDFSignChainCertEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_chain_cert(&self) -> &'a dyn PDFSignChainCertEvent;
  pub fn set_on_chain_cert(&mut self, value : &'a dyn PDFSignChainCertEvent);
  ...
}

Remarks

This event is fired once for each certificate encountered during chain validation to report that it is about to be processed. The struct tries to retrieve all required chain certificates automatically.

cert_encoded specifies the PEM (Base64-encoded) public certificate.

cert_subject and cert_issuer specify the distinguished names of the certificate owner and issuer respectively.

validation_time specifies the time point (in UTC) at which the certificate validity was established.

validation_result reports the outcome of the individual certificate validation and can be one of the following values:

In the case of a failure, validation_details provides more details on its reasons. Its value is a bitmask of the following flags:

Overridable Chain Validation

While the struct follows the validation rules defined by the X.509 standard to the best of its ability, minor technical issues may arise when validating the chain. The validation_result and validation_details parameters can be overridden to relax such requirements on a per-certificate basis.

For example, set validation_result to cvrValid and validation_details to 0 in order to:

• Ignore CA or TLS key usage requirements
• Ignore the AuthorityKeyId extension in certificate-issuing CAs (helps with incorrectly renewed certificates)
• Ignore the Basic Constraints or Name Constraints extensions of CA certificates
• Tolerate some weaker algorithms
• Implicitly trust self-signed certificates
• Skip validity period checks for trusted certificates (helps with older devices that have expired root certificates)
• Ignore chain loops (helps with buggy CAs that include subchains that sign themselves)

Based on the adjusted validity of the certificate that is currently being processed, the struct continues or aborts the chain validation procedure accordingly as if it had arrived at the chosen validation result itself.

NOTE: The user code is ultimately responsible for certificate validity decisions made via these two parameters. If their values are modified within this event, the resulting chain validation procedure may deviate from the standard.

on_document_info event (PDFSign Struct)

Fired when the document has been loaded into memory.

Syntax

// PDFSignDocumentInfoEventArgs carries the PDFSign DocumentInfo event's parameters.
pub struct PDFSignDocumentInfoEventArgs {
  fn page_count(&self) -> i32
  fn signature_count(&self) -> i32
}

// PDFSignDocumentInfoEvent defines the signature of the PDFSign DocumentInfo event's handler function.
pub trait PDFSignDocumentInfoEvent {
  fn on_document_info(&self, sender : PDFSign, e : &mut PDFSignDocumentInfoEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_document_info(&self) -> &'a dyn PDFSignDocumentInfoEvent;
  pub fn set_on_document_info(&mut self, value : &'a dyn PDFSignDocumentInfoEvent);
  ...
}

Remarks

This event is fired once per document processing routine to report that the document has been processed and loaded into memory.

The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details. These may be useful when preparing the signature. For example, get_page_property can be used to find the optimal position for the signature widget.

page_count reports the number of pages in the document.

signature_count reports the number of signatures in the document.

This event is fired when open is called, but only after on_password or on_recipient_info is fired (if applicable) and the document has been decrypted.

on_error event (PDFSign Struct)

Fired when information is available about errors during data delivery.

Syntax

// PDFSignErrorEventArgs carries the PDFSign Error event's parameters.
pub struct PDFSignErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PDFSignErrorEvent defines the signature of the PDFSign Error event's handler function.
pub trait PDFSignErrorEvent {
  fn on_error(&self, sender : PDFSign, e : &mut PDFSignErrorEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_error(&self) -> &'a dyn PDFSignErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PDFSignErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_log event (PDFSign Struct)

Fired once for each log message.

Syntax

// PDFSignLogEventArgs carries the PDFSign Log event's parameters.
pub struct PDFSignLogEventArgs {
  fn log_level(&self) -> i32
  fn message(&self) -> &String
  fn log_type(&self) -> &String
}

// PDFSignLogEvent defines the signature of the PDFSign Log event's handler function.
pub trait PDFSignLogEvent {
  fn on_log(&self, sender : PDFSign, e : &mut PDFSignLogEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_log(&self) -> &'a dyn PDFSignLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn PDFSignLogEvent);
  ...
}

Remarks

This event is fired once for each log message generated by the struct. The verbosity is controlled by the LogLevel configuration setting.

log_level indicates the detail level of the message. Possible values are:

message is the log message.

log_type identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

on_password event (PDFSign Struct)

Fired when the struct detects that the document is encrypted with a password.

Syntax

// PDFSignPasswordEventArgs carries the PDFSign Password event's parameters.
pub struct PDFSignPasswordEventArgs {
  fn available(&self) -> bool
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFSignPasswordEvent defines the signature of the PDFSign Password event's handler function.
pub trait PDFSignPasswordEvent {
  fn on_password(&self, sender : PDFSign, e : &mut PDFSignPasswordEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_password(&self) -> &'a dyn PDFSignPasswordEvent;
  pub fn set_on_password(&mut self, value : &'a dyn PDFSignPasswordEvent);
  ...
}

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to password.

available indicates whether the decryption password is already available to the struct or still needs to be set. If this parameter is false, the correct password must be provided for the decryption attempt to succeed.

cancel determines whether the struct will stop firing this event to request a password.

on_recipient_info event (PDFSign Struct)

Fired for each recipient certificate of the encrypted document.

Syntax

// PDFSignRecipientInfoEventArgs carries the PDFSign RecipientInfo event's parameters.
pub struct PDFSignRecipientInfoEventArgs {
  fn issuer(&self) -> &String
  fn serial_number(&self) -> &String
  fn subject_key_identifier(&self) -> &String
  fn available(&self) -> bool
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFSignRecipientInfoEvent defines the signature of the PDFSign RecipientInfo event's handler function.
pub trait PDFSignRecipientInfoEvent {
  fn on_recipient_info(&self, sender : PDFSign, e : &mut PDFSignRecipientInfoEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_recipient_info(&self) -> &'a dyn PDFSignRecipientInfoEvent;
  pub fn set_on_recipient_info(&mut self, value : &'a dyn PDFSignRecipientInfoEvent);
  ...
}

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to decryption_cert.

issuer specifies the subject of the issuer certificate.

serial_number specifies the serial number of the encryption certificate.

subject_key_identifier specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

available indicates whether the decryption certificate is already available to the struct or still needs to be set. If this parameter is false, the correct certificate must be provided for the decryption attempt to succeed.

cancel determines whether the struct will stop firing this event to request a certificate.

NOTE: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate causes its own invocation of this event.

on_signature_info event (PDFSign Struct)

Fired when the struct finds a signature in the document.

Syntax

// PDFSignSignatureInfoEventArgs carries the PDFSign SignatureInfo event's parameters.
pub struct PDFSignSignatureInfoEventArgs {
  fn signature_index(&self) -> i32
  fn validate_signature(&self) -> bool
  fn set_validate_signature(&self, value : bool)
  fn validate_chain(&self) -> bool
  fn set_validate_chain(&self, value : bool)
}

// PDFSignSignatureInfoEvent defines the signature of the PDFSign SignatureInfo event's handler function.
pub trait PDFSignSignatureInfoEvent {
  fn on_signature_info(&self, sender : PDFSign, e : &mut PDFSignSignatureInfoEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_signature_info(&self) -> &'a dyn PDFSignSignatureInfoEvent;
  pub fn set_on_signature_info(&mut self, value : &'a dyn PDFSignSignatureInfoEvent);
  ...
}

Remarks

This event is fired once for each signature found in the document to report that it is about to be validated.

signature_index is the index of the signature in the signatures collection.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. validate_signature and validate_chain determine whether each stage should be included in the validation. They can be overridden to modify the validation policy on a per-signature basis, allowing signatures to be verified individually instead of all at once (via verify). To skip validation entirely, set both parameters to false.

Use the following properties to adjust chain validation parameters:

• blocked_certs
• known_certs
• offline_mode
• revocation_check
• trusted_certs
• trusted_lists
• trust_sources
• validation_flags
• validation_policy
• validation_time

on_signature_processed event (PDFSign Struct)

Fired after a signature has been processed.

Syntax

// PDFSignSignatureProcessedEventArgs carries the PDFSign SignatureProcessed event's parameters.
pub struct PDFSignSignatureProcessedEventArgs {
  fn signature_index(&self) -> i32
  fn signature_validation_result(&self) -> i32
  fn chain_validation_result(&self) -> i32
  fn chain_validation_details(&self) -> i32
}

// PDFSignSignatureProcessedEvent defines the signature of the PDFSign SignatureProcessed event's handler function.
pub trait PDFSignSignatureProcessedEvent {
  fn on_signature_processed(&self, sender : PDFSign, e : &mut PDFSignSignatureProcessedEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_signature_processed(&self) -> &'a dyn PDFSignSignatureProcessedEvent;
  pub fn set_on_signature_processed(&mut self, value : &'a dyn PDFSignSignatureProcessedEvent);
  ...
}

Remarks

This event is fired once for each signature found in the document to report that it has completed validation. It is fired after on_signature_info if that event's validate_signature parameter is set to true.

signature_index is the index of the signature in the signatures collection.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in signature_validation_result and chain_validation_result.

The former reports the validity of the signature and can be one of the following values:

The latter reports the validity of the chain and can be one of the following values:

In the case of a failure, chain_validation_details provides more details on its reasons. Its value is a bitmask of the following flags:

NOTE: signature_validation_result, chain_validation_result, and chain_validation_details are also available as properties in the PDFSignature type.

on_ssl_server_authentication event (PDFSign Struct)

Fired after the server presents its certificate to the client.

Syntax

// PDFSignSSLServerAuthenticationEventArgs carries the PDFSign SSLServerAuthentication event's parameters.
pub struct PDFSignSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// PDFSignSSLServerAuthenticationEvent defines the signature of the PDFSign SSLServerAuthentication event's handler function.
pub trait PDFSignSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : PDFSign, e : &mut PDFSignSSLServerAuthenticationEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn PDFSignSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn PDFSignSSLServerAuthenticationEvent);
  ...
}

Remarks

This event is fired during timestamping or chain validation after the server presents its SSL/TLS certificate to the struct. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

During this event, the client can decide whether to continue with the connection process. accept is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue.

When accept is false, status shows why the verification failed (otherwise, status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting accept to true.

on_ssl_status event (PDFSign Struct)

Fired when secure connection progress messages are available.

Syntax

// PDFSignSSLStatusEventArgs carries the PDFSign SSLStatus event's parameters.
pub struct PDFSignSSLStatusEventArgs {
  fn message(&self) -> &String
}

// PDFSignSSLStatusEvent defines the signature of the PDFSign SSLStatus event's handler function.
pub trait PDFSignSSLStatusEvent {
  fn on_ssl_status(&self, sender : PDFSign, e : &mut PDFSignSSLStatusEventArgs);
}

impl <'a> PDFSign<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn PDFSignSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn PDFSignSSLStatusEvent);
  ...
}

Remarks

This event is fired during timestamping or chain validation for informational and logging purposes only. This event tracks the progress of the SSL/TLS connection. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

Config Settings (PDFSign Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

PDFSign Config Settings

Base Config Settings

Trappable Errors (PDFSign Struct)

PDFSign Errors

PDF Errors

Parsing Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors