Struct secureblackbox::MessageVerifier

Properties   Methods   Events   Config Settings   Errors  

The MessageVerifier struct verifies digital signatures of data stored in the PKCS#7 format.

Syntax

secureblackbox::MessageVerifier

Remarks

PKCS#7 (Public Key Cryptography Standard #7) is a common format used to store encrypted and signed data. It is used by a variety of protocols, including S/MIME and CMS.

MessageVerifier can process signed data in PKCS#7 SignedData and AuthenticatedData subformats. RSA, ECDSA, and EdDSA algorithms are supported.

Setting up and using MessageVerifier is easy:

• Set up your source and destination via input_file (input_bytes) and output_file (output_bytes) properties. For detached signatures, provide the signed data separately via data_file (data_bytes).
• For the SignedData-type signatures (most commonly used), add the public part of the signing certificate to the known_certificates collection. This step may be unnecessary, as it is typical for signers to include their certificates in the signature.
• For the AuthenticatedData-type signature, add the recipient's (i.e. your) certificate, with its private key, to known_certificates collection.
• Call verify or verify_detached, as appropriate, to execute the validation operation.
• Post-validation, you can get access to signature properties, such as claimed_signing_time, signed_attributes, and unsigned_attributes.

Note that MessageVerifier can only work with binary PKCS#7-compliant and PKCS#1-compliant signatures. To process S/MIME-signed emails, see MailReader. To process PGP signatures, see PGPReader.

MessageVerifier is a simplified form of CAdESVerifier. Both classes work with PKCS#7 signed messages. CAdESVerifier, however, provides support for advanced (CAdES) signatures, including long-term validity, archival, and full chain validation capabilities. These advanced capabilities are absent from MessageVerifier, which is only capable of processing basic PKCS#7 signatures without any chain of trust validation. MessageVerifier verifier = new MessageVerifier(); // Select the file which contains the signed message verifier.setInputFile("signedMessage.bin"); if (verifier.checkSignatureType() == Constants.stPKCS7Detached) { // To verify a detached signature, we need // to provide both the signature and the original data verifier.setDataFile("message.txt"); verifier.verifyDetached(); } else { // To verify an enveloping signature, we need // to provide the location to extract the data verifier.setOutputFile("output.txt"); verifier.verify(); } System.out.println("Validation result: " + verifier.getSignatureValidationResult() + "\n" + "Signing time: " + verifier.getValidatedSigningTime() + "\n" + "TSA certificate: " + verifier.getSigningCertificate().getSubjectRDN()); // Output: // // Validation result: 0 // 0 == svtValid // Signing time: 2024-05-16 15:18:35 // TSA certificate: /CN=Test Certificate

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 MessageVerifier struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of MessageVerifier 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.

