Struct secureblackbox::PDFSigner

Properties   Methods   Events   Config Settings   Errors  

The PDFSigner struct signs PDF documents digitally.

Syntax

secureblackbox::PDFSigner

Remarks

PDFSigner can sign PDF documents in accordance with a selection of PDF and PAdES signature standards. PDFSigner signer = new PDFSigner(); // Set the PDF document that you want to sign signer.setInputFile("MyDocument.pdf"); // Set the path where you want the signed document to be saved signer.setOutputFile("Signed.pdf"); // The certificate which the document will be signed with signer.setSigningCertificate(new Certificate("Cert.pfx","password")); // The signature level signer.getNewSignature().setLevel(PDFSignature.paslBaselineT); signer.getNewSignature().setHashAlgorithm("SHA512"); // Hashing algorithm used for signing, default SHA256 signer.setTimestampServer("https://..."); // The address of the timestamping server signer.sign();

Standards and technologies supported

PDFSigner can create PDF signatures that match the following baseline standards:

• Generic PDF signatures (ISO 32000)
• PAdES: all profiles are supported (BES, EPES, T, LTV, B-B, B-T, and others) (ETSI EN 319 142-1 and others)
• Signature and document timestamps using external TSAs.
• All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others).

Configuring the signature spec

Configuring PDFSigner to produce signatures of the right type is one of the most important questions you need to address. Normally the service or software you will be communicating your PDF documents to will provide you with the list of requirements that your signatures should match.

Typically, those will dictate the following key aspects of the signatures:

• Level (BES, T, or LTV). This can be adjusted with the property (Note: when creating EPES signatures you need to provide the signature and properties).
• Timestamp requirement: provide the address of your online TSA service via the timestamp_server property.
• When creating LTV signatures, tune up validation parameters via the revocation_check, offline_mode, and ignore_chain_validation_errors properties.
• To create a document timestamp, sign your document first, and then sign the result again with set to pslDocumentTimestamp and timestamp_server pointing to the TSA URL.

Signing certificates

PDFSigner can use certificates residing on different media. Besides generic certificates stored in PFX or PEM files (A1), it can operate with non-exportable certificates residing on hardware media (A3) or in the cloud.

Non-exportable certificates can be accessed transparently via a Windows CSP or a PKCS#11 driver, if supplied by the certificate issuer. Proprietary interfaces can be plugged in with the external signing feature (see below).

You can use the CertificateManager and CertificateStorage structs to load the signing certificate. Assign the certificate to the signing_certificate property, and optionally provide the remainder of its chain via the signing_chain property.

Note: If signing with a non-exportable key (such as residing on a hardware device or in the cloud), please make sure you keep the original CertificateStorage object open until the signing is completed. This is because the storage struct provides a 'bridge' to the private key. If the storage is closed prematurely, this bridge is destroyed, and the private key can't be used.

You don't need to provide a signing certificate or chain when creating document timestamp signatures, since this type of signature is done with a TSA's certificate.

Widget adjustment

PDFSigner provides means to customize the look of the signature widget to be shown on the document page. Create your very own signatures in the form of your company's logo, a handwritten signature, or a wet seal.

Alternatively, you can choose not to associate any widget with your signature by setting to true.

Please check out this self-describing PDF document for good guidance on widget positioning, background styles, and text formatting.

Signing the document

Now that you have set up all signature, certificate, and widget properties, it is time to sign. You can provide the input document in one of the following forms: as a file (assign the path to the input_file property), as a stream (assign to the input_stream property), or as a byte array (assign to input_bytes). Similarly, the output can be collected in one of the same forms, either by passing the destination path or stream via output_file and output_stream respectively, or by reading the resulting document bytes from the output_bytes property after the signing.

Having set up the input and output, call the struct's sign method. This will initiate the signing process. Depending on the settings, the signing may be as straightforward as calculating the document hash and signing it with the private key (e.g. in the PAdES-BES signing variant), or it may involve advanced chain validation routines (PAdES-LTV). During the latter, the struct may contact a number of external revocation information sources (CRL and OCSP servers) to establish the validity of the signing certificate.

If a TSA server was provided via the timestamp_server property, the struct will contact it too to timestamp the new signature.

During the signing, PDFSigner may fire events to let your code know of certain conditions. If the input document is encrypted but no decryption parameters were found in the password and decryption_certificate properties, the struct will fire the on_encrypted event to tell your code that it needs decryption information to be able to continue with the signing. It may fire on_tls_cert_validate if one of the HTTP endpoints involved during the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate to be validated.

External signing and DCAuth

PDFSigner, like many other structs offered by the product, supports two methods of signing with external keys. These methods are fully independent of each other: you can choose the one that suits your usage scenario best.

Synchronous method: ExternalSign

This is a simpler method that basically lets you infiltrate into the heart of the signing routine by taking care of the hash signing operation. The struct does the rest of the job (hash calculation, preparation of signature objects, CRL/OCSP retrieval).

To initiate this method, call sign_external instead of sign. When the hash is ready, it will be passed back to your code with the on_external_sign event. Your event handler needs to sign the hash with the private key and return the created signature back to the struct - which will embed it into the document.

You don't need your signing certificate to contain an associated private key when using this method. The certificate itself (its public copy) may be needed though, as it is often included in the hash calculation.

This method is synchronous, meaning sign_external provides you the results immediately upon its completion.

Asynchronous method: DCAuth

DCAuth is a SecureBlackbox know-how technology. This protocol was designed to allow sharing of private keys across environments, allowing the signer and the private key to reside on different systems. It works in the following way:

• The signing party - such as PDFSigner - initiates the operation using a sign_async_begin call. This produces two outcomes: a pre-signed document (a document with a blank signature placeholder), and a request state (an object containing a hash that needs to be signed). At this point the PDFSigner instance can be released, and the process itself terminated (which may be useful when run as part of a web page).
• The request state is passed to the private key holder party. The private key holder passes the request state to a DCAuth object, which parses the request state, extracts the hash, and signs it. The output of DCAuth processing is another object, a response state, which contains the signature. The private key holder then sends the response state back to the signing party.
• The signing party re-creates the structs and passes the response state, together with the pre-signed version of the document, to the signer's sign_async_end method. sign_async_end extracts the signature from the response state and incorporates it into the pre-signed document.

This method is asynchronous in that sense that from the signing party's viewpoint, it splits the signing operation into the pre-signing and completion stages which can be performed independently from each other and in different execution contexts. This makes this method particularly helpful for use in web pages and other scenarios where the signing key is not available in real time.

Fine-grained chain validation setup

Chain validation is a sophisticated, multi-faceted 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 tune up your chain validation parameters so they fit them best. A summary of such parameters is given below.

• revocation_check lets you choose between and/or prioritize revocation origins. OCSP sources are often preferred to CRL because of their real-time capability and the smaller size of validation tokens they produce.
• offline_mode is a master switch that stops the struct from looking for any validation tokens online. If this property is switched on, the struct will only use the known_certificates, trusted_certificates, known_crls, and known_ocsps collections to look for the missing validation material.
• ignore_chain_validation_errors makes the struct ignore any major validation issues it encounters (such us an untrusted chain or missing CRL). This option is handy for debugging and for creating signatures in the environments where the signing certificate is not trusted.
• known_certificates, known_crls, and known_ocsps let you provide your own validation material. This may be useful when working in offline_mode, where the signer has no access to the validation sources, or where the validation material has already been collected.
• trusted_certificates lets you provide a list of trust anchors, either as a complement to the system's or as an alternative to it.
• blocked_certificates lets you provide a list of blocked/distrusted certificates. Any CA certificate contained in it will be deemed untrusted/invalid.

The following parameters are not directly related to chain validation, but may have an implicit effect on it.

• proxy, socket_settings, and tls_settings let you tune up the connectivity and TLS options in accordance with local preferences.
• tls_client_chain lets you provide the client certificate and its chain for TLS client authentication.
• Subscribe to on_tls_cert_validate to validate any TLS certificates of the services involved in chain validation.

The results of the chain validation procedure, upon its completion, are published in the following properties:

• chain_validation_result contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined.
• chain_validation_details provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate.
• validation_log contains the detailed chain validation log. The log can often be very helpful in nailing down various validation issues.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the PDFSigner struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of PDFSigner 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.

attached_file_count property (PDFSigner Struct)

The number of records in the AttachedFiles arrays.

Syntax

fn attached_file_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• attached_files_content_subtype
• attached_files_content_type
• attached_files_creation_date
• attached_files_data
• attached_files_description
• attached_files_file_name
• attached_files_handle
• attached_files_id
• attached_files_modification_date
• attached_files_read_date
• attached_files_size

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

This property is read-only.

Data Type

i32

attached_files_content_subtype property (PDFSigner Struct)

Contains the content subtype of the attachment.

Syntax

