# MessageVerifier Class The MessageVerifier class verifies digital signatures of data stored in the PKCS#7 format. ## Class Name **SecureBlackbox_MessageVerifier** ## Procedural Interface ```text secureblackbox_messageverifier_open(); secureblackbox_messageverifier_close($res); secureblackbox_messageverifier_register_callback($res, $id, $function); secureblackbox_messageverifier_get_last_error($res); secureblackbox_messageverifier_get_last_error_code($res); secureblackbox_messageverifier_set($res, $id, $index, $value); secureblackbox_messageverifier_get($res, $id, $index); secureblackbox_messageverifier_do_checksignaturetype($res); secureblackbox_messageverifier_do_config($res, $configurationstring); secureblackbox_messageverifier_do_doaction($res, $actionid, $actionparams); secureblackbox_messageverifier_do_reset($res); secureblackbox_messageverifier_do_verify($res); secureblackbox_messageverifier_do_verifydetached($res); ``` ## 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 [InputFile](#inputfile-property-secureblackbox_messageverifier-class) ([InputBytes](#inputbytes-property-secureblackbox_messageverifier-class)) and [OutputFile](#outputfile-property-secureblackbox_messageverifier-class) ([OutputBytes](#outputbytes-property-secureblackbox_messageverifier-class)) properties. For detached signatures, provide the signed data separately via [DataFile](#datafile-property-secureblackbox_messageverifier-class) ([DataBytes](#databytes-property-secureblackbox_messageverifier-class)). - For the SignedData-type signatures (most commonly used), add the public part of the signing certificate to the KnownCertificates 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 KnownCertificates collection. - Call [Verify](#verify-method-secureblackbox_messageverifier-class) or [VerifyDetached](#verifydetached-method-secureblackbox_messageverifier-class), as appropriate, to execute the validation operation. - Post-validation, you can get access to signature properties, such as [ClaimedSigningTime](#claimedsigningtime-property-secureblackbox_messageverifier-class), SignedAttributes, and UnsignedAttributes. Note that MessageVerifier can only work with binary PKCS#7-compliant and PKCS#1-compliant signatures. To process S/MIME-signed emails, see [MailReader](MailReader.md#MailReader). To process PGP signatures, see [PGPReader](PGPReader.md#PGPReader). MessageVerifier is a simplified form of [CAdESVerifier](CAdESVerifier.md#CAdESVerifier). Both classes work with PKCS#7 signed messages. [CAdESVerifier](CAdESVerifier.md#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. ```text 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 ``` ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CertCount](#certcount-property-secureblackbox_messageverifier-class) | The number of records in the Cert arrays. | | [CertBytes](#certbytes-property-secureblackbox_messageverifier-class) | Returns the raw certificate data in DER format. | | [CertCA](#certca-property-secureblackbox_messageverifier-class) | Indicates whether the certificate has a CA capability. | | [CertCAKeyID](#certcakeyid-property-secureblackbox_messageverifier-class) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [CertType](#certtype-property-secureblackbox_messageverifier-class) | Returns the type of the entity contained in the Certificate object. | | [CertCRLDistributionPoints](#certcrldistributionpoints-property-secureblackbox_messageverifier-class) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [CertCurve](#certcurve-property-secureblackbox_messageverifier-class) | Specifies the elliptic curve associated with the certificate's public key. | | [CertFingerprint](#certfingerprint-property-secureblackbox_messageverifier-class) | Contains the fingerprint (a hash imprint) of this certificate. | | [CertFriendlyName](#certfriendlyname-property-secureblackbox_messageverifier-class) | Contains an associated alias (friendly name) of the certificate. | | [CertHandle](#certhandle-property-secureblackbox_messageverifier-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [CertHashAlgorithm](#certhashalgorithm-property-secureblackbox_messageverifier-class) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [CertIssuer](#certissuer-property-secureblackbox_messageverifier-class) | The common name of the certificate issuer (CA), typically a company name. | | [CertIssuerRDN](#certissuerrdn-property-secureblackbox_messageverifier-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [CertKeyAlgorithm](#certkeyalgorithm-property-secureblackbox_messageverifier-class) | Specifies the public key algorithm of this certificate. | | [CertKeyBits](#certkeybits-property-secureblackbox_messageverifier-class) | Returns the length of the public key in bits. | | [CertKeyFingerprint](#certkeyfingerprint-property-secureblackbox_messageverifier-class) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [CertKeyUsage](#certkeyusage-property-secureblackbox_messageverifier-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [CertKeyValid](#certkeyvalid-property-secureblackbox_messageverifier-class) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [CertOCSPLocations](#certocsplocations-property-secureblackbox_messageverifier-class) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [CertOCSPNoCheck](#certocspnocheck-property-secureblackbox_messageverifier-class) | Accessor to the value of the certificate's ocsp-no-check extension. | | [CertOrigin](#certorigin-property-secureblackbox_messageverifier-class) | Returns the location that the certificate was taken or loaded from. | | [CertPolicyIDs](#certpolicyids-property-secureblackbox_messageverifier-class) | Contains identifiers (OIDs) of the applicable certificate policies. | | [CertPrivateKeyBytes](#certprivatekeybytes-property-secureblackbox_messageverifier-class) | Returns the certificate's private key in DER-encoded format. | | [CertPrivateKeyExists](#certprivatekeyexists-property-secureblackbox_messageverifier-class) | Indicates whether the certificate has a usable private key associated with it. | | [CertPrivateKeyExtractable](#certprivatekeyextractable-property-secureblackbox_messageverifier-class) | Indicates whether the private key is extractable (exportable). | | [CertPublicKeyBytes](#certpublickeybytes-property-secureblackbox_messageverifier-class) | Contains the certificate's public key in DER format. | | [CertQualified](#certqualified-property-secureblackbox_messageverifier-class) | Indicates whether the certificate is qualified. | | [CertQualifiedStatements](#certqualifiedstatements-property-secureblackbox_messageverifier-class) | Returns a simplified qualified status of the certificate. | | [CertQualifiers](#certqualifiers-property-secureblackbox_messageverifier-class) | A list of qualifiers. | | [CertSelfSigned](#certselfsigned-property-secureblackbox_messageverifier-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [CertSerialNumber](#certserialnumber-property-secureblackbox_messageverifier-class) | Returns the certificate's serial number. | | [CertSigAlgorithm](#certsigalgorithm-property-secureblackbox_messageverifier-class) | Indicates the algorithm that was used by the CA to sign this certificate. | | [CertSource](#certsource-property-secureblackbox_messageverifier-class) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [CertSubject](#certsubject-property-secureblackbox_messageverifier-class) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [CertSubjectAlternativeName](#certsubjectalternativename-property-secureblackbox_messageverifier-class) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [CertSubjectKeyID](#certsubjectkeyid-property-secureblackbox_messageverifier-class) | Contains a unique identifier of the certificate's cryptographic key. | | [CertSubjectRDN](#certsubjectrdn-property-secureblackbox_messageverifier-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [CertValid](#certvalid-property-secureblackbox_messageverifier-class) | 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. | | [CertValidFrom](#certvalidfrom-property-secureblackbox_messageverifier-class) | The time point at which the certificate becomes valid, in UTC. | | [CertValidTo](#certvalidto-property-secureblackbox_messageverifier-class) | The time point at which the certificate expires, in UTC. | | [ClaimedSigningTime](#claimedsigningtime-property-secureblackbox_messageverifier-class) | Returns a signature's claimed signing time. | | [ContentType](#contenttype-property-secureblackbox_messageverifier-class) | A content type property of the signed message. | | [DataBytes](#databytes-property-secureblackbox_messageverifier-class) | Use this property to pass the original signed data to class in the byte array form. | | [DataFile](#datafile-property-secureblackbox_messageverifier-class) | The name of the file containing the original signed data. | | [FIPSMode](#fipsmode-property-secureblackbox_messageverifier-class) | Reserved. | | [HashAlgorithm](#hashalgorithm-property-secureblackbox_messageverifier-class) | Hash algorithm which was used to calculate the signature. | | [InputBytes](#inputbytes-property-secureblackbox_messageverifier-class) | Use this property to pass the input to class in byte array form. | | [InputFile](#inputfile-property-secureblackbox_messageverifier-class) | Path to the file containing the signed message. | | [InputIsHash](#inputishash-property-secureblackbox_messageverifier-class) | Specifies whether the input source contains the hash of the data or the actual data. | | [KnownCertCount](#knowncertcount-property-secureblackbox_messageverifier-class) | The number of records in the KnownCert arrays. | | [KnownCertBytes](#knowncertbytes-property-secureblackbox_messageverifier-class) | Returns the raw certificate data in DER format. | | [KnownCertHandle](#knowncerthandle-property-secureblackbox_messageverifier-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [MACAlgorithm](#macalgorithm-property-secureblackbox_messageverifier-class) | Specifies the hash algorithm to be used. | | [OutputBytes](#outputbytes-property-secureblackbox_messageverifier-class) | Use this property to read the output the class object has produced. | | [OutputFile](#outputfile-property-secureblackbox_messageverifier-class) | Path to the file to save the extracted data to. | | [SignatureType](#signaturetype-property-secureblackbox_messageverifier-class) | The type of the processed signature. | | [SignatureValidationResult](#signaturevalidationresult-property-secureblackbox_messageverifier-class) | The signature validation result. | | [SignedAttributeCount](#signedattributecount-property-secureblackbox_messageverifier-class) | The number of records in the SignedAttribute arrays. | | [SignedAttributeOID](#signedattributeoid-property-secureblackbox_messageverifier-class) | The object identifier of the attribute. | | [SignedAttributeValue](#signedattributevalue-property-secureblackbox_messageverifier-class) | The value of the attribute. | | [SigningCertBytes](#signingcertbytes-property-secureblackbox_messageverifier-class) | Returns the raw certificate data in DER format. | | [SigningCertCA](#signingcertca-property-secureblackbox_messageverifier-class) | Indicates whether the certificate has a CA capability. | | [SigningCertCAKeyID](#signingcertcakeyid-property-secureblackbox_messageverifier-class) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [SigningCertCertType](#signingcertcerttype-property-secureblackbox_messageverifier-class) | Returns the type of the entity contained in the Certificate object. | | [SigningCertCRLDistributionPoints](#signingcertcrldistributionpoints-property-secureblackbox_messageverifier-class) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [SigningCertCurve](#signingcertcurve-property-secureblackbox_messageverifier-class) | Specifies the elliptic curve associated with the certificate's public key. | | [SigningCertFingerprint](#signingcertfingerprint-property-secureblackbox_messageverifier-class) | Contains the fingerprint (a hash imprint) of this certificate. | | [SigningCertFriendlyName](#signingcertfriendlyname-property-secureblackbox_messageverifier-class) | Contains an associated alias (friendly name) of the certificate. | | [SigningCertHandle](#signingcerthandle-property-secureblackbox_messageverifier-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [SigningCertHashAlgorithm](#signingcerthashalgorithm-property-secureblackbox_messageverifier-class) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [SigningCertIssuer](#signingcertissuer-property-secureblackbox_messageverifier-class) | The common name of the certificate issuer (CA), typically a company name. | | [SigningCertIssuerRDN](#signingcertissuerrdn-property-secureblackbox_messageverifier-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [SigningCertKeyAlgorithm](#signingcertkeyalgorithm-property-secureblackbox_messageverifier-class) | Specifies the public key algorithm of this certificate. | | [SigningCertKeyBits](#signingcertkeybits-property-secureblackbox_messageverifier-class) | Returns the length of the public key in bits. | | [SigningCertKeyFingerprint](#signingcertkeyfingerprint-property-secureblackbox_messageverifier-class) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [SigningCertKeyUsage](#signingcertkeyusage-property-secureblackbox_messageverifier-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [SigningCertKeyValid](#signingcertkeyvalid-property-secureblackbox_messageverifier-class) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [SigningCertOCSPLocations](#signingcertocsplocations-property-secureblackbox_messageverifier-class) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [SigningCertOCSPNoCheck](#signingcertocspnocheck-property-secureblackbox_messageverifier-class) | Accessor to the value of the certificate's ocsp-no-check extension. | | [SigningCertOrigin](#signingcertorigin-property-secureblackbox_messageverifier-class) | Returns the location that the certificate was taken or loaded from. | | [SigningCertPolicyIDs](#signingcertpolicyids-property-secureblackbox_messageverifier-class) | Contains identifiers (OIDs) of the applicable certificate policies. | | [SigningCertPrivateKeyBytes](#signingcertprivatekeybytes-property-secureblackbox_messageverifier-class) | Returns the certificate's private key in DER-encoded format. | | [SigningCertPrivateKeyExists](#signingcertprivatekeyexists-property-secureblackbox_messageverifier-class) | Indicates whether the certificate has a usable private key associated with it. | | [SigningCertPrivateKeyExtractable](#signingcertprivatekeyextractable-property-secureblackbox_messageverifier-class) | Indicates whether the private key is extractable (exportable). | | [SigningCertPublicKeyBytes](#signingcertpublickeybytes-property-secureblackbox_messageverifier-class) | Contains the certificate's public key in DER format. | | [SigningCertQualified](#signingcertqualified-property-secureblackbox_messageverifier-class) | Indicates whether the certificate is qualified. | | [SigningCertQualifiedStatements](#signingcertqualifiedstatements-property-secureblackbox_messageverifier-class) | Returns a simplified qualified status of the certificate. | | [SigningCertQualifiers](#signingcertqualifiers-property-secureblackbox_messageverifier-class) | A list of qualifiers. | | [SigningCertSelfSigned](#signingcertselfsigned-property-secureblackbox_messageverifier-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [SigningCertSerialNumber](#signingcertserialnumber-property-secureblackbox_messageverifier-class) | Returns the certificate's serial number. | | [SigningCertSigAlgorithm](#signingcertsigalgorithm-property-secureblackbox_messageverifier-class) | Indicates the algorithm that was used by the CA to sign this certificate. | | [SigningCertSource](#signingcertsource-property-secureblackbox_messageverifier-class) | Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. | | [SigningCertSubject](#signingcertsubject-property-secureblackbox_messageverifier-class) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [SigningCertSubjectAlternativeName](#signingcertsubjectalternativename-property-secureblackbox_messageverifier-class) | Returns or sets the value of the Subject Alternative Name extension of the certificate. | | [SigningCertSubjectKeyID](#signingcertsubjectkeyid-property-secureblackbox_messageverifier-class) | Contains a unique identifier of the certificate's cryptographic key. | | [SigningCertSubjectRDN](#signingcertsubjectrdn-property-secureblackbox_messageverifier-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [SigningCertValid](#signingcertvalid-property-secureblackbox_messageverifier-class) | 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. | | [SigningCertValidFrom](#signingcertvalidfrom-property-secureblackbox_messageverifier-class) | The time point at which the certificate becomes valid, in UTC. | | [SigningCertValidTo](#signingcertvalidto-property-secureblackbox_messageverifier-class) | The time point at which the certificate expires, in UTC. | | [TimestampAccuracy](#timestampaccuracy-property-secureblackbox_messageverifier-class) | This property indicates the accuracy of the included time mark, in microseconds. | | [TimestampBytes](#timestampbytes-property-secureblackbox_messageverifier-class) | Returns the raw timestamp data in DER format. | | [TimestampCertificateIndex](#timestampcertificateindex-property-secureblackbox_messageverifier-class) | Returns the index of the TSA certificate in the Certificates collection. | | [TimestampChainValidationDetails](#timestampchainvalidationdetails-property-secureblackbox_messageverifier-class) | The details of a certificate chain validation outcome. | | [TimestampChainValidationResult](#timestampchainvalidationresult-property-secureblackbox_messageverifier-class) | The outcome of a certificate chain validation routine. | | [TimestampContainsLongTermInfo](#timestampcontainslongterminfo-property-secureblackbox_messageverifier-class) | Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). | | [TimestampEntityLabel](#timestampentitylabel-property-secureblackbox_messageverifier-class) | Use this property to get the timestamp entity label. | | [TimestampHashAlgorithm](#timestamphashalgorithm-property-secureblackbox_messageverifier-class) | Returns the timestamp's hash algorithm. | | [TimestampParentEntity](#timestampparententity-property-secureblackbox_messageverifier-class) | Use this property to get the label of the timestamp's parent entity. | | [TimestampSerialNumber](#timestampserialnumber-property-secureblackbox_messageverifier-class) | Returns the timestamp's serial number. | | [TimestampTime](#timestamptime-property-secureblackbox_messageverifier-class) | The time point incorporated into the timestamp. | | [TimestampType](#timestamptype-property-secureblackbox_messageverifier-class) | Returns the type of the timestamp. | | [TimestampTSAName](#timestamptsaname-property-secureblackbox_messageverifier-class) | This value uniquely identifies the Timestamp Authority (TSA). | | [TimestampValidationLog](#timestampvalidationlog-property-secureblackbox_messageverifier-class) | Contains the TSA certificate chain validation log. | | [TimestampValidationResult](#timestampvalidationresult-property-secureblackbox_messageverifier-class) | Contains the timestamp validation outcome. | | [Timestamped](#timestamped-property-secureblackbox_messageverifier-class) | Indicates whether or not the signature is timestamped. | | [TSACertBytes](#tsacertbytes-property-secureblackbox_messageverifier-class) | Returns the raw certificate data in DER format. | | [TSACertCA](#tsacertca-property-secureblackbox_messageverifier-class) | Indicates whether the certificate has a CA capability. | | [TSACertCAKeyID](#tsacertcakeyid-property-secureblackbox_messageverifier-class) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [TSACertCRLDistributionPoints](#tsacertcrldistributionpoints-property-secureblackbox_messageverifier-class) | Contains a list of locations of CRL distribution points used to check this certificate's validity. | | [TSACertCurve](#tsacertcurve-property-secureblackbox_messageverifier-class) | Specifies the elliptic curve associated with the certificate's public key. | | [TSACertFingerprint](#tsacertfingerprint-property-secureblackbox_messageverifier-class) | Contains the fingerprint (a hash imprint) of this certificate. | | [TSACertFriendlyName](#tsacertfriendlyname-property-secureblackbox_messageverifier-class) | Contains an associated alias (friendly name) of the certificate. | | [TSACertHandle](#tsacerthandle-property-secureblackbox_messageverifier-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [TSACertHashAlgorithm](#tsacerthashalgorithm-property-secureblackbox_messageverifier-class) | Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). | | [TSACertIssuer](#tsacertissuer-property-secureblackbox_messageverifier-class) | The common name of the certificate issuer (CA), typically a company name. | | [TSACertIssuerRDN](#tsacertissuerrdn-property-secureblackbox_messageverifier-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [TSACertKeyAlgorithm](#tsacertkeyalgorithm-property-secureblackbox_messageverifier-class) | Specifies the public key algorithm of this certificate. | | [TSACertKeyBits](#tsacertkeybits-property-secureblackbox_messageverifier-class) | Returns the length of the public key in bits. | | [TSACertKeyFingerprint](#tsacertkeyfingerprint-property-secureblackbox_messageverifier-class) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [TSACertKeyUsage](#tsacertkeyusage-property-secureblackbox_messageverifier-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [TSACertKeyValid](#tsacertkeyvalid-property-secureblackbox_messageverifier-class) | Returns True if the certificate's key is cryptographically valid, and False otherwise. | | [TSACertOCSPLocations](#tsacertocsplocations-property-secureblackbox_messageverifier-class) | Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. | | [TSACertPolicyIDs](#tsacertpolicyids-property-secureblackbox_messageverifier-class) | Contains identifiers (OIDs) of the applicable certificate policies. | | [TSACertPublicKeyBytes](#tsacertpublickeybytes-property-secureblackbox_messageverifier-class) | Contains the certificate's public key in DER format. | | [TSACertSelfSigned](#tsacertselfsigned-property-secureblackbox_messageverifier-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [TSACertSerialNumber](#tsacertserialnumber-property-secureblackbox_messageverifier-class) | Returns the certificate's serial number. | | [TSACertSigAlgorithm](#tsacertsigalgorithm-property-secureblackbox_messageverifier-class) | Indicates the algorithm that was used by the CA to sign this certificate. | | [TSACertSubject](#tsacertsubject-property-secureblackbox_messageverifier-class) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [TSACertSubjectKeyID](#tsacertsubjectkeyid-property-secureblackbox_messageverifier-class) | Contains a unique identifier of the certificate's cryptographic key. | | [TSACertSubjectRDN](#tsacertsubjectrdn-property-secureblackbox_messageverifier-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [TSACertValidFrom](#tsacertvalidfrom-property-secureblackbox_messageverifier-class) | The time point at which the certificate becomes valid, in UTC. | | [TSACertValidTo](#tsacertvalidto-property-secureblackbox_messageverifier-class) | The time point at which the certificate expires, in UTC. | | [UnsignedAttributeCount](#unsignedattributecount-property-secureblackbox_messageverifier-class) | The number of records in the UnsignedAttribute arrays. | | [UnsignedAttributeOID](#unsignedattributeoid-property-secureblackbox_messageverifier-class) | The object identifier of the attribute. | | [UnsignedAttributeValue](#unsignedattributevalue-property-secureblackbox_messageverifier-class) | The value of the attribute. | | [ValidatedSigningTime](#validatedsigningtime-property-secureblackbox_messageverifier-class) | Contains the certified signing time. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CheckSignatureType](#checksignaturetype-method-secureblackbox_messageverifier-class) | Determines the signature kind. | | [Config](#config-method-secureblackbox_messageverifier-class) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-secureblackbox_messageverifier-class) | Performs an additional action. | | [Reset](#reset-method-secureblackbox_messageverifier-class) | Resets the class settings. | | [Verify](#verify-method-secureblackbox_messageverifier-class) | Verifies digitally signed data. | | [VerifyDetached](#verifydetached-method-secureblackbox_messageverifier-class) | Verifies a detached signature. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Error](#error-event-secureblackbox_messageverifier-class) | Information about errors during PKCS#7 message verification. | | [Notification](#notification-event-secureblackbox_messageverifier-class) | This event notifies the application about an underlying control flow event. | | [RecipientFound](#recipientfound-event-secureblackbox_messageverifier-class) | Fires to report a message addressee parameters. | | [SignatureFound](#signaturefound-event-secureblackbox_messageverifier-class) | Signifies the start of signature validation. | | [SignatureValidated](#signaturevalidated-event-secureblackbox_messageverifier-class) | Marks the completion of the signature validation routine. | | [TimestampFound](#timestampfound-event-secureblackbox_messageverifier-class) | Signifies the start of a timestamp validation routine. | | [TimestampValidated](#timestampvalidated-event-secureblackbox_messageverifier-class) | Reports the completion of the timestamp validation routine. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [TempPath](#TempPath) | Path for storing temporary files. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # CertCount Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The number of records in the Cert arrays. ## Object Oriented Interface ```text public function getCertCount(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 1 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [CertBytes](#certbytes-property-secureblackbox_messageverifier-class) - [CertCA](#certca-property-secureblackbox_messageverifier-class) - [CertCAKeyID](#certcakeyid-property-secureblackbox_messageverifier-class) - [CertCRLDistributionPoints](#certcrldistributionpoints-property-secureblackbox_messageverifier-class) - [CertCurve](#certcurve-property-secureblackbox_messageverifier-class) - [CertFingerprint](#certfingerprint-property-secureblackbox_messageverifier-class) - [CertFriendlyName](#certfriendlyname-property-secureblackbox_messageverifier-class) - [CertHandle](#certhandle-property-secureblackbox_messageverifier-class) - [CertHashAlgorithm](#certhashalgorithm-property-secureblackbox_messageverifier-class) - [CertIssuer](#certissuer-property-secureblackbox_messageverifier-class) - [CertIssuerRDN](#certissuerrdn-property-secureblackbox_messageverifier-class) - [CertKeyAlgorithm](#certkeyalgorithm-property-secureblackbox_messageverifier-class) - [CertKeyBits](#certkeybits-property-secureblackbox_messageverifier-class) - [CertKeyFingerprint](#certkeyfingerprint-property-secureblackbox_messageverifier-class) - [CertKeyUsage](#certkeyusage-property-secureblackbox_messageverifier-class) - [CertKeyValid](#certkeyvalid-property-secureblackbox_messageverifier-class) - [CertOCSPLocations](#certocsplocations-property-secureblackbox_messageverifier-class) - [CertOCSPNoCheck](#certocspnocheck-property-secureblackbox_messageverifier-class) - [CertOrigin](#certorigin-property-secureblackbox_messageverifier-class) - [CertPolicyIDs](#certpolicyids-property-secureblackbox_messageverifier-class) - [CertPrivateKeyBytes](#certprivatekeybytes-property-secureblackbox_messageverifier-class) - [CertPrivateKeyExists](#certprivatekeyexists-property-secureblackbox_messageverifier-class) - [CertPrivateKeyExtractable](#certprivatekeyextractable-property-secureblackbox_messageverifier-class) - [CertPublicKeyBytes](#certpublickeybytes-property-secureblackbox_messageverifier-class) - [CertQualified](#certqualified-property-secureblackbox_messageverifier-class) - [CertQualifiedStatements](#certqualifiedstatements-property-secureblackbox_messageverifier-class) - [CertQualifiers](#certqualifiers-property-secureblackbox_messageverifier-class) - [CertSelfSigned](#certselfsigned-property-secureblackbox_messageverifier-class) - [CertSerialNumber](#certserialnumber-property-secureblackbox_messageverifier-class) - [CertSigAlgorithm](#certsigalgorithm-property-secureblackbox_messageverifier-class) - [CertSource](#certsource-property-secureblackbox_messageverifier-class) - [CertSubject](#certsubject-property-secureblackbox_messageverifier-class) - [CertSubjectAlternativeName](#certsubjectalternativename-property-secureblackbox_messageverifier-class) - [CertSubjectKeyID](#certsubjectkeyid-property-secureblackbox_messageverifier-class) - [CertSubjectRDN](#certsubjectrdn-property-secureblackbox_messageverifier-class) - [CertType](#certtype-property-secureblackbox_messageverifier-class) - [CertValid](#certvalid-property-secureblackbox_messageverifier-class) - [CertValidFrom](#certvalidfrom-property-secureblackbox_messageverifier-class) - [CertValidTo](#certvalidto-property-secureblackbox_messageverifier-class) The array indices start at *0* and end at *CertCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # CertBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getCertBytes($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 2 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # CertCA Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate has a CA capability. ## Object Oriented Interface ```text public function getCertCA($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 3 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Boolean # CertCAKeyID Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Object Oriented Interface ```text public function getCertCAKeyID($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 4 , $certindex); ``` ## 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](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [CertSubjectKeyID](#certsubjectkeyid-property-secureblackbox_messageverifier-class) 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # CertType Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the type of the entity contained in the Certificate object. ## Object Oriented Interface ```text public function getCertType($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 5 , $certindex); ``` ## Possible Values ```text MESSAGEVERIFIER_CERTTYPE_UNKNOWN(0), MESSAGEVERIFIER_CERTTYPE_X509CERTIFICATE(1), MESSAGEVERIFIER_CERTTYPE_X509CERTIFICATE_REQUEST(2) ``` ## Default Value 0 ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_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](#CertificateManager) class 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Integer # CertCRLDistributionPoints Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Object Oriented Interface ```text public function getCertCRLDistributionPoints($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 6 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertCurve Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Specifies the elliptic curve associated with the certificate's public key. ## Object Oriented Interface ```text public function getCertCurve($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 7 , $certindex); ``` ## Default Value '' ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertFingerprint Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the fingerprint (a hash imprint) of this certificate. ## Object Oriented Interface ```text public function getCertFingerprint($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 8 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertFriendlyName Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains an associated alias (friendly name) of the certificate. ## Object Oriented Interface ```text public function getCertFriendlyName($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 9 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertHandle Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getCertHandle($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 10 , $certindex); ``` ## 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. ```text 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Long64 # CertHashAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Object Oriented Interface ```text public function getCertHashAlgorithm($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 11 , $certindex); ``` ## 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 [CertSigAlgorithm](#certsigalgorithm-property-secureblackbox_messageverifier-class) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertIssuer Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The common name of the certificate issuer (CA), typically a company name. ## Object Oriented Interface ```text public function getCertIssuer($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 12 , $certindex); ``` ## 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 [CertIssuerRDN](#certissuerrdn-property-secureblackbox_messageverifier-class). The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertIssuerRDN Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Object Oriented Interface ```text public function getCertIssuerRDN($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 13 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertKeyAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Specifies the public key algorithm of this certificate. ## Object Oriented Interface ```text public function getCertKeyAlgorithm($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 14 , $certindex); ``` ## Default Value '0' ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [CertKeyBits](#certkeybits-property-secureblackbox_messageverifier-class), [CertCurve](#certcurve-property-secureblackbox_messageverifier-class), and [CertPublicKeyBytes](#certpublickeybytes-property-secureblackbox_messageverifier-class) 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertKeyBits Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the length of the public key in bits. ## Object Oriented Interface ```text public function getCertKeyBits($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 15 , $certindex); ``` ## 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 [CertPublicKeyBytes](#certpublickeybytes-property-secureblackbox_messageverifier-class) or [CertPrivateKeyBytes](#certprivatekeybytes-property-secureblackbox_messageverifier-class) 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Integer # CertKeyFingerprint Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Object Oriented Interface ```text public function getCertKeyFingerprint($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 16 , $certindex); ``` ## 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 [CertFingerprint](#certfingerprint-property-secureblackbox_messageverifier-class) 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertKeyUsage Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Object Oriented Interface ```text public function getCertKeyUsage($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 17 , $certindex); ``` ## 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: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Integer # CertKeyValid Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Object Oriented Interface ```text public function getCertKeyValid($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 18 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Boolean # CertOCSPLocations Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Object Oriented Interface ```text public function getCertOCSPLocations($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 19 , $certindex); ``` ## 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](#CertificateManager_m_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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertOCSPNoCheck Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Accessor to the value of the certificate's ocsp-no-check extension. ## Object Oriented Interface ```text public function getCertOCSPNoCheck($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 20 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Boolean # CertOrigin Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the location that the certificate was taken or loaded from. ## Object Oriented Interface ```text public function getCertOrigin($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 21 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Integer # CertPolicyIDs Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains identifiers (OIDs) of the applicable certificate policies. ## Object Oriented Interface ```text public function getCertPolicyIDs($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 22 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertPrivateKeyBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the certificate's private key in DER-encoded format. ## Object Oriented Interface ```text public function getCertPrivateKeyBytes($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 23 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # CertPrivateKeyExists Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate has a usable private key associated with it. ## Object Oriented Interface ```text public function getCertPrivateKeyExists($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 24 , $certindex); ``` ## 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 [CertPrivateKeyBytes](#certprivatekeybytes-property-secureblackbox_messageverifier-class), 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Boolean # CertPrivateKeyExtractable Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the private key is extractable (exportable). ## Object Oriented Interface ```text public function getCertPrivateKeyExtractable($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 25 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Boolean # CertPublicKeyBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the certificate's public key in DER format. ## Object Oriented Interface ```text public function getCertPublicKeyBytes($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 26 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # CertQualified Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate is qualified. ## Object Oriented Interface ```text public function getCertQualified($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 27 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Boolean # CertQualifiedStatements Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns a simplified qualified status of the certificate. ## Object Oriented Interface ```text public function getCertQualifiedStatements($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 28 , $certindex); ``` ## Possible Values ```text MESSAGEVERIFIER_CERTQUALIFIEDSTATEMENTS_NON_QUALIFIED(0), MESSAGEVERIFIER_CERTQUALIFIEDSTATEMENTS_QUALIFIED_HARDWARE(1), MESSAGEVERIFIER_CERTQUALIFIEDSTATEMENTS_QUALIFIED_SOFTWARE(2) ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Integer # CertQualifiers Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A list of qualifiers. ## Object Oriented Interface ```text public function getCertQualifiers($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 29 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertSelfSigned Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Object Oriented Interface ```text public function getCertSelfSigned($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 30 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Boolean # CertSerialNumber Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the certificate's serial number. ## Object Oriented Interface ```text public function getCertSerialNumber($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 31 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # CertSigAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates the algorithm that was used by the CA to sign this certificate. ## Object Oriented Interface ```text public function getCertSigAlgorithm($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 32 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertSource Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Object Oriented Interface ```text public function getCertSource($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 33 , $certindex); ``` ## Possible Values ```text MESSAGEVERIFIER_CERTSOURCE_UNKNOWN(0), MESSAGEVERIFIER_CERTSOURCE_SIGNATURE(1), MESSAGEVERIFIER_CERTSOURCE_DOCUMENT(2), MESSAGEVERIFIER_CERTSOURCE_USER(3), MESSAGEVERIFIER_CERTSOURCE_LOCAL(4), MESSAGEVERIFIER_CERTSOURCE_ONLINE(5) ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Integer # CertSubject Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Object Oriented Interface ```text public function getCertSubject($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 34 , $certindex); ``` ## 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 [CertSubjectRDN](#certsubjectrdn-property-secureblackbox_messageverifier-class). The *$certindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertSubjectAlternativeName Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Object Oriented Interface ```text public function getCertSubjectAlternativeName($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 35 , $certindex); ``` ## 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 [CertSubjectRDN](#certsubjectrdn-property-secureblackbox_messageverifier-class) 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertSubjectKeyID Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains a unique identifier of the certificate's cryptographic key. ## Object Oriented Interface ```text public function getCertSubjectKeyID($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 36 , $certindex); ``` ## 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 [CertSubjectKeyID](#certsubjectkeyid-property-secureblackbox_messageverifier-class) and [CertCAKeyID](#certcakeyid-property-secureblackbox_messageverifier-class) 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # CertSubjectRDN Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Object Oriented Interface ```text public function getCertSubjectRDN($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 37 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertValid Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) 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. ## Object Oriented Interface ```text public function getCertValid($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 38 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Boolean # CertValidFrom Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The time point at which the certificate becomes valid, in UTC. ## Object Oriented Interface ```text public function getCertValidFrom($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 39 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # CertValidTo Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The time point at which the certificate expires, in UTC. ## Object Oriented Interface ```text public function getCertValidTo($certindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 40 , $certindex); ``` ## 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](#certcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # ClaimedSigningTime Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns a signature's claimed signing time. ## Object Oriented Interface ```text public function getClaimedSigningTime(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 41 ); ``` ## 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 [ValidatedSigningTime](#validatedsigningtime-property-secureblackbox_messageverifier-class) to obtain the signing time figure verified by a trusted timestamping authority. The time is in UTC. This property is read-only and not available at design time. ## Data Type String # ContentType Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A content type property of the signed message. ## Object Oriented Interface ```text public function getContentType(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 42 ); ``` ## Default Value '' ## Remarks Use this property to check the content type property of the processed signed message. This property is read-only and not available at design time. ## Data Type String # DataBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Use this property to pass the original signed data to class in the byte array form. ## Object Oriented Interface ```text public function getDataBytes(); public function setDataBytes($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 43 ); secureblackbox_messageverifier_set($res, 43, $value ); ``` ## Remarks When validating detached signatures, assign a byte array containing the signed data to this property. This property is not available at design time. ## Data Type Byte Array # DataFile Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The name of the file containing the original signed data. ## Object Oriented Interface ```text public function getDataFile(); public function setDataFile($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 44 ); secureblackbox_messageverifier_set($res, 44, $value ); ``` ## Default Value '' ## Remarks Use this property to provide the original data when validating detached signatures with [VerifyDetached](#verifydetached-method-secureblackbox_messageverifier-class). ## Data Type String # FIPSMode Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Reserved. ## Object Oriented Interface ```text public function getFIPSMode(); public function setFIPSMode($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 45 ); secureblackbox_messageverifier_set($res, 45, $value ); ``` ## Default Value false ## Remarks This property is reserved for future use. ## Data Type Boolean # HashAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Hash algorithm which was used to calculate the signature. ## Object Oriented Interface ```text public function getHashAlgorithm(); public function setHashAlgorithm($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 46 ); secureblackbox_messageverifier_set($res, 46, $value ); ``` ## Default Value '' ## Remarks Check this property after calling [Verify](#verify-method-secureblackbox_messageverifier-class) or [VerifyDetached](#verifydetached-method-secureblackbox_messageverifier-class) to get the hash algorithm that was used to calculate the signature message digest. ## Data Type String # InputBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Use this property to pass the input to class in byte array form. ## Object Oriented Interface ```text public function getInputBytes(); public function setInputBytes($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 47 ); secureblackbox_messageverifier_set($res, 47, $value ); ``` ## Remarks Assign a byte array containing the data to be processed to this property. This property is not available at design time. ## Data Type Byte Array # InputFile Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Path to the file containing the signed message. ## Object Oriented Interface ```text public function getInputFile(); public function setInputFile($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 48 ); secureblackbox_messageverifier_set($res, 48, $value ); ``` ## Default Value '' ## Remarks Use this property to provide a file containing the signed data, either enveloping or detached. ## Data Type String # InputIsHash Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Specifies whether the input source contains the hash of the data or the actual data. ## Object Oriented Interface ```text public function getInputIsHash(); public function setInputIsHash($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 49 ); secureblackbox_messageverifier_set($res, 49, $value ); ``` ## Default Value false ## Remarks Use this property to tell the component whether the input source contains the actual data or its hash. This property is not available at design time. ## Data Type Boolean # KnownCertCount Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The number of records in the KnownCert arrays. ## Object Oriented Interface ```text public function getKnownCertCount(); public function setKnownCertCount($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 50 ); secureblackbox_messageverifier_set($res, 50, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [KnownCertBytes](#knowncertbytes-property-secureblackbox_messageverifier-class) - [KnownCertHandle](#knowncerthandle-property-secureblackbox_messageverifier-class) The array indices start at *0* and end at *KnownCertCount - 1*. This property is not available at design time. ## Data Type Integer # KnownCertBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getKnownCertBytes($knowncertindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 51 , $knowncertindex); ``` ## 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](#knowncertcount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # KnownCertHandle Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getKnownCertHandle($knowncertindex); public function setKnownCertHandle($knowncertindex, $value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 59 , $knowncertindex); secureblackbox_messageverifier_set($res, 59, $value , $knowncertindex); ``` ## 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. ```text 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](#knowncertcount-property-secureblackbox_messageverifier-class) property. This property is not available at design time. ## Data Type Long64 # MACAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Specifies the hash algorithm to be used. ## Object Oriented Interface ```text public function getMACAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 90 ); ``` ## Default Value 'SHA256' ## Remarks This property specifies the MAC algorithm that was used to calculate an authenticated signature. | | | | | --- | --- | --- | | SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | | | SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | | | SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 | | This property is read-only. ## Data Type String # OutputBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Use this property to read the output the class object has produced. ## Object Oriented Interface ```text public function getOutputBytes(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 91 ); ``` ## 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 [OutputFile](#outputfile-property-secureblackbox_messageverifier-class) and OutputStream properties had not been assigned. This property is read-only and not available at design time. ## Data Type Byte Array # OutputFile Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Path to the file to save the extracted data to. ## Object Oriented Interface ```text public function getOutputFile(); public function setOutputFile($value); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 92 ); secureblackbox_messageverifier_set($res, 92, $value ); ``` ## 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 # SignatureType Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The type of the processed signature. ## Object Oriented Interface ```text public function getSignatureType(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 93 ); ``` ## Possible Values ```text MESSAGEVERIFIER_SIGNATURETYPE_UNKNOWN(0), MESSAGEVERIFIER_SIGNATURETYPE_PKCS1DETACHED(1), MESSAGEVERIFIER_SIGNATURETYPE_PKCS7DETACHED(2), MESSAGEVERIFIER_SIGNATURETYPE_PKCS7ENVELOPING(3), MESSAGEVERIFIER_SIGNATURETYPE_PKCS7MACDETACHED(4), MESSAGEVERIFIER_SIGNATURETYPE_PKCS7MACENVELOPING(5) ``` ## Default Value 0 ## Remarks Use this property to check the result of the most recent signature validation. | | | | | --- | --- | --- | | stUnknown | 0 | Unknown or unsupported signature types | | stPKCS1Detached | 1 | Detached PKCS#1 signature | | stPKCS7Detached | 2 | Detached PKCS#7 signature | | stPKCS7Enveloping | 3 | Enveloping PKCS#7 signature | | stPKCS7MACDetached | 4 | Detached PKCS#7 MAC signature | | stPKCS7MACEnveloping | 5 | Enveloping PKCS#7 MAC signature | This property is read-only and not available at design time. ## Data Type Integer # SignatureValidationResult Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The signature validation result. ## Object Oriented Interface ```text public function getSignatureValidationResult(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 94 ); ``` ## Possible Values ```text MESSAGEVERIFIER_SIGNATUREVALIDATIONRESULT_VALID(0), MESSAGEVERIFIER_SIGNATUREVALIDATIONRESULT_UNKNOWN(1), MESSAGEVERIFIER_SIGNATUREVALIDATIONRESULT_CORRUPTED(2), MESSAGEVERIFIER_SIGNATUREVALIDATIONRESULT_SIGNER_NOT_FOUND(3), MESSAGEVERIFIER_SIGNATUREVALIDATIONRESULT_FAILURE(4), MESSAGEVERIFIER_SIGNATUREVALIDATIONRESULT_REFERENCE_CORRUPTED(5) ``` ## Default Value 0 ## Remarks Use this property to check the result of the most recent signature validation. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only and not available at design time. ## Data Type Integer # SignedAttributeCount Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The number of records in the SignedAttribute arrays. ## Object Oriented Interface ```text public function getSignedAttributeCount(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 95 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SignedAttributeOID](#signedattributeoid-property-secureblackbox_messageverifier-class) - [SignedAttributeValue](#signedattributevalue-property-secureblackbox_messageverifier-class) The array indices start at *0* and end at *SignedAttributeCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # SignedAttributeOID Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The object identifier of the attribute. ## Object Oriented Interface ```text public function getSignedAttributeOID($signedattributeindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 96 , $signedattributeindex); ``` ## 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](#signedattributecount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # SignedAttributeValue Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The value of the attribute. ## Object Oriented Interface ```text public function getSignedAttributeValue($signedattributeindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 97 , $signedattributeindex); ``` ## 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](#signedattributecount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # SigningCertBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getSigningCertBytes(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 98 ); ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only and not available at design time. ## Data Type Byte Array # SigningCertCA Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate has a CA capability. ## Object Oriented Interface ```text public function getSigningCertCA(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 99 ); ``` ## 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 and not available at design time. ## Data Type Boolean # SigningCertCAKeyID Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Object Oriented Interface ```text public function getSigningCertCAKeyID(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 100 ); ``` ## 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](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SigningCertSubjectKeyID](#signingcertsubjectkeyid-property-secureblackbox_messageverifier-class) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. This property is read-only and not available at design time. ## Data Type Byte Array # SigningCertCertType Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the type of the entity contained in the Certificate object. ## Object Oriented Interface ```text public function getSigningCertCertType(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 101 ); ``` ## Possible Values ```text MESSAGEVERIFIER_SIGNINGCERTCERTTYPE_UNKNOWN(0), MESSAGEVERIFIER_SIGNINGCERTCERTTYPE_X509CERTIFICATE(1), MESSAGEVERIFIER_SIGNINGCERTCERTTYPE_X509CERTIFICATE_REQUEST(2) ``` ## Default Value 0 ## Remarks Returns the type of the entity contained in the [Certificate](#Type_Certificate) object. A [Certificate](#Type_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](#CertificateManager) class to load or create new certificate and certificate requests objects. This property is read-only and not available at design time. ## Data Type Integer # SigningCertCRLDistributionPoints Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Object Oriented Interface ```text public function getSigningCertCRLDistributionPoints(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 102 ); ``` ## 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 and not available at design time. ## Data Type String # SigningCertCurve Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Specifies the elliptic curve associated with the certificate's public key. ## Object Oriented Interface ```text public function getSigningCertCurve(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 103 ); ``` ## Default Value '' ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | This property is read-only and not available at design time. ## Data Type String # SigningCertFingerprint Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the fingerprint (a hash imprint) of this certificate. ## Object Oriented Interface ```text public function getSigningCertFingerprint(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 104 ); ``` ## 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 and not available at design time. ## Data Type String # SigningCertFriendlyName Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains an associated alias (friendly name) of the certificate. ## Object Oriented Interface ```text public function getSigningCertFriendlyName(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 105 ); ``` ## 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 and not available at design time. ## Data Type String # SigningCertHandle Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getSigningCertHandle(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 106 ); ``` ## 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is read-only and not available at design time. ## Data Type Long64 # SigningCertHashAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Object Oriented Interface ```text public function getSigningCertHashAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 107 ); ``` ## 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 [SigningCertSigAlgorithm](#signingcertsigalgorithm-property-secureblackbox_messageverifier-class) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | This property is read-only and not available at design time. ## Data Type String # SigningCertIssuer Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The common name of the certificate issuer (CA), typically a company name. ## Object Oriented Interface ```text public function getSigningCertIssuer(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 108 ); ``` ## 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 [SigningCertIssuerRDN](#signingcertissuerrdn-property-secureblackbox_messageverifier-class). This property is read-only and not available at design time. ## Data Type String # SigningCertIssuerRDN Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Object Oriented Interface ```text public function getSigningCertIssuerRDN(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 109 ); ``` ## 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 and not available at design time. ## Data Type String # SigningCertKeyAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Specifies the public key algorithm of this certificate. ## Object Oriented Interface ```text public function getSigningCertKeyAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 110 ); ``` ## Default Value '0' ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [SigningCertKeyBits](#signingcertkeybits-property-secureblackbox_messageverifier-class), [SigningCertCurve](#signingcertcurve-property-secureblackbox_messageverifier-class), and [SigningCertPublicKeyBytes](#signingcertpublickeybytes-property-secureblackbox_messageverifier-class) properties to get more details about the key the certificate contains. This property is read-only and not available at design time. ## Data Type String # SigningCertKeyBits Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the length of the public key in bits. ## Object Oriented Interface ```text public function getSigningCertKeyBits(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 111 ); ``` ## 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 [SigningCertPublicKeyBytes](#signingcertpublickeybytes-property-secureblackbox_messageverifier-class) or [SigningCertPrivateKeyBytes](#signingcertprivatekeybytes-property-secureblackbox_messageverifier-class) property would typically contain auxiliary values, and therefore be longer. This property is read-only and not available at design time. ## Data Type Integer # SigningCertKeyFingerprint Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Object Oriented Interface ```text public function getSigningCertKeyFingerprint(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 112 ); ``` ## 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 [SigningCertFingerprint](#signingcertfingerprint-property-secureblackbox_messageverifier-class) 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 and not available at design time. ## Data Type String # SigningCertKeyUsage Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Object Oriented Interface ```text public function getSigningCertKeyUsage(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 113 ); ``` ## 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: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. This property is read-only and not available at design time. ## Data Type Integer # SigningCertKeyValid Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Object Oriented Interface ```text public function getSigningCertKeyValid(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 114 ); ``` ## Default Value false ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. This property is read-only and not available at design time. ## Data Type Boolean # SigningCertOCSPLocations Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Object Oriented Interface ```text public function getSigningCertOCSPLocations(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 115 ); ``` ## 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](#CertificateManager_m_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 and not available at design time. ## Data Type String # SigningCertOCSPNoCheck Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Accessor to the value of the certificate's ocsp-no-check extension. ## Object Oriented Interface ```text public function getSigningCertOCSPNoCheck(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 116 ); ``` ## Default Value false ## Remarks Accessor to the value of the certificate's ocsp-no-check extension. This property is read-only and not available at design time. ## Data Type Boolean # SigningCertOrigin Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the location that the certificate was taken or loaded from. ## Object Oriented Interface ```text public function getSigningCertOrigin(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 117 ); ``` ## Default Value 0 ## Remarks Returns the location that the certificate was taken or loaded from. This property is read-only and not available at design time. ## Data Type Integer # SigningCertPolicyIDs Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains identifiers (OIDs) of the applicable certificate policies. ## Object Oriented Interface ```text public function getSigningCertPolicyIDs(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 118 ); ``` ## 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 and not available at design time. ## Data Type String # SigningCertPrivateKeyBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the certificate's private key in DER-encoded format. ## Object Oriented Interface ```text public function getSigningCertPrivateKeyBytes(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 119 ); ``` ## 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 and not available at design time. ## Data Type Byte Array # SigningCertPrivateKeyExists Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate has a usable private key associated with it. ## Object Oriented Interface ```text public function getSigningCertPrivateKeyExists(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 120 ); ``` ## 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 [SigningCertPrivateKeyBytes](#signingcertprivatekeybytes-property-secureblackbox_messageverifier-class), 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 and not available at design time. ## Data Type Boolean # SigningCertPrivateKeyExtractable Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the private key is extractable (exportable). ## Object Oriented Interface ```text public function getSigningCertPrivateKeyExtractable(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 121 ); ``` ## Default Value false ## Remarks Indicates whether the private key is extractable (exportable). This property is read-only and not available at design time. ## Data Type Boolean # SigningCertPublicKeyBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the certificate's public key in DER format. ## Object Oriented Interface ```text public function getSigningCertPublicKeyBytes(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 122 ); ``` ## 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 and not available at design time. ## Data Type Byte Array # SigningCertQualified Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate is qualified. ## Object Oriented Interface ```text public function getSigningCertQualified(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 123 ); ``` ## 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 and not available at design time. ## Data Type Boolean # SigningCertQualifiedStatements Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns a simplified qualified status of the certificate. ## Object Oriented Interface ```text public function getSigningCertQualifiedStatements(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 124 ); ``` ## Possible Values ```text MESSAGEVERIFIER_SIGNINGCERTQUALIFIEDSTATEMENTS_NON_QUALIFIED(0), MESSAGEVERIFIER_SIGNINGCERTQUALIFIEDSTATEMENTS_QUALIFIED_HARDWARE(1), MESSAGEVERIFIER_SIGNINGCERTQUALIFIEDSTATEMENTS_QUALIFIED_SOFTWARE(2) ``` ## Default Value 0 ## Remarks Returns a simplified qualified status of the certificate. This property is read-only and not available at design time. ## Data Type Integer # SigningCertQualifiers Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A list of qualifiers. ## Object Oriented Interface ```text public function getSigningCertQualifiers(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 125 ); ``` ## 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 and not available at design time. ## Data Type String # SigningCertSelfSigned Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Object Oriented Interface ```text public function getSigningCertSelfSigned(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 126 ); ``` ## Default Value false ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. This property is read-only and not available at design time. ## Data Type Boolean # SigningCertSerialNumber Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the certificate's serial number. ## Object Oriented Interface ```text public function getSigningCertSerialNumber(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 127 ); ``` ## 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 and not available at design time. ## Data Type Byte Array # SigningCertSigAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates the algorithm that was used by the CA to sign this certificate. ## Object Oriented Interface ```text public function getSigningCertSigAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 128 ); ``` ## 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 and not available at design time. ## Data Type String # SigningCertSource Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Object Oriented Interface ```text public function getSigningCertSource(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 129 ); ``` ## Possible Values ```text MESSAGEVERIFIER_SIGNINGCERTSOURCE_UNKNOWN(0), MESSAGEVERIFIER_SIGNINGCERTSOURCE_SIGNATURE(1), MESSAGEVERIFIER_SIGNINGCERTSOURCE_DOCUMENT(2), MESSAGEVERIFIER_SIGNINGCERTSOURCE_USER(3), MESSAGEVERIFIER_SIGNINGCERTSOURCE_LOCAL(4), MESSAGEVERIFIER_SIGNINGCERTSOURCE_ONLINE(5) ``` ## 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 and not available at design time. ## Data Type Integer # SigningCertSubject Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Object Oriented Interface ```text public function getSigningCertSubject(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 130 ); ``` ## 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 [SigningCertSubjectRDN](#signingcertsubjectrdn-property-secureblackbox_messageverifier-class). This property is read-only and not available at design time. ## Data Type String # SigningCertSubjectAlternativeName Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns or sets the value of the Subject Alternative Name extension of the certificate. ## Object Oriented Interface ```text public function getSigningCertSubjectAlternativeName(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 131 ); ``` ## 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 [SigningCertSubjectRDN](#signingcertsubjectrdn-property-secureblackbox_messageverifier-class) 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 and not available at design time. ## Data Type String # SigningCertSubjectKeyID Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains a unique identifier of the certificate's cryptographic key. ## Object Oriented Interface ```text public function getSigningCertSubjectKeyID(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 132 ); ``` ## 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 [SigningCertSubjectKeyID](#signingcertsubjectkeyid-property-secureblackbox_messageverifier-class) and [SigningCertCAKeyID](#signingcertcakeyid-property-secureblackbox_messageverifier-class) 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 and not available at design time. ## Data Type Byte Array # SigningCertSubjectRDN Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Object Oriented Interface ```text public function getSigningCertSubjectRDN(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 133 ); ``` ## 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 and not available at design time. ## Data Type String # SigningCertValid Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) 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. ## Object Oriented Interface ```text public function getSigningCertValid(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 134 ); ``` ## 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 and not available at design time. ## Data Type Boolean # SigningCertValidFrom Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The time point at which the certificate becomes valid, in UTC. ## Object Oriented Interface ```text public function getSigningCertValidFrom(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 135 ); ``` ## Default Value '' ## Remarks The time point at which the certificate becomes valid, in UTC. This property is read-only and not available at design time. ## Data Type String # SigningCertValidTo Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The time point at which the certificate expires, in UTC. ## Object Oriented Interface ```text public function getSigningCertValidTo(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 136 ); ``` ## Default Value '' ## Remarks The time point at which the certificate expires, in UTC. This property is read-only and not available at design time. ## Data Type String # TimestampAccuracy Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) This property indicates the accuracy of the included time mark, in microseconds. ## Object Oriented Interface ```text public function getTimestampAccuracy(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 137 ); ``` ## Default Value 0 ## Remarks This field indicates the accuracy of the included time mark, in microseconds. This property is read-only and not available at design time. ## Data Type Long64 # TimestampBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the raw timestamp data in DER format. ## Object Oriented Interface ```text public function getTimestampBytes(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 138 ); ``` ## Remarks Returns the raw timestamp data in DER format. This property is read-only and not available at design time. ## Data Type Byte Array # TimestampCertificateIndex Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the index of the TSA certificate in the Certificates collection. ## Object Oriented Interface ```text public function getTimestampCertificateIndex(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 139 ); ``` ## 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 and not available at design time. ## Data Type Integer # TimestampChainValidationDetails Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The details of a certificate chain validation outcome. ## Object Oriented Interface ```text public function getTimestampChainValidationDetails(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 140 ); ``` ## 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: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is read-only and not available at design time. ## Data Type Integer # TimestampChainValidationResult Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The outcome of a certificate chain validation routine. ## Object Oriented Interface ```text public function getTimestampChainValidationResult(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 141 ); ``` ## Possible Values ```text MESSAGEVERIFIER_TIMESTAMPCHAINVALIDATIONRESULT_VALID(0), MESSAGEVERIFIER_TIMESTAMPCHAINVALIDATIONRESULT_VALID_BUT_UNTRUSTED(1), MESSAGEVERIFIER_TIMESTAMPCHAINVALIDATIONRESULT_INVALID(2), MESSAGEVERIFIER_TIMESTAMPCHAINVALIDATIONRESULT_CANT_BE_ESTABLISHED(3) ``` ## Default Value 0 ## Remarks The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. This property is read-only and not available at design time. ## Data Type Integer # TimestampContainsLongTermInfo Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns true if the signature was found to contain long-term validation details (certificates, CRLs, and OCSP response). ## Object Oriented Interface ```text public function getTimestampContainsLongTermInfo(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 142 ); ``` ## 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 and not available at design time. ## Data Type Boolean # TimestampEntityLabel Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Use this property to get the timestamp entity label. ## Object Oriented Interface ```text public function getTimestampEntityLabel(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 143 ); ``` ## 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 and not available at design time. ## Data Type String # TimestampHashAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the timestamp's hash algorithm. ## Object Oriented Interface ```text public function getTimestampHashAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 144 ); ``` ## Default Value '' ## Remarks Returns the timestamp's hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | This property is read-only and not available at design time. ## Data Type String # TimestampParentEntity Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Use this property to get the label of the timestamp's parent entity. ## Object Oriented Interface ```text public function getTimestampParentEntity(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 145 ); ``` ## 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 and not available at design time. ## Data Type String # TimestampSerialNumber Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the timestamp's serial number. ## Object Oriented Interface ```text public function getTimestampSerialNumber(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 146 ); ``` ## Remarks Returns the timestamp's serial number. This property is read-only and not available at design time. ## Data Type Byte Array # TimestampTime Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The time point incorporated into the timestamp. ## Object Oriented Interface ```text public function getTimestampTime(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 147 ); ``` ## Default Value '' ## Remarks The time point incorporated into the timestamp. This property is read-only and not available at design time. ## Data Type String # TimestampType Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the type of the timestamp. ## Object Oriented Interface ```text public function getTimestampType(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 148 ); ``` ## Default Value 0 ## Remarks Returns the type of the timestamp. Available options: | | | | | --- | --- | --- | | tstUnknown | 0 | | | tstLegacy | 1 | Supported by: Authenticode components | | tstTrusted | 2 | Supported by: Authenticode components | | tstGeneric | 3 | Supported by: CAdES components | | tstESC | 4 | Supported by: CAdES components | | tstContent | 5 | Supported by: CAdES components | | tstCertsAndCRLs | 6 | Supported by: CAdES components | | tstArchive | 7 | Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components | | tstArchive2 | 8 | Archive v2 timestamp. Supported by: ASiC, CAdES components | | tstArchive3 | 9 | Archive v3 timestamp. Supported by: ASiC, CAdES components | | tstIndividualDataObjects | 10 | Individual data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components | | tstAllDataObjects | 11 | All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components | | tstSignature | 12 | Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components | | tstRefsOnly | 13 | RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components | | tstSigAndRefs | 14 | SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components | | tstSignedData | 15 | SignedData timestamp. Supported by: JAdES components | | tstArchive141 | 16 | Archive timestamp v1.4.1. Supported by: ASiC, Office, SOAP, XAdES components | Not all of the above timestamp types can be supported by a specific signature technology used (CAdES, PDF, XAdES). This property is read-only and not available at design time. ## Data Type Integer # TimestampTSAName Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) This value uniquely identifies the Timestamp Authority (TSA). ## Object Oriented Interface ```text public function getTimestampTSAName(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 149 ); ``` ## 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 and not available at design time. ## Data Type String # TimestampValidationLog Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the TSA certificate chain validation log. ## Object Oriented Interface ```text public function getTimestampValidationLog(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 150 ); ``` ## 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 and not available at design time. ## Data Type String # TimestampValidationResult Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the timestamp validation outcome. ## Object Oriented Interface ```text public function getTimestampValidationResult(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 151 ); ``` ## Possible Values ```text MESSAGEVERIFIER_TIMESTAMPVALIDATIONRESULT_VALID(0), MESSAGEVERIFIER_TIMESTAMPVALIDATIONRESULT_UNKNOWN(1), MESSAGEVERIFIER_TIMESTAMPVALIDATIONRESULT_CORRUPTED(2), MESSAGEVERIFIER_TIMESTAMPVALIDATIONRESULT_SIGNER_NOT_FOUND(3), MESSAGEVERIFIER_TIMESTAMPVALIDATIONRESULT_FAILURE(4), MESSAGEVERIFIER_TIMESTAMPVALIDATIONRESULT_REFERENCE_CORRUPTED(5) ``` ## Default Value 0 ## Remarks Contains the timestamp validation outcome. Use this property to check the result of the most recent timestamp validation. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | This property is read-only and not available at design time. ## Data Type Integer # Timestamped Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether or not the signature is timestamped. ## Object Oriented Interface ```text public function getTimestamped(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 152 ); ``` ## Default Value false ## Remarks This property returns True if the signature is timestamped, and False otherwise. This property is read-only and not available at design time. ## Data Type Boolean # TSACertBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the raw certificate data in DER format. ## Object Oriented Interface ```text public function getTSACertBytes(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 153 ); ``` ## Remarks Returns the raw certificate data in DER format. This property is read-only and not available at design time. ## Data Type Byte Array # TSACertCA Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate has a CA capability. ## Object Oriented Interface ```text public function getTSACertCA(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 154 ); ``` ## 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 and not available at design time. ## Data Type Boolean # TSACertCAKeyID Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Object Oriented Interface ```text public function getTSACertCAKeyID(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 155 ); ``` ## 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](#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [TSACertSubjectKeyID](#tsacertsubjectkeyid-property-secureblackbox_messageverifier-class) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. This property is read-only and not available at design time. ## Data Type Byte Array # TSACertCRLDistributionPoints Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains a list of locations of CRL distribution points used to check this certificate's validity. ## Object Oriented Interface ```text public function getTSACertCRLDistributionPoints(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 157 ); ``` ## 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 and not available at design time. ## Data Type String # TSACertCurve Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Specifies the elliptic curve associated with the certificate's public key. ## Object Oriented Interface ```text public function getTSACertCurve(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 158 ); ``` ## Default Value '' ## Remarks Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | This property is read-only and not available at design time. ## Data Type String # TSACertFingerprint Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the fingerprint (a hash imprint) of this certificate. ## Object Oriented Interface ```text public function getTSACertFingerprint(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 159 ); ``` ## 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 and not available at design time. ## Data Type String # TSACertFriendlyName Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains an associated alias (friendly name) of the certificate. ## Object Oriented Interface ```text public function getTSACertFriendlyName(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 160 ); ``` ## 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 and not available at design time. ## Data Type String # TSACertHandle Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Object Oriented Interface ```text public function getTSACertHandle(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 161 ); ``` ## 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` This property is read-only and not available at design time. ## Data Type Long64 # TSACertHashAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). ## Object Oriented Interface ```text public function getTSACertHashAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 162 ); ``` ## 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 [TSACertSigAlgorithm](#tsacertsigalgorithm-property-secureblackbox_messageverifier-class) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | This property is read-only and not available at design time. ## Data Type String # TSACertIssuer Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The common name of the certificate issuer (CA), typically a company name. ## Object Oriented Interface ```text public function getTSACertIssuer(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 163 ); ``` ## 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 [TSACertIssuerRDN](#tsacertissuerrdn-property-secureblackbox_messageverifier-class). This property is read-only and not available at design time. ## Data Type String # TSACertIssuerRDN Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A list of Property=Value pairs that uniquely identify the certificate issuer. ## Object Oriented Interface ```text public function getTSACertIssuerRDN(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 164 ); ``` ## 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 and not available at design time. ## Data Type String # TSACertKeyAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Specifies the public key algorithm of this certificate. ## Object Oriented Interface ```text public function getTSACertKeyAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 165 ); ``` ## Default Value '0' ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [TSACertKeyBits](#tsacertkeybits-property-secureblackbox_messageverifier-class), [TSACertCurve](#tsacertcurve-property-secureblackbox_messageverifier-class), and [TSACertPublicKeyBytes](#tsacertpublickeybytes-property-secureblackbox_messageverifier-class) properties to get more details about the key the certificate contains. This property is read-only and not available at design time. ## Data Type String # TSACertKeyBits Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the length of the public key in bits. ## Object Oriented Interface ```text public function getTSACertKeyBits(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 166 ); ``` ## 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 [TSACertPublicKeyBytes](#tsacertpublickeybytes-property-secureblackbox_messageverifier-class) or [TSACertPrivateKeyBytes](#MessageVerifier_p_TSACertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. This property is read-only and not available at design time. ## Data Type Integer # TSACertKeyFingerprint Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns a SHA1 fingerprint of the public key contained in the certificate. ## Object Oriented Interface ```text public function getTSACertKeyFingerprint(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 167 ); ``` ## 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 [TSACertFingerprint](#tsacertfingerprint-property-secureblackbox_messageverifier-class) 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 and not available at design time. ## Data Type String # TSACertKeyUsage Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Object Oriented Interface ```text public function getTSACertKeyUsage(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 168 ); ``` ## 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: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. This property is read-only and not available at design time. ## Data Type Integer # TSACertKeyValid Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns True if the certificate's key is cryptographically valid, and False otherwise. ## Object Oriented Interface ```text public function getTSACertKeyValid(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 169 ); ``` ## Default Value false ## Remarks Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. This property is read-only and not available at design time. ## Data Type Boolean # TSACertOCSPLocations Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. ## Object Oriented Interface ```text public function getTSACertOCSPLocations(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 170 ); ``` ## 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](#CertificateManager_m_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 and not available at design time. ## Data Type String # TSACertPolicyIDs Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains identifiers (OIDs) of the applicable certificate policies. ## Object Oriented Interface ```text public function getTSACertPolicyIDs(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 173 ); ``` ## 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 and not available at design time. ## Data Type String # TSACertPublicKeyBytes Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the certificate's public key in DER format. ## Object Oriented Interface ```text public function getTSACertPublicKeyBytes(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 177 ); ``` ## 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 and not available at design time. ## Data Type Byte Array # TSACertSelfSigned Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Object Oriented Interface ```text public function getTSACertSelfSigned(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 181 ); ``` ## Default Value false ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. This property is read-only and not available at design time. ## Data Type Boolean # TSACertSerialNumber Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Returns the certificate's serial number. ## Object Oriented Interface ```text public function getTSACertSerialNumber(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 182 ); ``` ## 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 and not available at design time. ## Data Type Byte Array # TSACertSigAlgorithm Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Indicates the algorithm that was used by the CA to sign this certificate. ## Object Oriented Interface ```text public function getTSACertSigAlgorithm(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 183 ); ``` ## 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 and not available at design time. ## Data Type String # TSACertSubject Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Object Oriented Interface ```text public function getTSACertSubject(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 185 ); ``` ## 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 [TSACertSubjectRDN](#tsacertsubjectrdn-property-secureblackbox_messageverifier-class). This property is read-only and not available at design time. ## Data Type String # TSACertSubjectKeyID Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains a unique identifier of the certificate's cryptographic key. ## Object Oriented Interface ```text public function getTSACertSubjectKeyID(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 187 ); ``` ## 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 [TSACertSubjectKeyID](#tsacertsubjectkeyid-property-secureblackbox_messageverifier-class) and [TSACertCAKeyID](#tsacertcakeyid-property-secureblackbox_messageverifier-class) 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 and not available at design time. ## Data Type Byte Array # TSACertSubjectRDN Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Object Oriented Interface ```text public function getTSACertSubjectRDN(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 188 ); ``` ## 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 and not available at design time. ## Data Type String # TSACertValidFrom Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The time point at which the certificate becomes valid, in UTC. ## Object Oriented Interface ```text public function getTSACertValidFrom(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 190 ); ``` ## Default Value '' ## Remarks The time point at which the certificate becomes valid, in UTC. This property is read-only and not available at design time. ## Data Type String # TSACertValidTo Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The time point at which the certificate expires, in UTC. ## Object Oriented Interface ```text public function getTSACertValidTo(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 191 ); ``` ## Default Value '' ## Remarks The time point at which the certificate expires, in UTC. This property is read-only and not available at design time. ## Data Type String # UnsignedAttributeCount Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The number of records in the UnsignedAttribute arrays. ## Object Oriented Interface ```text public function getUnsignedAttributeCount(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 192 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [UnsignedAttributeOID](#unsignedattributeoid-property-secureblackbox_messageverifier-class) - [UnsignedAttributeValue](#unsignedattributevalue-property-secureblackbox_messageverifier-class) The array indices start at *0* and end at *UnsignedAttributeCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # UnsignedAttributeOID Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The object identifier of the attribute. ## Object Oriented Interface ```text public function getUnsignedAttributeOID($unsignedattributeindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 193 , $unsignedattributeindex); ``` ## 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](#unsignedattributecount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type String # UnsignedAttributeValue Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) The value of the attribute. ## Object Oriented Interface ```text public function getUnsignedAttributeValue($unsignedattributeindex); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 194 , $unsignedattributeindex); ``` ## 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](#unsignedattributecount-property-secureblackbox_messageverifier-class) property. This property is read-only and not available at design time. ## Data Type Byte Array # ValidatedSigningTime Property ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Contains the certified signing time. ## Object Oriented Interface ```text public function getValidatedSigningTime(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_get($res, 195 ); ``` ## 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 and not available at design time. ## Data Type String # CheckSignatureType Method ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Determines the signature kind. ## Object Oriented Interface ```text public function doCheckSignatureType(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_do_checksignaturetype($res); ``` ## Remarks Use this method to determine the kind of the signature stored in [InputFile](#inputfile-property-secureblackbox_messageverifier-class) (InputStream). | | | | | --- | --- | --- | | stUnknown | 0 | Unknown or unsupported signature types | | stPKCS1Detached | 1 | Detached PKCS#1 signature | | stPKCS7Detached | 2 | Detached PKCS#7 signature | | stPKCS7Enveloping | 3 | Enveloping PKCS#7 signature | | stPKCS7MACDetached | 4 | Detached PKCS#7 MAC signature | | stPKCS7MACEnveloping | 5 | Enveloping PKCS#7 MAC signature | # Config Method ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text secureblackbox_messageverifier_do_config($res, $configurationstring); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-messageverifier-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#config-settings-messageverifier-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Performs an additional action. ## Object Oriented Interface ```text public function doDoAction($actionid, $actionparams); ``` ## Procedural Interface ```text secureblackbox_messageverifier_do_doaction($res, $actionid, $actionparams); ``` ## Remarks DoAction is a generic method available in every class. 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: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # Reset Method ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Resets the class settings. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_do_reset($res); ``` ## Remarks Reset is a generic method available in every class. # Verify Method ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Verifies digitally signed data. ## Object Oriented Interface ```text public function doVerify(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_do_verify($res); ``` ## 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 [VerifyDetached](#verifydetached-method-secureblackbox_messageverifier-class) to verify detached signatures. This method expects the enveloping signature to be provided via [InputFile](#inputfile-property-secureblackbox_messageverifier-class) or InputStream 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](CertificateValidator.md#CertificateValidator) component together with MessageVerifier, or consider using [CAdESVerifier](CAdESVerifier.md#CAdESVerifier) component instead. # VerifyDetached Method ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Verifies a detached signature. ## Object Oriented Interface ```text public function doVerifyDetached(); ``` ## Procedural Interface ```text secureblackbox_messageverifier_do_verifydetached($res); ``` ## Remarks Use this method to verify detached signatures. Pass the signature via [InputFile](#inputfile-property-secureblackbox_messageverifier-class) (or InputStream) property, and the original data via [DataFile](#datafile-property-secureblackbox_messageverifier-class) (DataStream). # Error Event ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Information about errors during PKCS#7 message verification. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text secureblackbox_messageverifier_register_callback($res, 1, array($this, 'fireError')); ``` ## Parameter List ```text 'errorcode' 'description' ``` ## 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](#trappable-errors-messageverifier-class) section. # Notification Event ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) This event notifies the application about an underlying control flow event. ## Object Oriented Interface ```text public function fireNotification($param); ``` ## Procedural Interface ```text secureblackbox_messageverifier_register_callback($res, 2, array($this, 'fireNotification')); ``` ## Parameter List ```text 'eventid' 'eventparam' ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, the exact action it is performing, or the document being processed, one or both may be omitted. This class can fire this event with the following *EventID* values: | | | | --- | --- | | Progress | Fires periodically to report the progress of the current operation. The EventParam parameter contains a slash-separated pair of values (Current/Total). | # RecipientFound Event ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Fires to report a message addressee parameters. ## Object Oriented Interface ```text public function fireRecipientFound($param); ``` ## Procedural Interface ```text secureblackbox_messageverifier_register_callback($res, 3, array($this, 'fireRecipientFound')); ``` ## Parameter List ```text 'issuerrdn' 'serialnumber' 'subjectkeyid' 'certfound' ``` ## 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. # SignatureFound Event ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Signifies the start of signature validation. ## Object Oriented Interface ```text public function fireSignatureFound($param); ``` ## Procedural Interface ```text secureblackbox_messageverifier_register_callback($res, 4, array($this, 'fireSignatureFound')); ``` ## Parameter List ```text 'issuerrdn' 'serialnumber' 'subjectkeyid' 'certfound' 'validatesignature' 'validatechain' ``` ## 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 class 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 KnownCertificates 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. # SignatureValidated Event ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Marks the completion of the signature validation routine. ## Object Oriented Interface ```text public function fireSignatureValidated($param); ``` ## Procedural Interface ```text secureblackbox_messageverifier_register_callback($res, 5, array($this, 'fireSignatureValidated')); ``` ## Parameter List ```text 'issuerrdn' 'serialnumber' 'subjectkeyid' 'validationresult' ``` ## 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. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | # TimestampFound Event ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Signifies the start of a timestamp validation routine. ## Object Oriented Interface ```text public function fireTimestampFound($param); ``` ## Procedural Interface ```text secureblackbox_messageverifier_register_callback($res, 6, array($this, 'fireTimestampFound')); ``` ## Parameter List ```text 'issuerrdn' 'serialnumber' 'subjectkeyid' 'certfound' 'validatetimestamp' 'validatechain' ``` ## 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 class 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 KnownCertificates 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. # TimestampValidated Event ([SecureBlackbox_MessageVerifier](#messageverifier-class) Class) Reports the completion of the timestamp validation routine. ## Object Oriented Interface ```text public function fireTimestampValidated($param); ``` ## Procedural Interface ```text secureblackbox_messageverifier_register_callback($res, 7, array($this, 'fireTimestampValidated')); ``` ## Parameter List ```text 'issuerrdn' 'serialnumber' 'subjectkeyid' 'time' 'validationresult' 'chainvalidationresult' 'chainvalidationdetails' ``` ## 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. | | | | | --- | --- | --- | | svtValid | 0 | The signature is valid | | svtUnknown | 1 | Signature validity is unknown | | svtCorrupted | 2 | The signature is corrupted | | svtSignerNotFound | 3 | Failed to acquire the signing certificate. The signature cannot be validated. | | svtFailure | 4 | General failure | | svtReferenceCorrupted | 5 | Reference corrupted (XML-based signatures only) | # Config Settings ([MessageVerifier](#messageverifier-class) Class) The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-secureblackbox_messageverifier-class) method. ### MessageVerifier Config Settings **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([MessageVerifier](#messageverifier-class) Class) ### MessageVerifier Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |