MessageVerifier Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

MessageVerifier

Remarks

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

Property List


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

CertCountThe number of records in the Cert arrays.
CertBytesReturns raw certificate data in DER format.
CertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
CertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
CertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
CertCurveSpecifies the elliptic curve of the EC public key.
CertFingerprintContains the fingerprint (a hash imprint) of this certificate.
CertFriendlyNameContains an associated alias (friendly name) of the certificate.
CertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CertHashAlgorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
CertIssuerThe common name of the certificate issuer (CA), typically a company name.
CertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
CertKeyAlgorithmSpecifies the public key algorithm of this certificate.
CertKeyBitsReturns the length of the public key.
CertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
CertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
CertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
CertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
CertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
CertPublicKeyBytesContains the certificate's public key in DER format.
CertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
CertSerialNumberReturns the certificate's serial number.
CertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
CertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
CertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
CertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
CertValidFromThe time point at which the certificate becomes valid, in UTC.
CertValidToThe time point at which the certificate expires, in UTC.
ClaimedSigningTimeReturns a signature's claimed signing time.
ContentTypeA content type property of the signed message.
DataBytesUse this property to pass the original signed data to class in the byte array form.
DataFileThe name of the file containing the original signed data.
FIPSModeReserved.
HashAlgorithmHash algorithm which was used to calculate the signature.
InputBytesUse this property to pass the input to class in the byte array form.
InputFilePath to the file containing the signed message.
InputIsHashSpecifies whether the input source contains the hash of the data or the actual data.
KnownCertCountThe number of records in the KnownCert arrays.
KnownCertBytesReturns raw certificate data in DER format.
KnownCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
MACAlgorithmSpecifies the hash algorithm to be used.
OutputBytesUse this property to read the output the class object has produced.
OutputFilePath to the file to save the extracted data to.
SignatureTypeThe type of the processed signature.
SignatureValidationResultThe signature validation result.
SignedAttributeCountThe number of records in the SignedAttribute arrays.
SignedAttributeOIDThe object identifier of the attribute.
SignedAttributeValueThe value of the attribute.
SigningCertBytesReturns raw certificate data in DER format.
SigningCertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
SigningCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
SigningCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
SigningCertCurveSpecifies the elliptic curve of the EC public key.
SigningCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
SigningCertFriendlyNameContains an associated alias (friendly name) of the certificate.
SigningCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
SigningCertHashAlgorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
SigningCertIssuerThe common name of the certificate issuer (CA), typically a company name.
SigningCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
SigningCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
SigningCertKeyBitsReturns the length of the public key.
SigningCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
SigningCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
SigningCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
SigningCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
SigningCertOCSPNoCheckAccessor to the value of the certificates ocsp-no-check extension.
SigningCertOriginReturns the origin of this certificate.
SigningCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
SigningCertPrivateKeyBytesContains the certificate's private key.
SigningCertPrivateKeyExistsIndicates whether the certificate has an associated private key.
SigningCertPrivateKeyExtractableIndicates whether the private key is extractable.
SigningCertPublicKeyBytesContains the certificate's public key in DER format.
SigningCertQualifiedStatementsReturns the qualified status of the certificate.
SigningCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
SigningCertSerialNumberReturns the certificate's serial number.
SigningCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
SigningCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
SigningCertSubjectAlternativeNameReturns or sets the value of the Subject Alternative Name extension of the certificate.
SigningCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
SigningCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
SigningCertValidFromThe time point at which the certificate becomes valid, in UTC.
SigningCertValidToThe time point at which the certificate expires, in UTC.
TimestampAccuracyThis property indicates the accuracy of the included time mark, in microseconds.
TimestampBytesReturns raw timestamp data in DER format.
TimestampCertificateIndexReturns the index of the TSA certificate in the Certificates collection Use this property to look up the TSA certificate in the Certificates collection.
TimestampChainValidationDetailsThe details of a certificate chain validation outcome.
TimestampChainValidationResultThe outcome of a certificate chain validation routine.
TimestampHashAlgorithmReturns 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 .
TimestampSerialNumberReturns the timestamp's serial number.
TimestampSignatureIndexReturns the index of the owner signature, if applicable.
TimestampTimeThe time point incorporated into the timestamp.
TimestampTimestampTypeReturns the type of the timestamp.
TimestampTSANameThis value uniquely identifies the Timestamp Authority (TSA).
TimestampValidationLogContains the TSA certificate chain validation log.
TimestampValidationResultContains timestamp validation outcome.
TimestampedIndicates whether or not the signature is timestamped.
TSACertBytesReturns raw certificate data in DER format.
TSACertCAIndicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
TSACertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
TSACertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
TSACertCurveSpecifies the elliptic curve of the EC public key.
TSACertFingerprintContains the fingerprint (a hash imprint) of this certificate.
TSACertFriendlyNameContains an associated alias (friendly name) of the certificate.
TSACertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
TSACertHashAlgorithmSpecifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .
TSACertIssuerThe common name of the certificate issuer (CA), typically a company name.
TSACertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
TSACertKeyAlgorithmSpecifies the public key algorithm of this certificate.
TSACertKeyBitsReturns the length of the public key.
TSACertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
TSACertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
TSACertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
TSACertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
TSACertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
TSACertPublicKeyBytesContains the certificate's public key in DER format.
TSACertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
TSACertSerialNumberReturns the certificate's serial number.
TSACertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
TSACertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
TSACertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
TSACertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
TSACertValidFromThe time point at which the certificate becomes valid, in UTC.
TSACertValidToThe time point at which the certificate expires, in UTC.
UnsignedAttributeCountThe number of records in the UnsignedAttribute arrays.
UnsignedAttributeOIDThe object identifier of the attribute.
UnsignedAttributeValueThe value of the attribute.
ValidatedSigningTimeContains 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.

CheckSignatureTypeDetermines the signature kind.
ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
VerifyVerifies digitally signed data.
VerifyDetachedVerifies 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.

ErrorInformation about errors during PKCS#7 message verification.
NotificationThis event notifies the application about an underlying control flow event.
RecipientFoundFires to report a message addressee parameters.
SignatureFoundSignifies the start of signature validation.
SignatureValidatedMarks the completion of the signature validation routine.
TimestampFoundSignifies the start of a timestamp validation routine.
TimestampValidatedReports 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.

TempPathPath for storing temporary files.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

CertCount Property (MessageVerifier Class)

The number of records in the Cert arrays.

Syntax

ANSI (Cross Platform)
int GetCertCount();

Unicode (Windows)
INT GetCertCount();
int secureblackbox_messageverifier_getcertcount(void* lpObj);
int GetCertCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetCertBytes(int iCertIndex, char* &lpCertBytes, int &lenCertBytes);

Unicode (Windows)
INT GetCertBytes(INT iCertIndex, LPSTR &lpCertBytes, INT &lenCertBytes);
int secureblackbox_messageverifier_getcertbytes(void* lpObj, int certindex, char** lpCertBytes, int* lenCertBytes);
QByteArray GetCertBytes(int iCertIndex);

Remarks

Returns raw certificate data in DER format.

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

This property is read-only and not available at design time.

Data Type

Byte Array

CertCA Property (MessageVerifier Class)

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

Syntax

ANSI (Cross Platform)
int GetCertCA(int iCertIndex);

Unicode (Windows)
BOOL GetCertCA(INT iCertIndex);
int secureblackbox_messageverifier_getcertca(void* lpObj, int certindex);
bool GetCertCA(int iCertIndex);

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

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

This property is read-only and not available at design time.

Data Type

Boolean

CertCAKeyID Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetCertCAKeyID(int iCertIndex, char* &lpCertCAKeyID, int &lenCertCAKeyID);

Unicode (Windows)
INT GetCertCAKeyID(INT iCertIndex, LPSTR &lpCertCAKeyID, INT &lenCertCAKeyID);
int secureblackbox_messageverifier_getcertcakeyid(void* lpObj, int certindex, char** lpCertCAKeyID, int* lenCertCAKeyID);
QByteArray GetCertCAKeyID(int iCertIndex);

Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

This property is read-only and not available at design time.

Data Type

Byte Array