cert_count property (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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

claimed_signing_time property (MessageVerifier Struct)

Returns a signature's claimed signing time.

Syntax

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

Default Value

""

Remarks

Use this property to get the signature creation time from the signer's computer. Note that the claimed time is not covered by the signature and may be forfeited or wrong. Use validated_signing_time to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC.

This property is read-only.

Data Type

String

content_type property (MessageVerifier Struct)

A content type property of the signed message.

Syntax

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

Default Value

""

Remarks

Use this property to check the content type property of the processed signed message.

This property is read-only.

Data Type

String

data_bytes property (MessageVerifier Struct)

Use this property to pass the original signed data to struct in the byte array form.

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

When validating detached signatures, assign a byte array containing the signed data to this property.

Data Type

Vec

data_file property (MessageVerifier Struct)

The name of the file containing the original signed data.

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 the original data when validating detached signatures with verify_detached.

Data Type

String

fips_mode property (MessageVerifier 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

hash_algorithm property (MessageVerifier Struct)

Hash algorithm which was used to calculate the signature.

Syntax

fn hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Check this property after calling verify or verify_detached to get the hash algorithm that was used to calculate the signature message digest.

Data Type

String

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

Path to the file containing the signed message.

Syntax

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

Default Value

""

Remarks

Use this property to provide a file containing the signed data, either enveloping or detached.

Data Type

String

input_is_hash property (MessageVerifier Struct)

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

Syntax

fn input_is_hash(&self ) -> Result<bool, SecureBlackboxError> 
fn set_input_is_hash(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

known_cert_count property (MessageVerifier 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 (MessageVerifier 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 (MessageVerifier 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

mac_algorithm property (MessageVerifier Struct)

Specifies the hash algorithm to be used.

Syntax

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

Default Value

"SHA256"

Remarks

This property specifies the MAC algorithm that was used to calculate an authenticated signature.

This property is read-only.

Data Type

String

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

Path to the file to save the extracted data to.

Syntax

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

Default Value

""

Remarks

Use this property when validating enveloping signatures to specify the output file where the extracted message should be saved.

Data Type

String

signature_type property (MessageVerifier Struct)

The type of the processed signature.

Syntax

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

Possible Values

0   // Unknown
1   // PKCS1Detached
2   // PKCS7Detached
3   // PKCS7Enveloping
4   // PKCS7MACDetached
5   // PKCS7MACEnveloping

Default Value

0

Remarks

Use this property to check the result of the most recent signature validation.

This property is read-only.

Data Type

i32

signature_validation_result property (MessageVerifier Struct)

The signature validation result.

Syntax

fn 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

Use this property to check the result of the most recent signature validation.

This property is read-only.

Data Type

i32

signed_attribute_count property (MessageVerifier Struct)

The number of records in the SignedAttribute arrays.

Syntax

fn signed_attribute_count(&self ) -> Result<i32, 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.

This property is read-only.

Data Type

i32

signed_attribute_oid property (MessageVerifier Struct)

The object identifier of the attribute.

Syntax

fn signed_attribute_oid(&self , SignedAttributeIndex : i32) -> Result<String, 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.

This property is read-only.

Data Type

String

signed_attribute_value property (MessageVerifier Struct)

The value of the attribute.

Syntax

fn signed_attribute_value(&self , SignedAttributeIndex : i32) -> Result<Vec<u8>, 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.

This property is read-only.

Data Type

Vec

signing_cert_bytes property (MessageVerifier 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_ca property (MessageVerifier Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn signing_cert_ca(&self ) -> 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.

This property is read-only.

Data Type

bool

signing_cert_ca_key_id property (MessageVerifier Struct)

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

Syntax

fn signing_cert_ca_key_id(&self ) -> 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 signing_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

Data Type

Vec

signing_cert_cert_type property (MessageVerifier Struct)

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

Syntax

fn signing_cert_cert_type(&self ) -> 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.

This property is read-only.

Data Type

i32

signing_cert_crl_distribution_points property (MessageVerifier Struct)

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

Syntax

fn signing_cert_crl_distribution_points(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_curve property (MessageVerifier Struct)

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

Syntax

fn signing_cert_curve(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_fingerprint property (MessageVerifier Struct)

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

Syntax

fn signing_cert_fingerprint(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_friendly_name property (MessageVerifier Struct)

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

Syntax

fn signing_cert_friendly_name(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_handle property (MessageVerifier 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> 

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());

This property is read-only.

Data Type

i64

signing_cert_hash_algorithm property (MessageVerifier 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 signing_cert_hash_algorithm(&self ) -> 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 signing_cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.

This property is read-only.

Data Type

String

signing_cert_issuer property (MessageVerifier Struct)

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

Syntax

fn signing_cert_issuer(&self ) -> 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 signing_cert_issuer_rdn.

This property is read-only.

Data Type

String

signing_cert_issuer_rdn property (MessageVerifier Struct)

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

Syntax

fn signing_cert_issuer_rdn(&self ) -> 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

This property is read-only.

Data Type

String

signing_cert_key_algorithm property (MessageVerifier Struct)

Specifies the public key algorithm of this certificate.

Syntax

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

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the signing_cert_key_bits, signing_cert_curve, and signing_cert_public_key_bytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

String

signing_cert_key_bits property (MessageVerifier Struct)

Returns the length of the public key in bits.

Syntax

fn signing_cert_key_bits(&self ) -> 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 signing_cert_public_key_bytes or signing_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

Data Type

i32

signing_cert_key_fingerprint property (MessageVerifier Struct)

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

Syntax

fn signing_cert_key_fingerprint(&self ) -> 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 signing_cert_fingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

Data Type

String

signing_cert_key_usage property (MessageVerifier Struct)

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

Syntax

fn signing_cert_key_usage(&self ) -> 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.

This property is read-only.

Data Type

i32

signing_cert_key_valid property (MessageVerifier Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

signing_cert_ocsp_locations property (MessageVerifier 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 signing_cert_ocsp_locations(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_ocsp_no_check property (MessageVerifier Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

signing_cert_origin property (MessageVerifier Struct)

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

Syntax

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

Default Value

0

Remarks

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

This property is read-only.

Data Type

i32

signing_cert_policy_i_ds property (MessageVerifier Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn signing_cert_policy_i_ds(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_private_key_bytes property (MessageVerifier Struct)

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

Syntax

fn signing_cert_private_key_bytes(&self ) -> 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.

This property is read-only.

Data Type

Vec

signing_cert_private_key_exists property (MessageVerifier Struct)

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

Syntax

fn signing_cert_private_key_exists(&self ) -> 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 signing_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.

This property is read-only.

Data Type

bool

signing_cert_private_key_extractable property (MessageVerifier Struct)

Indicates whether the private key is extractable (exportable).

Syntax

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

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

Data Type

bool

signing_cert_public_key_bytes property (MessageVerifier Struct)

Contains the certificate's public key in DER format.

Syntax

fn signing_cert_public_key_bytes(&self ) -> 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.

This property is read-only.

Data Type

Vec

signing_cert_qualified property (MessageVerifier Struct)

Indicates whether the certificate is qualified.

Syntax

fn signing_cert_qualified(&self ) -> 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.

This property is read-only.

Data Type

bool

signing_cert_qualified_statements property (MessageVerifier Struct)

Returns a simplified qualified status of the certificate.

Syntax

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

Possible Values

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

Default Value

0

Remarks

Returns a simplified qualified status of the certificate.

This property is read-only.

Data Type

i32

signing_cert_qualifiers property (MessageVerifier Struct)

A list of qualifiers.

Syntax

fn signing_cert_qualifiers(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_self_signed property (MessageVerifier Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

signing_cert_serial_number property (MessageVerifier Struct)

Returns the certificate's serial number.

Syntax

fn signing_cert_serial_number(&self ) -> 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.

This property is read-only.

Data Type

Vec

signing_cert_sig_algorithm property (MessageVerifier Struct)

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

Syntax

fn signing_cert_sig_algorithm(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_source property (MessageVerifier Struct)

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

Syntax

fn signing_cert_source(&self ) -> 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.

This property is read-only.

Data Type

i32

signing_cert_subject property (MessageVerifier 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 signing_cert_subject(&self ) -> 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 signing_cert_subject_rdn.

This property is read-only.

Data Type

String

signing_cert_subject_alternative_name property (MessageVerifier Struct)

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

Syntax

fn signing_cert_subject_alternative_name(&self ) -> 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 signing_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.

This property is read-only.

Data Type

String

signing_cert_subject_key_id property (MessageVerifier Struct)

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

Syntax

fn signing_cert_subject_key_id(&self ) -> 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 signing_cert_subject_key_id and signing_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.

This property is read-only.

Data Type

Vec

signing_cert_subject_rdn property (MessageVerifier Struct)

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

Syntax

fn signing_cert_subject_rdn(&self ) -> 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.

This property is read-only.

Data Type

String

signing_cert_valid property (MessageVerifier 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 signing_cert_valid(&self ) -> 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.

This property is read-only.

Data Type

bool

signing_cert_valid_from property (MessageVerifier Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

signing_cert_valid_to property (MessageVerifier Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

timestamp_accuracy property (MessageVerifier Struct)

This property indicates the accuracy of the included time mark, in microseconds.

Syntax

fn timestamp_accuracy(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

This field indicates the accuracy of the included time mark, in microseconds.

This property is read-only.

Data Type

i64

timestamp_bytes property (MessageVerifier Struct)

Returns the raw timestamp data in DER format.

Syntax

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

Remarks

Returns the raw timestamp data in DER format.

This property is read-only.

Data Type

Vec

timestamp_certificate_index property (MessageVerifier Struct)

Returns the index of the TSA certificate in the Certificates collection.

Syntax

fn timestamp_certificate_index(&self ) -> 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.

This property is read-only.

Data Type

i32

timestamp_chain_validation_details property (MessageVerifier Struct)

The details of a certificate chain validation outcome.

Syntax

fn timestamp_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:

This property is read-only.

Data Type

i32

timestamp_chain_validation_result property (MessageVerifier Struct)

The outcome of a certificate chain validation routine.

Syntax

fn timestamp_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.

This property is read-only.

Data Type

i32

timestamp_contains_long_term_info property (MessageVerifier 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 ) -> 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).

This property is read-only.

Data Type

bool

timestamp_entity_label property (MessageVerifier Struct)

Use this property to get the timestamp entity label.

Syntax

fn timestamp_entity_label(&self ) -> 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.

This property is read-only.

Data Type

String

timestamp_hash_algorithm property (MessageVerifier Struct)

Returns the timestamp's hash algorithm.

Syntax

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

Default Value

""

Remarks

Returns the timestamp's hash algorithm.

This property is read-only.

Data Type

String

timestamp_parent_entity property (MessageVerifier Struct)

Use this property to get the label of the timestamp's parent entity.

Syntax

fn timestamp_parent_entity(&self ) -> 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.

This property is read-only.

Data Type

String

timestamp_serial_number property (MessageVerifier Struct)

Returns the timestamp's serial number.

Syntax

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

Remarks

Returns the timestamp's serial number.

This property is read-only.

Data Type

Vec

timestamp_time property (MessageVerifier Struct)

The time point incorporated into the timestamp.

Syntax

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

Default Value

""

Remarks

The time point incorporated into the timestamp.

This property is read-only.

Data Type

String

timestamp_type property (MessageVerifier Struct)

Returns the type of the timestamp.

Syntax

fn timestamp_type(&self ) -> 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).

This property is read-only.

Data Type

i32

timestamp_tsa_name property (MessageVerifier Struct)

This value uniquely identifies the Timestamp Authority (TSA).

Syntax

fn timestamp_tsa_name(&self ) -> 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.

This property is read-only.

Data Type

String

timestamp_validation_log property (MessageVerifier Struct)

Contains the TSA certificate chain validation log.

Syntax

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

Default Value

""

Remarks

Contains the TSA certificate chain validation log. This information is extremely useful if the timestamp validation fails.

This property is read-only.

Data Type

String

timestamp_validation_result property (MessageVerifier Struct)

Contains the timestamp validation outcome.

Syntax

fn timestamp_validation_result(&self ) -> 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.

This property is read-only.

Data Type

i32

timestamped property (MessageVerifier Struct)

Indicates whether or not the signature is timestamped.

Syntax

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

Default Value

false

Remarks

This property returns True if the signature is timestamped, and False otherwise.

This property is read-only.

Data Type

bool

tsa_cert_bytes property (MessageVerifier Struct)

Returns the raw certificate data in DER format.

Syntax

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

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

tsa_cert_ca property (MessageVerifier Struct)

Indicates whether the certificate has a CA capability.

Syntax

fn tsa_cert_ca(&self ) -> 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.

This property is read-only.

Data Type

bool

tsa_cert_ca_key_id property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_ca_key_id(&self ) -> 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 tsa_cert_subject_key_id setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

Data Type

Vec

tsa_cert_crl_distribution_points property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_crl_distribution_points(&self ) -> 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.

This property is read-only.

Data Type

String

tsa_cert_curve property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_curve(&self ) -> 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.

This property is read-only.

Data Type

String

tsa_cert_fingerprint property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_fingerprint(&self ) -> 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.

This property is read-only.

Data Type

String

tsa_cert_friendly_name property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_friendly_name(&self ) -> 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.

This property is read-only.

Data Type

String

tsa_cert_handle property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_handle(&self ) -> 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());

This property is read-only.

Data Type

i64

tsa_cert_hash_algorithm property (MessageVerifier 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 tsa_cert_hash_algorithm(&self ) -> 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 tsa_cert_sig_algorithm to find out the hash algorithm that is part of the certificate signature.

This property is read-only.

Data Type

String

tsa_cert_issuer property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_issuer(&self ) -> 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 tsa_cert_issuer_rdn.

This property is read-only.

Data Type

String

tsa_cert_issuer_rdn property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_issuer_rdn(&self ) -> 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

This property is read-only.

Data Type

String

tsa_cert_key_algorithm property (MessageVerifier Struct)

Specifies the public key algorithm of this certificate.

Syntax

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

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the tsa_cert_key_bits, tsa_cert_curve, and tsa_cert_public_key_bytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

String

tsa_cert_key_bits property (MessageVerifier Struct)

Returns the length of the public key in bits.

Syntax

fn tsa_cert_key_bits(&self ) -> 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 tsa_cert_public_key_bytes or tsa_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

Data Type

i32

tsa_cert_key_fingerprint property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_key_fingerprint(&self ) -> 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 tsa_cert_fingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

Data Type

String

tsa_cert_key_usage property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_key_usage(&self ) -> 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.

This property is read-only.

Data Type

i32

tsa_cert_key_valid property (MessageVerifier Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

tsa_cert_ocsp_locations property (MessageVerifier 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 tsa_cert_ocsp_locations(&self ) -> 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.

This property is read-only.

Data Type

String

tsa_cert_policy_i_ds property (MessageVerifier Struct)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

fn tsa_cert_policy_i_ds(&self ) -> 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.

This property is read-only.

Data Type

String

tsa_cert_public_key_bytes property (MessageVerifier Struct)

Contains the certificate's public key in DER format.

Syntax

fn tsa_cert_public_key_bytes(&self ) -> 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.

This property is read-only.

Data Type

Vec

tsa_cert_self_signed property (MessageVerifier Struct)

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

Syntax

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

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

tsa_cert_serial_number property (MessageVerifier Struct)

Returns the certificate's serial number.

Syntax

fn tsa_cert_serial_number(&self ) -> 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.

This property is read-only.

Data Type

Vec

tsa_cert_sig_algorithm property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_sig_algorithm(&self ) -> 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.

This property is read-only.

Data Type

String

tsa_cert_subject property (MessageVerifier 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 tsa_cert_subject(&self ) -> 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 tsa_cert_subject_rdn.

This property is read-only.

Data Type

String

tsa_cert_subject_key_id property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_subject_key_id(&self ) -> 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 tsa_cert_subject_key_id and tsa_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.

This property is read-only.

Data Type

Vec

tsa_cert_subject_rdn property (MessageVerifier Struct)

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

Syntax

fn tsa_cert_subject_rdn(&self ) -> 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.

This property is read-only.

Data Type

String

tsa_cert_valid_from property (MessageVerifier Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

tsa_cert_valid_to property (MessageVerifier Struct)

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

Syntax

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

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

unsigned_attribute_count property (MessageVerifier Struct)

The number of records in the UnsignedAttribute arrays.

Syntax

fn unsigned_attribute_count(&self ) -> Result<i32, 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.

This property is read-only.

Data Type

i32

unsigned_attribute_oid property (MessageVerifier Struct)

The object identifier of the attribute.

Syntax

fn unsigned_attribute_oid(&self , UnsignedAttributeIndex : i32) -> Result<String, 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.

This property is read-only.

Data Type

String

unsigned_attribute_value property (MessageVerifier Struct)

The value of the attribute.

Syntax

fn unsigned_attribute_value(&self , UnsignedAttributeIndex : i32) -> Result<Vec<u8>, 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.

This property is read-only.

Data Type

Vec

validated_signing_time property (MessageVerifier Struct)

Contains the certified signing time.

Syntax

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

Default Value

""

Remarks

Use this property to obtain the signing time as certified by an external timestamp. The time is in UTC.

This property is read-only.

Data Type

String

check_signature_type method (MessageVerifier Struct)

Determines the signature kind.

Syntax

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

Remarks

Use this method to determine the kind of the signature stored in input_file (input_stream).

config method (MessageVerifier Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

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

reset method (MessageVerifier Struct)

Resets the struct settings.

Syntax

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

Remarks

reset is a generic method available in every struct.

verify method (MessageVerifier Struct)

Verifies digitally signed data.

Syntax

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

Remarks

PKCS#7 and its successor, CMS, support two types of signatures: (1) enveloping signatures, where the signed data and its signature are combined in the same message, and (2) detached signatures, where the signature is stored as a separate entity. This method verifies enveloped signatures and extracts data contained in them. Use verify_detached to verify detached signatures.

This method expects the enveloping signature to be provided via input_file or input_stream properties.

Note that this method only checks the integrity of the signature, i.e., that it is signed with the claimed certificate and has not been altered. It does not validate the signing certificate chain. To validate the certificate chain, either use CertificateValidator component together with MessageVerifier, or consider using CAdESVerifier component instead.

verify_detached method (MessageVerifier Struct)

Verifies a detached signature.

Syntax

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

Remarks

Use this method to verify detached signatures. Pass the signature via input_file (or input_stream) property, and the original data via data_file (data_stream).

on_error event (MessageVerifier Struct)

Information about errors during PKCS#7 message verification.

Syntax

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

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

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

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_notification event (MessageVerifier Struct)

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

Syntax

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

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

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

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_recipient_found event (MessageVerifier Struct)

Fires to report a message addressee parameters.

Syntax

// MessageVerifierRecipientFoundEventArgs carries the MessageVerifier RecipientFound event's parameters.
pub struct MessageVerifierRecipientFoundEventArgs {
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn cert_found(&self) -> bool
}

// MessageVerifierRecipientFoundEvent defines the signature of the MessageVerifier RecipientFound event's handler function.
pub trait MessageVerifierRecipientFoundEvent {
  fn on_recipient_found(&self, sender : MessageVerifier, e : &mut MessageVerifierRecipientFoundEventArgs);
}

impl <'a> MessageVerifier<'a> {
  pub fn on_recipient_found(&self) -> &'a dyn MessageVerifierRecipientFoundEvent;
  pub fn set_on_recipient_found(&mut self, value : &'a dyn MessageVerifierRecipientFoundEvent);
  ...
}

Remarks

This event is fired for each addressee the message is encrypted for. It may fire several times in a row if the message is encrypted for more than one recipient.

The IssuerRDN, SerialNumber, and SubjectKeyID parameters to identify the recipient's certificate. CertFound indicates if the specified certificate has been located in certificates collection. If it wasn't, you might want to look up the certificate manually, and add it to the collection inside the event handler.

on_signature_found event (MessageVerifier Struct)

Signifies the start of signature validation.

Syntax

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

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

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

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

Marks the completion of the signature validation routine.

Syntax

// MessageVerifierSignatureValidatedEventArgs carries the MessageVerifier SignatureValidated event's parameters.
pub struct MessageVerifierSignatureValidatedEventArgs {
  fn issuer_rdn(&self) -> &String
  fn serial_number(&self) -> &[u8]
  fn subject_key_id(&self) -> &[u8]
  fn validation_result(&self) -> i32
}

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

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

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

Signifies the start of a timestamp validation routine.

Syntax

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

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

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

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_validated event (MessageVerifier Struct)

Reports the completion of the timestamp validation routine.

Syntax

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

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

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

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.

Config Settings (MessageVerifier 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.

MessageVerifier Config Settings

Base Config Settings

Trappable Errors (MessageVerifier Struct)

MessageVerifier Errors