Struct secureblackbox::CAdESSigner

Properties   Methods   Events   Config Settings   Errors  

The CAdESSigner struct creates CAdES- and CMS-compliant electronic signatures.

Syntax

secureblackbox::CAdESSigner

Remarks

CAdESSigner can sign documents and files in compliance with CMS Advanced Electronic Signatures (CAdES) specification. Originally developed by ETSI on the basis of PKCS#7 format and initially adopted in the European Union, CAdES has quickly become a recognized international standard for signing all sorts of electronic documents. CAdESSigner signer = new CAdESSigner(); signer.getNewSignature().setHashAlgorithm("SHA512"); // Default hashing algorithm SHA256 signer.getNewSignature().setLevel(CAdESSignature.aslBaselineT); // Set the level of the signature // Select the file which will be signed signer.setInputFile("MyExe.exe"); // Set the path where the signed file will be saved signer.setOutputFile("signedFile.scs"); // Specify the certificate that shall be used for signing signer.setSigningCertificate(new Certificate("cert.pfx","password")); // Provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature signer.setTimestampServer("http://freetsa.org/tsr"); signer.sign(); // Sign

Besides being a signature standard in its own right, CAdES is used as part of other higher-level signature standards, such as PAdES or S/MIME. It provides a convenient framework for creating short-lived and long-term signatures over any kind of documents, and is now used by governments, healthcare providers, banks, and independent service providers all across the globe.

Standards and technologies supported

CAdESSigner offers the following signing capabilities:

• Create and upgrade CAdES signatures in accordance with the most recent CAdES specification (ETSI EN 319 122). Some features from older versions are also supported.
• All profiles are supported (BES, EPES, T, C, X, XL, A, including Baseline and Extended variants).
• Timestamping using external TSAs.
• All industry-standard cryptographic algorithms (RSA, ECDSA, SHA256-512, and many others).

Configuring the signature parameters

Configuring CAdESSigner to make it produce a signature of the right type is the main task you would need to perform in your code. Normally the service or software you will be communicating your signed 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:

• The signature Level (such BES, T, XL, A, or XLong). This can be passed as the Level parameter of the sign method.
• Whether the signature should be detached or enveloping: this can be adjusted via the Detached parameter of the sign method.
• When creating a timestamped signature (such as T or A), provide the address of your online TSA service via timestamp_server property.
• When creating long-term signatures that include the signing chain and validation material, tune up validation parameters via revocation_check, offline_mode, and ignore_chain_validation_errors properties.

In some circumstances you will also need to adjust the following lower-level settings:

• Set claimed_signing_time to include the local signature creation time (not timestamped by a TTP).
• Specify EPES signature parameters via new_sig_policy_hash, new_sig_policy_hash_algorithm, new_sig_policy_id, and new_sig_policy_uri properties.
• Provide the hash algorithm via the hash_algorithm property.

Signing certificates

CAdESSigner 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 CertificateManager and CertificateStorage components to access the signing certificate. Assign the certificate to signing_certificate property, and optionally provide the remainder of its chain via 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 component 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 timestamping and upgrading signatures, since this type of operation does not involve the signing private key.

Signing a file