CertCRLDistributionPoints Property (MessageVerifier Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

ANSI (Cross Platform)
char* GetCertCRLDistributionPoints(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertCRLDistributionPoints(INT iCertIndex);
char* secureblackbox_messageverifier_getcertcrldistributionpoints(void* lpObj, int certindex);
QString GetCertCRLDistributionPoints(int iCertIndex);

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

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

This property is read-only and not available at design time.

Data Type

String

CertCurve Property (MessageVerifier Class)

Specifies the elliptic curve of the EC public key.

Syntax

ANSI (Cross Platform)
char* GetCertCurve(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertCurve(INT iCertIndex);
char* secureblackbox_messageverifier_getcertcurve(void* lpObj, int certindex);
QString GetCertCurve(int iCertIndex);

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

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

This property is read-only and not available at design time.

Data Type

String

CertFingerprint Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetCertFingerprint(int iCertIndex, char* &lpCertFingerprint, int &lenCertFingerprint);

Unicode (Windows)
INT GetCertFingerprint(INT iCertIndex, LPSTR &lpCertFingerprint, INT &lenCertFingerprint);
int secureblackbox_messageverifier_getcertfingerprint(void* lpObj, int certindex, char** lpCertFingerprint, int* lenCertFingerprint);
QByteArray GetCertFingerprint(int iCertIndex);

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Byte Array

CertFriendlyName Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetCertFriendlyName(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertFriendlyName(INT iCertIndex);
char* secureblackbox_messageverifier_getcertfriendlyname(void* lpObj, int certindex);
QString GetCertFriendlyName(int iCertIndex);

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

CertHandle Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int64 GetCertHandle(int iCertIndex);

Unicode (Windows)
LONG64 GetCertHandle(INT iCertIndex);
int64 secureblackbox_messageverifier_getcerthandle(void* lpObj, int certindex);
qint64 GetCertHandle(int iCertIndex);

Default Value

0

Remarks

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

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

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

This property is read-only and not available at design time.

Data Type

Long64

CertHashAlgorithm Property (MessageVerifier Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .

Syntax

ANSI (Cross Platform)
char* GetCertHashAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertHashAlgorithm(INT iCertIndex);
char* secureblackbox_messageverifier_getcerthashalgorithm(void* lpObj, int certindex);
QString GetCertHashAlgorithm(int iCertIndex);

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

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

This property is read-only and not available at design time.

Data Type

String

CertIssuer Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetCertIssuer(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertIssuer(INT iCertIndex);
char* secureblackbox_messageverifier_getcertissuer(void* lpObj, int certindex);
QString GetCertIssuer(int iCertIndex);

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

CertIssuerRDN Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetCertIssuerRDN(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertIssuerRDN(INT iCertIndex);
char* secureblackbox_messageverifier_getcertissuerrdn(void* lpObj, int certindex);
QString GetCertIssuerRDN(int iCertIndex);

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

CertKeyAlgorithm Property (MessageVerifier Class)

Specifies the public key algorithm of this certificate.

Syntax

ANSI (Cross Platform)
char* GetCertKeyAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertKeyAlgorithm(INT iCertIndex);
char* secureblackbox_messageverifier_getcertkeyalgorithm(void* lpObj, int certindex);
QString GetCertKeyAlgorithm(int iCertIndex);

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

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

This property is read-only and not available at design time.

Data Type

String

CertKeyBits Property (MessageVerifier Class)

Returns the length of the public key.

Syntax

ANSI (Cross Platform)
int GetCertKeyBits(int iCertIndex);

Unicode (Windows)
INT GetCertKeyBits(INT iCertIndex);
int secureblackbox_messageverifier_getcertkeybits(void* lpObj, int certindex);
int GetCertKeyBits(int iCertIndex);

Default Value

0

Remarks

Returns the length of the public key.

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

This property is read-only and not available at design time.

Data Type

Integer

CertKeyFingerprint Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetCertKeyFingerprint(int iCertIndex, char* &lpCertKeyFingerprint, int &lenCertKeyFingerprint);

Unicode (Windows)
INT GetCertKeyFingerprint(INT iCertIndex, LPSTR &lpCertKeyFingerprint, INT &lenCertKeyFingerprint);
int secureblackbox_messageverifier_getcertkeyfingerprint(void* lpObj, int certindex, char** lpCertKeyFingerprint, int* lenCertKeyFingerprint);
QByteArray GetCertKeyFingerprint(int iCertIndex);

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Byte Array

CertKeyUsage Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetCertKeyUsage(int iCertIndex);

Unicode (Windows)
INT GetCertKeyUsage(INT iCertIndex);
int secureblackbox_messageverifier_getcertkeyusage(void* lpObj, int certindex);
int GetCertKeyUsage(int iCertIndex);

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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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

This property is read-only and not available at design time.

Data Type

Integer

CertKeyValid Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetCertKeyValid(int iCertIndex);

Unicode (Windows)
BOOL GetCertKeyValid(INT iCertIndex);
int secureblackbox_messageverifier_getcertkeyvalid(void* lpObj, int certindex);
bool GetCertKeyValid(int iCertIndex);

Default Value

FALSE

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Boolean

CertOCSPLocations Property (MessageVerifier Class)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

ANSI (Cross Platform)
char* GetCertOCSPLocations(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertOCSPLocations(INT iCertIndex);
char* secureblackbox_messageverifier_getcertocsplocations(void* lpObj, int certindex);
QString GetCertOCSPLocations(int iCertIndex);

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

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

This property is read-only and not available at design time.

Data Type

String

CertPolicyIDs Property (MessageVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

ANSI (Cross Platform)
char* GetCertPolicyIDs(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertPolicyIDs(INT iCertIndex);
char* secureblackbox_messageverifier_getcertpolicyids(void* lpObj, int certindex);
QString GetCertPolicyIDs(int iCertIndex);

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.

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

This property is read-only and not available at design time.

Data Type

String

CertPublicKeyBytes Property (MessageVerifier Class)

Contains the certificate's public key in DER format.

Syntax

ANSI (Cross Platform)
int GetCertPublicKeyBytes(int iCertIndex, char* &lpCertPublicKeyBytes, int &lenCertPublicKeyBytes);

Unicode (Windows)
INT GetCertPublicKeyBytes(INT iCertIndex, LPSTR &lpCertPublicKeyBytes, INT &lenCertPublicKeyBytes);
int secureblackbox_messageverifier_getcertpublickeybytes(void* lpObj, int certindex, char** lpCertPublicKeyBytes, int* lenCertPublicKeyBytes);
QByteArray GetCertPublicKeyBytes(int iCertIndex);

Remarks

Contains the certificate's public key in DER format.

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

This property is read-only and not available at design time.

Data Type

Byte Array

CertSelfSigned Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetCertSelfSigned(int iCertIndex);

Unicode (Windows)
BOOL GetCertSelfSigned(INT iCertIndex);
int secureblackbox_messageverifier_getcertselfsigned(void* lpObj, int certindex);
bool GetCertSelfSigned(int iCertIndex);

Default Value

FALSE

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Boolean

CertSerialNumber Property (MessageVerifier Class)

Returns the certificate's serial number.

Syntax

ANSI (Cross Platform)
int GetCertSerialNumber(int iCertIndex, char* &lpCertSerialNumber, int &lenCertSerialNumber);

Unicode (Windows)
INT GetCertSerialNumber(INT iCertIndex, LPSTR &lpCertSerialNumber, INT &lenCertSerialNumber);
int secureblackbox_messageverifier_getcertserialnumber(void* lpObj, int certindex, char** lpCertSerialNumber, int* lenCertSerialNumber);
QByteArray GetCertSerialNumber(int iCertIndex);

Remarks

Returns the certificate's serial number.

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

This property is read-only and not available at design time.

Data Type

Byte Array

CertSigAlgorithm Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetCertSigAlgorithm(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSigAlgorithm(INT iCertIndex);
char* secureblackbox_messageverifier_getcertsigalgorithm(void* lpObj, int certindex);
QString GetCertSigAlgorithm(int iCertIndex);

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

CertSubject Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetCertSubject(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSubject(INT iCertIndex);
char* secureblackbox_messageverifier_getcertsubject(void* lpObj, int certindex);
QString GetCertSubject(int iCertIndex);

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.

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

This property is read-only and not available at design time.

Data Type

String

CertSubjectKeyID Property (MessageVerifier Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

ANSI (Cross Platform)
int GetCertSubjectKeyID(int iCertIndex, char* &lpCertSubjectKeyID, int &lenCertSubjectKeyID);

Unicode (Windows)
INT GetCertSubjectKeyID(INT iCertIndex, LPSTR &lpCertSubjectKeyID, INT &lenCertSubjectKeyID);
int secureblackbox_messageverifier_getcertsubjectkeyid(void* lpObj, int certindex, char** lpCertSubjectKeyID, int* lenCertSubjectKeyID);
QByteArray GetCertSubjectKeyID(int iCertIndex);

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

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

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

This property is read-only and not available at design time.

Data Type

Byte Array

CertSubjectRDN Property (MessageVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

ANSI (Cross Platform)
char* GetCertSubjectRDN(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertSubjectRDN(INT iCertIndex);
char* secureblackbox_messageverifier_getcertsubjectrdn(void* lpObj, int certindex);
QString GetCertSubjectRDN(int iCertIndex);

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

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

This property is read-only and not available at design time.

Data Type

String

CertValidFrom Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetCertValidFrom(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertValidFrom(INT iCertIndex);
char* secureblackbox_messageverifier_getcertvalidfrom(void* lpObj, int certindex);
QString GetCertValidFrom(int iCertIndex);

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

CertValidTo Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetCertValidTo(int iCertIndex);

Unicode (Windows)
LPWSTR GetCertValidTo(INT iCertIndex);
char* secureblackbox_messageverifier_getcertvalidto(void* lpObj, int certindex);
QString GetCertValidTo(int iCertIndex);

Default Value

""

Remarks

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

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

This property is read-only and not available at design time.

Data Type

String

ClaimedSigningTime Property (MessageVerifier Class)

Returns a signature's claimed signing time.

Syntax

ANSI (Cross Platform)
char* GetClaimedSigningTime();

Unicode (Windows)
LPWSTR GetClaimedSigningTime();
char* secureblackbox_messageverifier_getclaimedsigningtime(void* lpObj);
QString GetClaimedSigningTime();

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

A content type property of the signed message.

Syntax

ANSI (Cross Platform)
char* GetContentType();

Unicode (Windows)
LPWSTR GetContentType();
char* secureblackbox_messageverifier_getcontenttype(void* lpObj);
QString GetContentType();

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

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

Syntax

ANSI (Cross Platform)
int GetDataBytes(char* &lpDataBytes, int &lenDataBytes);
int SetDataBytes(const char* lpDataBytes, int lenDataBytes); Unicode (Windows) INT GetDataBytes(LPSTR &lpDataBytes, INT &lenDataBytes);
INT SetDataBytes(LPCSTR lpDataBytes, INT lenDataBytes);
int secureblackbox_messageverifier_getdatabytes(void* lpObj, char** lpDataBytes, int* lenDataBytes);
int secureblackbox_messageverifier_setdatabytes(void* lpObj, const char* lpDataBytes, int lenDataBytes);
QByteArray GetDataBytes();
int SetDataBytes(QByteArray qbaDataBytes);

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

The name of the file containing the original signed data.

Syntax

ANSI (Cross Platform)
char* GetDataFile();
int SetDataFile(const char* lpszDataFile); Unicode (Windows) LPWSTR GetDataFile();
INT SetDataFile(LPCWSTR lpszDataFile);
char* secureblackbox_messageverifier_getdatafile(void* lpObj);
int secureblackbox_messageverifier_setdatafile(void* lpObj, const char* lpszDataFile);
QString GetDataFile();
int SetDataFile(QString qsDataFile);

Default Value

""

Remarks

Use this property to provide the original data when validating detached signatures with VerifyDetached.

Data Type

String

FIPSMode Property (MessageVerifier Class)

Reserved.

Syntax

ANSI (Cross Platform)
int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_messageverifier_getfipsmode(void* lpObj);
int secureblackbox_messageverifier_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

FALSE

Remarks

This property is reserved for future use.

Data Type

Boolean

HashAlgorithm Property (MessageVerifier Class)

Hash algorithm which was used to calculate the signature.

Syntax

ANSI (Cross Platform)
char* GetHashAlgorithm();
int SetHashAlgorithm(const char* lpszHashAlgorithm); Unicode (Windows) LPWSTR GetHashAlgorithm();
INT SetHashAlgorithm(LPCWSTR lpszHashAlgorithm);
char* secureblackbox_messageverifier_gethashalgorithm(void* lpObj);
int secureblackbox_messageverifier_sethashalgorithm(void* lpObj, const char* lpszHashAlgorithm);
QString GetHashAlgorithm();
int SetHashAlgorithm(QString qsHashAlgorithm);

Default Value

""

Remarks

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

Data Type

String

InputBytes Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetInputBytes(char* &lpInputBytes, int &lenInputBytes);
int SetInputBytes(const char* lpInputBytes, int lenInputBytes); Unicode (Windows) INT GetInputBytes(LPSTR &lpInputBytes, INT &lenInputBytes);
INT SetInputBytes(LPCSTR lpInputBytes, INT lenInputBytes);
int secureblackbox_messageverifier_getinputbytes(void* lpObj, char** lpInputBytes, int* lenInputBytes);
int secureblackbox_messageverifier_setinputbytes(void* lpObj, const char* lpInputBytes, int lenInputBytes);
QByteArray GetInputBytes();
int SetInputBytes(QByteArray qbaInputBytes);

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

Path to the file containing the signed message.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* secureblackbox_messageverifier_getinputfile(void* lpObj);
int secureblackbox_messageverifier_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

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

Data Type

String

InputIsHash Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetInputIsHash();
int SetInputIsHash(int bInputIsHash); Unicode (Windows) BOOL GetInputIsHash();
INT SetInputIsHash(BOOL bInputIsHash);
int secureblackbox_messageverifier_getinputishash(void* lpObj);
int secureblackbox_messageverifier_setinputishash(void* lpObj, int bInputIsHash);
bool GetInputIsHash();
int SetInputIsHash(bool bInputIsHash);

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

The number of records in the KnownCert arrays.

Syntax

ANSI (Cross Platform)
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); Unicode (Windows) INT GetKnownCertCount();
INT SetKnownCertCount(INT iKnownCertCount);
int secureblackbox_messageverifier_getknowncertcount(void* lpObj);
int secureblackbox_messageverifier_setknowncertcount(void* lpObj, int iKnownCertCount);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (MessageVerifier Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetKnownCertBytes(int iKnownCertIndex, char* &lpKnownCertBytes, int &lenKnownCertBytes);

Unicode (Windows)
INT GetKnownCertBytes(INT iKnownCertIndex, LPSTR &lpKnownCertBytes, INT &lenKnownCertBytes);
int secureblackbox_messageverifier_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
QByteArray GetKnownCertBytes(int iKnownCertIndex);

Remarks

Returns raw certificate data in DER format.

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

This property is read-only and not available at design time.

Data Type

Byte Array

KnownCertHandle Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, int64 lKnownCertHandle); Unicode (Windows) LONG64 GetKnownCertHandle(INT iKnownCertIndex);
INT SetKnownCertHandle(INT iKnownCertIndex, LONG64 lKnownCertHandle);
int64 secureblackbox_messageverifier_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_messageverifier_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);

Default Value

0

Remarks

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

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

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

This property is not available at design time.

Data Type

Long64

MACAlgorithm Property (MessageVerifier Class)

Specifies the hash algorithm to be used.

Syntax

ANSI (Cross Platform)
char* GetMACAlgorithm();

Unicode (Windows)
LPWSTR GetMACAlgorithm();
char* secureblackbox_messageverifier_getmacalgorithm(void* lpObj);
QString GetMACAlgorithm();

Default Value

"SHA256"

Remarks

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

SB_MAC_ALGORITHM_HMAC_SHA1SHA1
SB_MAC_ALGORITHM_HMAC_SHA256SHA256
SB_MAC_ALGORITHM_HMAC_SHA512SHA512

This property is read-only.

Data Type

String

OutputBytes Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetOutputBytes(char* &lpOutputBytes, int &lenOutputBytes);

Unicode (Windows)
INT GetOutputBytes(LPSTR &lpOutputBytes, INT &lenOutputBytes);
int secureblackbox_messageverifier_getoutputbytes(void* lpObj, char** lpOutputBytes, int* lenOutputBytes);
QByteArray GetOutputBytes();

Remarks

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

This property is read-only and not available at design time.

Data Type

Byte Array

OutputFile Property (MessageVerifier Class)

Path to the file to save the extracted data to.

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* secureblackbox_messageverifier_getoutputfile(void* lpObj);
int secureblackbox_messageverifier_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

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

The type of the processed signature.

Syntax

ANSI (Cross Platform)
int GetSignatureType();

Unicode (Windows)
INT GetSignatureType();

Possible Values

ST_UNKNOWN(0), 
ST_PKCS1DETACHED(1),
ST_PKCS7DETACHED(2),
ST_PKCS7ENVELOPING(3),
ST_PKCS7MACDETACHED(4),
ST_PKCS7MACENVELOPING(5)
int secureblackbox_messageverifier_getsignaturetype(void* lpObj);
int GetSignatureType();

Default Value

0

Remarks

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

stUnknown0Unknown or unsupported signature types

stPKCS1Detached1Detached PKCS#1 signature

stPKCS7Detached2Detached PKCS#7 signature

stPKCS7Enveloping3Enveloping PKCS#7 signature

stPKCS7MACDetached4Detached PKCS#7 MAC signature

stPKCS7MACEnveloping5Enveloping PKCS#7 MAC signature

This property is read-only and not available at design time.

Data Type

Integer

SignatureValidationResult Property (MessageVerifier Class)

The signature validation result.

Syntax

ANSI (Cross Platform)
int GetSignatureValidationResult();

Unicode (Windows)
INT GetSignatureValidationResult();

Possible Values

SVT_VALID(0), 
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
int secureblackbox_messageverifier_getsignaturevalidationresult(void* lpObj);
int GetSignatureValidationResult();

Default Value

0

Remarks

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

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

This property is read-only and not available at design time.

Data Type

Integer

SignedAttributeCount Property (MessageVerifier Class)

The number of records in the SignedAttribute arrays.

Syntax

ANSI (Cross Platform)
int GetSignedAttributeCount();

Unicode (Windows)
INT GetSignedAttributeCount();
int secureblackbox_messageverifier_getsignedattributecount(void* lpObj);
int GetSignedAttributeCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

The object identifier of the attribute.

Syntax

ANSI (Cross Platform)
char* GetSignedAttributeOID(int iSignedAttributeIndex);

Unicode (Windows)
LPWSTR GetSignedAttributeOID(INT iSignedAttributeIndex);
char* secureblackbox_messageverifier_getsignedattributeoid(void* lpObj, int signedattributeindex);
QString GetSignedAttributeOID(int iSignedAttributeIndex);

Default Value

""

Remarks

The object identifier of the attribute.

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

This property is read-only and not available at design time.

Data Type

String

SignedAttributeValue Property (MessageVerifier Class)

The value of the attribute.

Syntax

ANSI (Cross Platform)
int GetSignedAttributeValue(int iSignedAttributeIndex, char* &lpSignedAttributeValue, int &lenSignedAttributeValue);

Unicode (Windows)
INT GetSignedAttributeValue(INT iSignedAttributeIndex, LPSTR &lpSignedAttributeValue, INT &lenSignedAttributeValue);
int secureblackbox_messageverifier_getsignedattributevalue(void* lpObj, int signedattributeindex, char** lpSignedAttributeValue, int* lenSignedAttributeValue);
QByteArray GetSignedAttributeValue(int iSignedAttributeIndex);

Remarks

The value of the attribute.

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

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertBytes Property (MessageVerifier Class)

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetSigningCertBytes(char* &lpSigningCertBytes, int &lenSigningCertBytes);

Unicode (Windows)
INT GetSigningCertBytes(LPSTR &lpSigningCertBytes, INT &lenSigningCertBytes);
int secureblackbox_messageverifier_getsigningcertbytes(void* lpObj, char** lpSigningCertBytes, int* lenSigningCertBytes);
QByteArray GetSigningCertBytes();

Remarks

Returns raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCA Property (MessageVerifier Class)

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

Syntax

ANSI (Cross Platform)
int GetSigningCertCA();

Unicode (Windows)
BOOL GetSigningCertCA();
int secureblackbox_messageverifier_getsigningcertca(void* lpObj);
bool GetSigningCertCA();

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertCAKeyID Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetSigningCertCAKeyID(char* &lpSigningCertCAKeyID, int &lenSigningCertCAKeyID);

Unicode (Windows)
INT GetSigningCertCAKeyID(LPSTR &lpSigningCertCAKeyID, INT &lenSigningCertCAKeyID);
int secureblackbox_messageverifier_getsigningcertcakeyid(void* lpObj, char** lpSigningCertCAKeyID, int* lenSigningCertCAKeyID);
QByteArray GetSigningCertCAKeyID();

Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertCRLDistributionPoints Property (MessageVerifier Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

ANSI (Cross Platform)
char* GetSigningCertCRLDistributionPoints();

Unicode (Windows)
LPWSTR GetSigningCertCRLDistributionPoints();
char* secureblackbox_messageverifier_getsigningcertcrldistributionpoints(void* lpObj);
QString GetSigningCertCRLDistributionPoints();

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is read-only and not available at design time.

Data Type

String

SigningCertCurve Property (MessageVerifier Class)

Specifies the elliptic curve of the EC public key.

Syntax

ANSI (Cross Platform)
char* GetSigningCertCurve();

Unicode (Windows)
LPWSTR GetSigningCertCurve();
char* secureblackbox_messageverifier_getsigningcertcurve(void* lpObj);
QString GetSigningCertCurve();

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

This property is read-only and not available at design time.

Data Type

String

SigningCertFingerprint Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetSigningCertFingerprint(char* &lpSigningCertFingerprint, int &lenSigningCertFingerprint);

Unicode (Windows)
INT GetSigningCertFingerprint(LPSTR &lpSigningCertFingerprint, INT &lenSigningCertFingerprint);
int secureblackbox_messageverifier_getsigningcertfingerprint(void* lpObj, char** lpSigningCertFingerprint, int* lenSigningCertFingerprint);
QByteArray GetSigningCertFingerprint();

Remarks

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

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertFriendlyName Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetSigningCertFriendlyName();

Unicode (Windows)
LPWSTR GetSigningCertFriendlyName();
char* secureblackbox_messageverifier_getsigningcertfriendlyname(void* lpObj);
QString GetSigningCertFriendlyName();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertHandle Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int64 GetSigningCertHandle();

Unicode (Windows)
LONG64 GetSigningCertHandle();
int64 secureblackbox_messageverifier_getsigningcerthandle(void* lpObj);
qint64 GetSigningCertHandle();

Default Value

0

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Long64

SigningCertHashAlgorithm Property (MessageVerifier Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .

Syntax

ANSI (Cross Platform)
char* GetSigningCertHashAlgorithm();

Unicode (Windows)
LPWSTR GetSigningCertHashAlgorithm();
char* secureblackbox_messageverifier_getsigningcerthashalgorithm(void* lpObj);
QString GetSigningCertHashAlgorithm();

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuer Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetSigningCertIssuer();

Unicode (Windows)
LPWSTR GetSigningCertIssuer();
char* secureblackbox_messageverifier_getsigningcertissuer(void* lpObj);
QString GetSigningCertIssuer();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertIssuerRDN Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetSigningCertIssuerRDN();

Unicode (Windows)
LPWSTR GetSigningCertIssuerRDN();
char* secureblackbox_messageverifier_getsigningcertissuerrdn(void* lpObj);
QString GetSigningCertIssuerRDN();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyAlgorithm Property (MessageVerifier Class)

Specifies the public key algorithm of this certificate.

Syntax

ANSI (Cross Platform)
char* GetSigningCertKeyAlgorithm();

Unicode (Windows)
LPWSTR GetSigningCertKeyAlgorithm();
char* secureblackbox_messageverifier_getsigningcertkeyalgorithm(void* lpObj);
QString GetSigningCertKeyAlgorithm();

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

This property is read-only and not available at design time.

Data Type

String

SigningCertKeyBits Property (MessageVerifier Class)

Returns the length of the public key.

Syntax

ANSI (Cross Platform)
int GetSigningCertKeyBits();

Unicode (Windows)
INT GetSigningCertKeyBits();
int secureblackbox_messageverifier_getsigningcertkeybits(void* lpObj);
int GetSigningCertKeyBits();

Default Value

0

Remarks

Returns the length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyFingerprint Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetSigningCertKeyFingerprint(char* &lpSigningCertKeyFingerprint, int &lenSigningCertKeyFingerprint);

Unicode (Windows)
INT GetSigningCertKeyFingerprint(LPSTR &lpSigningCertKeyFingerprint, INT &lenSigningCertKeyFingerprint);
int secureblackbox_messageverifier_getsigningcertkeyfingerprint(void* lpObj, char** lpSigningCertKeyFingerprint, int* lenSigningCertKeyFingerprint);
QByteArray GetSigningCertKeyFingerprint();

Remarks

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

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertKeyUsage Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetSigningCertKeyUsage();

Unicode (Windows)
INT GetSigningCertKeyUsage();
int secureblackbox_messageverifier_getsigningcertkeyusage(void* lpObj);
int GetSigningCertKeyUsage();

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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

This property is read-only and not available at design time.

Data Type

Integer

SigningCertKeyValid Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetSigningCertKeyValid();

Unicode (Windows)
BOOL GetSigningCertKeyValid();
int secureblackbox_messageverifier_getsigningcertkeyvalid(void* lpObj);
bool GetSigningCertKeyValid();

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

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

ANSI (Cross Platform)
char* GetSigningCertOCSPLocations();

Unicode (Windows)
LPWSTR GetSigningCertOCSPLocations();
char* secureblackbox_messageverifier_getsigningcertocsplocations(void* lpObj);
QString GetSigningCertOCSPLocations();

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is read-only and not available at design time.

Data Type

String

SigningCertOCSPNoCheck Property (MessageVerifier Class)

Accessor to the value of the certificates ocsp-no-check extension.

Syntax

ANSI (Cross Platform)
int GetSigningCertOCSPNoCheck();

Unicode (Windows)
BOOL GetSigningCertOCSPNoCheck();
int secureblackbox_messageverifier_getsigningcertocspnocheck(void* lpObj);
bool GetSigningCertOCSPNoCheck();

Default Value

FALSE

Remarks

Accessor to the value of the certificates ocsp-no-check extension.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertOrigin Property (MessageVerifier Class)

Returns the origin of this certificate.

Syntax

ANSI (Cross Platform)
int GetSigningCertOrigin();

Unicode (Windows)
INT GetSigningCertOrigin();
int secureblackbox_messageverifier_getsigningcertorigin(void* lpObj);
int GetSigningCertOrigin();

Default Value

0

Remarks

Returns the origin of this certificate.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertPolicyIDs Property (MessageVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

ANSI (Cross Platform)
char* GetSigningCertPolicyIDs();

Unicode (Windows)
LPWSTR GetSigningCertPolicyIDs();
char* secureblackbox_messageverifier_getsigningcertpolicyids(void* lpObj);
QString GetSigningCertPolicyIDs();

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.

This property is read-only and not available at design time.

Data Type

String

SigningCertPrivateKeyBytes Property (MessageVerifier Class)

Contains the certificate's private key.

Syntax

ANSI (Cross Platform)
int GetSigningCertPrivateKeyBytes(char* &lpSigningCertPrivateKeyBytes, int &lenSigningCertPrivateKeyBytes);

Unicode (Windows)
INT GetSigningCertPrivateKeyBytes(LPSTR &lpSigningCertPrivateKeyBytes, INT &lenSigningCertPrivateKeyBytes);
int secureblackbox_messageverifier_getsigningcertprivatekeybytes(void* lpObj, char** lpSigningCertPrivateKeyBytes, int* lenSigningCertPrivateKeyBytes);
QByteArray GetSigningCertPrivateKeyBytes();

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertPrivateKeyExists Property (MessageVerifier Class)

Indicates whether the certificate has an associated private key.

Syntax

ANSI (Cross Platform)
int GetSigningCertPrivateKeyExists();

Unicode (Windows)
BOOL GetSigningCertPrivateKeyExists();
int secureblackbox_messageverifier_getsigningcertprivatekeyexists(void* lpObj);
bool GetSigningCertPrivateKeyExists();

Default Value

FALSE

Remarks

Indicates whether the certificate has an associated private key.

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertPrivateKeyExtractable Property (MessageVerifier Class)

Indicates whether the private key is extractable.

Syntax

ANSI (Cross Platform)
int GetSigningCertPrivateKeyExtractable();

Unicode (Windows)
BOOL GetSigningCertPrivateKeyExtractable();
int secureblackbox_messageverifier_getsigningcertprivatekeyextractable(void* lpObj);
bool GetSigningCertPrivateKeyExtractable();

Default Value

FALSE

Remarks

Indicates whether the private key is extractable

This property is read-only and not available at design time.

Data Type

Boolean

SigningCertPublicKeyBytes Property (MessageVerifier Class)

Contains the certificate's public key in DER format.

Syntax

ANSI (Cross Platform)
int GetSigningCertPublicKeyBytes(char* &lpSigningCertPublicKeyBytes, int &lenSigningCertPublicKeyBytes);

Unicode (Windows)
INT GetSigningCertPublicKeyBytes(LPSTR &lpSigningCertPublicKeyBytes, INT &lenSigningCertPublicKeyBytes);
int secureblackbox_messageverifier_getsigningcertpublickeybytes(void* lpObj, char** lpSigningCertPublicKeyBytes, int* lenSigningCertPublicKeyBytes);
QByteArray GetSigningCertPublicKeyBytes();

Remarks

Contains the certificate's public key in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertQualifiedStatements Property (MessageVerifier Class)

Returns the qualified status of the certificate.

Syntax

ANSI (Cross Platform)
int GetSigningCertQualifiedStatements();

Unicode (Windows)
INT GetSigningCertQualifiedStatements();

Possible Values

QST_NON_QUALIFIED(0), 
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
int secureblackbox_messageverifier_getsigningcertqualifiedstatements(void* lpObj);
int GetSigningCertQualifiedStatements();

Default Value

0

Remarks

Returns the qualified status of the certificate.

This property is read-only and not available at design time.

Data Type

Integer

SigningCertSelfSigned Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetSigningCertSelfSigned();

Unicode (Windows)
BOOL GetSigningCertSelfSigned();
int secureblackbox_messageverifier_getsigningcertselfsigned(void* lpObj);
bool GetSigningCertSelfSigned();

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

Returns the certificate's serial number.

Syntax

ANSI (Cross Platform)
int GetSigningCertSerialNumber(char* &lpSigningCertSerialNumber, int &lenSigningCertSerialNumber);

Unicode (Windows)
INT GetSigningCertSerialNumber(LPSTR &lpSigningCertSerialNumber, INT &lenSigningCertSerialNumber);
int secureblackbox_messageverifier_getsigningcertserialnumber(void* lpObj, char** lpSigningCertSerialNumber, int* lenSigningCertSerialNumber);
QByteArray GetSigningCertSerialNumber();

Remarks

Returns the certificate's serial number.

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSigAlgorithm Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetSigningCertSigAlgorithm();

Unicode (Windows)
LPWSTR GetSigningCertSigAlgorithm();
char* secureblackbox_messageverifier_getsigningcertsigalgorithm(void* lpObj);
QString GetSigningCertSigAlgorithm();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertSubject Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetSigningCertSubject();

Unicode (Windows)
LPWSTR GetSigningCertSubject();
char* secureblackbox_messageverifier_getsigningcertsubject(void* lpObj);
QString GetSigningCertSubject();

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 property is read-only and not available at design time.

Data Type

String

SigningCertSubjectAlternativeName Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetSigningCertSubjectAlternativeName();

Unicode (Windows)
LPWSTR GetSigningCertSubjectAlternativeName();
char* secureblackbox_messageverifier_getsigningcertsubjectalternativename(void* lpObj);
QString GetSigningCertSubjectAlternativeName();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

SigningCertSubjectKeyID Property (MessageVerifier Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

ANSI (Cross Platform)
int GetSigningCertSubjectKeyID(char* &lpSigningCertSubjectKeyID, int &lenSigningCertSubjectKeyID);

Unicode (Windows)
INT GetSigningCertSubjectKeyID(LPSTR &lpSigningCertSubjectKeyID, INT &lenSigningCertSubjectKeyID);
int secureblackbox_messageverifier_getsigningcertsubjectkeyid(void* lpObj, char** lpSigningCertSubjectKeyID, int* lenSigningCertSubjectKeyID);
QByteArray GetSigningCertSubjectKeyID();

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

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

This property is read-only and not available at design time.

Data Type

Byte Array

SigningCertSubjectRDN Property (MessageVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

ANSI (Cross Platform)
char* GetSigningCertSubjectRDN();

Unicode (Windows)
LPWSTR GetSigningCertSubjectRDN();
char* secureblackbox_messageverifier_getsigningcertsubjectrdn(void* lpObj);
QString GetSigningCertSubjectRDN();

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

This property is read-only and not available at design time.

Data Type

String

SigningCertValidFrom Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetSigningCertValidFrom();

Unicode (Windows)
LPWSTR GetSigningCertValidFrom();
char* secureblackbox_messageverifier_getsigningcertvalidfrom(void* lpObj);
QString GetSigningCertValidFrom();

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

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

Syntax

ANSI (Cross Platform)
char* GetSigningCertValidTo();

Unicode (Windows)
LPWSTR GetSigningCertValidTo();
char* secureblackbox_messageverifier_getsigningcertvalidto(void* lpObj);
QString GetSigningCertValidTo();

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

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

Syntax

ANSI (Cross Platform)
int64 GetTimestampAccuracy();

Unicode (Windows)
LONG64 GetTimestampAccuracy();
int64 secureblackbox_messageverifier_gettimestampaccuracy(void* lpObj);
qint64 GetTimestampAccuracy();

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

Returns raw timestamp data in DER format.

Syntax

ANSI (Cross Platform)
int GetTimestampBytes(char* &lpTimestampBytes, int &lenTimestampBytes);

Unicode (Windows)
INT GetTimestampBytes(LPSTR &lpTimestampBytes, INT &lenTimestampBytes);
int secureblackbox_messageverifier_gettimestampbytes(void* lpObj, char** lpTimestampBytes, int* lenTimestampBytes);
QByteArray GetTimestampBytes();

Remarks

Returns raw timestamp data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

TimestampCertificateIndex Property (MessageVerifier Class)

Returns the index of the TSA certificate in the Certificates collection Use this property to look up the TSA certificate in the Certificates collection.

Syntax

ANSI (Cross Platform)
int GetTimestampCertificateIndex();

Unicode (Windows)
INT GetTimestampCertificateIndex();
int secureblackbox_messageverifier_gettimestampcertificateindex(void* lpObj);
int GetTimestampCertificateIndex();

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

The details of a certificate chain validation outcome.

Syntax

ANSI (Cross Platform)
int GetTimestampChainValidationDetails();

Unicode (Windows)
INT GetTimestampChainValidationDetails();
int secureblackbox_messageverifier_gettimestampchainvalidationdetails(void* lpObj);
int GetTimestampChainValidationDetails();

Default Value

0

Remarks

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

Returns a bit mask of the following options:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

cvrUnknownCA0x0020A CA certificate for one or more certificates has not been found (chain incomplete)

cvrCAUnauthorized0x0040One of the CA certificates are not authorized to act as CA

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

cvrIdentityMismatch0x0200The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate

cvrNoKeyUsage0x0400A mandatory key usage is not enabled in one of the chain certificates

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

cvrWeakAlgorithm0x4000A weak algorithm is used in one of certificates or revocation elements

cvrUserEnforced0x8000The 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 (MessageVerifier Class)

The outcome of a certificate chain validation routine.

Syntax

ANSI (Cross Platform)
int GetTimestampChainValidationResult();

Unicode (Windows)
INT GetTimestampChainValidationResult();

Possible Values

CVT_VALID(0), 
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_messageverifier_gettimestampchainvalidationresult(void* lpObj);
int GetTimestampChainValidationResult();

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

cvtValid0The chain is valid

cvtValidButUntrusted1The chain is valid, but the root certificate is not trusted

cvtInvalid2The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature)

cvtCantBeEstablished3The 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

TimestampHashAlgorithm Property (MessageVerifier Class)

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 .

Syntax

ANSI (Cross Platform)
char* GetTimestampHashAlgorithm();

Unicode (Windows)
LPWSTR GetTimestampHashAlgorithm();
char* secureblackbox_messageverifier_gettimestamphashalgorithm(void* lpObj);
QString GetTimestampHashAlgorithm();

Default Value

""

Remarks

Returns the timestamp's hash algorithm

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

This property is read-only and not available at design time.

Data Type

String

TimestampSerialNumber Property (MessageVerifier Class)

Returns the timestamp's serial number.

Syntax

ANSI (Cross Platform)
int GetTimestampSerialNumber(char* &lpTimestampSerialNumber, int &lenTimestampSerialNumber);

Unicode (Windows)
INT GetTimestampSerialNumber(LPSTR &lpTimestampSerialNumber, INT &lenTimestampSerialNumber);
int secureblackbox_messageverifier_gettimestampserialnumber(void* lpObj, char** lpTimestampSerialNumber, int* lenTimestampSerialNumber);
QByteArray GetTimestampSerialNumber();

Remarks

Returns the timestamp's serial number.

This property is read-only and not available at design time.

Data Type

Byte Array

TimestampSignatureIndex Property (MessageVerifier Class)

Returns the index of the owner signature, if applicable.

Syntax

ANSI (Cross Platform)
int GetTimestampSignatureIndex();

Unicode (Windows)
INT GetTimestampSignatureIndex();
int secureblackbox_messageverifier_gettimestampsignatureindex(void* lpObj);
int GetTimestampSignatureIndex();

Default Value

-1

Remarks

Returns the index of the owner signature, if applicable.

Use this property to establish the index of the associated signature object in the signature collection.

This property is read-only and not available at design time.

Data Type

Integer

TimestampTime Property (MessageVerifier Class)

The time point incorporated into the timestamp.

Syntax

ANSI (Cross Platform)
char* GetTimestampTime();

Unicode (Windows)
LPWSTR GetTimestampTime();
char* secureblackbox_messageverifier_gettimestamptime(void* lpObj);
QString GetTimestampTime();

Default Value

""

Remarks

The time point incorporated into the timestamp.

This property is read-only and not available at design time.

Data Type

String

TimestampTimestampType Property (MessageVerifier Class)

Returns the type of the timestamp.

Syntax

ANSI (Cross Platform)
int GetTimestampTimestampType();

Unicode (Windows)
INT GetTimestampTimestampType();
int secureblackbox_messageverifier_gettimestamptimestamptype(void* lpObj);
int GetTimestampTimestampType();

Default Value

0

Remarks

Returns the type of the timestamp.

Available options:

tstUnknown0
tstLegacy1Supported by: Authenticode components

tstTrusted2Supported by: Authenticode components

tstGeneric3Supported by: CAdES components

tstESC4Supported by: CAdES components

tstContent5Supported by: CAdES components

tstCertsAndCRLs6Supported by: CAdES components

tstArchive7Archive timestamp. Supported by: ASiC, CAdES, JAdES, Office, SOAP, XAdES components

tstArchive28Archive v2 timestamp. Supported by: ASiC, CAdES components

tstArchive39Archive v3 timestamp. Supported by: ASiC, CAdES components

tstIndividualDataObjects10Individual data objects timetamp. Supported by: ASiC, Office, SOAP, XAdES components

tstAllDataObjects11All data objects timestamp. Supported by: ASiC, Office, SOAP, XAdES components

tstSignature12Signature timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstRefsOnly13RefsOnly timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstSigAndRefs14SigAndRefs timestamp. Supported by: ASiC, JAdES, Office, SOAP, XAdES components

tstSignedData15SignedData timestamp. Supported by: JAdES components

tstArchive14116Archive 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 (MessageVerifier Class)

This value uniquely identifies the Timestamp Authority (TSA).

Syntax

ANSI (Cross Platform)
char* GetTimestampTSAName();

Unicode (Windows)
LPWSTR GetTimestampTSAName();
char* secureblackbox_messageverifier_gettimestamptsaname(void* lpObj);
QString GetTimestampTSAName();

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

Contains the TSA certificate chain validation log.

Syntax

ANSI (Cross Platform)
char* GetTimestampValidationLog();

Unicode (Windows)
LPWSTR GetTimestampValidationLog();
char* secureblackbox_messageverifier_gettimestampvalidationlog(void* lpObj);
QString GetTimestampValidationLog();

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

Contains timestamp validation outcome.

Syntax

ANSI (Cross Platform)
int GetTimestampValidationResult();

Unicode (Windows)
INT GetTimestampValidationResult();

Possible Values

SVT_VALID(0), 
SVT_UNKNOWN(1),
SVT_CORRUPTED(2),
SVT_SIGNER_NOT_FOUND(3),
SVT_FAILURE(4)
int secureblackbox_messageverifier_gettimestampvalidationresult(void* lpObj);
int GetTimestampValidationResult();

Default Value

0

Remarks

Contains timestamp validation outcome.

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

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

This property is read-only and not available at design time.

Data Type

Integer

Timestamped Property (MessageVerifier Class)

Indicates whether or not the signature is timestamped.

Syntax

ANSI (Cross Platform)
int GetTimestamped();

Unicode (Windows)
BOOL GetTimestamped();
int secureblackbox_messageverifier_gettimestamped(void* lpObj);
bool GetTimestamped();

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

Returns raw certificate data in DER format.

Syntax

ANSI (Cross Platform)
int GetTSACertBytes(char* &lpTSACertBytes, int &lenTSACertBytes);

Unicode (Windows)
INT GetTSACertBytes(LPSTR &lpTSACertBytes, INT &lenTSACertBytes);
int secureblackbox_messageverifier_gettsacertbytes(void* lpObj, char** lpTSACertBytes, int* lenTSACertBytes);
QByteArray GetTSACertBytes();

Remarks

Returns raw certificate data in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

TSACertCA Property (MessageVerifier Class)

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

Syntax

ANSI (Cross Platform)
int GetTSACertCA();

Unicode (Windows)
BOOL GetTSACertCA();
int secureblackbox_messageverifier_gettsacertca(void* lpObj);
bool GetTSACertCA();

Default Value

FALSE

Remarks

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

This property is read-only and not available at design time.

Data Type

Boolean

TSACertCAKeyID Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetTSACertCAKeyID(char* &lpTSACertCAKeyID, int &lenTSACertCAKeyID);

Unicode (Windows)
INT GetTSACertCAKeyID(LPSTR &lpTSACertCAKeyID, INT &lenTSACertCAKeyID);
int secureblackbox_messageverifier_gettsacertcakeyid(void* lpObj, char** lpTSACertCAKeyID, int* lenTSACertCAKeyID);
QByteArray GetTSACertCAKeyID();

Remarks

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

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

This property is read-only and not available at design time.

Data Type

Byte Array

TSACertCRLDistributionPoints Property (MessageVerifier Class)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

ANSI (Cross Platform)
char* GetTSACertCRLDistributionPoints();

Unicode (Windows)
LPWSTR GetTSACertCRLDistributionPoints();
char* secureblackbox_messageverifier_gettsacertcrldistributionpoints(void* lpObj);
QString GetTSACertCRLDistributionPoints();

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is read-only and not available at design time.

Data Type

String

TSACertCurve Property (MessageVerifier Class)

Specifies the elliptic curve of the EC public key.

Syntax

ANSI (Cross Platform)
char* GetTSACertCurve();

Unicode (Windows)
LPWSTR GetTSACertCurve();
char* secureblackbox_messageverifier_gettsacertcurve(void* lpObj);
QString GetTSACertCurve();

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

This property is read-only and not available at design time.

Data Type

String

TSACertFingerprint Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetTSACertFingerprint(char* &lpTSACertFingerprint, int &lenTSACertFingerprint);

Unicode (Windows)
INT GetTSACertFingerprint(LPSTR &lpTSACertFingerprint, INT &lenTSACertFingerprint);
int secureblackbox_messageverifier_gettsacertfingerprint(void* lpObj, char** lpTSACertFingerprint, int* lenTSACertFingerprint);
QByteArray GetTSACertFingerprint();

Remarks

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

This property is read-only and not available at design time.

Data Type

Byte Array

TSACertFriendlyName Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetTSACertFriendlyName();

Unicode (Windows)
LPWSTR GetTSACertFriendlyName();
char* secureblackbox_messageverifier_gettsacertfriendlyname(void* lpObj);
QString GetTSACertFriendlyName();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

TSACertHandle Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int64 GetTSACertHandle();

Unicode (Windows)
LONG64 GetTSACertHandle();
int64 secureblackbox_messageverifier_gettsacerthandle(void* lpObj);
qint64 GetTSACertHandle();

Default Value

0

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Long64

TSACertHashAlgorithm Property (MessageVerifier Class)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) 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 .

Syntax

ANSI (Cross Platform)
char* GetTSACertHashAlgorithm();

Unicode (Windows)
LPWSTR GetTSACertHashAlgorithm();
char* secureblackbox_messageverifier_gettsacerthashalgorithm(void* lpObj);
QString GetTSACertHashAlgorithm();

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

This property is read-only and not available at design time.

Data Type

String

TSACertIssuer Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetTSACertIssuer();

Unicode (Windows)
LPWSTR GetTSACertIssuer();
char* secureblackbox_messageverifier_gettsacertissuer(void* lpObj);
QString GetTSACertIssuer();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

TSACertIssuerRDN Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetTSACertIssuerRDN();

Unicode (Windows)
LPWSTR GetTSACertIssuerRDN();
char* secureblackbox_messageverifier_gettsacertissuerrdn(void* lpObj);
QString GetTSACertIssuerRDN();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

TSACertKeyAlgorithm Property (MessageVerifier Class)

Specifies the public key algorithm of this certificate.

Syntax

ANSI (Cross Platform)
char* GetTSACertKeyAlgorithm();

Unicode (Windows)
LPWSTR GetTSACertKeyAlgorithm();
char* secureblackbox_messageverifier_gettsacertkeyalgorithm(void* lpObj);
QString GetTSACertKeyAlgorithm();

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

This property is read-only and not available at design time.

Data Type

String

TSACertKeyBits Property (MessageVerifier Class)

Returns the length of the public key.

Syntax

ANSI (Cross Platform)
int GetTSACertKeyBits();

Unicode (Windows)
INT GetTSACertKeyBits();
int secureblackbox_messageverifier_gettsacertkeybits(void* lpObj);
int GetTSACertKeyBits();

Default Value

0

Remarks

Returns the length of the public key.

This property is read-only and not available at design time.

Data Type

Integer

TSACertKeyFingerprint Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetTSACertKeyFingerprint(char* &lpTSACertKeyFingerprint, int &lenTSACertKeyFingerprint);

Unicode (Windows)
INT GetTSACertKeyFingerprint(LPSTR &lpTSACertKeyFingerprint, INT &lenTSACertKeyFingerprint);
int secureblackbox_messageverifier_gettsacertkeyfingerprint(void* lpObj, char** lpTSACertKeyFingerprint, int* lenTSACertKeyFingerprint);
QByteArray GetTSACertKeyFingerprint();

Remarks

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

This property is read-only and not available at design time.

Data Type

Byte Array

TSACertKeyUsage Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetTSACertKeyUsage();

Unicode (Windows)
INT GetTSACertKeyUsage();
int secureblackbox_messageverifier_gettsacertkeyusage(void* lpObj);
int GetTSACertKeyUsage();

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:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

This property is read-only and not available at design time.

Data Type

Integer

TSACertKeyValid Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetTSACertKeyValid();

Unicode (Windows)
BOOL GetTSACertKeyValid();
int secureblackbox_messageverifier_gettsacertkeyvalid(void* lpObj);
bool GetTSACertKeyValid();

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

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

ANSI (Cross Platform)
char* GetTSACertOCSPLocations();

Unicode (Windows)
LPWSTR GetTSACertOCSPLocations();
char* secureblackbox_messageverifier_gettsacertocsplocations(void* lpObj);
QString GetTSACertOCSPLocations();

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is read-only and not available at design time.

Data Type

String

TSACertPolicyIDs Property (MessageVerifier Class)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

ANSI (Cross Platform)
char* GetTSACertPolicyIDs();

Unicode (Windows)
LPWSTR GetTSACertPolicyIDs();
char* secureblackbox_messageverifier_gettsacertpolicyids(void* lpObj);
QString GetTSACertPolicyIDs();

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.

This property is read-only and not available at design time.

Data Type

String

TSACertPublicKeyBytes Property (MessageVerifier Class)

Contains the certificate's public key in DER format.

Syntax

ANSI (Cross Platform)
int GetTSACertPublicKeyBytes(char* &lpTSACertPublicKeyBytes, int &lenTSACertPublicKeyBytes);

Unicode (Windows)
INT GetTSACertPublicKeyBytes(LPSTR &lpTSACertPublicKeyBytes, INT &lenTSACertPublicKeyBytes);
int secureblackbox_messageverifier_gettsacertpublickeybytes(void* lpObj, char** lpTSACertPublicKeyBytes, int* lenTSACertPublicKeyBytes);
QByteArray GetTSACertPublicKeyBytes();

Remarks

Contains the certificate's public key in DER format.

This property is read-only and not available at design time.

Data Type

Byte Array

TSACertSelfSigned Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
int GetTSACertSelfSigned();

Unicode (Windows)
BOOL GetTSACertSelfSigned();
int secureblackbox_messageverifier_gettsacertselfsigned(void* lpObj);
bool GetTSACertSelfSigned();

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

Returns the certificate's serial number.

Syntax

ANSI (Cross Platform)
int GetTSACertSerialNumber(char* &lpTSACertSerialNumber, int &lenTSACertSerialNumber);

Unicode (Windows)
INT GetTSACertSerialNumber(LPSTR &lpTSACertSerialNumber, INT &lenTSACertSerialNumber);
int secureblackbox_messageverifier_gettsacertserialnumber(void* lpObj, char** lpTSACertSerialNumber, int* lenTSACertSerialNumber);
QByteArray GetTSACertSerialNumber();

Remarks

Returns the certificate's serial number.

This property is read-only and not available at design time.

Data Type

Byte Array

TSACertSigAlgorithm Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetTSACertSigAlgorithm();

Unicode (Windows)
LPWSTR GetTSACertSigAlgorithm();
char* secureblackbox_messageverifier_gettsacertsigalgorithm(void* lpObj);
QString GetTSACertSigAlgorithm();

Default Value

""

Remarks

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

This property is read-only and not available at design time.

Data Type

String

TSACertSubject Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetTSACertSubject();

Unicode (Windows)
LPWSTR GetTSACertSubject();
char* secureblackbox_messageverifier_gettsacertsubject(void* lpObj);
QString GetTSACertSubject();

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 property is read-only and not available at design time.

Data Type

String

TSACertSubjectKeyID Property (MessageVerifier Class)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

ANSI (Cross Platform)
int GetTSACertSubjectKeyID(char* &lpTSACertSubjectKeyID, int &lenTSACertSubjectKeyID);

Unicode (Windows)
INT GetTSACertSubjectKeyID(LPSTR &lpTSACertSubjectKeyID, INT &lenTSACertSubjectKeyID);
int secureblackbox_messageverifier_gettsacertsubjectkeyid(void* lpObj, char** lpTSACertSubjectKeyID, int* lenTSACertSubjectKeyID);
QByteArray GetTSACertSubjectKeyID();

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

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

This property is read-only and not available at design time.

Data Type

Byte Array

TSACertSubjectRDN Property (MessageVerifier Class)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

ANSI (Cross Platform)
char* GetTSACertSubjectRDN();

Unicode (Windows)
LPWSTR GetTSACertSubjectRDN();
char* secureblackbox_messageverifier_gettsacertsubjectrdn(void* lpObj);
QString GetTSACertSubjectRDN();

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

This property is read-only and not available at design time.

Data Type

String

TSACertValidFrom Property (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
char* GetTSACertValidFrom();

Unicode (Windows)
LPWSTR GetTSACertValidFrom();
char* secureblackbox_messageverifier_gettsacertvalidfrom(void* lpObj);
QString GetTSACertValidFrom();

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

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

Syntax

ANSI (Cross Platform)
char* GetTSACertValidTo();

Unicode (Windows)
LPWSTR GetTSACertValidTo();
char* secureblackbox_messageverifier_gettsacertvalidto(void* lpObj);
QString GetTSACertValidTo();

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

The number of records in the UnsignedAttribute arrays.

Syntax

ANSI (Cross Platform)
int GetUnsignedAttributeCount();

Unicode (Windows)
INT GetUnsignedAttributeCount();
int secureblackbox_messageverifier_getunsignedattributecount(void* lpObj);
int GetUnsignedAttributeCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

The object identifier of the attribute.

Syntax

ANSI (Cross Platform)
char* GetUnsignedAttributeOID(int iUnsignedAttributeIndex);

Unicode (Windows)
LPWSTR GetUnsignedAttributeOID(INT iUnsignedAttributeIndex);
char* secureblackbox_messageverifier_getunsignedattributeoid(void* lpObj, int unsignedattributeindex);
QString GetUnsignedAttributeOID(int iUnsignedAttributeIndex);

Default Value

""

Remarks

The object identifier of the attribute.

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

This property is read-only and not available at design time.

Data Type

String

UnsignedAttributeValue Property (MessageVerifier Class)

The value of the attribute.

Syntax

ANSI (Cross Platform)
int GetUnsignedAttributeValue(int iUnsignedAttributeIndex, char* &lpUnsignedAttributeValue, int &lenUnsignedAttributeValue);

Unicode (Windows)
INT GetUnsignedAttributeValue(INT iUnsignedAttributeIndex, LPSTR &lpUnsignedAttributeValue, INT &lenUnsignedAttributeValue);
int secureblackbox_messageverifier_getunsignedattributevalue(void* lpObj, int unsignedattributeindex, char** lpUnsignedAttributeValue, int* lenUnsignedAttributeValue);
QByteArray GetUnsignedAttributeValue(int iUnsignedAttributeIndex);

Remarks

The value of the attribute.

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

This property is read-only and not available at design time.

Data Type

Byte Array

ValidatedSigningTime Property (MessageVerifier Class)

Contains the certified signing time.

Syntax

ANSI (Cross Platform)
char* GetValidatedSigningTime();

Unicode (Windows)
LPWSTR GetValidatedSigningTime();
char* secureblackbox_messageverifier_getvalidatedsigningtime(void* lpObj);
QString GetValidatedSigningTime();

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

Determines the signature kind.

Syntax

ANSI (Cross Platform)
int CheckSignatureType();

Unicode (Windows)
INT CheckSignatureType();
int secureblackbox_messageverifier_checksignaturetype(void* lpObj);
int CheckSignatureType();

Remarks

Use this method to determine the kind of the signature stored in InputFile (InputStream).

stUnknown0Unknown or unsupported signature types

stPKCS1Detached1Detached PKCS#1 signature

stPKCS7Detached2Detached PKCS#7 signature

stPKCS7Enveloping3Enveloping PKCS#7 signature

stPKCS7MACDetached4Detached PKCS#7 MAC signature

stPKCS7MACEnveloping5Enveloping PKCS#7 MAC signature

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Config Method (MessageVerifier Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_messageverifier_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DoAction Method (MessageVerifier Class)

Performs an additional action.

Syntax

ANSI (Cross Platform)
char* DoAction(const char* lpszActionID, const char* lpszActionParams);

Unicode (Windows)
LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_messageverifier_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);

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 insencitive) 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;....

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Verify Method (MessageVerifier Class)

Verifies digitally signed data.

Syntax

ANSI (Cross Platform)
int Verify();

Unicode (Windows)
INT Verify();
int secureblackbox_messageverifier_verify(void* lpObj);
int Verify();

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 to verify detached signatures.

This method expects the enveloping signature to be provided via InputFile 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 component together with MessageVerifier, or consider using CAdESVerifier component instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

VerifyDetached Method (MessageVerifier Class)

Verifies a detached signature.

Syntax

ANSI (Cross Platform)
int VerifyDetached();

Unicode (Windows)
INT VerifyDetached();
int secureblackbox_messageverifier_verifydetached(void* lpObj);
int VerifyDetached();

Remarks

Use this method to verify detached signatures. Pass the signature via InputFile (or InputStream) property, and the original data via DataFile (DataStream).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (MessageVerifier Class)

Information about errors during PKCS#7 message verification.

Syntax

ANSI (Cross Platform)
virtual int FireError(MessageVerifierErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } MessageVerifierErrorEventParams;
Unicode (Windows) virtual INT FireError(MessageVerifierErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } MessageVerifierErrorEventParams;
#define EID_MESSAGEVERIFIER_ERROR 1

virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class MessageVerifierErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(MessageVerifierErrorEventParams *e);
// Or, subclass MessageVerifier and override this emitter function. virtual int FireError(MessageVerifierErrorEventParams *e) {...}

Remarks

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

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

Notification Event (MessageVerifier Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireNotification(MessageVerifierNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } MessageVerifierNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(MessageVerifierNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } MessageVerifierNotificationEventParams;
#define EID_MESSAGEVERIFIER_NOTIFICATION 2

virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class MessageVerifierNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Notification(MessageVerifierNotificationEventParams *e);
// Or, subclass MessageVerifier and override this emitter function. virtual int FireNotification(MessageVerifierNotificationEventParams *e) {...}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the component. 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 EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

RecipientFound Event (MessageVerifier Class)

Fires to report a message addressee parameters.

Syntax

ANSI (Cross Platform)
virtual int FireRecipientFound(MessageVerifierRecipientFoundEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound; int reserved; } MessageVerifierRecipientFoundEventParams;
Unicode (Windows) virtual INT FireRecipientFound(MessageVerifierRecipientFoundEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound; INT reserved; } MessageVerifierRecipientFoundEventParams;
#define EID_MESSAGEVERIFIER_RECIPIENTFOUND 3

virtual INT SECUREBLACKBOX_CALL FireRecipientFound(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound);
class MessageVerifierRecipientFoundEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void RecipientFound(MessageVerifierRecipientFoundEventParams *e);
// Or, subclass MessageVerifier and override this emitter function. virtual int FireRecipientFound(MessageVerifierRecipientFoundEventParams *e) {...}

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

Signifies the start of signature validation.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureFound(MessageVerifierSignatureFoundEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound;
int ValidateSignature;
int ValidateChain; int reserved; } MessageVerifierSignatureFoundEventParams;
Unicode (Windows) virtual INT FireSignatureFound(MessageVerifierSignatureFoundEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateSignature;
BOOL ValidateChain; INT reserved; } MessageVerifierSignatureFoundEventParams;
#define EID_MESSAGEVERIFIER_SIGNATUREFOUND 4

virtual INT SECUREBLACKBOX_CALL FireSignatureFound(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateSignature, BOOL &bValidateChain);
class MessageVerifierSignatureFoundEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  bool ValidateSignature();
  void SetValidateSignature(bool bValidateSignature);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SignatureFound(MessageVerifierSignatureFoundEventParams *e);
// Or, subclass MessageVerifier and override this emitter function. virtual int FireSignatureFound(MessageVerifierSignatureFoundEventParams *e) {...}

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 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 KnownCertificates property.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each, with SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

SignatureValidated Event (MessageVerifier Class)

Marks the completion of the signature validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireSignatureValidated(MessageVerifierSignatureValidatedEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int ValidationResult; int reserved; } MessageVerifierSignatureValidatedEventParams;
Unicode (Windows) virtual INT FireSignatureValidated(MessageVerifierSignatureValidatedEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
INT ValidationResult; INT reserved; } MessageVerifierSignatureValidatedEventParams;
#define EID_MESSAGEVERIFIER_SIGNATUREVALIDATED 5

virtual INT SECUREBLACKBOX_CALL FireSignatureValidated(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, INT &iValidationResult);
class MessageVerifierSignatureValidatedEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  int ValidationResult();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SignatureValidated(MessageVerifierSignatureValidatedEventParams *e);
// Or, subclass MessageVerifier and override this emitter function. virtual int FireSignatureValidated(MessageVerifierSignatureValidatedEventParams *e) {...}

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.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

TimestampFound Event (MessageVerifier Class)

Signifies the start of a timestamp validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampFound(MessageVerifierTimestampFoundEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
int CertFound;
int ValidateTimestamp;
int ValidateChain; int reserved; } MessageVerifierTimestampFoundEventParams;
Unicode (Windows) virtual INT FireTimestampFound(MessageVerifierTimestampFoundEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
BOOL CertFound;
BOOL ValidateTimestamp;
BOOL ValidateChain; INT reserved; } MessageVerifierTimestampFoundEventParams;
#define EID_MESSAGEVERIFIER_TIMESTAMPFOUND 6

virtual INT SECUREBLACKBOX_CALL FireTimestampFound(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, BOOL &bCertFound, BOOL &bValidateTimestamp, BOOL &bValidateChain);
class MessageVerifierTimestampFoundEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  bool CertFound();

  bool ValidateTimestamp();
  void SetValidateTimestamp(bool bValidateTimestamp);

  bool ValidateChain();
  void SetValidateChain(bool bValidateChain);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TimestampFound(MessageVerifierTimestampFoundEventParams *e);
// Or, subclass MessageVerifier and override this emitter function. virtual int FireTimestampFound(MessageVerifierTimestampFoundEventParams *e) {...}

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 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 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 SignatureValidationResult and ChainValidationResult properties respectively.

Use the ValidateSignature and ValidateChain parameters to tell the verifier which stages to include in the validation.

TimestampValidated Event (MessageVerifier Class)

Reports the completion of the timestamp validation routine.

Syntax

ANSI (Cross Platform)
virtual int FireTimestampValidated(MessageVerifierTimestampValidatedEventParams *e);
typedef struct {
const char *IssuerRDN;
const char *SerialNumber; int lenSerialNumber;
const char *SubjectKeyID; int lenSubjectKeyID;
const char *Time;
int ValidationResult;
int ChainValidationResult;
int ChainValidationDetails; int reserved; } MessageVerifierTimestampValidatedEventParams;
Unicode (Windows) virtual INT FireTimestampValidated(MessageVerifierTimestampValidatedEventParams *e);
typedef struct {
LPCWSTR IssuerRDN;
LPCSTR SerialNumber; INT lenSerialNumber;
LPCSTR SubjectKeyID; INT lenSubjectKeyID;
LPCWSTR Time;
INT ValidationResult;
INT ChainValidationResult;
INT ChainValidationDetails; INT reserved; } MessageVerifierTimestampValidatedEventParams;
#define EID_MESSAGEVERIFIER_TIMESTAMPVALIDATED 7

virtual INT SECUREBLACKBOX_CALL FireTimestampValidated(LPSTR &lpszIssuerRDN, LPSTR &lpSerialNumber, INT &lenSerialNumber, LPSTR &lpSubjectKeyID, INT &lenSubjectKeyID, LPSTR &lpszTime, INT &iValidationResult, INT &iChainValidationResult, INT &iChainValidationDetails);
class MessageVerifierTimestampValidatedEventParams {
public:
  const QString &IssuerRDN();

  const QByteArray &SerialNumber();

  const QByteArray &SubjectKeyID();

  const QString &Time();

  int ValidationResult();

  int ChainValidationResult();

  int ChainValidationDetails();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void TimestampValidated(MessageVerifierTimestampValidatedEventParams *e);
// Or, subclass MessageVerifier and override this emitter function. virtual int FireTimestampValidated(MessageVerifierTimestampValidatedEventParams *e) {...}

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.

svtValid0The signature is valid

svtUnknown1Signature validity is unknown

svtCorrupted2The signature is corrupted

svtSignerNotFound3Failed to acquire the signing certificate. The signature cannot be validated.

svtFailure4General failure

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

Base Config Settings

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:

offNo caching (default)
localLocal caching
globalGlobal 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.

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.

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".

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.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (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:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll 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-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude 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:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush 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:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore 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:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep 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.

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:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal 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 devided 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 chached 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).

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.

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.

Trappable Errors (MessageVerifier Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

MessageVerifier Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)