fn attached_files_content_subtype(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the content subtype of the attachment.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

String

attached_files_content_type property (PDFSigner Struct)

Contains the content type of the attachment.

Syntax

fn attached_files_content_type(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the content type of the attachment.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

String

attached_files_creation_date property (PDFSigner Struct)

The creation date.

Syntax

fn attached_files_creation_date(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The creation date.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

String

attached_files_data property (PDFSigner Struct)

The content of the attachment.

Syntax

fn attached_files_data(&self , AttachedFileIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The content of the attachment.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

Vec

attached_files_description property (PDFSigner Struct)

Textual description of the attachment.

Syntax

fn attached_files_description(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Textual description of the attachment.

This property maps to the Content-Description e-mail header field. Although the field is optional, the ability to associate descriptive information with a given body is often desirable. One example is specifying the title of an image using this property.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

String

attached_files_file_name property (PDFSigner Struct)

Specifies the name of the attachment file.

Syntax

fn attached_files_file_name(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the name of the attachment file.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

String

attached_files_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn attached_files_handle(&self , AttachedFileIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

i64

attached_files_id property (PDFSigner Struct)

Contains the attachment's unique identifier.

Syntax

fn attached_files_id(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the attachment's unique identifier.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

String

attached_files_modification_date property (PDFSigner Struct)

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

Syntax

fn attached_files_modification_date(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

String

attached_files_read_date property (PDFSigner Struct)

Specifies the file's last read date.

Syntax

fn attached_files_read_date(&self , AttachedFileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the file's last read date.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

String

attached_files_size property (PDFSigner Struct)

The attachment's size in bytes.

Syntax

fn attached_files_size(&self , AttachedFileIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The attachment's size in bytes.

The AttachedFileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachedFileCount property.

This property is read-only.

Data Type

i64

auto_validate_signatures property (PDFSigner Struct)

Specifies whether PDFSigner should validate any present signatures when the document is opened.

Syntax

fn auto_validate_signatures(&self ) -> Result<bool, SecureBlackboxError> 
fn set_auto_validate_signatures(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This setting is switched off by default to speed up document processing. Even if the document is loaded with this property set to false, you can validate the signatures manually on a later stage using the revalidate method.

Data Type

bool

blocked_cert_count property (PDFSigner Struct)

The number of records in the BlockedCert arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• blocked_cert_bytes
• blocked_cert_handle

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

Data Type

i32

blocked_cert_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn blocked_cert_bytes(&self , BlockedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

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

Vec

blocked_cert_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn blocked_cert_handle(&self , BlockedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_blocked_cert_handle(&self, BlockedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

i64

cert_count property (PDFSigner Struct)

The number of records in the Cert arrays.

Syntax

fn cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• cert_bytes
• cert_ca
• cert_ca_key_id
• cert_crl_distribution_points
• cert_curve
• cert_fingerprint
• cert_friendly_name
• cert_handle
• cert_hash_algorithm
• cert_issuer
• cert_issuer_rdn
• cert_key_algorithm
• cert_key_bits
• cert_key_fingerprint
• cert_key_usage
• cert_key_valid
• cert_ocsp_locations
• cert_ocsp_no_check
• cert_origin
• cert_policy_i_ds
• cert_private_key_bytes
• cert_private_key_exists
• cert_private_key_extractable
• cert_public_key_bytes
• cert_qualified
• cert_qualified_statements
• cert_qualifiers
• cert_self_signed
• cert_serial_number
• cert_sig_algorithm
• cert_source
• cert_subject
• cert_subject_alternative_name
• cert_subject_key_id
• cert_subject_rdn
• cert_type
• cert_valid
• cert_valid_from
• cert_valid_to

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

This property is read-only.

Data Type

i32

cert_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn cert_bytes(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

Vec

cert_ca property (PDFSigner Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn cert_ca(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

cert_ca_key_id property (PDFSigner Struct)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

fn cert_ca_key_id(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

Vec

cert_type property (PDFSigner Struct)

Returns the type of the entity contained in the Certificate object.

Syntax

fn cert_type(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

Default Value

0

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager struct to load or create new certificate and certificate requests objects.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

i32

cert_crl_distribution_points property (PDFSigner Struct)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

fn cert_crl_distribution_points(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_curve property (PDFSigner Struct)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

fn cert_curve(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_fingerprint property (PDFSigner Struct)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

fn cert_fingerprint(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_friendly_name property (PDFSigner Struct)

Contains an associated alias (friendly name) of the certificate.

Syntax

fn cert_friendly_name(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn cert_handle(&self , CertIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

i64

cert_hash_algorithm property (PDFSigner Struct)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

fn cert_hash_algorithm(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_issuer property (PDFSigner Struct)

The common name of the certificate issuer (CA), typically a company name.

Syntax

fn cert_issuer(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via cert_issuer_rdn.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_issuer_rdn property (PDFSigner Struct)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

fn cert_issuer_rdn(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_key_algorithm property (PDFSigner Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn cert_key_algorithm(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the cert_key_bits, cert_curve, and cert_public_key_bytes properties to get more details about the key the certificate contains.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_key_bits property (PDFSigner Struct)

Returns the length of the public key in bits.

Syntax

fn cert_key_bits(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the cert_public_key_bytes or cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

i32

cert_key_fingerprint property (PDFSigner Struct)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

fn cert_key_fingerprint(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Returns a SHA1 fingerprint of the public key contained in the certificate.

Note that the key fingerprint is different from the certificate fingerprint accessible via the cert_fingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_key_usage property (PDFSigner Struct)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

fn cert_key_usage(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

i32

cert_key_valid property (PDFSigner Struct)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

fn cert_key_valid(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

cert_ocsp_locations property (PDFSigner Struct)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

fn cert_ocsp_locations(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_ocsp_no_check property (PDFSigner Struct)

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

fn cert_ocsp_no_check(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

cert_origin property (PDFSigner Struct)

Returns the location that the certificate was taken or loaded from.

Syntax

fn cert_origin(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

i32

cert_policy_i_ds property (PDFSigner Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn cert_policy_i_ds(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_private_key_bytes property (PDFSigner Struct)

Returns the certificate's private key in DER-encoded format.

Syntax

fn cert_private_key_bytes(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

Vec

cert_private_key_exists property (PDFSigner Struct)

Indicates whether the certificate has a usable private key associated with it.

Syntax

fn cert_private_key_exists(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from cert_private_key_bytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

cert_private_key_extractable property (PDFSigner Struct)

Indicates whether the private key is extractable (exportable).

Syntax

fn cert_private_key_extractable(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

cert_public_key_bytes property (PDFSigner Struct)

Contains the certificate's public key in DER format.

Syntax

fn cert_public_key_bytes(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

Vec

cert_qualified property (PDFSigner Struct)

Indicates whether the certificate is qualified.

Syntax

fn cert_qualified(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

cert_qualified_statements property (PDFSigner Struct)

Returns a simplified qualified status of the certificate.

Syntax

fn cert_qualified_statements(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

i32

cert_qualifiers property (PDFSigner Struct)

A list of qualifiers.

Syntax

fn cert_qualifiers(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_self_signed property (PDFSigner Struct)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

fn cert_self_signed(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

cert_serial_number property (PDFSigner Struct)

Returns the certificate's serial number.

Syntax

fn cert_serial_number(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

Vec

cert_sig_algorithm property (PDFSigner Struct)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

fn cert_sig_algorithm(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_source property (PDFSigner Struct)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

fn cert_source(&self , CertIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

i32

cert_subject property (PDFSigner Struct)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

fn cert_subject(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via cert_subject_rdn.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_subject_alternative_name property (PDFSigner Struct)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

fn cert_subject_alternative_name(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Subject alternative names are used to provide additional names that are impractical to store in the main cert_subject_rdn field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_subject_key_id property (PDFSigner Struct)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

fn cert_subject_key_id(&self , CertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The cert_subject_key_id and cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

Vec

cert_subject_rdn property (PDFSigner Struct)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

fn cert_subject_rdn(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_valid property (PDFSigner Struct)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

fn cert_valid(&self , CertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

bool

cert_valid_from property (PDFSigner Struct)

The time point at which the certificate becomes valid, in UTC.

Syntax

fn cert_valid_from(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

cert_valid_to property (PDFSigner Struct)

The time point at which the certificate expires, in UTC.

Syntax

fn cert_valid_to(&self , CertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The CertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CertCount property.

This property is read-only.

Data Type

String

check_trusted_lists property (PDFSigner Struct)

Specifies whether the struct should attempt to validate chain trust via a known Trusted List.

Syntax

fn check_trusted_lists(&self ) -> Result<bool, SecureBlackboxError> 
fn set_check_trusted_lists(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

Data Type

bool

crl_count property (PDFSigner Struct)

The number of records in the CRL arrays.

Syntax

fn crl_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• crl_bytes
• crlca_key_id
• crl_entry_count
• crl_handle
• crl_issuer
• crl_issuer_rdn
• crl_location
• crl_next_update
• crl_sig_algorithm
• crl_source
• crltbs
• crl_this_update

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

This property is read-only.

Data Type

i32

crl_bytes property (PDFSigner Struct)

Returns the raw CRL data in DER format.

Syntax

fn crl_bytes(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw CRL data in DER format.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

Vec

crlca_key_id property (PDFSigner Struct)

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

Syntax

fn crlca_key_id(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

Vec

crl_entry_count property (PDFSigner Struct)

Returns the number of certificate status entries in the CRL.

Syntax

fn crl_entry_count(&self , CRLIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the number of certificate status entries in the CRL.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

i32

crl_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn crl_handle(&self , CRLIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

i64

crl_issuer property (PDFSigner Struct)

The common name of the CRL issuer (CA), typically a company name.

Syntax

fn crl_issuer(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the CRL issuer (CA), typically a company name.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

String

crl_issuer_rdn property (PDFSigner Struct)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

Syntax

fn crl_issuer_rdn(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

String

crl_location property (PDFSigner Struct)

The URL that the CRL was downloaded from.

Syntax

fn crl_location(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The URL that the CRL was downloaded from.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

String

crl_next_update property (PDFSigner Struct)

The planned time and date of the next version of this CRL to be published.

Syntax

fn crl_next_update(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The planned time and date of the next version of this CRL to be published.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

String

crl_sig_algorithm property (PDFSigner Struct)

The public key algorithm that was used by the CA to sign this CRL.

Syntax

fn crl_sig_algorithm(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

The public key algorithm that was used by the CA to sign this CRL.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

String

crl_source property (PDFSigner Struct)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

fn crl_source(&self , CRLIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

i32

crltbs property (PDFSigner Struct)

The to-be-signed part of the CRL (the CRL without the signature part).

Syntax

fn crltbs(&self , CRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The to-be-signed part of the CRL (the CRL without the signature part).

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

Vec

crl_this_update property (PDFSigner Struct)

The date and time at which this version of the CRL was published.

Syntax

fn crl_this_update(&self , CRLIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The date and time at which this version of the CRL was published.

The CRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CRLCount property.

This property is read-only.

Data Type

String

decryption_certificate_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn decryption_certificate_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

decryption_certificate_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn decryption_certificate_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_decryption_certificate_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

document_info_encryption_algorithm property (PDFSigner Struct)

The symmetric algorithm used to encrypt the document.

Syntax

fn document_info_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The symmetric algorithm used to encrypt the document.

This property contains the encryption algorithm that was used to encrypt the PDF document.

Supported values:

This property is read-only.

Data Type

String

document_info_encryption_type property (PDFSigner Struct)

The document encryption type.

Syntax

fn document_info_encryption_type(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // None
1   // Password
2   // Certificate

Default Value

1

Remarks

The document encryption type.

This property indicates the kind of encryption that was used to encrypt the PDF document.

Supported values:

This property is read-only.

Data Type

i32

document_info_metadata_encrypted property (PDFSigner Struct)

Indicates if the document metadata is encrypted.

Syntax

fn document_info_metadata_encrypted(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

true

Remarks

Indicates if the document metadata is encrypted.

Use this property to check if the document metadata is encrypted.

Metadata contains additional information about the document such as its name and author.

This property is read-only.

Data Type

bool

document_info_permissions property (PDFSigner Struct)

Contains the document permissions associated with the encryption.

Syntax

fn document_info_permissions(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Contains the document permissions associated with the encryption.

Use this property to check the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:

This property is read-only.

Data Type

i32

empty_field_index property (PDFSigner Struct)

Specifies the index of the empty signature field to sign.

Syntax

fn empty_field_index(&self ) -> Result<i32, SecureBlackboxError> 
fn set_empty_field_index(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

-1

Remarks

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

NOTE: To read info about empty signature fields, use EmptySignatureFieldCount and other EmptySignatureFields* configuration settings.

Data Type

i32

external_crypto_async_document_id property (PDFSigner Struct)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

fn external_crypto_async_document_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_async_document_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_async_document_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

external_crypto_custom_params property (PDFSigner Struct)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

fn external_crypto_custom_params(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_custom_params(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_custom_params_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

Data Type

String

external_crypto_data property (PDFSigner Struct)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

fn external_crypto_data(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_data(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_data_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

Data Type

String

external_crypto_external_hash_calculation property (PDFSigner Struct)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

fn external_crypto_external_hash_calculation(&self ) -> Result<bool, SecureBlackboxError> 
fn set_external_crypto_external_hash_calculation(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth struct.

If set to true, the struct will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

bool

external_crypto_hash_algorithm property (PDFSigner Struct)

Specifies the request's signature hash algorithm.

Syntax

fn external_crypto_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

external_crypto_key_id property (PDFSigner Struct)

The ID of the pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use external_crypto_key_secret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

external_crypto_key_secret property (PDFSigner Struct)

The pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_secret(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_secret(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_secret_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the external_crypto_key_id topic.

Data Type

String

external_crypto_method property (PDFSigner Struct)

Specifies the asynchronous signing method.

Syntax

fn external_crypto_method(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_method(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

0

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

i32

external_crypto_mode property (PDFSigner Struct)

Specifies the external cryptography mode.

Syntax

fn external_crypto_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

Data Type

i32

external_crypto_public_key_algorithm property (PDFSigner Struct)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

fn external_crypto_public_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

fips_mode property (PDFSigner Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

ignore_chain_validation_errors property (PDFSigner Struct)

Makes the struct tolerant to chain validation errors.

Syntax

fn ignore_chain_validation_errors(&self ) -> Result<bool, SecureBlackboxError> 
fn set_ignore_chain_validation_errors(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain.

Data Type

bool

input_bytes property (PDFSigner Struct)

Use this property to pass the input to struct in byte array form.

Syntax

fn input_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_input_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_input_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Assign a byte array containing the data to be processed to this property.

Data Type

Vec

input_file property (PDFSigner Struct)

The PDF file to be signed or updated.

Syntax

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

Default Value

""

Remarks

Use this property to provide a path to the PDF document to be signed or updated, or to the pre-signed copy expected by sign_async_end.

Data Type

String

known_cert_count property (PDFSigner Struct)

The number of records in the KnownCert arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_cert_bytes
• known_cert_handle

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

Data Type

i32

known_cert_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn known_cert_bytes(&self , KnownCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

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

Vec

known_cert_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn known_cert_handle(&self , KnownCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_cert_handle(&self, KnownCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

i64

known_crl_count property (PDFSigner Struct)

The number of records in the KnownCRL arrays.

Syntax

fn known_crl_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_crl_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_crl_bytes
• known_crl_handle

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

Data Type

i32

known_crl_bytes property (PDFSigner Struct)

Returns the raw CRL data in DER format.

Syntax

fn known_crl_bytes(&self , KnownCRLIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is read-only.

Data Type

Vec

known_crl_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn known_crl_handle(&self , KnownCRLIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_crl_handle(&self, KnownCRLIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

Data Type

i64

known_ocsp_count property (PDFSigner Struct)

The number of records in the KnownOCSP arrays.

Syntax

fn known_ocsp_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_known_ocsp_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• known_ocsp_bytes
• known_ocsp_handle

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

Data Type

i32

known_ocsp_bytes property (PDFSigner Struct)

A buffer containing the raw OCSP response data.

Syntax

fn known_ocsp_bytes(&self , KnownOCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is read-only.

Data Type

Vec

known_ocsp_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn known_ocsp_handle(&self , KnownOCSPIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_known_ocsp_handle(&self, KnownOCSPIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

Data Type

i64

new_sig_allowed_changes property (PDFSigner Struct)

The changes to the document allowed by the signature.

Syntax

fn new_sig_allowed_changes(&self ) -> Result<i32, SecureBlackboxError> 
fn set_new_sig_allowed_changes(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // FillInForms
2   // Comment
3   // All

Default Value

0

Remarks

The changes to the document allowed by the signature.

This property is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).

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

Data Type

i32

new_sig_author_name property (PDFSigner Struct)

A human-readable signer name.

Syntax

fn new_sig_author_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_author_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_author_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A human-readable signer name. This is a PDF document property.

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

Data Type

String

new_sig_certification property (PDFSigner Struct)

Specifies whether this is a Certification (MDP) signature.

Syntax

fn new_sig_certification(&self ) -> Result<bool, SecureBlackboxError> 
fn set_new_sig_certification(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether this is a Certification (MDP) signature.

Certification signatures certify the current revision of the document and define which changes, if any, may be made afterwards without invalidating that certification. Use new_sig_allowed_changes to specify the permitted changes.

A PDF document normally contains at most one certification signature, and it is the first signature in the document. This setting does not apply to document timestamps.

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

Data Type

bool

new_sig_chain_validation_details property (PDFSigner Struct)

The details of a certificate chain validation outcome.

Syntax

fn new_sig_chain_validation_details(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

Returns a bit mask of the following options:

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

This property is read-only.

Data Type

i32

new_sig_chain_validation_result property (PDFSigner Struct)

The outcome of a certificate chain validation routine.

Syntax

fn new_sig_chain_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

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

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

This property is read-only.

Data Type

i32

new_sig_claimed_signing_time property (PDFSigner Struct)

Returns or sets the signature's creation time.

Syntax

fn new_sig_claimed_signing_time(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_claimed_signing_time(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_claimed_signing_time_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Returns or sets the signature's creation time.

Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike new_sig_validated_signing_time, does not originate from a trusted TSA and may be forged or wrong. If this value is not set when a new signature is created, the component uses the current UTC time.

The time is provided in UTC.

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

Data Type

String

new_sig_compatibility_errors property (PDFSigner Struct)

Returns compatibility errors encountered during validation.

Syntax

fn new_sig_compatibility_errors(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns compatibility errors encountered during validation.

Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.

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

This property is read-only.

Data Type

i32

new_sig_contact_info property (PDFSigner Struct)

Contains the signer's contact information.

Syntax

fn new_sig_contact_info(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_contact_info(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_contact_info_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the signer's contact information. This is a PDF document property.

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

Data Type

String

new_sig_contains_long_term_info property (PDFSigner Struct)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

Syntax

fn new_sig_contains_long_term_info(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

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

This property is read-only.

Data Type

bool

new_sig_coverage_ends_at property (PDFSigner Struct)

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

Syntax

fn new_sig_coverage_ends_at(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

PDF generators often use incremental updates to make changes in the 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. Alternatively, use the get_signed_version method of the PDFVerifier struct to extract the exact revision that was signed.

A value of -1 indicates that the component could not determine the coverage offset.

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

This property is read-only.

Data Type

i32

new_sig_custom_data property (PDFSigner Struct)

Uninterpreted custom data to save with the PDF signature.

Syntax

fn new_sig_custom_data(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_new_sig_custom_data(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_new_sig_custom_data_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Uninterpreted custom data to save with the PDF signature. The component stores and returns this value as-is and does not validate its contents.

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

Data Type

Vec

new_sig_empty_field property (PDFSigner Struct)

Indicates whether the signature is created as an empty property (a signature placeholder).

Syntax

fn new_sig_empty_field(&self ) -> Result<bool, SecureBlackboxError> 
fn set_new_sig_empty_field(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the signature is created as an empty field (a signature placeholder).

An empty field reserves a place for a future signature but does not contain a cryptographic signature value.

NOTE: This property is only applicable for creating new empty signature fields. To read info about empty signature fields, use EmptySignatureFieldCount and other EmptySignatureFields* configuration settings.

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

Data Type

bool

new_sig_entity_label property (PDFSigner Struct)

Use this property to get the signature entity label.

Syntax

fn new_sig_entity_label(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Use this property to get the signature entity label.

This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

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

This property is read-only.

Data Type

String

new_sig_filter_name property (PDFSigner Struct)

Specifies the PDF security handler filter name to use when creating a new signature.

Syntax

fn new_sig_filter_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_filter_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_filter_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the PDF security handler filter name to use when creating a new signature.

This value determines how PDF viewers, such as Adobe Acrobat Reader, interpret and validate the digital signature. Commonly recognized values include:

• "Adobe.PPKLite" - the default value; instructs Adobe to use its built-in certificate infrastructure.
• "Adobe.PPKMS" - instructs Adobe to use the system-wide Windows certificate store for signature validation.

Custom values (e.g. "VeriSign.PPKVS" used by the VeriSign plug-in) are also supported. However, non-standard filter names may not be recognized by all PDF viewers or validators, which could lead to compatibility or validation issues.

For maximum compatibility across different PDF environments, it is recommended to use the default value "Adobe.PPKLite" unless integration with a specific custom handler is required.

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

Data Type

String

new_sig_full_signature_name property (PDFSigner Struct)

Specifies the full name of the signature property.

Syntax

fn new_sig_full_signature_name(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the full name of the signature field.

This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.

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

This property is read-only.

Data Type

String

new_sig_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn new_sig_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_new_sig_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

Data Type

i64

new_sig_hash_algorithm property (PDFSigner Struct)

Specifies the hash algorithm to be used for signing.

Syntax

fn new_sig_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the hash algorithm to be used for signing.

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

Data Type

String

new_sig_height property (PDFSigner Struct)

Specifies the height of the signature widget.

Syntax

fn new_sig_height(&self ) -> Result<i32, SecureBlackboxError> 
fn set_new_sig_height(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the height of the signature widget.

Note that the dimensions of the widget are provided in document-specific points, not pixels. This integer field uses whole points. To specify fractional values, use the WidgetHeight configuration setting.

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

Data Type

i32

new_sig_issuer_rdn property (PDFSigner Struct)

The Relative Distinguished Name of the signing certificate's issuer.

Syntax

fn new_sig_issuer_rdn(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the certificate authority or entity that issued the signing certificate.

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

This property is read-only.

Data Type

String

new_sig_level property (PDFSigner Struct)

Specifies the PAdES signature level.

Syntax

fn new_sig_level(&self ) -> Result<i32, SecureBlackboxError> 
fn set_new_sig_level(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Generic
2   // BaselineB
3   // BaselineT
4   // BaselineLT
5   // BaselineLTA
6   // BES
7   // EPES
8   // LTV

Default Value

2

Remarks

Specifies the PAdES signature level.

PAdES standard defines a number of different 'levels' of signatures which can be used for different purposes.

Note that when validating a signature, the LTV modifier may be affected by the validation settings. These include OfflineMode (set it to true to obtain the clean LTV capability) and certificate caching (switch it off to stop earlier validations from affecting the current validation).

The supported levels are:

When creating a signature, some levels require additional settings:

• paslBaselineT requires a timestamp server.
• paslBaselineLT, paslBaselineLTA, and paslLTV require deep validation and a timestamp server.
• paslEPES requires new_sig_policy_id, new_sig_policy_hash_algorithm, and new_sig_policy_hash.

When evaluating the level of a PAdES signature, SecureBlackbox uses the following criteria and conditions:

• If the signing chain is found to be invalid or incomplete, the level will be reported as Baseline-B, BES, or EPES, depending on the attributes included in the signature (such as policy details).
• If the signing chain is found to be valid, the signature includes a timestamp, and the timestamp chain is valid (or the IgnoreTimestampChainValidityForLevelDetection config property is set to true), the level will be reported as Baseline-T.
• If the Baseline-T conditions above are met, and all the validation material is included in the DSS, the level will be reported as Baseline-LT.
• If the Baseline-LT conditions above are met, and the signature is protected by a later document timestamp, the level will be reported as Baseline-LTA.
• If the signing chain is found to be valid, the signature includes a timestamp, and the timestamp chain is valid (or the IgnoreTimestampChainValidityForLevelDetection config property is set to true), and all the validation material is included in the DSS or signature, and the signature does not meet the Baseline-LT and Baseline-LTA criteria, the level will be reported as LTV. In other words, the LTV level is a relaxed version of Baseline-LT, that allows the validation material to be included in the signature itself and not DSS.

Note: The LTV-enabled property reported by Adobe Reader can be misleading, as it does not represent a valid PAdES level. Instead, it is a rather indicative claim that advises that the signature does include some form of an external timestamp (a signature timestamp or a document timestamp) and some piece of validation material, and the signing chain ends up with a local trust anchor. As such, it can be a much weaker property than the Baseline-LT, Baseline-LTA, and LTV levels reported by SecureBlackbox.

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

Data Type

i32

new_sig_location property (PDFSigner Struct)

Specifies the host name or the physical location of the signing entity.

Syntax

fn new_sig_location(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_location(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_location_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the host name or the physical location of the signing entity. This is a PDF property.

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

Data Type

String

new_sig_offset_x property (PDFSigner Struct)

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

Syntax

fn new_sig_offset_x(&self ) -> Result<i32, SecureBlackboxError> 
fn set_new_sig_offset_x(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

The value is expressed in document-specific points. When a new visible signature is created, a negative value is converted to the page width plus that value. This integer field uses whole points; to specify fractional values, use the WidgetOffsetX configuration setting.

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

Data Type

i32

new_sig_offset_y property (PDFSigner Struct)

Specifies the signature widget offset from the bottom page border.

Syntax

fn new_sig_offset_y(&self ) -> Result<i32, SecureBlackboxError> 
fn set_new_sig_offset_y(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the signature widget offset from the bottom page border.

The value is expressed in document-specific points. When a new visible signature is created, a negative value is converted to the page height plus that value. This integer field uses whole points; to specify fractional values, use the WidgetOffsetY configuration setting.

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

Data Type

i32

new_sig_page property (PDFSigner Struct)

Indicates the index of the page on which the signature is placed.

Syntax

fn new_sig_page(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

-1

Remarks

Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature.

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

This property is read-only.

Data Type

i32

new_sig_policy_hash property (PDFSigner Struct)

The signature policy hash value for EPES signatures.

Syntax

fn new_sig_policy_hash(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_policy_hash(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_policy_hash_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The signature policy hash value for EPES signatures.

This property contains the hash of the external signature policy document. It must be set, together with new_sig_policy_id and new_sig_policy_hash_algorithm, when creating a paslEPES signature.

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

Data Type

String

new_sig_policy_hash_algorithm property (PDFSigner Struct)

The algorithm that was used to calculate the signature policy hash.

Syntax

fn new_sig_policy_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_policy_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_policy_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The algorithm that was used to calculate the signature policy hash.

This property must be set, together with new_sig_policy_id and new_sig_policy_hash, when creating a paslEPES signature.

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

Data Type

String

new_sig_policy_id property (PDFSigner Struct)

The policy ID to be included in the signature.

Syntax

fn new_sig_policy_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_policy_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_policy_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The policy ID to be included in the signature.

This property identifies the signature policy for EPES signatures. It must be set, together with new_sig_policy_hash_algorithm and new_sig_policy_hash, when creating a paslEPES signature.

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

Data Type

String

new_sig_policy_uri property (PDFSigner Struct)

The signature policy URI that was included in the signature.

Syntax

fn new_sig_policy_uri(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_policy_uri(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_policy_uri_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy for EPES signatures. The URI is optional metadata; the policy ID, policy hash algorithm, and policy hash identify the policy value itself.

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

Data Type

String

new_sig_reason property (PDFSigner Struct)

Specifies the reason for signing.

Syntax

fn new_sig_reason(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_reason(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_reason_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the reason for signing. This is a PDF document property.

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

Data Type

String

new_sig_serial_number property (PDFSigner Struct)

The serial number of the signing certificate that created the signature.

Syntax

fn new_sig_serial_number(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The serial number of the signing certificate that created the signature.

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

This property is read-only.

Data Type

Vec

new_sig_signature_bytes property (PDFSigner Struct)

Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures.

Syntax

fn new_sig_signature_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures.

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

This property is read-only.

Data Type

Vec

new_sig_signature_name property (PDFSigner Struct)

Specifies the unique signature identifier to use.

Syntax

fn new_sig_signature_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_signature_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_signature_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the unique signature identifier to use.

This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.

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

Data Type

String

new_sig_signature_type property (PDFSigner Struct)

The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.

Syntax

fn new_sig_signature_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_new_sig_signature_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Legacy
2   // PAdES
3   // DocumentTimestamp

Default Value

2

Remarks

The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.

The default value for new signatures is pstPAdES. PAdES signatures use new_sig_level to select the PAdES profile. Document timestamp signatures require a timestamp server and do not contain signer certificate information.

The supported values are:

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

Data Type

i32

new_sig_signature_validation_result property (PDFSigner Struct)

The outcome of the cryptographic signature validation.

Syntax

fn new_sig_signature_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

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

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

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

This property is read-only.

Data Type

i32

new_sig_subject_key_id property (PDFSigner Struct)

Contains the subject key identifier of the signing certificate.

Syntax

fn new_sig_subject_key_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains the subject key identifier of the signing certificate.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.

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

This property is read-only.

Data Type

Vec

new_sig_subject_rdn property (PDFSigner Struct)

Contains the RDN of the owner of the signing certificate.

Syntax

fn new_sig_subject_rdn(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the RDN of the owner of the signing certificate.

RDN is a set of OID=Value pairs declared in the certificate that provide the subject owner's details.

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

This property is read-only.

Data Type

String

new_sig_timestamped property (PDFSigner Struct)

Use this property to establish whether the signature contains an embedded timestamp.

Syntax

fn new_sig_timestamped(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Use this property to establish whether the signature contains an embedded timestamp.

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

This property is read-only.

Data Type

bool

new_sig_validated_signing_time property (PDFSigner Struct)

Contains the certified signing time.

Syntax

fn new_sig_validated_signing_time(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the certified signing time.

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 was a valid timestamp included in the signature.

new_sig_claimed_signing_time returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

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

This property is read-only.

Data Type

String

new_sig_validation_log property (PDFSigner Struct)

Contains the signing certificate's chain validation log.

Syntax

fn new_sig_validation_log(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.

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

This property is read-only.

Data Type

String

new_sig_width property (PDFSigner Struct)

Specifies the width of the signature widget.

Syntax

fn new_sig_width(&self ) -> Result<i32, SecureBlackboxError> 
fn set_new_sig_width(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the width of the signature widget.

Note that the dimensions of the widget are provided in document-specific points, not pixels. This integer field uses whole points. To specify fractional values, use the WidgetWidth configuration setting.

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

Data Type

i32

ocsp_count property (PDFSigner Struct)

The number of records in the OCSP arrays.

Syntax

fn ocsp_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• ocsp_bytes
• ocsp_entry_count
• ocsp_handle
• ocsp_issuer
• ocsp_issuer_rdn
• ocsp_location
• ocsp_produced_at
• ocsp_sig_algorithm
• ocsp_source

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

This property is read-only.

Data Type

i32

ocsp_bytes property (PDFSigner Struct)

A buffer containing the raw OCSP response data.

Syntax

fn ocsp_bytes(&self , OCSPIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

A buffer containing the raw OCSP response data.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

Vec

ocsp_entry_count property (PDFSigner Struct)

The number of SingleResponse elements contained in this OCSP response.

Syntax

fn ocsp_entry_count(&self , OCSPIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

i32

ocsp_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn ocsp_handle(&self , OCSPIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

i64

ocsp_issuer property (PDFSigner Struct)

Indicates the issuer of this response (a CA or its authorized representative).

Syntax

fn ocsp_issuer(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the issuer of this response (a CA or its authorized representative).

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

String

ocsp_issuer_rdn property (PDFSigner Struct)

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

Syntax

fn ocsp_issuer_rdn(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

String

ocsp_location property (PDFSigner Struct)

The location of the OCSP responder.

Syntax

fn ocsp_location(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The location of the OCSP responder.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

String

ocsp_produced_at property (PDFSigner Struct)

Specifies the time when the response was produced, in UTC.

Syntax

fn ocsp_produced_at(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the time when the response was produced, in UTC.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

String

ocsp_sig_algorithm property (PDFSigner Struct)

The public key algorithm that was used by the CA to sign this OCSP response.

Syntax

fn ocsp_sig_algorithm(&self , OCSPIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

The public key algorithm that was used by the CA to sign this OCSP response.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

String

ocsp_source property (PDFSigner Struct)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

fn ocsp_source(&self , OCSPIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

0

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

The OCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OCSPCount property.

This property is read-only.

Data Type

i32

offline_mode property (PDFSigner Struct)

Switches the struct to offline mode.

Syntax

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

Default Value

false

Remarks

When working in offline mode, the struct restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via known_certificates, known_crls, and other related properties.

Data Type

bool

output_bytes property (PDFSigner Struct)

Use this property to read the output the struct object has produced.

Syntax

fn output_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the output_file and output_stream properties had not been assigned.

This property is read-only.

Data Type

Vec

output_file property (PDFSigner Struct)

The file to save the signed or updated document to.

Syntax

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

Default Value

""

Remarks

Use this property to provide a path where the resulting PDF document should be saved to.

Data Type

String

page_count property (PDFSigner Struct)

The number of records in the Page arrays.

Syntax

fn page_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• page_crop_llx
• page_crop_lly
• page_crop_urx
• page_crop_ury
• page_height
• page_media_llx
• page_media_lly
• page_media_urx
• page_media_ury
• page_rotate
• page_width

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

This property is read-only.

Data Type

i32

page_crop_llx property (PDFSigner Struct)

Specifies the lower-left X coordinate of the page crop area.

Syntax

fn page_crop_llx(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the lower-left X coordinate of the page crop area.

Specifies the lower-left X coordinate of the page crop area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_crop_lly property (PDFSigner Struct)

Specifies the lower-left Y coordinate of the page crop area.

Syntax

fn page_crop_lly(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the lower-left Y coordinate of the page crop area.

Specifies the lower-left Y coordinate of the page crop area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_crop_urx property (PDFSigner Struct)

Specifies the upper-right X coordinate of the page crop area.

Syntax

fn page_crop_urx(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the upper-right X coordinate of the page crop area.

Specifies the upper-right X coordinate of the page crop area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_crop_ury property (PDFSigner Struct)

Specifies the upper-right Y coordinate of the page crop area.

Syntax

fn page_crop_ury(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the upper-right Y coordinate of the page crop area.

Specifies the upper-right Y coordinate of the page crop area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_height property (PDFSigner Struct)

Specifies the height of the page.

Syntax

fn page_height(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the height of the page.

Returns the height of the page.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_media_llx property (PDFSigner Struct)

Specifies the lower-left X coordinate of the page media area.

Syntax

fn page_media_llx(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the lower-left X coordinate of the page media area.

Specifies the lower-left X coordinate of the page media area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_media_lly property (PDFSigner Struct)

Specifies the lower-left Y coordinate of the page media area.

Syntax

fn page_media_lly(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the lower-left Y coordinate of the page media area.

Specifies the lower-left Y coordinate of the page media area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_media_urx property (PDFSigner Struct)

Specifies the upper-right X coordinate of the page media area.

Syntax

fn page_media_urx(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the upper-right X coordinate of the page media area.

Specifies the upper-right X coordinate of the page media area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_media_ury property (PDFSigner Struct)

Specifies the upper-right Y coordinate of the page media area.

Syntax

fn page_media_ury(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the upper-right Y coordinate of the page media area.

Specifies the upper-right Y coordinate of the page media area rectangle.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_rotate property (PDFSigner Struct)

Specifies the rotation angle of the page in degrees.

Syntax

fn page_rotate(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the rotation angle of the page in degrees. Values of 0, 90, 180, and 270 are allowed.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

page_width property (PDFSigner Struct)

Specifies the width of the page.

Syntax

fn page_width(&self , PageIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the width of the page.

Returns the width of the page.

The PageIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PageCount property.

This property is read-only.

Data Type

i32

password property (PDFSigner Struct)

The decryption password.

Syntax

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

Default Value

""

Remarks

Use this property to provide the decryption password.

Data Type

String

profile property (PDFSigner Struct)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

fn profile(&self ) -> Result<String, SecureBlackboxError> 
fn set_profile(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_profile_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Supported profiles:

Data Type

String

proxy_address property (PDFSigner Struct)

The IP address of the proxy server.

Syntax

fn proxy_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

proxy_authentication property (PDFSigner Struct)

The authentication type used by the proxy server.

Syntax

fn proxy_authentication(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_authentication(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

0

Remarks

The authentication type used by the proxy server.

Data Type

i32

proxy_password property (PDFSigner Struct)

The password to authenticate to the proxy server.

Syntax

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

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

proxy_port property (PDFSigner Struct)

The port on the proxy server to connect to.

Syntax

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

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

i32

proxy_type property (PDFSigner Struct)

The type of the proxy server.

Syntax

fn proxy_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_proxy_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

0

Remarks

The type of the proxy server.

Data Type

i32

proxy_request_headers property (PDFSigner Struct)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

fn proxy_request_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_request_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_request_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

proxy_response_body property (PDFSigner Struct)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

fn proxy_response_body(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_body(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_body_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

proxy_response_headers property (PDFSigner Struct)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

fn proxy_response_headers(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_response_headers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_response_headers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

proxy_use_ipv6 property (PDFSigner Struct)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

fn proxy_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_proxy_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

bool

proxy_username property (PDFSigner Struct)

Specifies the username credential for proxy authentication.

Syntax

fn proxy_username(&self ) -> Result<String, SecureBlackboxError> 
fn set_proxy_username(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_proxy_username_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

revocation_check property (PDFSigner Struct)

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

Syntax

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

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

1

Remarks

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

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

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. 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 some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is 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 setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL 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 "crcAll*" 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 will be 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_count property (PDFSigner Struct)

The number of records in the Signature arrays.

Syntax

fn signature_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• signature_allowed_changes
• signature_author_name
• signature_bytes
• signature_certification
• signature_chain_validation_details
• signature_chain_validation_result
• signature_claimed_signing_time
• signature_compatibility_errors
• signature_contact_info
• signature_contains_long_term_info
• signature_coverage_ends_at
• signature_custom_data
• signature_empty_field
• signature_entity_label
• signature_filter_name
• signature_full_signature_name
• signature_handle
• signature_hash_algorithm
• signature_height
• signature_issuer_rdn
• signature_level
• signature_location
• signature_name
• signature_offset_x
• signature_offset_y
• signature_page
• signature_policy_hash
• signature_policy_hash_algorithm
• signature_policy_id
• signature_policy_uri
• signature_reason
• signature_serial_number
• signature_subject_key_id
• signature_subject_rdn
• signature_timestamped
• signature_type
• signature_validated_signing_time
• signature_validation_log
• signature_validation_result
• signature_width

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

This property is read-only.

Data Type

i32

signature_allowed_changes property (PDFSigner Struct)

The changes to the document allowed by the signature.

Syntax

fn signature_allowed_changes(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // None
1   // FillInForms
2   // Comment
3   // All

Default Value

0

Remarks

The changes to the document allowed by the signature.

This property is only applicable to MDP/certification signatures and has no effect for any other kinds of signatures (regular or document timestamps).

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_author_name property (PDFSigner Struct)

A human-readable signer name.

Syntax

fn signature_author_name(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A human-readable signer name. This is a PDF document property.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_certification property (PDFSigner Struct)

Specifies whether this is a Certification (MDP) signature.

Syntax

fn signature_certification(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether this is a Certification (MDP) signature.

Certification signatures certify the current revision of the document and define which changes, if any, may be made afterwards without invalidating that certification. Use signature_allowed_changes to specify the permitted changes.

A PDF document normally contains at most one certification signature, and it is the first signature in the document. This setting does not apply to document timestamps.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_chain_validation_details property (PDFSigner Struct)

The details of a certificate chain validation outcome.

Syntax

fn signature_chain_validation_details(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

Returns a bit mask of the following options:

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_chain_validation_result property (PDFSigner Struct)

The outcome of a certificate chain validation routine.

Syntax

fn signature_chain_validation_result(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

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

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_claimed_signing_time property (PDFSigner Struct)

Returns or sets the signature's creation time.

Syntax

fn signature_claimed_signing_time(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Returns or sets the signature's creation time.

Use this property to get or set the signature creation time from the signer's computer. The claimed time, unlike signature_validated_signing_time, does not originate from a trusted TSA and may be forged or wrong. If this value is not set when a new signature is created, the component uses the current UTC time.

The time is provided in UTC.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_compatibility_errors property (PDFSigner Struct)

Returns compatibility errors encountered during validation.

Syntax

fn signature_compatibility_errors(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns compatibility errors encountered during validation.

Use this property to get specific compatibility errors encountered during validation. Unlike chain validation details, compatibility errors indicate violations by the signature of the assumed signature level/profile. For example, BES signatures are required to contain the signing time attribute. A prospective BES signature without such attribute will invoke a compatibility error.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_contact_info property (PDFSigner Struct)

Contains the signer's contact information.

Syntax

fn signature_contact_info(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the signer's contact information. This is a PDF document property.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_contains_long_term_info property (PDFSigner Struct)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

Syntax

fn signature_contains_long_term_info(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_coverage_ends_at property (PDFSigner Struct)

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

Syntax

fn signature_coverage_ends_at(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

PDF generators often use incremental updates to make changes in the 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. Alternatively, use the get_signed_version method of the PDFVerifier struct to extract the exact revision that was signed.

A value of -1 indicates that the component could not determine the coverage offset.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_custom_data property (PDFSigner Struct)

Uninterpreted custom data to save with the PDF signature.

Syntax

fn signature_custom_data(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Uninterpreted custom data to save with the PDF signature. The component stores and returns this value as-is and does not validate its contents.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

Vec

signature_empty_field property (PDFSigner Struct)

Indicates whether the signature is created as an empty property (a signature placeholder).

Syntax

fn signature_empty_field(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the signature is created as an empty field (a signature placeholder).

An empty field reserves a place for a future signature but does not contain a cryptographic signature value.

NOTE: This property is only applicable for creating new empty signature fields. To read info about empty signature fields, use EmptySignatureFieldCount and other EmptySignatureFields* configuration settings.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_entity_label property (PDFSigner Struct)

Use this property to get the signature entity label.

Syntax

fn signature_entity_label(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Use this property to get the signature entity label.

This property returns a string label that uniquely identifies the signature. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_filter_name property (PDFSigner Struct)

Specifies the PDF security handler filter name to use when creating a new signature.

Syntax

fn signature_filter_name(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the PDF security handler filter name to use when creating a new signature.

This value determines how PDF viewers, such as Adobe Acrobat Reader, interpret and validate the digital signature. Commonly recognized values include:

• "Adobe.PPKLite" - the default value; instructs Adobe to use its built-in certificate infrastructure.
• "Adobe.PPKMS" - instructs Adobe to use the system-wide Windows certificate store for signature validation.

Custom values (e.g. "VeriSign.PPKVS" used by the VeriSign plug-in) are also supported. However, non-standard filter names may not be recognized by all PDF viewers or validators, which could lead to compatibility or validation issues.

For maximum compatibility across different PDF environments, it is recommended to use the default value "Adobe.PPKLite" unless integration with a specific custom handler is required.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_full_signature_name property (PDFSigner Struct)

Specifies the full name of the signature property.

Syntax

fn signature_full_signature_name(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the full name of the signature field.

This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn signature_handle(&self , SignatureIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i64

signature_hash_algorithm property (PDFSigner Struct)

Specifies the hash algorithm to be used for signing.

Syntax

fn signature_hash_algorithm(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the hash algorithm to be used for signing.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_height property (PDFSigner Struct)

Specifies the height of the signature widget.

Syntax

fn signature_height(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the height of the signature widget.

Note that the dimensions of the widget are provided in document-specific points, not pixels. This integer field uses whole points. To specify fractional values, use the WidgetHeight configuration setting.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_issuer_rdn property (PDFSigner Struct)

The Relative Distinguished Name of the signing certificate's issuer.

Syntax

fn signature_issuer_rdn(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The Relative Distinguished Name of the signing certificate's issuer.

A collection of information, in the form of [OID, Value] pairs, about the certificate authority or entity that issued the signing certificate.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_level property (PDFSigner Struct)

Specifies the PAdES signature level.

Syntax

fn signature_level(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Generic
2   // BaselineB
3   // BaselineT
4   // BaselineLT
5   // BaselineLTA
6   // BES
7   // EPES
8   // LTV

Default Value

2

Remarks

Specifies the PAdES signature level.

PAdES standard defines a number of different 'levels' of signatures which can be used for different purposes.

Note that when validating a signature, the LTV modifier may be affected by the validation settings. These include OfflineMode (set it to true to obtain the clean LTV capability) and certificate caching (switch it off to stop earlier validations from affecting the current validation).

The supported levels are:

When creating a signature, some levels require additional settings:

• paslBaselineT requires a timestamp server.
• paslBaselineLT, paslBaselineLTA, and paslLTV require deep validation and a timestamp server.
• paslEPES requires signature_policy_id, signature_policy_hash_algorithm, and signature_policy_hash.

When evaluating the level of a PAdES signature, SecureBlackbox uses the following criteria and conditions:

• If the signing chain is found to be invalid or incomplete, the level will be reported as Baseline-B, BES, or EPES, depending on the attributes included in the signature (such as policy details).
• If the signing chain is found to be valid, the signature includes a timestamp, and the timestamp chain is valid (or the IgnoreTimestampChainValidityForLevelDetection config property is set to true), the level will be reported as Baseline-T.
• If the Baseline-T conditions above are met, and all the validation material is included in the DSS, the level will be reported as Baseline-LT.
• If the Baseline-LT conditions above are met, and the signature is protected by a later document timestamp, the level will be reported as Baseline-LTA.
• If the signing chain is found to be valid, the signature includes a timestamp, and the timestamp chain is valid (or the IgnoreTimestampChainValidityForLevelDetection config property is set to true), and all the validation material is included in the DSS or signature, and the signature does not meet the Baseline-LT and Baseline-LTA criteria, the level will be reported as LTV. In other words, the LTV level is a relaxed version of Baseline-LT, that allows the validation material to be included in the signature itself and not DSS.

Note: The LTV-enabled property reported by Adobe Reader can be misleading, as it does not represent a valid PAdES level. Instead, it is a rather indicative claim that advises that the signature does include some form of an external timestamp (a signature timestamp or a document timestamp) and some piece of validation material, and the signing chain ends up with a local trust anchor. As such, it can be a much weaker property than the Baseline-LT, Baseline-LTA, and LTV levels reported by SecureBlackbox.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_location property (PDFSigner Struct)

Specifies the host name or the physical location of the signing entity.

Syntax

fn signature_location(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the host name or the physical location of the signing entity. This is a PDF property.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_offset_x property (PDFSigner Struct)

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

Syntax

fn signature_offset_x(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

The value is expressed in document-specific points. When a new visible signature is created, a negative value is converted to the page width plus that value. This integer field uses whole points; to specify fractional values, use the WidgetOffsetX configuration setting.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_offset_y property (PDFSigner Struct)

Specifies the signature widget offset from the bottom page border.

Syntax

fn signature_offset_y(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the signature widget offset from the bottom page border.

The value is expressed in document-specific points. When a new visible signature is created, a negative value is converted to the page height plus that value. This integer field uses whole points; to specify fractional values, use the WidgetOffsetY configuration setting.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_page property (PDFSigner Struct)

Indicates the index of the page on which the signature is placed.

Syntax

fn signature_page(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

-1

Remarks

Indicates the index of the page on which the signature is placed. The value "-1" indicates an invisible signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_policy_hash property (PDFSigner Struct)

The signature policy hash value for EPES signatures.

Syntax

fn signature_policy_hash(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The signature policy hash value for EPES signatures.

This property contains the hash of the external signature policy document. It must be set, together with signature_policy_id and signature_policy_hash_algorithm, when creating a paslEPES signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_policy_hash_algorithm property (PDFSigner Struct)

The algorithm that was used to calculate the signature policy hash.

Syntax

fn signature_policy_hash_algorithm(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The algorithm that was used to calculate the signature policy hash.

This property must be set, together with signature_policy_id and signature_policy_hash, when creating a paslEPES signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_policy_id property (PDFSigner Struct)

The policy ID to be included in the signature.

Syntax

fn signature_policy_id(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The policy ID to be included in the signature.

This property identifies the signature policy for EPES signatures. It must be set, together with signature_policy_hash_algorithm and signature_policy_hash, when creating a paslEPES signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_policy_uri property (PDFSigner Struct)

The signature policy URI that was included in the signature.

Syntax

fn signature_policy_uri(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The signature policy URI that was included in the signature.

Use this property to set or retrieve the URI of the signature policy for EPES signatures. The URI is optional metadata; the policy ID, policy hash algorithm, and policy hash identify the policy value itself.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_reason property (PDFSigner Struct)

Specifies the reason for signing.

Syntax

fn signature_reason(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the reason for signing. This is a PDF document property.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_serial_number property (PDFSigner Struct)

The serial number of the signing certificate that created the signature.

Syntax

fn signature_serial_number(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The serial number of the signing certificate that created the signature.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

Vec

signature_bytes property (PDFSigner Struct)

Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures.

Syntax

fn signature_bytes(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the binary representation of the underlying CMS/PKCS#7 signature container, or the timestamp token for document timestamp signatures.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

Vec

signature_name property (PDFSigner Struct)

Specifies the unique signature identifier to use.

Syntax

fn signature_name(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Specifies the unique signature identifier to use.

This is an internal identifier of a signature (such as Signature1) and is not meant to be human-readable.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_type property (PDFSigner Struct)

The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.

Syntax

fn signature_type(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Legacy
2   // PAdES
3   // DocumentTimestamp

Default Value

2

Remarks

The type of the PDF signature: Legacy, PAdES, document timestamp, or unknown.

The default value for new signatures is pstPAdES. PAdES signatures use signature_level to select the PAdES profile. Document timestamp signatures require a timestamp server and do not contain signer certificate information.

The supported values are:

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_validation_result property (PDFSigner Struct)

The outcome of the cryptographic signature validation.

Syntax

fn signature_validation_result(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

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

Default Value

0

Remarks

The outcome of the cryptographic signature validation.

The following signature validity values are supported:

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signature_subject_key_id property (PDFSigner Struct)

Contains the subject key identifier of the signing certificate.

Syntax

fn signature_subject_key_id(&self , SignatureIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Contains the subject key identifier of the signing certificate.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented by a SHA-1 hash of the bit string of the subject public key.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

Vec

signature_subject_rdn property (PDFSigner Struct)

Contains the RDN of the owner of the signing certificate.

Syntax

fn signature_subject_rdn(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the RDN of the owner of the signing certificate.

RDN is a set of OID=Value pairs declared in the certificate that provide the subject owner's details.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_timestamped property (PDFSigner Struct)

Use this property to establish whether the signature contains an embedded timestamp.

Syntax

fn signature_timestamped(&self , SignatureIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Use this property to establish whether the signature contains an embedded timestamp.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

bool

signature_validated_signing_time property (PDFSigner Struct)

Contains the certified signing time.

Syntax

fn signature_validated_signing_time(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the certified signing time.

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 was a valid timestamp included in the signature.

signature_claimed_signing_time returns a non-trusted signing time from the signer's computer.

Both times are in UTC.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_validation_log property (PDFSigner Struct)

Contains the signing certificate's chain validation log.

Syntax

fn signature_validation_log(&self , SignatureIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the signing certificate's chain validation log. This information may be very useful in investigating chain validation failures.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

String

signature_width property (PDFSigner Struct)

Specifies the width of the signature widget.

Syntax

fn signature_width(&self , SignatureIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Specifies the width of the signature widget.

Note that the dimensions of the widget are provided in document-specific points, not pixels. This integer field uses whole points. To specify fractional values, use the WidgetWidth configuration setting.

The SignatureIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignatureCount property.

This property is read-only.

Data Type

i32

signing_cert_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

signing_cert_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_signing_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

signing_chain_count property (PDFSigner Struct)

The number of records in the SigningChain arrays.

Syntax

fn signing_chain_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_signing_chain_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• signing_chain_bytes
• signing_chain_handle

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

Data Type

i32

signing_chain_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_chain_bytes(&self , SigningChainIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only.

Data Type

Vec

signing_chain_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_signing_chain_handle(&self, SigningChainIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

Data Type

i64

socket_dns_mode property (PDFSigner Struct)

Selects the DNS resolver to use: the struct's (secure) built-in one, or the one provided by the system.

Syntax

fn socket_dns_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

i32

socket_dns_port property (PDFSigner Struct)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

fn socket_dns_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

i32

socket_dns_query_timeout property (PDFSigner Struct)

The timeout (in milliseconds) for each DNS query.

Syntax

fn socket_dns_query_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_query_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

i32

socket_dns_servers property (PDFSigner Struct)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

fn socket_dns_servers(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_dns_servers(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_dns_servers_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

socket_dns_total_timeout property (PDFSigner Struct)

The timeout (in milliseconds) for the whole resolution process.

Syntax

fn socket_dns_total_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_dns_total_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

i32

socket_incoming_speed_limit property (PDFSigner Struct)

The maximum number of bytes to read from the socket, per second.

Syntax

fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

i32

socket_local_address property (PDFSigner Struct)

The local network interface to bind the socket to.

Syntax

fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (PDFSigner Struct)

The local port number to bind the socket to.

Syntax

fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (PDFSigner Struct)

The maximum number of bytes to write to the socket, per second.

Syntax

fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

i32

socket_timeout property (PDFSigner Struct)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

i32

socket_use_ipv6 property (PDFSigner Struct)

Enables or disables IP protocol version 6.

Syntax

fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

timestamp_count property (PDFSigner Struct)

The number of records in the Timestamp arrays.

Syntax

fn timestamp_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• timestamp_accuracy
• timestamp_bytes
• timestamp_certificate_index
• timestamp_chain_validation_details
• timestamp_chain_validation_result
• timestamp_contains_long_term_info
• timestamp_entity_label
• timestamp_hash_algorithm
• timestamp_parent_entity
• timestamp_serial_number
• timestamp_time
• timestamp_tsa_name
• timestamp_type
• timestamp_validation_log
• timestamp_validation_result

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

This property is read-only.

Data Type

i32

timestamp_accuracy property (PDFSigner Struct)

This property indicates the accuracy of the included time mark, in microseconds.

Syntax

fn timestamp_accuracy(&self , TimestampIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

This field indicates the accuracy of the included time mark, in microseconds.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

i64

timestamp_bytes property (PDFSigner Struct)

Returns the raw timestamp data in DER format.

Syntax

fn timestamp_bytes(&self , TimestampIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw timestamp data in DER format.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

Vec

timestamp_certificate_index property (PDFSigner Struct)

Returns the index of the TSA certificate in the Certificates collection.

Syntax

fn timestamp_certificate_index(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

-1

Remarks

Returns the index of the TSA certificate in the Certificates collection.

Use this property to look up the TSA certificate in the Certificates collection.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

i32

timestamp_chain_validation_details property (PDFSigner Struct)

The details of a certificate chain validation outcome.

Syntax

fn timestamp_chain_validation_details(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

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

Returns a bit mask of the following options:

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

i32

timestamp_chain_validation_result property (PDFSigner Struct)

The outcome of a certificate chain validation routine.

Syntax

fn timestamp_chain_validation_result(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

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

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

i32

timestamp_contains_long_term_info property (PDFSigner Struct)

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

Syntax

fn timestamp_contains_long_term_info(&self , TimestampIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response).

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

bool

timestamp_entity_label property (PDFSigner Struct)

Use this property to get the timestamp entity label.

Syntax

fn timestamp_entity_label(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Use this property to get the timestamp entity label.

This property returns a string label that uniquely identifies the timestamp. The label can be used to establish the signature target in the SignatureFound event or to select the signing chain via the SelectInfo method.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

String

timestamp_hash_algorithm property (PDFSigner Struct)

Returns the timestamp's hash algorithm.

Syntax

fn timestamp_hash_algorithm(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Returns the timestamp's hash algorithm.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

String

timestamp_parent_entity property (PDFSigner Struct)

Use this property to get the label of the timestamp's parent entity.

Syntax

fn timestamp_parent_entity(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Use this property to get the label of the timestamp's parent entity.

This property references the EntityLabel of the object that the timestamp covers, typically a signature.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

String

timestamp_serial_number property (PDFSigner Struct)

Returns the timestamp's serial number.

Syntax

fn timestamp_serial_number(&self , TimestampIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the timestamp's serial number.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

Vec

timestamp_time property (PDFSigner Struct)

The time point incorporated into the timestamp.

Syntax

fn timestamp_time(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point incorporated into the timestamp.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

String

timestamp_type property (PDFSigner Struct)

Returns the type of the timestamp.

Syntax

fn timestamp_type(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the type of the timestamp.

Available options:

Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES).

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

i32

timestamp_tsa_name property (PDFSigner Struct)

This value uniquely identifies the Timestamp Authority (TSA).

Syntax

fn timestamp_tsa_name(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

This value uniquely identifies the Timestamp Authority (TSA).

This property provides information about the entity that manages the TSA.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

String

timestamp_validation_log property (PDFSigner Struct)

Contains the TSA certificate chain validation log.

Syntax

fn timestamp_validation_log(&self , TimestampIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

String

timestamp_validation_result property (PDFSigner Struct)

Contains the timestamp validation outcome.

Syntax

fn timestamp_validation_result(&self , TimestampIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

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

Default Value

0

Remarks

Contains the timestamp validation outcome.

Use this property to check the result of the most recent timestamp validation.

The TimestampIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TimestampCount property.

This property is read-only.

Data Type

i32

timestamp_server property (PDFSigner Struct)

The address of the timestamping server.

Syntax

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

Default Value

""

Remarks

Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.

SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.

If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:

http://user:password@timestamp.server.com/TsaService

For TSAs using certificate-based TLS authentication, provide the client certificate via the tls_client_chain property.

If this property is left empty, no timestamp will be added to the signature.

Starting from summer 2021 update (Vol. 2), the virtual timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.

To employ the virtual service, assign an URI of the following format to this property:

virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true

Subscribe to on_notification event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:

component.Config("TimestampResponse=308208ab...");

Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.

The hashonly parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.

The includecerts parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.

The reqpolicy parameter lets you specify the request policy, and the halg parameter specifies the hash algorithm to use for timestamping.

The ignorenonce parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

Data Type

String

tls_client_cert_count property (PDFSigner Struct)

The number of records in the TLSClientCert arrays.

Syntax

fn tls_client_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_client_cert_bytes
• tls_client_cert_handle

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

Data Type

i32

tls_client_cert_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_client_cert_bytes(&self , TLSClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is read-only.

Data Type

Vec

tls_client_cert_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn tls_client_cert_handle(&self , TLSClientCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_tls_client_cert_handle(&self, TLSClientCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

Data Type

i64

tls_server_cert_count property (PDFSigner Struct)

The number of records in the TLSServerCert arrays.

Syntax

fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_fingerprint
• tls_server_cert_handle
• tls_server_cert_issuer
• tls_server_cert_issuer_rdn
• tls_server_cert_key_algorithm
• tls_server_cert_key_bits
• tls_server_cert_key_usage
• tls_server_cert_self_signed
• tls_server_cert_serial_number
• tls_server_cert_sig_algorithm
• tls_server_cert_subject
• tls_server_cert_subject_rdn
• tls_server_cert_valid_from
• tls_server_cert_valid_to

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

This property is read-only.

Data Type

i32

tls_server_cert_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_fingerprint property (PDFSigner Struct)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

fn tls_server_cert_fingerprint(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i64

tls_server_cert_issuer property (PDFSigner Struct)

The common name of the certificate issuer (CA), typically a company name.

Syntax

fn tls_server_cert_issuer(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via tls_issuer_rdn.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_issuer_rdn property (PDFSigner Struct)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

fn tls_server_cert_issuer_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_key_algorithm property (PDFSigner Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn tls_server_cert_key_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the tls_key_bits, tls_curve, and tls_public_key_bytes properties to get more details about the key the certificate contains.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_key_bits property (PDFSigner Struct)

Returns the length of the public key in bits.

Syntax

fn tls_server_cert_key_bits(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the tls_public_key_bytes or tls_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i32

tls_server_cert_key_usage property (PDFSigner Struct)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

fn tls_server_cert_key_usage(&self , TLSServerCertIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

i32

tls_server_cert_self_signed property (PDFSigner Struct)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

fn tls_server_cert_self_signed(&self , TLSServerCertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

bool

tls_server_cert_serial_number property (PDFSigner Struct)

Returns the certificate's serial number.

Syntax

fn tls_server_cert_serial_number(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_sig_algorithm property (PDFSigner Struct)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

fn tls_server_cert_sig_algorithm(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_subject property (PDFSigner Struct)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

fn tls_server_cert_subject(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via tls_subject_rdn.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_subject_rdn property (PDFSigner Struct)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

fn tls_server_cert_subject_rdn(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_valid_from property (PDFSigner Struct)

The time point at which the certificate becomes valid, in UTC.

Syntax

fn tls_server_cert_valid_from(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_server_cert_valid_to property (PDFSigner Struct)

The time point at which the certificate expires, in UTC.

Syntax

fn tls_server_cert_valid_to(&self , TLSServerCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

String

tls_auto_validate_certificates property (PDFSigner Struct)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

bool

tls_base_configuration property (PDFSigner Struct)

Selects the base configuration for the TLS settings.

Syntax

fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

i32

tls_ciphersuites property (PDFSigner Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by tls_base_configuration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

tls_client_auth property (PDFSigner Struct)

Enables or disables certificate-based client authentication.

Syntax

fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

i32

tls_extensions property (PDFSigner Struct)

Provides access to TLS extensions.

Syntax

fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (PDFSigner Struct)

Whether to force TLS session resumption when the destination address changes.

Syntax

fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

bool

tls_groups property (PDFSigner Struct)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

fn tls_groups(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

• SECT163K1
• SECT163R1
• SECT163R2
• SECT193R1
• SECT193R2
• SECT233K1
• SECT233R1
• SECT239K1
• SECT283K1
• SECT283R1
• SECT409K1
• SECT409R1
• SECT571K1
• SECT571R1
• SECP160K1
• SECP160R1
• SECP160R2
• SECP192K1
• SECP192R1
• SECP224K1
• SECP224R1
• SECP256K1
• SECP256R1
• SECP384R1
• SECP521R1
• BRAINPOOLP256R1
• BRAINPOOLP384R1
• BRAINPOOLP512R1
• X25519
• X448

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

• MLKEM512
• MLKEM768
• MLKEM1024
• SECP256R1MLKEM768
• X25519MLKEM768
• SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

String

tls_pre_shared_identity property (PDFSigner Struct)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Data Type

String

tls_pre_shared_key property (PDFSigner Struct)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Data Type

String

tls_pre_shared_key_ciphersuite property (PDFSigner Struct)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

tls_renegotiation_attack_prevention_mode property (PDFSigner Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (PDFSigner Struct)

Specifies the kind(s) of revocation check to perform.

Syntax

fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

1

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. 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 some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is 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 setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL 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 "crcAll*" 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 will be 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

tls_ssl_options property (PDFSigner Struct)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (PDFSigner Struct)

Specifies the TLS mode to use.

Syntax

fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (PDFSigner Struct)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

bool

tls_use_session_resumption property (PDFSigner Struct)

Enables or disables the TLS session resumption capability.

Syntax

fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (PDFSigner Struct)

The SSL/TLS versions to enable by default.

Syntax

fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

trusted_cert_count property (PDFSigner Struct)

The number of records in the TrustedCert arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• trusted_cert_bytes
• trusted_cert_handle

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

Data Type

i32

trusted_cert_bytes property (PDFSigner Struct)

Returns the raw certificate data in DER format.

Syntax

fn trusted_cert_bytes(&self , TrustedCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

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

Vec

trusted_cert_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn trusted_cert_handle(&self , TrustedCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_trusted_cert_handle(&self, TrustedCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

i64

validation_moment property (PDFSigner Struct)

The time point at which signature validity is to be established.

Syntax

fn validation_moment(&self ) -> Result<String, SecureBlackboxError> 
fn set_validation_moment(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_validation_moment_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time).

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

widget_algorithm_caption property (PDFSigner Struct)

The caption of the signature widget property with information about the signature algorithm.

Syntax

fn widget_algorithm_caption(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_algorithm_caption(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_algorithm_caption_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"#auto"

Remarks

The caption of the signature widget field with information about the signature algorithm.

Data Type

String

widget_algorithm_info property (PDFSigner Struct)

Information about the algorithm to be shown on the signature widget.

Syntax

fn widget_algorithm_info(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_algorithm_info(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_algorithm_info_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"#auto"

Remarks

Information about the algorithm to be shown on the signature widget.

This property contains information about the algorithm to be displayed in the signature widget. Keep this property set to #auto to make the component generate the algorithm text automatically, in the form of "Algorithm/Key size", e.g. "RSA/1024 bits".

Data Type

String

widget_background_data property (PDFSigner Struct)

Contains/takes the data of the signature widget background bitmap.

Syntax

fn widget_background_data(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_widget_background_data(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_widget_background_data_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains/takes the data of the signature widget background bitmap.

Assign the widget background data (in the form of JPEG or JPEG2000 bytes) to this property.

Data Type

Vec

widget_background_height property (PDFSigner Struct)

Use this property to manually adjust the size of the stretched background picture in the vertical direction.

Syntax

fn widget_background_height(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_background_height(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_background_height_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"0"

Remarks

Use this property to manually adjust the size of the stretched background picture in the vertical direction.

Data Type

String

widget_background_image_height property (PDFSigner Struct)

The height of the background image in pixels.

Syntax

fn widget_background_image_height(&self ) -> Result<i32, SecureBlackboxError> 
fn set_widget_background_image_height(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The height of the background image in pixels.

It is important that this property matches the exact size of the image when a custom background is used. The width and height of the background image have no direct relation to the dimensions of the signature widget on the document page, and are only used to indicate the parameters of the image to the PDF processor. Big images will ultimately be squeezed to fit in the widget, and smaller ones stretched.

Data Type

i32

widget_background_image_type property (PDFSigner Struct)

The type of the image contained in BackgroundData .

Syntax

fn widget_background_image_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_widget_background_image_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // JPEG2000
1   // JPEG
2   // Custom

Default Value

0

Remarks

The type of the image contained in widget_background_data. The JPEG and JPEG2000 formats are currently supported.

Data Type

i32

widget_background_image_width property (PDFSigner Struct)

The width of the background image in pixels.

Syntax

fn widget_background_image_width(&self ) -> Result<i32, SecureBlackboxError> 
fn set_widget_background_image_width(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The width of the background image in pixels.

It is important that this property matches the exact size of the image when a custom background is used. The width and height of the background image have no direct relation to the dimensions of the signature widget on the document page, and are only used to indicate the parameters of the image to the PDF processor. Big images will ultimately be squeezed to fit in the widget, and smaller ones stretched.

Data Type

i32

widget_background_mask property (PDFSigner Struct)

Contains the background image mask.

Syntax

fn widget_background_mask(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_widget_background_mask(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_widget_background_mask_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the background image mask.

Masks provide a means for marking transparent areas on your signature widgets. Specifically, a transparency mask tells PDF viewing apps which pixels of the signature widget should be kept visible and which should be rendered transparent instead.

In most cases, you will need a unique mask that is tailored for your signature widget image. This is something that you will need to create yourself based on your preferences and the actual image design.

A mask is effectively a matrix of bits, with each bit corresponding to a pixel on your background bitmap. A bit is set to 1 if the corresponding pixel needs to be made transparent, or to 0 if it needs to be opaque.

To create the mask that can be passed to BackgroundMask, please follow the below procedure:

Go through your signature widget bitmap row by row, processing each row of pixels from left to right. For each row,

1. Start with an empty bit string.

2. For every pixel in a row, add a '1' bit if you want it to be transparent, or a '0' bit if you want it to be opaque.

3. Upon reaching the end of the row, append '0' bits to your bit string until the number of bits in it is a multiple of 8. This is because each row of pixels needs to be represented with a whole number of bytes.

4. Convert the bit string to a byte array by grouping every 8 bits into a byte.

Do the same for every row of pixels, and then concatenate the received byte arrays together. Pass the created byte array to BackgroundMask.

A small example. Imagine your image is 19 pixels wide and 3 pixels tall. Imagine you want to make it 'semi-transparent' by using a 'mesh' pattern. The mask will therefore look like this:

10101010 10101010 10100000 // first row

01010101 01010101 01000000 // second row

10101010 10101010 10100000 // third row

Note that the last 5 bits of each row are padding '0' bits and are ignored: you only need them to make each row contain a whole number of bytes. When converted to a byte string, this would look like

0xAA 0xAA 0xA0

0x55 0x55 0x40

0xAA 0xAA 0xA0

, or, if written as a byte array, (0xAA, 0xAA, 0xA0, 0x55, 0x55, 0x40, 0xAA, 0xAA, 0xA0): this is what you need to pass to BackgroundMask.

Data Type

Vec

widget_background_position property (PDFSigner Struct)

The position of the widget background.

Syntax

fn widget_background_position(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_background_position(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_background_position_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The position of the widget background.

Specifies the position of the background image.

The value may be:

The keyword value "center", which centers the image.

A pair of coordinates ("10 5.5"), in which one value defines X and the other defines Y starting from the bottom-left corner.

Data Type

String

widget_background_style property (PDFSigner Struct)

The style of the signature widget background.

Syntax

fn widget_background_style(&self ) -> Result<i32, SecureBlackboxError> 
fn set_widget_background_style(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoBackground
2   // Custom

Default Value

0

Remarks

The style of the signature widget background.

pwbsDefault uses the default image, pwbsNoBackground doesn't use a background image at all, and pwbsCustom expects the application to provide a custom background image.

Data Type

i32

widget_background_width property (PDFSigner Struct)

Use this property to manually adjust the horizontal size of the stretched background picture.

Syntax

fn widget_background_width(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_background_width(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_background_width_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"0"

Remarks

Use this property to manually adjust the horizontal size of the stretched background picture.

Data Type

String

widget_compress_widget_data property (PDFSigner Struct)

Whether the signature widget data should be compressed before saving.

Syntax

fn widget_compress_widget_data(&self ) -> Result<bool, SecureBlackboxError> 
fn set_widget_compress_widget_data(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Whether the signature widget data should be compressed before saving.

Data Type

bool

widget_custom_appearance property (PDFSigner Struct)

Contains a custom widget description in raw PDF graphic operators format.

Syntax

fn widget_custom_appearance(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_widget_custom_appearance(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_widget_custom_appearance_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains a custom widget description in raw PDF graphic operators format.

Use this property to provide a PDF stream describing the widget appearance.

Data Type

Vec

widget_custom_background_content_stream property (PDFSigner Struct)

Specifies a custom background content stream for the pwbsCustom BackgroundStyle .

Syntax

fn widget_custom_background_content_stream(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_custom_background_content_stream(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_custom_background_content_stream_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies a custom background content stream for the pwbsCustom widget_background_style.

Data Type

String

widget_custom_visual_status_matrix property (PDFSigner Struct)

Defines the custom visual status matrix.

Syntax

fn widget_custom_visual_status_matrix(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_custom_visual_status_matrix(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_custom_visual_status_matrix_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Defines the custom visual status matrix.

Use of this property makes sense only if a visual status icon is displayed over the signature (widget_show_visual_status). Prior to Acrobat 6, a signature's visual appearance was modified with a status icon, e.g., "valid" or "invalid". The visual status matrix is used to position the icon in the signature widget. If CustomVisualStatusMatrix is empty, the value of '0.25 0 0 0.25 0 0' is used.

Data Type

String

widget_date_format property (PDFSigner Struct)

The format string used to display the signing date and time in the signature widget.

Syntax

fn widget_date_format(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_date_format(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_date_format_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The format string used to display the signing date and time in the signature widget.

Leave this property empty (default value) to use the default formatting.

Use the "L" value to convert UTC time to local time using the default formatting, or use the "L:" prefix with a custom date time formatting string.

Data Type

String

widget_font_name property (PDFSigner Struct)

Specifies the font name for the signature text.

Syntax

fn widget_font_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_font_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_font_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Specifies the font name for the signature text.

Use this property to specify a Type 1 or TrueType font name for the signature text. If this property is empty, the widget uses the standard PDF Helvetica font.

The PDF format supports 14 standard Type 1 fonts, specifically: "Times-Roman", "Helvetica", "Courier", "Symbol", "Times-Bold", "Helvetica-Bold", "Courier-Bold", "ZapfDingbats", "Times-Italic", "Helvetica-Oblique", "Courier-Oblique", "Times-BoldItalic", "Helvetica-BoldOblique", "Courier-BoldOblique".

Standard Type 1 fonts are used as standard PDF fonts and are not embedded by the component. If the target document profile, such as PDF/A, requires fonts used in visible text to be embedded, specify a TrueType font.

For TrueType fonts, the component supports a full font name (e.g. "Times New Roman", "Arial Bold Italic"), a file name (e.g. "times.ttf", "arialbi.ttf"), or a full file path.

If a TrueType font is used, then a font subset is embedded into the PDF document.

The list of system TrueType font names that the component supports can be obtained using the do_action method with the "GetSystemFontNames" action ID.

Use the FontPaths configuration setting (accessed via config) to specify font search paths when a TrueType font is specified without a full file path. The FontPaths setting contains a CRLF-separated list of directories. Alternatively, specify the full path to the TrueType font file in this property.

Data Type

String

widget_handle property (PDFSigner Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn widget_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_widget_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

widget_header property (PDFSigner Struct)

Specifies the header text to put on the signature widget.

Syntax

fn widget_header(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_header(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_header_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"#auto"

Remarks

Specifies the header text to put on the signature widget. Keep this property set to #auto to make the component generate the header automatically.

Data Type

String

widget_hide_default_text property (PDFSigner Struct)

Switches off the generation of any headers for the signature widget.

Syntax

fn widget_hide_default_text(&self ) -> Result<bool, SecureBlackboxError> 
fn set_widget_hide_default_text(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Switches off the generation of any headers for the signature widget.

Data Type

bool

widget_ignore_existing_appearance property (PDFSigner Struct)

Tells the struct to discard any existing widget parameters when signing empty signature properties.

Syntax

fn widget_ignore_existing_appearance(&self ) -> Result<bool, SecureBlackboxError> 
fn set_widget_ignore_existing_appearance(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Tells the component to discard any existing widget parameters when signing empty signature fields.

IgnoreExistingAppearance only makes sense for signatures created by signing existing empty signature fields with pre-defined widget descriptions.

Data Type

bool

widget_invert_mask property (PDFSigner Struct)

Specifies whether BackgroundMask should be inverted.

Syntax

fn widget_invert_mask(&self ) -> Result<bool, SecureBlackboxError> 
fn set_widget_invert_mask(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether widget_background_mask should be inverted.

Set this property to flip all the bits in the mask, by making opaque all the bits declared by the mask as transparent, and making transparent all the bits declared as opaque.

Data Type

bool

widget_invisible property (PDFSigner Struct)

Controls whether the signature widget is visible on the page.

Syntax

fn widget_invisible(&self ) -> Result<bool, SecureBlackboxError> 
fn set_widget_invisible(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Controls whether the signature widget is visible on the page.

Data Type

bool

widget_pages_to_place_on property (PDFSigner Struct)

The page numbers on which the signature is shown.

Syntax

fn widget_pages_to_place_on(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_pages_to_place_on(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_pages_to_place_on_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The page numbers on which the signature is shown. This field supports a variety of syntaxes:

• A single page number: 3
• A comma-separated list of page numbers: 1,2,5,7
• The star 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.

The page numbers are expected to be provided in zero-based notation. That is, the index of 0 stands for the first page, the index of 1 for the second page, and so on.

Data Type

String

widget_position_anchor property (PDFSigner Struct)

The anchor to bind the position of the widget to.

Syntax

fn widget_position_anchor(&self ) -> Result<i32, SecureBlackboxError> 
fn set_widget_position_anchor(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // BottomLeft
2   // BottomRight
3   // TopLeft
4   // TopRight
5   // Center

Default Value

0

Remarks

The anchor to bind the position of the widget to.

Supported values are:

Data Type

i32

widget_render_options property (PDFSigner Struct)

This setting is a container for a selection of rendering options.

Syntax

fn widget_render_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_widget_render_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

8

Remarks

This setting is a container for a selection of rendering options. OR or NOT an option to include or exclude it from the bit mask.

Data Type

i32

widget_rotate property (PDFSigner Struct)

Specifies the rotation angle of the signature widget in degrees.

Syntax

fn widget_rotate(&self ) -> Result<i32, SecureBlackboxError> 
fn set_widget_rotate(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the rotation angle of the signature widget in degrees. Values of 0, 90, 180, and 270 are allowed.

Data Type

i32

widget_show_date property (PDFSigner Struct)

Whether to display the signing date and time details on the widget.

Syntax

fn widget_show_date(&self ) -> Result<bool, SecureBlackboxError> 
fn set_widget_show_date(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

Whether to display the signing date and time details on the widget.

Data Type

bool

widget_show_visual_status property (PDFSigner Struct)

Specifies whether to show the signature's status icon.

Syntax

fn widget_show_visual_status(&self ) -> Result<bool, SecureBlackboxError> 
fn set_widget_show_visual_status(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether to show the signature's status icon.

It is a good idea to avoid using the visual status icon, as described below:

According to the Digital Signature Appearances Adobe Acrobat SDK (May 2015), "Prior to Acrobat 6.0, signature appearances were manipulated at run-time in order to display the validity of the signature. The validity was shown as a graphic icon and with an additional, optional text message. The manipulated portions of the signature appearance were contained in layers n1, n3 and n4. Beginning with version 6, Acrobat does not maintain support for signature appearances that can be manipulated, though legacy signatures with these appearances may continue to display correctly. Use of layers n1, n3, and n4 is not recommended."

Data Type

bool

widget_signer_caption property (PDFSigner Struct)

Specifies the caption for the signer section on the signature widget.

Syntax

fn widget_signer_caption(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_signer_caption(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_signer_caption_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"#auto"

Remarks

Specifies the caption for the signer section on the signature widget.

The default value, which is used if the property is set to #auto, is "Signer: ".

Data Type

String

widget_signer_info property (PDFSigner Struct)

Provides custom signer information to put on the signature widget.

Syntax

fn widget_signer_info(&self ) -> Result<String, SecureBlackboxError> 
fn set_widget_signer_info(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_widget_signer_info_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"#auto"

Remarks

Provides custom signer information to put on the signature widget.

The standard signature widget allows for several short strings separated by CRLF. Keep this property set to #auto to make the component generate the signer text automatically.

Data Type

String

add_widget_custom_data method (PDFSigner Struct)

Adds a custom data to the signature widget.

Syntax

fn add_widget_custom_data(&self, custom_data : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to quickly add a custom data block that contains PDF graphics operators to your signature widget.

The method returns the index of the new custom text in the CustomText collection (accessed via config).

add_widget_text method (PDFSigner Struct)

Adds a text block to the signature widget.

Syntax

fn add_widget_text(&self, text : &str, x : i32, y : i32, font_size : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to quickly add a custom text block to your signature widget.

The method returns the index of the new custom text in the CustomText collection (accessed via config).

add_widget_text_ex method (PDFSigner Struct)

Adds a text block to the signature widget.

Syntax

fn add_widget_text_ex(&self, text : &str, settings : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add a custom text block to your signature widget.

Text represents the text string to add. Settings contains a list of parameters in the form of PARAM1=VALUE1;PARAM2=VALUE2;... or in JSON format.

The following parameters are supported:

The method returns the index of the new custom text in the CustomText collection (accessed via config).

attach_bytes method (PDFSigner Struct)

Adds an attachment to the PDF document.

Syntax

fn attach_bytes(&self, data : &[u8], obj_name : &str, file_name : &str, description : &str, sub_type : &str, c_date : &str, m_date : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to add an attachment (embedded file) to a PDF document.

attach_file method (PDFSigner Struct)

Adds an attachment to the PDF document.

Syntax

fn attach_file(&self, path : &str, obj_name : &str, file_name : &str, description : &str, sub_type : &str, c_date : &str, m_date : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to add an attachment (embedded file) to a PDF document.

close method (PDFSigner Struct)

Closes an opened document.

Syntax

fn close(&self, save_changes : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to close a previously opened document. Set SaveChanges to true to apply any changes made.

config method (PDFSigner Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

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.

do_action method (PDFSigner Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

The PDFSigner struct ActionIDs:

Use "AddImage" action to add an image to the foreground layer. The following parameters are supported:

Parameters ImageData, ImageWidth, ImageHeight, ImageType, X, Y, Width and Height are required.

Sample code to add a JPEG image of size 100px x 100px and place it in position (10, 10) with an image size (30, 30): Signer.DoAction("AddImage", "ImageData=" + Utils.HexEncode(BinaryImageData) + "; ImageWidth=100; ImageHeight=100; ImageType=jpeg; X=10; Y=10; Width=30; Height=30");

Use "GetTextWidth" action to calculate the width of the given text for a specific font. The following parameters are supported:

Sample code: Signer.DoAction("GetTextWidth", "Text=Lorem Ipsum; FontSize=10; FontName=Arial Bold Italic");

Use "GetSystemFontNames" action to get a CRLF-separated list of system TrueType font names that the component supports.

Use "IsAllGlyphsAvailable" action to check if all glyphs that correspond to the given text are available for a specific font. The following parameters are required:

For standard Type 1 fonts this action always returns a "true" value.

extract_async_data method (PDFSigner Struct)

Extracts user data from the DC signing service response.

Syntax

fn extract_async_data(&self, async_reply : &str) ->  Result<String, SecureBlackboxError>

Remarks

Call this method before finalizing the asynchronous signing process to extract the data passed to the ExternalCrypto.Data property on the pre-signing stage.

The Data parameter can be used to pass some state or document identifier along with the signing request from the pre-signing to the completion async stage.

get_attached_bytes method (PDFSigner Struct)

Saves a PDF attachment to a byte array.

Syntax

fn get_attached_bytes(&self, index : i32) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to retrieve the contents of an attached file as a byte array.

get_attached_file method (PDFSigner Struct)

Saves a PDF attachment to a file.

Syntax

fn get_attached_file(&self, index : i32, path : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to retrieve the contents of an attached file and save it to a file.

open method (PDFSigner Struct)

Opens a document for signing or updating.

Syntax

fn open(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to open a document for signing or updating. When finished, call close to complete or discard the operation.

reset method (PDFSigner Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

revalidate method (PDFSigner Struct)

Revalidates a signature in accordance with current settings.

Syntax

fn revalidate(&self, sig_label : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to re-validate a signature in the opened PDF document.

select_info method (PDFSigner Struct)

Select signature information for a specific entity.

Syntax

fn select_info(&self, entity_label : &str, info_type : i32, clear_selection : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to select (or filter) signature-related information for a specific signature element.

Provide the unique label of the entity that you are interested in via the EntityLabel parameter. Use one of the following filters, or their combination, to specify what information you are interested in:

Following the call, the relevant pieces of information will be copied to the respective component properties (Certificates, CRLs, OCSPs). Note that you can accumulate information in the properties by making repeated calls to select_info and keeping ClearSelection set to false.

This method is useful if you would like to read/display detailed information about a particular signature or timestamp.

sign method (PDFSigner Struct)

Signs a PDF document.

Syntax

fn sign(&self) -> Result<(), SecureBlackboxError>

Remarks

Call this method to sign the document referenced by the input_file (or input_stream) property. The document will be signed with signing_certificate as configured in new_signature, and saved in output_file (output_stream).

Use trusted_certificates, known_certificates, revocation_check, offline_mode and other properties of the struct to adjust chain validation parameters. After the signing, the chain validation log will be available in the property.

sign_async_begin method (PDFSigner Struct)

Initiates the asynchronous signing operation.

Syntax

fn sign_async_begin(&self) ->  Result<String, SecureBlackboxError>

Remarks

When using the DC framework, call this method to initiate the asynchronous signing process. Upon completion, a pre-signed copy of the document will be saved in output_file (or output_stream). Keep the pre-signed copy somewhere local, and pass the returned string ('the request state') to the DC processor for handling.

Upon receiving the response state from the DC processor, assign the path to the pre-signed copy to input_file (or input_stream), and call sign_async_end to finalize the signing.

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the signing_certificate property.

Use the ExternalCrypto.AsyncDocumentID property to supply a unique document ID to include in the request. This is helpful when creating batches of multiple async requests, as it allows you to pass the whole response batch to sign_async_end and expect it to recover the correct response from the batch automatically.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the sign_async_begin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth struct), which processes it and produces a matching signature state. The async state produced by the server is then passed to the sign_async_end method.

There are some conditions that should be met when signing PDF documents asynchronously. The advanced PDF signature levels, specifically BES, EPES, and LTV, require that the 'signingCertificate' attribute is included in the signature. This can only be satisfied if either external_crypto is configured to use the asmdPKCS7 method, or the public copy of the signing certificate is provided on the pre-signing stage.

Please note that you will still be able to sign a document with the asmdPKCS1 method and no public copy of the certificate provided (resulting in the omission of the 'signingCertificate' attribute from the signature); however, most modern PDF processors will reject such signatures as invalid or non-compliant.

sign_async_end method (PDFSigner Struct)

Completes the asynchronous signing operation.

Syntax

fn sign_async_end(&self, async_reply : &str) -> Result<(), SecureBlackboxError>

Remarks

When using the DC framework, call this method upon receiving the response state from the DC processor to complete the asynchronous signing process.

Before calling this method, assign the path to the pre-signed copy of the document obtained from the prior sign_async_begin call to input_file (or input_stream). The method will embed the signature into the pre-signed document, and save the complete signed document to output_file (or output_stream).

Note that depending on the signing method and DC configuration used, you may still need to provide the public part of the signing certificate via the signing_certificate property.

Use the ExternalCrypto.AsyncDocumentID parameter to pass a specific document ID if using batched AsyncReply. If used, it should match the value provided on the pre-signing (sign_async_begin) stage.

AsyncState is a message of the distributed cryptography (DC) protocol. The DC protocol is based on the exchange of async states between a DC client (an application that wants to sign a PDF, XML, or Office document) and a DC server (an application that controls access to the private key). An async state can carry one or more signing requests, comprised of document hashes, or one or more signatures produced over those hashes.

In a typical scenario you get a client-side async state from the sign_async_begin method. This state contains document hashes to be signed on the DC server side. You then send the async state to the DC server (often represented by the DCAuth struct), which processes it and produces a matching signature state. The async state produced by the server is then passed to the sign_async_end method.

sign_external method (PDFSigner Struct)

Signs the document using an external signing facility.

Syntax

fn sign_external(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to create a PDF signature using an external signing facility for the cryptographic computations. SignExternal delegates the low-level signing operation to an external, remote, or custom signing engine. This method is useful if the signature has to be made by a device accessible through a custom or non-standard signing interface.

When all preparations are done and the hash is computed, the struct fires the on_external_sign event which allows the hash value to be passed for signing.

update method (PDFSigner Struct)

Updates a signature.

Syntax

fn update(&self, sig_label : &str) -> Result<(), SecureBlackboxError>

Remarks

PDF signatures may be updated from time to time by embedding newer/missing revocation information. The update approach is typically used to extend the validity of an LTV signature. Set SigLabel to the label of the signature field to update.

Updating is typically accompanied with a document timestamping operation. Set timestamp_server to have the struct obtain and embed a document timestamp for you.

Before calling this method, provide the signed document via the input_file (or input_stream) property. The updated document will be saved to output_file (or output_stream).

on_chain_element_download event (PDFSigner Struct)

Fires when there is a need to download a chain element from an online source.

Syntax

// PDFSignerChainElementDownloadEventArgs carries the PDFSigner ChainElementDownload event's parameters.
pub struct PDFSignerChainElementDownloadEventArgs {
  fn kind(&self) -> i32
  fn cert_rdn(&self) -> &String
  fn ca_cert_rdn(&self) -> &String
  fn location(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// PDFSignerChainElementDownloadEvent defines the signature of the PDFSigner ChainElementDownload event's handler function.
pub trait PDFSignerChainElementDownloadEvent {
  fn on_chain_element_download(&self, sender : PDFSigner, e : &mut PDFSignerChainElementDownloadEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_chain_element_download(&self) -> &'a dyn PDFSignerChainElementDownloadEvent;
  pub fn set_on_chain_element_download(&mut self, value : &'a dyn PDFSignerChainElementDownloadEvent);
  ...
}

Remarks

Subscribe to this event to be notified about validation element retrievals. Use the Action parameter to suppress the download if required.

on_chain_element_needed event (PDFSigner Struct)

Fires when an element required to validate the chain was not located.

Syntax

// PDFSignerChainElementNeededEventArgs carries the PDFSigner ChainElementNeeded event's parameters.
pub struct PDFSignerChainElementNeededEventArgs {
  fn kind(&self) -> i32
  fn cert_rdn(&self) -> &String
  fn ca_cert_rdn(&self) -> &String
}

// PDFSignerChainElementNeededEvent defines the signature of the PDFSigner ChainElementNeeded event's handler function.
pub trait PDFSignerChainElementNeededEvent {
  fn on_chain_element_needed(&self, sender : PDFSigner, e : &mut PDFSignerChainElementNeededEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_chain_element_needed(&self) -> &'a dyn PDFSignerChainElementNeededEvent;
  pub fn set_on_chain_element_needed(&mut self, value : &'a dyn PDFSignerChainElementNeededEvent);
  ...
}

Remarks

Subscribe to this event to be notified about missing validation elements. Use the known_crls, known_certificates, and known_ocsps properties in the event handler to provide the missing piece.

on_chain_validated event (PDFSigner Struct)

Reports the completion of a certificate chain validation.

Syntax

// PDFSignerChainValidatedEventArgs carries the PDFSigner ChainValidated event's parameters.
pub struct PDFSignerChainValidatedEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn subject_rdn(&self) -> &String
  fn validation_result(&self) -> i32
  fn validation_details(&self) -> i32
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFSignerChainValidatedEvent defines the signature of the PDFSigner ChainValidated event's handler function.
pub trait PDFSignerChainValidatedEvent {
  fn on_chain_validated(&self, sender : PDFSigner, e : &mut PDFSignerChainValidatedEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_chain_validated(&self) -> &'a dyn PDFSignerChainValidatedEvent;
  pub fn set_on_chain_validated(&mut self, value : &'a dyn PDFSignerChainValidatedEvent);
  ...
}

Remarks

This event is fired when a certificate chain validation routine completes. SubjectRDN identifies the owner of the validated certificate.

ValidationResult set to 0 (zero) indicates successful chain validation.

Any other value reports a failure, and ValidationDetails provides more details on its reasons.

on_chain_validation_progress event (PDFSigner Struct)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Syntax

// PDFSignerChainValidationProgressEventArgs carries the PDFSigner ChainValidationProgress event's parameters.
pub struct PDFSignerChainValidationProgressEventArgs {
  fn event_kind(&self) -> &String
  fn cert_rdn(&self) -> &String
  fn ca_cert_rdn(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// PDFSignerChainValidationProgressEvent defines the signature of the PDFSigner ChainValidationProgress event's handler function.
pub trait PDFSignerChainValidationProgressEvent {
  fn on_chain_validation_progress(&self, sender : PDFSigner, e : &mut PDFSignerChainValidationProgressEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_chain_validation_progress(&self) -> &'a dyn PDFSignerChainValidationProgressEvent;
  pub fn set_on_chain_validation_progress(&mut self, value : &'a dyn PDFSignerChainValidationProgressEvent);
  ...
}

Remarks

Subscribe to this event to be notified about chain validation progress. Use the Action parameter to alter the validation flow.

The EventKind parameter reports the nature of the event being reported. The CertRDN and CACertRDN parameters report the distinguished names of the certificates that are relevant for the event invocation (one or both can be empty, depending on EventKind). Use the Action parameter to adjust the validation flow.

on_document_loaded event (PDFSigner Struct)

This event is fired when the document has been loaded into memory.

Syntax

// PDFSignerDocumentLoadedEventArgs carries the PDFSigner DocumentLoaded event's parameters.
pub struct PDFSignerDocumentLoadedEventArgs {
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFSignerDocumentLoadedEvent defines the signature of the PDFSigner DocumentLoaded event's handler function.
pub trait PDFSignerDocumentLoadedEvent {
  fn on_document_loaded(&self, sender : PDFSigner, e : &mut PDFSignerDocumentLoadedEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_document_loaded(&self) -> &'a dyn PDFSignerDocumentLoadedEvent;
  pub fn set_on_document_loaded(&mut self, value : &'a dyn PDFSignerDocumentLoadedEvent);
  ...
}

Remarks

The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the pages information to find the optimal position for the signature widget.

Set Cancel to true to terminate document processing on this stage.

on_encrypted event (PDFSigner Struct)

Notifies the application that the document is encrypted and provides recipient certificate details if asymmetric encryption was used to encrypt the document.

Syntax

// PDFSignerEncryptedEventArgs carries the PDFSigner Encrypted event's parameters.
pub struct PDFSignerEncryptedEventArgs {
  fn cert_used(&self) -> bool
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn need_credential(&self) -> bool
  fn skip_this(&self) -> bool
  fn set_skip_this(&self, value : bool)
}

// PDFSignerEncryptedEvent defines the signature of the PDFSigner Encrypted event's handler function.
pub trait PDFSignerEncryptedEvent {
  fn on_encrypted(&self, sender : PDFSigner, e : &mut PDFSignerEncryptedEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_encrypted(&self) -> &'a dyn PDFSignerEncryptedEvent;
  pub fn set_on_encrypted(&mut self, value : &'a dyn PDFSignerEncryptedEvent);
  ...
}

Remarks

The struct fires this event when processing encrypted documents to report the fact of encryption and pass certificate parameters to the user.

This event fires repeatedly for each encryption mechanism used in the document until the user provides the correct credential via the decryption_certificate or password property (depending on the encryption method used), or sets SkipThis to true.

The CertUsed parameter specifies the encryption method used. If set to true, it indicates that the document uses asymmetric (certificate-based) encryption. In that case, the IssuerRDN, SerialNumber, and SubjectKeyID parameters provide the details of the encryption certificate. Note that the document can be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will invoke its own on_encrypted event loop.

CertUsed set to false indicates that the document uses password encryption. In this case, provide the password via the password property.

The NeedCredential parameter specifies whether the correct credential is already available to the struct or still needs to be set. One example where NeedCredential would be set to false is where it had been provided by the application prior to processing the document (e.g. by setting the password property to a known pre-defined value). If NeedCredential is set to true, you must provide the valid credential for the decryption process to succeed.

on_error event (PDFSigner Struct)

Information about errors during signing/validation.

Syntax

// PDFSignerErrorEventArgs carries the PDFSigner Error event's parameters.
pub struct PDFSignerErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PDFSignerErrorEvent defines the signature of the PDFSigner Error event's handler function.
pub trait PDFSignerErrorEvent {
  fn on_error(&self, sender : PDFSigner, e : &mut PDFSignerErrorEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_error(&self) -> &'a dyn PDFSignerErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PDFSignerErrorEvent);
  ...
}

Remarks

The event is fired in case of exceptional conditions during PDF processing.

ErrorCode contains an error code and Description contains a textual description of the error.

on_external_decrypt event (PDFSigner Struct)

Handles remote or external decryption.

Syntax

// PDFSignerExternalDecryptEventArgs carries the PDFSigner ExternalDecrypt event's parameters.
pub struct PDFSignerExternalDecryptEventArgs {
  fn operation_id(&self) -> &String
  fn algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn encrypted_data(&self) -> &String
  fn data(&self) -> &String
  fn set_data(&self, value : &str)
  fn set_data_ref(&self, value : &String)
}

// PDFSignerExternalDecryptEvent defines the signature of the PDFSigner ExternalDecrypt event's handler function.
pub trait PDFSignerExternalDecryptEvent {
  fn on_external_decrypt(&self, sender : PDFSigner, e : &mut PDFSignerExternalDecryptEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_external_decrypt(&self) -> &'a dyn PDFSignerExternalDecryptEvent;
  pub fn set_on_external_decrypt(&mut self, value : &'a dyn PDFSignerExternalDecryptEvent);
  ...
}

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The struct uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

on_external_sign event (PDFSigner Struct)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

// PDFSignerExternalSignEventArgs carries the PDFSigner ExternalSign event's parameters.
pub struct PDFSignerExternalSignEventArgs {
  fn operation_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn data(&self) -> &String
  fn signed_data(&self) -> &String
  fn set_signed_data(&self, value : &str)
  fn set_signed_data_ref(&self, value : &String)
}

// PDFSignerExternalSignEvent defines the signature of the PDFSigner ExternalSign event's handler function.
pub trait PDFSignerExternalSignEvent {
  fn on_external_sign(&self, sender : PDFSigner, e : &mut PDFSignerExternalSignEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_external_sign(&self) -> &'a dyn PDFSignerExternalSignEvent;
  pub fn set_on_external_sign(&mut self, value : &'a dyn PDFSignerExternalSignEvent);
  ...
}

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the struct via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact struct being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The struct uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

on_notification event (PDFSigner Struct)

This event notifies the application about an underlying control flow event.

Syntax

// PDFSignerNotificationEventArgs carries the PDFSigner Notification event's parameters.
pub struct PDFSignerNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// PDFSignerNotificationEvent defines the signature of the PDFSigner Notification event's handler function.
pub trait PDFSignerNotificationEvent {
  fn on_notification(&self, sender : PDFSigner, e : &mut PDFSignerNotificationEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_notification(&self) -> &'a dyn PDFSignerNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn PDFSignerNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted.

This struct can fire this event with the following EventID values:

on_pre_render_widget event (PDFSigner Struct)

Fires when a signature widget is ready to be written to the document.

Syntax

// PDFSignerPreRenderWidgetEventArgs carries the PDFSigner PreRenderWidget event's parameters.
pub struct PDFSignerPreRenderWidgetEventArgs {
  fn add_another(&self) -> bool
  fn set_add_another(&self, value : bool)
  fn reset_another(&self) -> bool
  fn set_reset_another(&self, value : bool)
}

// PDFSignerPreRenderWidgetEvent defines the signature of the PDFSigner PreRenderWidget event's handler function.
pub trait PDFSignerPreRenderWidgetEvent {
  fn on_pre_render_widget(&self, sender : PDFSigner, e : &mut PDFSignerPreRenderWidgetEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_pre_render_widget(&self) -> &'a dyn PDFSignerPreRenderWidgetEvent;
  pub fn set_on_pre_render_widget(&mut self, value : &'a dyn PDFSignerPreRenderWidgetEvent);
  ...
}

Remarks

The struct fires this event when it is ready to insert a new instance of the signature widget to the document. This event is fired repeatedly until the event handler sets the AddAnother parameter to false, allowing your application to create as many copies of the signature widget as required.

You can use this event handler to adjust the look of each widget copy. Set the ResetAnother parameter to true to automatically clean up all the existing widget settings after the current widget is saved. Setting ResetAnother to true will let you start every new widget from scratch. Keeping it set to false would result in every new widget looking the same as the previous one.

on_signature_found event (PDFSigner Struct)

Signifies the start of signature validation.

Syntax

// PDFSignerSignatureFoundEventArgs carries the PDFSigner SignatureFound event's parameters.
pub struct PDFSignerSignatureFoundEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn cert_found(&self) -> bool
  fn validate_signature(&self) -> bool
  fn set_validate_signature(&self, value : bool)
  fn validate_chain(&self) -> bool
  fn set_validate_chain(&self, value : bool)
}

// PDFSignerSignatureFoundEvent defines the signature of the PDFSigner SignatureFound event's handler function.
pub trait PDFSignerSignatureFoundEvent {
  fn on_signature_found(&self, sender : PDFSigner, e : &mut PDFSignerSignatureFoundEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_signature_found(&self) -> &'a dyn PDFSignerSignatureFoundEvent;
  pub fn set_on_signature_found(&mut self, value : &'a dyn PDFSignerSignatureFoundEvent);
  ...
}

Remarks

This event tells the application that signature validation is about to start, and provides the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters. It fires for every signature located in the verified document or message.

The CertFound parameter is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

on_signature_validated event (PDFSigner Struct)

Marks the completion of the signature validation routine.

Syntax

// PDFSignerSignatureValidatedEventArgs carries the PDFSigner SignatureValidated event's parameters.
pub struct PDFSignerSignatureValidatedEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn validation_result(&self) -> i32
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFSignerSignatureValidatedEvent defines the signature of the PDFSigner SignatureValidated event's handler function.
pub trait PDFSignerSignatureValidatedEvent {
  fn on_signature_validated(&self, sender : PDFSigner, e : &mut PDFSignerSignatureValidatedEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_signature_validated(&self) -> &'a dyn PDFSignerSignatureValidatedEvent;
  pub fn set_on_signature_validated(&mut self, value : &'a dyn PDFSignerSignatureValidatedEvent);
  ...
}

Remarks

This event is fired upon the completion of the signature validation routine, and reports the respective validation result.

Use the IssuerRDN, SerialNumber, and/or SubjectKeyID parameters to identify the signing certificate.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a validation failure.

on_timestamp_found event (PDFSigner Struct)

Signifies the start of a timestamp validation routine.

Syntax

// PDFSignerTimestampFoundEventArgs carries the PDFSigner TimestampFound event's parameters.
pub struct PDFSignerTimestampFoundEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn cert_found(&self) -> bool
  fn validate_timestamp(&self) -> bool
  fn set_validate_timestamp(&self, value : bool)
  fn validate_chain(&self) -> bool
  fn set_validate_chain(&self, value : bool)
}

// PDFSignerTimestampFoundEvent defines the signature of the PDFSigner TimestampFound event's handler function.
pub trait PDFSignerTimestampFoundEvent {
  fn on_timestamp_found(&self, sender : PDFSigner, e : &mut PDFSignerTimestampFoundEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_timestamp_found(&self) -> &'a dyn PDFSignerTimestampFoundEvent;
  pub fn set_on_timestamp_found(&mut self, value : &'a dyn PDFSignerTimestampFoundEvent);
  ...
}

Remarks

This event fires for every timestamp identified during signature processing, and reports the details about the signer's certificate via its IssuerRDN, SerialNumber, and SubjectKeyID parameters.

The CertFound parameter is set to True if the struct has found the needed certificate in one of the known locations, and to False otherwise, in which case you must provide it manually via the known_certificates property.

Just like with signature validation, timestamp validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with the and properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

on_timestamp_request event (PDFSigner Struct)

Fires when the struct is ready to request a timestamp from an external TSA.

Syntax

// PDFSignerTimestampRequestEventArgs carries the PDFSigner TimestampRequest event's parameters.
pub struct PDFSignerTimestampRequestEventArgs {
  fn tsa(&self) -> &String
  fn timestamp_request(&self) -> &String
  fn timestamp_response(&self) -> &String
  fn set_timestamp_response(&self, value : &str)
  fn set_timestamp_response_ref(&self, value : &String)
  fn suppress_default(&self) -> bool
  fn set_suppress_default(&self, value : bool)
}

// PDFSignerTimestampRequestEvent defines the signature of the PDFSigner TimestampRequest event's handler function.
pub trait PDFSignerTimestampRequestEvent {
  fn on_timestamp_request(&self, sender : PDFSigner, e : &mut PDFSignerTimestampRequestEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_timestamp_request(&self) -> &'a dyn PDFSignerTimestampRequestEvent;
  pub fn set_on_timestamp_request(&mut self, value : &'a dyn PDFSignerTimestampRequestEvent);
  ...
}

Remarks

Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The TSA parameter indicates the timestamping service being used. It matches the value passed to the timestamp_server property. Set the SuppressDefault parameter to true if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned TimestampResponse parameter is not empty.

on_timestamp_validated event (PDFSigner Struct)

Reports the completion of the timestamp validation routine.

Syntax

// PDFSignerTimestampValidatedEventArgs carries the PDFSigner TimestampValidated event's parameters.
pub struct PDFSignerTimestampValidatedEventArgs {
  fn index(&self) -> i32
  fn entity_label(&self) -> &String
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn time(&self) -> &String
  fn validation_result(&self) -> i32
  fn chain_validation_result(&self) -> i32
  fn chain_validation_details(&self) -> i32
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// PDFSignerTimestampValidatedEvent defines the signature of the PDFSigner TimestampValidated event's handler function.
pub trait PDFSignerTimestampValidatedEvent {
  fn on_timestamp_validated(&self, sender : PDFSigner, e : &mut PDFSignerTimestampValidatedEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_timestamp_validated(&self) -> &'a dyn PDFSignerTimestampValidatedEvent;
  pub fn set_on_timestamp_validated(&mut self, value : &'a dyn PDFSignerTimestampValidatedEvent);
  ...
}

Remarks

This event is fired upon the completion of the timestamp validation routine, and reports the respective validation result.

ValidationResult is set to 0 if the validation has been successful, or to a non-zero value in case of a failure.

on_tls_cert_needed event (PDFSigner Struct)

Fires when a remote TLS party requests a client certificate.

Syntax

// PDFSignerTLSCertNeededEventArgs carries the PDFSigner TLSCertNeeded event's parameters.
pub struct PDFSignerTLSCertNeededEventArgs {
  fn host(&self) -> &String
  fn ca_names(&self) -> &String
}

// PDFSignerTLSCertNeededEvent defines the signature of the PDFSigner TLSCertNeeded event's handler function.
pub trait PDFSignerTLSCertNeededEvent {
  fn on_tls_cert_needed(&self, sender : PDFSigner, e : &mut PDFSignerTLSCertNeededEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_tls_cert_needed(&self) -> &'a dyn PDFSignerTLSCertNeededEvent;
  pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn PDFSignerTLSCertNeededEvent);
  ...
}

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the tls_client_chain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the on_tls_handshake event for the given host and, if the certificate was accepted, succeeded by the on_tls_established event.

on_tls_cert_validate event (PDFSigner Struct)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

// PDFSignerTLSCertValidateEventArgs carries the PDFSigner TLSCertValidate event's parameters.
pub struct PDFSignerTLSCertValidateEventArgs {
  fn server_host(&self) -> &String
  fn server_ip(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// PDFSignerTLSCertValidateEvent defines the signature of the PDFSigner TLSCertValidate event's handler function.
pub trait PDFSignerTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : PDFSigner, e : &mut PDFSignerTLSCertValidateEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn PDFSignerTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn PDFSignerTLSCertValidateEvent);
  ...
}

Remarks

This event is fired during a TLS handshake. Use the tls_server_chain property to access the certificate chain. In general, structs may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the struct, and can be adjusted if needed.

on_tls_established event (PDFSigner Struct)

Fires when a TLS handshake with Host successfully completes.

Syntax

// PDFSignerTLSEstablishedEventArgs carries the PDFSigner TLSEstablished event's parameters.
pub struct PDFSignerTLSEstablishedEventArgs {
  fn host(&self) -> &String
  fn version(&self) -> &String
  fn ciphersuite(&self) -> &String
  fn connection_id(&self) -> &[u8]
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// PDFSignerTLSEstablishedEvent defines the signature of the PDFSigner TLSEstablished event's handler function.
pub trait PDFSignerTLSEstablishedEvent {
  fn on_tls_established(&self, sender : PDFSigner, e : &mut PDFSignerTLSEstablishedEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_tls_established(&self) -> &'a dyn PDFSignerTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn PDFSignerTLSEstablishedEvent);
  ...
}

Remarks

The struct uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

on_tls_handshake event (PDFSigner Struct)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

// PDFSignerTLSHandshakeEventArgs carries the PDFSigner TLSHandshake event's parameters.
pub struct PDFSignerTLSHandshakeEventArgs {
  fn host(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// PDFSignerTLSHandshakeEvent defines the signature of the PDFSigner TLSHandshake event's handler function.
pub trait PDFSignerTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : PDFSigner, e : &mut PDFSignerTLSHandshakeEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn PDFSignerTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn PDFSignerTLSHandshakeEvent);
  ...
}

Remarks

The struct uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the on_tls_established event. If the server chooses to request a client certificate, the on_tls_cert_needed event will also be fired.

on_tls_shutdown event (PDFSigner Struct)

Reports the graceful closure of a TLS connection.

Syntax

// PDFSignerTLSShutdownEventArgs carries the PDFSigner TLSShutdown event's parameters.
pub struct PDFSignerTLSShutdownEventArgs {
  fn host(&self) -> &String
}

// PDFSignerTLSShutdownEvent defines the signature of the PDFSigner TLSShutdown event's handler function.
pub trait PDFSignerTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : PDFSigner, e : &mut PDFSignerTLSShutdownEventArgs);
}

impl <'a> PDFSigner<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn PDFSignerTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn PDFSignerTLSShutdownEvent);
  ...
}

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (PDFSigner 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.

PDFSigner Config Settings

Base Config Settings

Trappable Errors (PDFSigner Struct)

PDFSigner Errors