Now that you have set up all signature properties and attached the signing certificate, it is time to proceed to signing. You can provide the input document in one of the following forms: as a file (assign the path to input_file property), as a stream (assign to 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 completes.

Having set up the input and output (unless using output_bytes, which should be read later), call the component's sign method, passing the desired signature level and type as parameters. 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 CAdES-BES or B-B variant), or it may involve advanced chain validation routines (CAdES-XL or -A). During the latter the component 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 component will contact it too to timestamp the new signature.

During the signing CAdESSigner may fire events to let your code know of certain conditions. It may fire on_tls_cert_validate if one of the HTTP endpoints involved in the operation (which may be a CRL, OCSP, or TSA service) works over TLS and needs its certificate to be validated.

Apart from signing, CAdESSigner can perform operations on signatures of other kinds. Use upgrade method to upgrade an existing CAdES signature to a higher level (e.g. BES to XL). Use timestamp to add a generic or validation timestamp to an existing signature. Use the countersign method to add a countersignature to an existing signature. For any of these operations the input should constitute a valid CAdES signature.

External signing and DCAuth

CAdESSigner, like many other components 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 component 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 on_external_sign event. Your event handler needs to sign the hash with the private key and return the created signature back to the component - 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-own 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 CAdESSigner - initiates the operation using 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 CAdESSigner 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, 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 controls, 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 CAdESSigner struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of CAdESSigner 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.

auto_validate_signatures property (CAdESSigner Struct)

Specifies whether CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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

data_bytes property (CAdESSigner Struct)

A byte array containing the external data source.

Syntax

fn data_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_data_bytes(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_data_bytes_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Use this property to provide external data source for detached signatures in the form of a byte array.

Data Type

Vec

data_file property (CAdESSigner Struct)

A path to a file containing an external data source.

Syntax

fn data_file(&self ) -> Result<String, SecureBlackboxError> 
fn set_data_file(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_data_file_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to provide an external data source for detached signatures. This property should only be assigned when countersigning or timestamping existing detached signatures. In this case the detached signature should be provided via input_file, and the corresponding detached data via this property.

Data Type

String

data_is_hash property (CAdESSigner Struct)

Specifies whether the data source contains the hash of the data or the actual data.

Syntax

fn data_is_hash(&self ) -> Result<bool, SecureBlackboxError> 
fn set_data_is_hash(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Use this property to tell the component whether the data source contains the actual data or its hash.

Data Type

bool

detached property (CAdESSigner Struct)

Specifies whether a detached signature should be produced or verified.

Syntax

fn detached(&self ) -> Result<bool, SecureBlackboxError> 
fn set_detached(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Use this property to specify whether a detached signature should be produced or verified.

When this property is set to "true" value, the data will be detached from the signature.

If this property is set to "true" value, the user must provide the detached content via the data_file or data_stream or data_bytes properties.

When Detached is set to "false" value, the data is included with the signature.

Data Type

bool

external_crypto_async_document_id property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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

extract_content property (CAdESSigner Struct)

Specifies whether a message content should be extracted.

Syntax

fn extract_content(&self ) -> Result<bool, SecureBlackboxError> 
fn set_extract_content(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Use this property to specify whether a message content should be extracted when a signature is loaded. This applies only to non-detached signatures with embedded data.

When this property is set to "true" value, the message content will be extracted from the signature.

The user must provide the output_file or output_stream properties with a filename or stream where to save the message content, if none is provided then message content is returned via output_bytes property.

Data Type

bool

fips_mode property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner Struct)

A path to a file containing the data 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 the data to work on. In case of the first-time signing, point this property to your data file. If countersigning, upgrading, or timestamping an existing signature, provide your existing signature file.

If updating a detached signature, you might need to provide the original data via data_file property.

The data provided via this property can alternatively be provided from memory via input_stream property.

Data Type

String

known_cert_count property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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_chain_validation_details property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner Struct)

The signing time from the signer's computer.

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

The signing time from the signer's computer.

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is 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 (CAdESSigner 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.

Supported values:

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_contains_long_term_info property (CAdESSigner 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_content_type property (CAdESSigner Struct)

The signature content type.

Syntax

fn new_sig_content_type(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_content_type(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_content_type_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The signature content type.

Use this property to check the content type attribute of the message record in it by the signer.

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_countersigned property (CAdESSigner Struct)

Indicates if the signature is countersigned.

Syntax

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

Default Value

false

Remarks

Indicates if the signature is countersigned.

Use this property to find out whether the signed message contains any countersignatures over the main signature(s).

You can track countersignatures during the validating by subscribing to on_signature_validated event.

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_entity_label property (CAdESSigner 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_handle property (CAdESSigner 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 (CAdESSigner Struct)

Set or returns the hash algorithm used to generate the signature.

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

""

Remarks

Set or returns the hash algorithm used to generate the signature.

Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.

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_issuer_rdn property (CAdESSigner 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 company 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_last_archival_time property (CAdESSigner Struct)

Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.

Syntax

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

Default Value

""

Remarks

Indicates the most recent archival time of an archived signature

This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is 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_level property (CAdESSigner Struct)

Specifies the CAdES 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   // T
9   // C
10   // X
11   // XType1
12   // XType2
13   // XL
14   // XLType1
15   // XLType2
16   // A
17   // ExtendedBES
18   // ExtendedEPES
19   // ExtendedT
20   // ExtendedC
21   // ExtendedX
22   // ExtendedXType1
23   // ExtendedXType2
24   // ExtendedXLong
25   // ExtendedXL
26   // ExtendedXLType1
27   // ExtendedXLType2
28   // ExtendedA
29   // BaselineExtendedB
30   // BaselineExtendedT
31   // BaselineExtendedLT
32   // BaselineExtendedLTA

Default Value

2

Remarks

Specifies the CAdES signature level.

CMS Advanced Electronic Signatures (CAdES) standard defines a number of different 'levels' of signatures which can be used for different purposes.

The supported levels 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_message_digest property (CAdESSigner Struct)

The binary of the signature's message digest.

Syntax

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

Default Value

""

Remarks

The binary of the signature's message digest.

Use this property to access the 'main' message digest of the CMS blob (the digest included as a message-digest signed attribute).

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_parent_entity property (CAdESSigner Struct)

Use this property to get the parent signature label.

Syntax

fn new_sig_parent_entity(&self ) -> Result<String, SecureBlackboxError> 
fn set_new_sig_parent_entity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_new_sig_parent_entity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to get the parent signature label.

This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a timestamp.

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 property (CAdESSigner Struct)

The signature policy hash value.

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.

Use this property to get the signature policy hash from EPES signatures

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 (CAdESSigner Struct)

The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm 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

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from new_sig_policy_hash.

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 (CAdESSigner Struct)

The policy ID that was included or to be included into 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 that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES signatures.

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 (CAdESSigner 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 from EPES signatures.

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_public_key_algorithm property (CAdESSigner Struct)

Returns the public key algorithm that was used to create the signature.

Syntax

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

Default Value

""

Remarks

Returns the public key algorithm that was used to create the signature.

This property specifies the public key algorithm that was used to create the signature. This typically matches the algorithm of 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_scope property (CAdESSigner Struct)

Returns the type of the entity that this signature corresponds to.

Syntax

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

Default Value

0

Remarks

Returns the type of the entity that this signature corresponds to.

A CAdES signature may cover several kinds of entities: the signed data itself (a top-level signature - something you create when you sign documents), a timestamp, or a countersignature.

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_serial_number property (CAdESSigner Struct)

The serial number of the signing certificate.

Syntax

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

Remarks

The serial number of 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

Vec

new_sig_signature_bytes property (CAdESSigner Struct)

Returns the binary representation of the CAdES signature.

Syntax

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

Remarks

Returns the binary representation of the CAdES 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_validation_result property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 number of OID=Value pairs declared in the certificate and providing the 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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

ocsp_count property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner Struct)

A file where the signed data is to be saved.

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 to the file where to save the resulting signed message.

Data Type

String

profile property (CAdESSigner 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.

Data Type

String

proxy_address property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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_bytes
• signature_chain_validation_details
• signature_chain_validation_result
• signature_claimed_signing_time
• signature_compatibility_errors
• signature_contains_long_term_info
• signature_content_type
• signature_countersigned
• signature_entity_label
• signature_handle
• signature_hash_algorithm
• signature_issuer_rdn
• signature_last_archival_time
• signature_level
• signature_message_digest
• signature_parent_entity
• signature_policy_hash
• signature_policy_hash_algorithm
• signature_policy_id
• signature_policy_uri
• signature_public_key_algorithm
• signature_scope
• signature_serial_number
• signature_subject_key_id
• signature_subject_rdn
• signature_timestamped
• signature_validated_signing_time
• signature_validation_log
• signature_validation_result

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

This property is read-only.

Data Type

i32

signature_chain_validation_details property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner Struct)

The signing time from the signer's computer.

Syntax

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

Default Value

""

Remarks

The signing time from the signer's computer.

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is 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 (CAdESSigner 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.

Supported values:

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_contains_long_term_info property (CAdESSigner 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_content_type property (CAdESSigner Struct)

The signature content type.

Syntax

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

Default Value

""

Remarks

The signature content type.

Use this property to check the content type attribute of the message record in it by the signer.

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_countersigned property (CAdESSigner Struct)

Indicates if the signature is countersigned.

Syntax

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

Default Value

false

Remarks

Indicates if the signature is countersigned.

Use this property to find out whether the signed message contains any countersignatures over the main signature(s).

You can track countersignatures during the validating by subscribing to on_signature_validated event.

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 (CAdESSigner 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_handle property (CAdESSigner 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 (CAdESSigner Struct)

Set or returns the hash algorithm used to generate the signature.

Syntax

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

Default Value

""

Remarks

Set or returns the hash algorithm used to generate the signature.

Check this property after verifying the signature to get the hash algorithm which was used to calculate it. When creating a signed file, use this property to specify the hash algorithm to use.

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_issuer_rdn property (CAdESSigner 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 company 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_last_archival_time property (CAdESSigner Struct)

Indicates the most recent archival time of an archived signature This property returns the time of the most recent archival timestamp applied to the signature.

Syntax

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

Default Value

""

Remarks

Indicates the most recent archival time of an archived signature

This property returns the time of the most recent archival timestamp applied to the signature. This property only makes sense for 'archived' (e.g. CAdES-A) signatures. Time is 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_level property (CAdESSigner Struct)

Specifies the CAdES 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   // T
9   // C
10   // X
11   // XType1
12   // XType2
13   // XL
14   // XLType1
15   // XLType2
16   // A
17   // ExtendedBES
18   // ExtendedEPES
19   // ExtendedT
20   // ExtendedC
21   // ExtendedX
22   // ExtendedXType1
23   // ExtendedXType2
24   // ExtendedXLong
25   // ExtendedXL
26   // ExtendedXLType1
27   // ExtendedXLType2
28   // ExtendedA
29   // BaselineExtendedB
30   // BaselineExtendedT
31   // BaselineExtendedLT
32   // BaselineExtendedLTA

Default Value

2

Remarks

Specifies the CAdES signature level.

CMS Advanced Electronic Signatures (CAdES) standard defines a number of different 'levels' of signatures which can be used for different purposes.

The supported levels 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_message_digest property (CAdESSigner Struct)

The binary of the signature's message digest.

Syntax

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

Default Value

""

Remarks

The binary of the signature's message digest.

Use this property to access the 'main' message digest of the CMS blob (the digest included as a message-digest signed attribute).

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_parent_entity property (CAdESSigner Struct)

Use this property to get the parent signature label.

Syntax

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

Default Value

""

Remarks

Use this property to get the parent signature label.

This property contains the unique entity label of the current signature's parent object - typically a higher-level signature or a 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

String

signature_policy_hash property (CAdESSigner Struct)

The signature policy hash value.

Syntax

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

Default Value

""

Remarks

The signature policy hash value.

Use this property to get the signature policy hash from EPES 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

String

signature_policy_hash_algorithm property (CAdESSigner Struct)

The algorithm that was used to calculate the signature policy hash Use this property to get or set the hash algorithm 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

Use this property to get or set the hash algorithm used to calculate the signature policy hash. Read the actual hash value from signature_policy_hash.

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 (CAdESSigner Struct)

The policy ID that was included or to be included into the signature.

Syntax

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

Default Value

""

Remarks

The policy ID that was included or to be included into the signature.

Use this property to retrieve the signature policy identifier from EPES 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

String

signature_policy_uri property (CAdESSigner 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 from EPES 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

String

signature_public_key_algorithm property (CAdESSigner Struct)

Returns the public key algorithm that was used to create the signature.

Syntax

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

Default Value

""

Remarks

Returns the public key algorithm that was used to create the signature.

This property specifies the public key algorithm that was used to create the signature. This typically matches the algorithm of 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_scope property (CAdESSigner Struct)

Returns the type of the entity that this signature corresponds to.

Syntax

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

Default Value

0

Remarks

Returns the type of the entity that this signature corresponds to.

A CAdES signature may cover several kinds of entities: the signed data itself (a top-level signature - something you create when you sign documents), a timestamp, or a countersignature.

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_serial_number property (CAdESSigner Struct)

The serial number of the signing certificate.

Syntax

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

Remarks

The serial number of 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

Vec

signature_bytes property (CAdESSigner Struct)

Returns the binary representation of the CAdES signature.

Syntax

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

Remarks

Returns the binary representation of the CAdES 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_validation_result property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 number of OID=Value pairs declared in the certificate and providing the 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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

signed_attribute_count property (CAdESSigner Struct)

The number of records in the SignedAttribute arrays.

Syntax

fn signed_attribute_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_signed_attribute_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• signed_attribute_oid
• signed_attribute_value

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

Data Type

i32

signed_attribute_oid property (CAdESSigner Struct)

The object identifier of the attribute.

Syntax

fn signed_attribute_oid(&self , SignedAttributeIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_signed_attribute_oid(&self, SignedAttributeIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_signed_attribute_oid_ref(&self, SignedAttributeIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The object identifier of the attribute.

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

Data Type

String

signed_attribute_value property (CAdESSigner Struct)

The value of the attribute.

Syntax

fn signed_attribute_value(&self , SignedAttributeIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_signed_attribute_value(&self, SignedAttributeIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_signed_attribute_value_ref(&self, SignedAttributeIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

The value of the attribute.

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

Data Type

Vec

signing_cert_bytes property (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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 (CAdESSigner 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

unsigned_attribute_count property (CAdESSigner Struct)

The number of records in the UnsignedAttribute arrays.

Syntax

fn unsigned_attribute_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_unsigned_attribute_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• unsigned_attribute_oid
• unsigned_attribute_value

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

Data Type

i32

unsigned_attribute_oid property (CAdESSigner Struct)

The object identifier of the attribute.

Syntax

fn unsigned_attribute_oid(&self , UnsignedAttributeIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_unsigned_attribute_oid(&self, UnsignedAttributeIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_unsigned_attribute_oid_ref(&self, UnsignedAttributeIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The object identifier of the attribute.

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

Data Type

String

unsigned_attribute_value property (CAdESSigner Struct)

The value of the attribute.

Syntax

fn unsigned_attribute_value(&self , UnsignedAttributeIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_unsigned_attribute_value(&self, UnsignedAttributeIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_unsigned_attribute_value_ref(&self, UnsignedAttributeIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

The value of the attribute.

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

Data Type

Vec

validation_moment property (CAdESSigner 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

add_attribute method (CAdESSigner Struct)

Adds an attribute to the signature.

Syntax

fn add_attribute(&self, oid : &str, value : &[u8], signed_attribute : bool) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add a signed or unsigned attribute to the collection of attributes included in the new signature.

Note that CAdESSigner creates certain mandatory and/or widely used attributes automatically in accordance with requirements for a specific signing profile. For example, attributes such as SigningCertificateV2 or SigningTime are always added. Policy attributes are added if specified via the PolicyID or PolicyURI properties of the signature object.

Use the OID parameter to provide the object identifier of the attribute, in string form. For example, the OID for the SigningCertificateV2 attribute is 1.2.840.113549.1.9.16.2.47. The Value parameter should contain a well-formed, DER-encoded representation of the attribute value, in accordance with its specification.

archive method (CAdESSigner Struct)

Archives the signature.

Syntax

fn archive(&self, sig_label : &str, baseline : bool) -> Result<(), SecureBlackboxError>

Remarks

Call this method to produce an archival signature. Archival signature (CAdES-A) is built on top of CAdES-XL by certifying it with an archival timestamp.

Set Baseline to True to produce a baseline CAdES-A.

close method (CAdESSigner Struct)

Closes an opened container.

Syntax

fn close(&self, save_changes : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to close a previously opened container. Set SaveChanges to true to apply any changes made.

config method (CAdESSigner 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.

create_new method (CAdESSigner Struct)

Create a new CAdES signature.

Syntax

fn create_new(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to create a new CAdES signature. When finished, call close to complete or discard the operation.

do_action method (CAdESSigner 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:

extract_async_data method (CAdESSigner 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.

open method (CAdESSigner Struct)

Opens an existing container for signing or updating.

Syntax

fn open(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to open a container for signing or updating. When finished, call close to complete or discard the operation.

reset method (CAdESSigner Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

revalidate method (CAdESSigner 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 CAdES signature.

select_info method (CAdESSigner 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 (CAdESSigner Struct)

Creates a new CAdES signature over the provided data.

Syntax

fn sign(&self) -> Result<(), SecureBlackboxError>

Remarks

Call this method to produce a new signature over the provided data.

sign_async_begin method (CAdESSigner 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.

sign_async_end method (CAdESSigner 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 (CAdESSigner Struct)

Signs the document using an external signing facility.

Syntax

fn sign_external(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to create a CAdES signature using an external signing facility for the cryptographic computations. SignRemote 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 hash is computed, the struct fires on_external_sign event which allows to pass the hash value for signing.

timestamp method (CAdESSigner Struct)

Use this method to add timestamp.

Syntax

fn timestamp(&self, sig_label : &str, timestamp_type : i32) -> Result<(), SecureBlackboxError>

Remarks

Call this method to add a timestamp to the signature. Use the timestamp_server property to provide the address of the TSA (Time Stamping Authority) server which should be used for timestamping. Use the TimestampType parameter to specify the type of timestamp to create

Supported timestamp types:

upgrade method (CAdESSigner Struct)

Upgrades existing CAdES to a new level.

Syntax

fn upgrade(&self, sig_label : &str, upgrade_kind : i32) -> Result<(), SecureBlackboxError>

Remarks

CMS Advanced Electronic Signatures (CAdES) standard defines a number of different 'levels' of signatures which can be used for different purposes. Use this method to upgrade CAdES to a new level specified by UpgradeKind. Signatures can normally be upgraded from less sophisticated levels (BES, EPES) to more sophisticated (T, XL, A).

Supported levels:

The supported additional upgrade kinds are:

on_chain_element_download event (CAdESSigner Struct)

Fires when there is a need to download a chain element from an online source.

Syntax

// CAdESSignerChainElementDownloadEventArgs carries the CAdESSigner ChainElementDownload event's parameters.
pub struct CAdESSignerChainElementDownloadEventArgs {
  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)
}

// CAdESSignerChainElementDownloadEvent defines the signature of the CAdESSigner ChainElementDownload event's handler function.
pub trait CAdESSignerChainElementDownloadEvent {
  fn on_chain_element_download(&self, sender : CAdESSigner, e : &mut CAdESSignerChainElementDownloadEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_chain_element_download(&self) -> &'a dyn CAdESSignerChainElementDownloadEvent;
  pub fn set_on_chain_element_download(&mut self, value : &'a dyn CAdESSignerChainElementDownloadEvent);
  ...
}

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 (CAdESSigner Struct)

Fires when an element required to validate the chain was not located.

Syntax

// CAdESSignerChainElementNeededEventArgs carries the CAdESSigner ChainElementNeeded event's parameters.
pub struct CAdESSignerChainElementNeededEventArgs {
  fn kind(&self) -> i32
  fn cert_rdn(&self) -> &String
  fn ca_cert_rdn(&self) -> &String
}

// CAdESSignerChainElementNeededEvent defines the signature of the CAdESSigner ChainElementNeeded event's handler function.
pub trait CAdESSignerChainElementNeededEvent {
  fn on_chain_element_needed(&self, sender : CAdESSigner, e : &mut CAdESSignerChainElementNeededEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_chain_element_needed(&self) -> &'a dyn CAdESSignerChainElementNeededEvent;
  pub fn set_on_chain_element_needed(&mut self, value : &'a dyn CAdESSignerChainElementNeededEvent);
  ...
}

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 (CAdESSigner Struct)

Reports the completion of a certificate chain validation.

Syntax

// CAdESSignerChainValidatedEventArgs carries the CAdESSigner ChainValidated event's parameters.
pub struct CAdESSignerChainValidatedEventArgs {
  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)
}

// CAdESSignerChainValidatedEvent defines the signature of the CAdESSigner ChainValidated event's handler function.
pub trait CAdESSignerChainValidatedEvent {
  fn on_chain_validated(&self, sender : CAdESSigner, e : &mut CAdESSignerChainValidatedEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_chain_validated(&self) -> &'a dyn CAdESSignerChainValidatedEvent;
  pub fn set_on_chain_validated(&mut self, value : &'a dyn CAdESSignerChainValidatedEvent);
  ...
}

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 (CAdESSigner Struct)

This event is fired multiple times during chain validation to report various stages of the validation procedure.

Syntax

// CAdESSignerChainValidationProgressEventArgs carries the CAdESSigner ChainValidationProgress event's parameters.
pub struct CAdESSignerChainValidationProgressEventArgs {
  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)
}

// CAdESSignerChainValidationProgressEvent defines the signature of the CAdESSigner ChainValidationProgress event's handler function.
pub trait CAdESSignerChainValidationProgressEvent {
  fn on_chain_validation_progress(&self, sender : CAdESSigner, e : &mut CAdESSignerChainValidationProgressEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_chain_validation_progress(&self) -> &'a dyn CAdESSignerChainValidationProgressEvent;
  pub fn set_on_chain_validation_progress(&mut self, value : &'a dyn CAdESSignerChainValidationProgressEvent);
  ...
}

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_error event (CAdESSigner Struct)

Information about errors during CAdES signing.

Syntax

// CAdESSignerErrorEventArgs carries the CAdESSigner Error event's parameters.
pub struct CAdESSignerErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// CAdESSignerErrorEvent defines the signature of the CAdESSigner Error event's handler function.
pub trait CAdESSignerErrorEvent {
  fn on_error(&self, sender : CAdESSigner, e : &mut CAdESSignerErrorEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_error(&self) -> &'a dyn CAdESSignerErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn CAdESSignerErrorEvent);
  ...
}

Remarks

The event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Messages section.

on_external_sign event (CAdESSigner Struct)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

// CAdESSignerExternalSignEventArgs carries the CAdESSigner ExternalSign event's parameters.
pub struct CAdESSignerExternalSignEventArgs {
  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)
}

// CAdESSignerExternalSignEvent defines the signature of the CAdESSigner ExternalSign event's handler function.
pub trait CAdESSignerExternalSignEvent {
  fn on_external_sign(&self, sender : CAdESSigner, e : &mut CAdESSignerExternalSignEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_external_sign(&self) -> &'a dyn CAdESSignerExternalSignEvent;
  pub fn set_on_external_sign(&mut self, value : &'a dyn CAdESSignerExternalSignEvent);
  ...
}

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_loaded event (CAdESSigner Struct)

This event is fired when the CAdES signature has been loaded into memory.

Syntax

// CAdESSignerLoadedEventArgs carries the CAdESSigner Loaded event's parameters.
pub struct CAdESSignerLoadedEventArgs {
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// CAdESSignerLoadedEvent defines the signature of the CAdESSigner Loaded event's handler function.
pub trait CAdESSignerLoadedEvent {
  fn on_loaded(&self, sender : CAdESSigner, e : &mut CAdESSignerLoadedEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_loaded(&self) -> &'a dyn CAdESSignerLoadedEvent;
  pub fn set_on_loaded(&mut self, value : &'a dyn CAdESSignerLoadedEvent);
  ...
}

Remarks

The handler for this event is a good place to check CAdES signature properties, which may be useful when preparing the signature.

Set Cancel to true to terminate CAdES signature processing on this stage.

on_notification event (CAdESSigner Struct)

This event notifies the application about an underlying control flow event.

Syntax

// CAdESSignerNotificationEventArgs carries the CAdESSigner Notification event's parameters.
pub struct CAdESSignerNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// CAdESSignerNotificationEvent defines the signature of the CAdESSigner Notification event's handler function.
pub trait CAdESSignerNotificationEvent {
  fn on_notification(&self, sender : CAdESSigner, e : &mut CAdESSignerNotificationEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_notification(&self) -> &'a dyn CAdESSignerNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn CAdESSignerNotificationEvent);
  ...
}

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_signature_found event (CAdESSigner Struct)

Signifies the start of signature validation.

Syntax

// CAdESSignerSignatureFoundEventArgs carries the CAdESSigner SignatureFound event's parameters.
pub struct CAdESSignerSignatureFoundEventArgs {
  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)
}

// CAdESSignerSignatureFoundEvent defines the signature of the CAdESSigner SignatureFound event's handler function.
pub trait CAdESSignerSignatureFoundEvent {
  fn on_signature_found(&self, sender : CAdESSigner, e : &mut CAdESSignerSignatureFoundEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_signature_found(&self) -> &'a dyn CAdESSignerSignatureFoundEvent;
  pub fn set_on_signature_found(&mut self, value : &'a dyn CAdESSignerSignatureFoundEvent);
  ...
}

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 (CAdESSigner Struct)

Marks the completion of the signature validation routine.

Syntax

// CAdESSignerSignatureValidatedEventArgs carries the CAdESSigner SignatureValidated event's parameters.
pub struct CAdESSignerSignatureValidatedEventArgs {
  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)
}

// CAdESSignerSignatureValidatedEvent defines the signature of the CAdESSigner SignatureValidated event's handler function.
pub trait CAdESSignerSignatureValidatedEvent {
  fn on_signature_validated(&self, sender : CAdESSigner, e : &mut CAdESSignerSignatureValidatedEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_signature_validated(&self) -> &'a dyn CAdESSignerSignatureValidatedEvent;
  pub fn set_on_signature_validated(&mut self, value : &'a dyn CAdESSignerSignatureValidatedEvent);
  ...
}

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 (CAdESSigner Struct)

Signifies the start of a timestamp validation routine.

Syntax

// CAdESSignerTimestampFoundEventArgs carries the CAdESSigner TimestampFound event's parameters.
pub struct CAdESSignerTimestampFoundEventArgs {
  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)
}

// CAdESSignerTimestampFoundEvent defines the signature of the CAdESSigner TimestampFound event's handler function.
pub trait CAdESSignerTimestampFoundEvent {
  fn on_timestamp_found(&self, sender : CAdESSigner, e : &mut CAdESSignerTimestampFoundEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_timestamp_found(&self) -> &'a dyn CAdESSignerTimestampFoundEvent;
  pub fn set_on_timestamp_found(&mut self, value : &'a dyn CAdESSignerTimestampFoundEvent);
  ...
}

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 (CAdESSigner Struct)

Fires when the struct is ready to request a timestamp from an external TSA.

Syntax

// CAdESSignerTimestampRequestEventArgs carries the CAdESSigner TimestampRequest event's parameters.
pub struct CAdESSignerTimestampRequestEventArgs {
  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)
}

// CAdESSignerTimestampRequestEvent defines the signature of the CAdESSigner TimestampRequest event's handler function.
pub trait CAdESSignerTimestampRequestEvent {
  fn on_timestamp_request(&self, sender : CAdESSigner, e : &mut CAdESSignerTimestampRequestEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_timestamp_request(&self) -> &'a dyn CAdESSignerTimestampRequestEvent;
  pub fn set_on_timestamp_request(&mut self, value : &'a dyn CAdESSignerTimestampRequestEvent);
  ...
}

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 (CAdESSigner Struct)

Reports the completion of the timestamp validation routine.

Syntax

// CAdESSignerTimestampValidatedEventArgs carries the CAdESSigner TimestampValidated event's parameters.
pub struct CAdESSignerTimestampValidatedEventArgs {
  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)
}

// CAdESSignerTimestampValidatedEvent defines the signature of the CAdESSigner TimestampValidated event's handler function.
pub trait CAdESSignerTimestampValidatedEvent {
  fn on_timestamp_validated(&self, sender : CAdESSigner, e : &mut CAdESSignerTimestampValidatedEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_timestamp_validated(&self) -> &'a dyn CAdESSignerTimestampValidatedEvent;
  pub fn set_on_timestamp_validated(&mut self, value : &'a dyn CAdESSignerTimestampValidatedEvent);
  ...
}

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 (CAdESSigner Struct)

Fires when a remote TLS party requests a client certificate.

Syntax

// CAdESSignerTLSCertNeededEventArgs carries the CAdESSigner TLSCertNeeded event's parameters.
pub struct CAdESSignerTLSCertNeededEventArgs {
  fn host(&self) -> &String
  fn ca_names(&self) -> &String
}

// CAdESSignerTLSCertNeededEvent defines the signature of the CAdESSigner TLSCertNeeded event's handler function.
pub trait CAdESSignerTLSCertNeededEvent {
  fn on_tls_cert_needed(&self, sender : CAdESSigner, e : &mut CAdESSignerTLSCertNeededEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_tls_cert_needed(&self) -> &'a dyn CAdESSignerTLSCertNeededEvent;
  pub fn set_on_tls_cert_needed(&mut self, value : &'a dyn CAdESSignerTLSCertNeededEvent);
  ...
}

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 (CAdESSigner Struct)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

// CAdESSignerTLSCertValidateEventArgs carries the CAdESSigner TLSCertValidate event's parameters.
pub struct CAdESSignerTLSCertValidateEventArgs {
  fn server_host(&self) -> &String
  fn server_ip(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// CAdESSignerTLSCertValidateEvent defines the signature of the CAdESSigner TLSCertValidate event's handler function.
pub trait CAdESSignerTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : CAdESSigner, e : &mut CAdESSignerTLSCertValidateEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn CAdESSignerTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn CAdESSignerTLSCertValidateEvent);
  ...
}

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 (CAdESSigner Struct)

Fires when a TLS handshake with Host successfully completes.

Syntax

// CAdESSignerTLSEstablishedEventArgs carries the CAdESSigner TLSEstablished event's parameters.
pub struct CAdESSignerTLSEstablishedEventArgs {
  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)
}

// CAdESSignerTLSEstablishedEvent defines the signature of the CAdESSigner TLSEstablished event's handler function.
pub trait CAdESSignerTLSEstablishedEvent {
  fn on_tls_established(&self, sender : CAdESSigner, e : &mut CAdESSignerTLSEstablishedEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_tls_established(&self) -> &'a dyn CAdESSignerTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn CAdESSignerTLSEstablishedEvent);
  ...
}

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 (CAdESSigner Struct)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

// CAdESSignerTLSHandshakeEventArgs carries the CAdESSigner TLSHandshake event's parameters.
pub struct CAdESSignerTLSHandshakeEventArgs {
  fn host(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// CAdESSignerTLSHandshakeEvent defines the signature of the CAdESSigner TLSHandshake event's handler function.
pub trait CAdESSignerTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : CAdESSigner, e : &mut CAdESSignerTLSHandshakeEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn CAdESSignerTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn CAdESSignerTLSHandshakeEvent);
  ...
}

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 (CAdESSigner Struct)

Reports the graceful closure of a TLS connection.

Syntax

// CAdESSignerTLSShutdownEventArgs carries the CAdESSigner TLSShutdown event's parameters.
pub struct CAdESSignerTLSShutdownEventArgs {
  fn host(&self) -> &String
}

// CAdESSignerTLSShutdownEvent defines the signature of the CAdESSigner TLSShutdown event's handler function.
pub trait CAdESSignerTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : CAdESSigner, e : &mut CAdESSignerTLSShutdownEventArgs);
}

impl <'a> CAdESSigner<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn CAdESSignerTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn CAdESSignerTLSShutdownEvent);
  ...
}

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 (CAdESSigner 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.

CAdESSigner Config Settings

Base Config Settings

Trappable Errors (CAdESSigner Struct)

CAdESSigner Errors