CertificateValidator Class
Properties Methods Events Config Settings Errors
The CertificateValidator class provides fine-grained validation of X.509 certificates.
Syntax
CertificateValidator
Remarks
This is a powerful and configurable class which can be used to validate all kinds of certificates and their chains.
The purpose of CertificateValidator is to validate certificate chains according to the X.509 specification. It supports a variety of technologies, including CRL and OCSP services, and can provide a comprehensive output on the certificate cryptographic validity, chain integrity, and trust levels. CertificateValidator is used internally in many other SecureBlackbox components, such as PDFSigner, HTTPClient, and OfficeVerifier.
To validate a certificate, please tune up the component as following:
- Assign the certificate to be validated to the Certificate property.
- Set RevocationCheck in accordance with your revocation check preferences.
- Enable UseSystemCertificates property to trust certificates that are trusted by the operating system. Copy any certificates that are not available in the standard system locations to KnownCertificates and TrustedCertificates collections (see Note 1 below).
- Optionally, adjust TLSSettings and SocketSettings.
- Adjust ValidationMoment if you would like to check the certificate validity at a different moment in time. Leave it unchanged to validate the certificate at the current time moment.
- Call Validate or ValidateForSSL method to initiate chain validation.
Depending on the complexity of the chain and the configuration of the component, the validation routine may take certain amount of time. The validator reports chain validation progress using a selection of events, such as BeforeCertificateProcessing, AfterCertificateProcessing, and CRLDownloaded events. It may also ask you for missing objects using CRLNeeded or CACertificateNeeded events. In each such event handler you can access the currently validated certificate via the CurrentCertificate property, and the interim validity figures via the InterimValidationResult and InterimValidationDetails property.
The return of the Validate (or similar) method indicates the completion of the validation procedure. The outcome of the chain validation is represented with the two parameters:
- ChainValidationResult reports the general validation outcome: valid, valid-but-untrusted, invalid, and unknown. As a rule, only the valid result can be taken as a good reason to consider the chain valid.
- ChainValidationDetails provides insights into the factors that caused the validation to fail.
Note 1: On Windows, CertificateValidator can use CA and ROOT system stores to look for any missing CA certificates and trust anchors. No similar functionality is currently available for other platforms, so in most cases you must provide your own list of trusted and CA certificates via TrustedCertificates and KnownCertificates collections to have your chains validate fully in Linux and macOS projects.
Note 2: The OfflineMode property is a handy way to check the completeness of your revocation/validation information. When the offline mode is on, CertificateValidator won't go online for any missing certificates, CRLs, and OCSP responses. Paired with a switched-off UseSystemCertificates property, it allows to make sure that any content provided via KnownCertificates, KnownCRLs, and KnownOCSPs represents the complete set of validation information required to validate the chain.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
BlockedCertCount | The number of records in the BlockedCert arrays. |
BlockedCertBytes | Returns raw certificate data in DER format. |
BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CacheValidationResults | Enables or disables validation result caching. |
CertBytes | Returns raw certificate data in DER format. |
CertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ChainValidationDetails | The details of a certificate chain validation outcome. |
ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
CurrentCACertBytes | Returns raw certificate data in DER format. |
CurrentCACertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
CurrentCACertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CurrentCACertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CurrentCACertCurve | Specifies the elliptic curve of the EC public key. |
CurrentCACertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CurrentCACertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CurrentCACertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CurrentCACertHashAlgorithm | 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 . |
CurrentCACertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CurrentCACertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CurrentCACertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CurrentCACertKeyBits | Returns the length of the public key. |
CurrentCACertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CurrentCACertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CurrentCACertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CurrentCACertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CurrentCACertOCSPNoCheck | Accessor to the value of the certificates ocsp-no-check extension. |
CurrentCACertOrigin | Returns the origin of this certificate. |
CurrentCACertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CurrentCACertPrivateKeyBytes | Contains the certificate's private key. |
CurrentCACertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
CurrentCACertPrivateKeyExtractable | Indicates whether the private key is extractable. |
CurrentCACertPublicKeyBytes | Contains the certificate's public key in DER format. |
CurrentCACertQualifiedStatements | Returns the qualified status of the certificate. |
CurrentCACertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CurrentCACertSerialNumber | Returns the certificate's serial number. |
CurrentCACertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CurrentCACertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CurrentCACertSubjectAlternativeName | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
CurrentCACertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CurrentCACertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CurrentCACertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CurrentCACertValidTo | The time point at which the certificate expires, in UTC. |
CurrentCertBytes | Returns raw certificate data in DER format. |
CurrentCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
CurrentCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CurrentCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CurrentCertCurve | Specifies the elliptic curve of the EC public key. |
CurrentCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CurrentCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CurrentCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CurrentCertHashAlgorithm | 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 . |
CurrentCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CurrentCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CurrentCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CurrentCertKeyBits | Returns the length of the public key. |
CurrentCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CurrentCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CurrentCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CurrentCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CurrentCertOCSPNoCheck | Accessor to the value of the certificates ocsp-no-check extension. |
CurrentCertOrigin | Returns the origin of this certificate. |
CurrentCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CurrentCertPrivateKeyBytes | Contains the certificate's private key. |
CurrentCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
CurrentCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
CurrentCertPublicKeyBytes | Contains the certificate's public key in DER format. |
CurrentCertQualifiedStatements | Returns the qualified status of the certificate. |
CurrentCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CurrentCertSerialNumber | Returns the certificate's serial number. |
CurrentCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CurrentCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CurrentCertSubjectAlternativeName | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
CurrentCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CurrentCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CurrentCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CurrentCertValidTo | The time point at which the certificate expires, in UTC. |
FIPSMode | Reserved. |
GracePeriod | Specifies a grace period to apply during certificate validation. |
InterimValidationDetails | Contains the validation details of the moment. |
InterimValidationResult | Contains the validation status of the moment. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownCRLCount | The number of records in the KnownCRL arrays. |
KnownCRLBytes | Returns raw CRL data in DER format. |
KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownOCSPCount | The number of records in the KnownOCSP arrays. |
KnownOCSPBytes | Buffer containing raw OCSP response data. |
KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
MaxValidationTime | Specifies the maximum time the validation process may take. |
OfflineMode | Switches the class to the offline mode. |
ProxyAddress | The IP address of the proxy server. |
ProxyAuthentication | The authentication type used by the proxy server. |
ProxyPassword | The password to authenticate to the proxy server. |
ProxyPort | The port on the proxy server to connect to. |
ProxyProxyType | The type of the proxy server. |
ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
ProxyUseProxy | Enables or disables proxy-driven connection. |
ProxyUsername | Specifies the username credential for proxy authentication. |
QualifiedInfoAddress | Contains the address of the TSL provider. |
QualifiedInfoCustomTSLs | The list of custom TSLs to use. |
QualifiedInfoDownloadLog | Contains the TLS download log. |
QualifiedInfoInformationURI | Contains the URI of the provider information. |
QualifiedInfoLanguages | The preferred language(s) for TSL data. |
QualifiedInfoNextUpdate | Returns the next update date and time of the TSL. |
QualifiedInfoProvider | Contains the name of the TSL provider. |
QualifiedInfoQualified | Indicates whether the certificate is qualified. |
QualifiedInfoQualifiers | A list of qualifiers. |
QualifiedInfoServiceName | Contains the name of the TSL service. |
QualifiedInfoServiceTypeId | Contains the TSL service type identifier. |
QualifiedInfoSource | The source of qualified information. |
QualifiedInfoStatus | Indicates a qualified electronic signature. |
QualifiedInfoTradeName | Contains the trade name of the TSL provider. |
QualifiedInfoUseDefaultTSLs | Use this setting to enable or disable the use of the default TSLs. |
QualifiedInfoValidationLog | Contains the TLS validation log. |
QualifiedInfoXML | Contains the XML of the TSL. |
RevocationCheck | Specifies the kind(s) of revocation check to perform. |
SocketDNSMode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
TLSClientCertCount | The number of records in the TLSClientCert arrays. |
TLSClientCertBytes | Returns raw certificate data in DER format. |
TLSClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSServerCertCount | The number of records in the TLSServerCert arrays. |
TLSServerCertBytes | Returns raw certificate data in DER format. |
TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables TLS session resumption capability. |
TLSVersions | The SSL/TLS versions to enable by default. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertBytes | Returns raw certificate data in DER format. |
TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UsedCertCount | The number of records in the UsedCert arrays. |
UsedCertBytes | Returns raw certificate data in DER format. |
UsedCertCA | Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension). |
UsedCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
UsedCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
UsedCertCurve | Specifies the elliptic curve of the EC public key. |
UsedCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
UsedCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
UsedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UsedCertHashAlgorithm | 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 . |
UsedCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
UsedCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
UsedCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
UsedCertKeyBits | Returns the length of the public key. |
UsedCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
UsedCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
UsedCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
UsedCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
UsedCertOCSPNoCheck | Accessor to the value of the certificates ocsp-no-check extension. |
UsedCertOrigin | Returns the origin of this certificate. |
UsedCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
UsedCertPrivateKeyBytes | Contains the certificate's private key. |
UsedCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
UsedCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
UsedCertPublicKeyBytes | Contains the certificate's public key in DER format. |
UsedCertQualifiedStatements | Returns the qualified status of the certificate. |
UsedCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
UsedCertSerialNumber | Returns the certificate's serial number. |
UsedCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
UsedCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
UsedCertSubjectAlternativeName | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
UsedCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
UsedCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
UsedCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
UsedCertValidTo | The time point at which the certificate expires, in UTC. |
UsedCRLCount | The number of records in the UsedCRL arrays. |
UsedCRLBytes | Returns raw CRL data in DER format. |
UsedCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UsedCRLIssuer | The common name of the CRL issuer (CA), typically a company name. |
UsedCRLIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
UsedCRLLocation | The URL that the CRL was downloaded from. |
UsedCRLNextUpdate | The planned time and date of the next version of this CRL to be published. |
UsedCRLThisUpdate | The date and time at which this version of the CRL was published. |
UseDefaultTSLs | Enables or disables the use of the default TSLs. |
UsedOCSPCount | The number of records in the UsedOCSP arrays. |
UsedOCSPBytes | Buffer containing raw OCSP response data. |
UsedOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UsedOCSPIssuer | Indicates the issuer of this response (a CA or its authorized representative). |
UsedOCSPIssuerRDN | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
UsedOCSPLocation | Location of the OCSP responder. |
UsedOCSPProducedAt | Specifies the time when the response was produced, in UTC. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
ValidationLog | Contains the complete log of the certificate validation routine. |
ValidationMoment | The time point at which chain validity is to be established. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
GetQualifiedStatus | Obtains the qualified information for Certificate . |
GetTSLProperty | Returns a specific TSL property. |
RefreshCache | Refreshes the certificate cache. |
ResetCache | Clears all data contained in the validation cache. |
Terminate | Terminates the validation process. |
Validate | Validates the certificate chain. |
ValidateForSMIME | Validates an e-mail signing certificate. |
ValidateForSSL | Validates a server-side SSL/TLS certificate. |
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.
AfterCertificateProcessing | Marks the end of a single certificate processing step. |
AfterCertificateValidation | Marks the end of a single certificate validation step. |
BeforeCACertificateDownload | Fires when a CA certificate is about to be downloaded. |
BeforeCertificateProcessing | Reports the start of certificate processing. |
BeforeCertificateValidation | Reports the start of certificate validation. |
BeforeCRLDownload | Fires when a CRL is about to be downloaded. |
BeforeOCSPDownload | Fires when a certificate's OCSP status is about to be requested. |
CACertificateDownloaded | Marks the success of a certificate download. |
CACertificateNeeded | Requests a missing certificate from the user. |
CRLDownloaded | Marks the success of a CRL download. |
CRLNeeded | Requests a missing CRL from the user. |
Error | Information about errors during certificate validation. |
Notification | This event notifies the application about an underlying control flow event. |
OCSPDownloaded | Marks the success of an OCSP request. |
TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
CacheValidityTime | Time period during which to keep validation cache. |
CheckStrongAlgorithmForTrusted | Whether to check a 'strong' hash algorithm for trusted certificates. |
CheckValidityPeriodForTrusted | Whether to check validity period for trusted certificates. |
CrossCertificationValidationStrategy | Defines how the cross certification validation is performed. |
DislikeOpenEndedOCSPs | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. |
ForceCompleteChainValidationForTrusted | Whether to validate the whole chain. |
ForceRevocationCheckForRoot | Whether to check revocation info for root certificates. |
IgnoreBadOCSPChains | Whether to ignore bad OCSP chains during validation. |
IgnoreCABasicConstraints | Whether to ignore the Basic Constraints extension for the CA certificates. |
IgnoreCAKeyUsage | Whether to ignore Key Usage extension for CA certificates. |
IgnoreCANameConstraints | Whether to ignore the Name Constraints extension for the CA certificates. |
IgnoreChainLoops | Whether chain loops should be ignored. |
IgnoreOCSPNoCheckExtension | Whether OCSP NoCheck extension should be ignored. |
IgnoreRevocationKeyUsage | Whether to check the CA certs used to sign revocation info. |
IgnoreSSLKeyUsage | Whether to check the CA certs used in SSL/TLS. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
LookupCRLByNameIfDPNotPresent | Whether to look for implicit CRL Distribution Points. |
PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
RevocationMomentGracePeriod | Grace period for revocation information propagation. |
SkipSubjectNameIfAltNameExists | Whether to check CommonName if SubjectAltName is present. |
UseMicrosoftCTL | Enables or disables automatic use of Microsoft online certificate trust list. |
UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
ValidateInvalidCertificates | Whether to do all checks on invalid certificates. |
WeakAlgorithmHandlingMode | How to handle certificates signed with a 'weak' hash algorithm. |
CustomTSLs | Specifies the custom TSLs. |
QualifiedStatus | Indicates a qualified electronic signature. |
TSLContent | Specifies the TrustedList content. |
TSLContentHex | Specifies the TrustedList content. |
TSLDistributionPoints | Contains XML content of distribution points of the TSL used. |
TSLDistributionPoints[Idx] | Contains distribution point of the specified index of the TSL used. |
TSLHistoricalInformationPeriod | Contains historical information period of the TSL used. |
TSLLegalNotices | Contains XML content of legal notices of the TSL used. |
TSLLegalNotices[lang] | Contains legal notices for the specified language of the TSL used. |
TSLListIssueDateTime | Contains list issue date and time of the TSL used. |
TSLNextUpdate | Contains next update date and time of the TSL used. |
TSLPolicies | Contains XML content of policies of the TSL used. |
TSLPolicies[lang] | Contains policies for the specified language of the TSL used. |
TSLSchemeExtensions | Contains XML content of scheme extensions of the TSL used. |
TSLSchemeExtensions[Idx] | Contains XML content of scheme extension of the specified index of the TSL used. |
TSLSchemeInformationURI | Contains XML content of scheme information URI of the TSL used. |
TSLSchemeInformationURI[lang] | Contains scheme information URI for the specified language of the TSL used. |
TSLSchemeName | Contains XML content of scheme name of the TSL used. |
TSLSchemeName[lang] | Contains scheme name for the specified language of the TSL used. |
TSLSchemeOperatorAddress | Contains XML content of scheme operator address of the TSL used. |
TSLSchemeOperatorName | Contains XML content of scheme operator name of the TSL used. |
TSLSchemeOperatorName[lang] | Contains scheme operator name for the specified language of the TSL used. |
TSLSchemeTerritory | Contains scheme territory of the TSL used. |
TSLSchemeTypeCommunityRules | Contains XML content of scheme type/community/rules of the TSL used. |
TSLSchemeTypeCommunityRules[lang] | Contains scheme type/community/rules for the specified language of the TSL used. |
TSLSequenceNumber | Contains sequence number of the TSL used. |
TSLsRetrieveLog | Contains the complete log of the TSLs retrieve. |
TSLStatusDeterminationApproach | Contains status determination approach of the TSL used. |
TSLsValidationLog | Contains the complete log of the TSLs validation. |
TSLTSPAdditionalServiceInformation | Contains addtional service information of the TSP service used. |
TSLTSPAddress | Contains XML content of the address of the TSP used. |
TSLTSPHistoryInstance | Indicates that TSP service history instance used. |
TSLTSPHistoryInstanceAdditionalServiceInformation | Contains addtional service information of the TSP service history instance used. |
TSLTSPHistoryInstanceQualifiers | Contains list of qualifiers of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceInformationExtensions | Contains XML content of information extensions of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceName | Contains XML content of name of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceName[lang] | Contains name for the specified language of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceStatus | Contains status of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceStatusStartingTime | Contains status starting time of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceTypeIdentifier | Contains type identifier of the TSP service history instance used. |
TSLTSPHistoryInstanceXML | Contains XML content of the TSP service history instance used. |
TSLTSPInformationExtensions | Contains XML content of information extensions of the TSP used. |
TSLTSPInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP used. |
TSLTSPInformationURI | Contains XML content of information URI of the TSP used. |
TSLTSPInformationURI[lang] | Contains information URI for the specified language of the TSP used. |
TSLTSPName | Contains XML content of name of the TSP used. |
TSLTSPName[lang] | Contains name for the specified language of the TSP used. |
TSLTSPSchemeServiceDefinitionURI | Contains XML content of scheme service definition URI of the TSP service used. |
TSLTSPSchemeServiceDefinitionURI[lang] | Contains scheme service definition URI for the specified language of the TSP service used. |
TSLTSPServiceDefinitionURI | Contains XML content of definition URI of the TSP service used. |
TSLTSPServiceDefinitionURI[lang] | Contains definition URI for the specified language of the TSP service used. |
TSLTSPServiceInformationExtensions | Contains XML content of information extensions of the TSP service used. |
TSLTSPServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service used. |
TSLTSPServiceName | Contains XML content of name of the TSP service used. |
TSLTSPServiceName[lang] | Contains name for the specified language of the TSP service used. |
TSLTSPServiceQualifiers | Contains list of qualifiers of the TSP service used. |
TSLTSPServiceStatus | Contains status of the TSP service used. |
TSLTSPServiceStatusStartingTime | Contains status starting time of the TSP service used. |
TSLTSPServiceSupplyPoints | Contains XML content of the supply points of the TSP service used. |
TSLTSPServiceTypeIdentifier | Contains type identifier of the TSP service used. |
TSLTSPServiceXML | Contains XML content of the TSP service used. |
TSLTSPTradeName | Contains XML content of trade name of the TSP used. |
TSLTSPTradeName[lang] | Contains trade name for the specified language of the TSP used. |
TSLTSPXML | Contains XML content of the TSP used. |
TSLType | Contains TSL type of the TSL used. |
TSLVersionIdentifier | Contains version identifier of the TSL used. |
TSLXML | Contains XML content of the TSL used. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
BlockedCertCount Property (CertificateValidator Class)
The number of records in the BlockedCert arrays.
Syntax
ANSI (Cross Platform) int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); Unicode (Windows) INT GetBlockedCertCount();
INT SetBlockedCertCount(INT iBlockedCertCount);
int secureblackbox_certificatevalidator_getblockedcertcount(void* lpObj);
int secureblackbox_certificatevalidator_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at BlockedCertCount - 1.This property is not available at design time.
Data Type
Integer
BlockedCertBytes Property (CertificateValidator Class)
Returns raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetBlockedCertBytes(int iBlockedCertIndex, char* &lpBlockedCertBytes, int &lenBlockedCertBytes); Unicode (Windows) INT GetBlockedCertBytes(INT iBlockedCertIndex, LPSTR &lpBlockedCertBytes, INT &lenBlockedCertBytes);
int secureblackbox_certificatevalidator_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
QByteArray GetBlockedCertBytes(int iBlockedCertIndex);
Remarks
Returns raw certificate data in DER format.
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
BlockedCertHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, int64 lBlockedCertHandle); Unicode (Windows) LONG64 GetBlockedCertHandle(INT iBlockedCertIndex);
INT SetBlockedCertHandle(INT iBlockedCertIndex, LONG64 lBlockedCertHandle);
int64 secureblackbox_certificatevalidator_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_certificatevalidator_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is not available at design time.
Data Type
Long64
CacheValidationResults Property (CertificateValidator Class)
Enables or disables validation result caching.
Syntax
ANSI (Cross Platform) int GetCacheValidationResults();
int SetCacheValidationResults(int bCacheValidationResults); Unicode (Windows) BOOL GetCacheValidationResults();
INT SetCacheValidationResults(BOOL bCacheValidationResults);
int secureblackbox_certificatevalidator_getcachevalidationresults(void* lpObj);
int secureblackbox_certificatevalidator_setcachevalidationresults(void* lpObj, int bCacheValidationResults);
bool GetCacheValidationResults();
int SetCacheValidationResults(bool bCacheValidationResults);
Default Value
FALSE
Remarks
Set this property to True to enable caching of validation results.
Data Type
Boolean
CertBytes Property (CertificateValidator Class)
Returns raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetCertBytes(char* &lpCertBytes, int &lenCertBytes); Unicode (Windows) INT GetCertBytes(LPSTR &lpCertBytes, INT &lenCertBytes);
int secureblackbox_certificatevalidator_getcertbytes(void* lpObj, char** lpCertBytes, int* lenCertBytes);
QByteArray GetCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CertHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetCertHandle();
int SetCertHandle(int64 lCertHandle); Unicode (Windows) LONG64 GetCertHandle();
INT SetCertHandle(LONG64 lCertHandle);
int64 secureblackbox_certificatevalidator_getcerthandle(void* lpObj);
int secureblackbox_certificatevalidator_setcerthandle(void* lpObj, int64 lCertHandle);
qint64 GetCertHandle();
int SetCertHandle(qint64 lCertHandle);
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 not available at design time.
Data Type
Long64
ChainValidationDetails Property (CertificateValidator Class)
The details of a certificate chain validation outcome.
Syntax
ANSI (Cross Platform) int GetChainValidationDetails(); Unicode (Windows) INT GetChainValidationDetails();
int secureblackbox_certificatevalidator_getchainvalidationdetails(void* lpObj);
int GetChainValidationDetails();
Default Value
0
Remarks
Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
ChainValidationResult Property (CertificateValidator Class)
The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
Syntax
ANSI (Cross Platform) int GetChainValidationResult(); Unicode (Windows) INT GetChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_certificatevalidator_getchainvalidationresult(void* lpObj);
int GetChainValidationResult();
Default Value
0
Remarks
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertBytes Property (CertificateValidator Class)
Returns raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetCurrentCACertBytes(char* &lpCurrentCACertBytes, int &lenCurrentCACertBytes); Unicode (Windows) INT GetCurrentCACertBytes(LPSTR &lpCurrentCACertBytes, INT &lenCurrentCACertBytes);
int secureblackbox_certificatevalidator_getcurrentcacertbytes(void* lpObj, char** lpCurrentCACertBytes, int* lenCurrentCACertBytes);
QByteArray GetCurrentCACertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertCA Property (CertificateValidator Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
ANSI (Cross Platform) int GetCurrentCACertCA(); Unicode (Windows) BOOL GetCurrentCACertCA();
int secureblackbox_certificatevalidator_getcurrentcacertca(void* lpObj);
bool GetCurrentCACertCA();
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
CurrentCACertCAKeyID Property (CertificateValidator Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
ANSI (Cross Platform) int GetCurrentCACertCAKeyID(char* &lpCurrentCACertCAKeyID, int &lenCurrentCACertCAKeyID); Unicode (Windows) INT GetCurrentCACertCAKeyID(LPSTR &lpCurrentCACertCAKeyID, INT &lenCurrentCACertCAKeyID);
int secureblackbox_certificatevalidator_getcurrentcacertcakeyid(void* lpObj, char** lpCurrentCACertCAKeyID, int* lenCurrentCACertCAKeyID);
QByteArray GetCurrentCACertCAKeyID();
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
CurrentCACertCRLDistributionPoints Property (CertificateValidator Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertCRLDistributionPoints(); Unicode (Windows) LPWSTR GetCurrentCACertCRLDistributionPoints();
char* secureblackbox_certificatevalidator_getcurrentcacertcrldistributionpoints(void* lpObj);
QString GetCurrentCACertCRLDistributionPoints();
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
CurrentCACertCurve Property (CertificateValidator Class)
Specifies the elliptic curve of the EC public key.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertCurve(); Unicode (Windows) LPWSTR GetCurrentCACertCurve();
char* secureblackbox_certificatevalidator_getcurrentcacertcurve(void* lpObj);
QString GetCurrentCACertCurve();
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertFingerprint Property (CertificateValidator Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
ANSI (Cross Platform) int GetCurrentCACertFingerprint(char* &lpCurrentCACertFingerprint, int &lenCurrentCACertFingerprint); Unicode (Windows) INT GetCurrentCACertFingerprint(LPSTR &lpCurrentCACertFingerprint, INT &lenCurrentCACertFingerprint);
int secureblackbox_certificatevalidator_getcurrentcacertfingerprint(void* lpObj, char** lpCurrentCACertFingerprint, int* lenCurrentCACertFingerprint);
QByteArray GetCurrentCACertFingerprint();
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
CurrentCACertFriendlyName Property (CertificateValidator Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertFriendlyName(); Unicode (Windows) LPWSTR GetCurrentCACertFriendlyName();
char* secureblackbox_certificatevalidator_getcurrentcacertfriendlyname(void* lpObj);
QString GetCurrentCACertFriendlyName();
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
CurrentCACertHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetCurrentCACertHandle(); Unicode (Windows) LONG64 GetCurrentCACertHandle();
int64 secureblackbox_certificatevalidator_getcurrentcacerthandle(void* lpObj);
qint64 GetCurrentCACertHandle();
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
CurrentCACertHashAlgorithm Property (CertificateValidator 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* GetCurrentCACertHashAlgorithm(); Unicode (Windows) LPWSTR GetCurrentCACertHashAlgorithm();
char* secureblackbox_certificatevalidator_getcurrentcacerthashalgorithm(void* lpObj);
QString GetCurrentCACertHashAlgorithm();
Default Value
""
Remarks
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 |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertIssuer Property (CertificateValidator Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertIssuer(); Unicode (Windows) LPWSTR GetCurrentCACertIssuer();
char* secureblackbox_certificatevalidator_getcurrentcacertissuer(void* lpObj);
QString GetCurrentCACertIssuer();
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
CurrentCACertIssuerRDN Property (CertificateValidator Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertIssuerRDN(); Unicode (Windows) LPWSTR GetCurrentCACertIssuerRDN();
char* secureblackbox_certificatevalidator_getcurrentcacertissuerrdn(void* lpObj);
QString GetCurrentCACertIssuerRDN();
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
CurrentCACertKeyAlgorithm Property (CertificateValidator Class)
Specifies the public key algorithm of this certificate.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertKeyAlgorithm(); Unicode (Windows) LPWSTR GetCurrentCACertKeyAlgorithm();
char* secureblackbox_certificatevalidator_getcurrentcacertkeyalgorithm(void* lpObj);
QString GetCurrentCACertKeyAlgorithm();
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertKeyBits Property (CertificateValidator Class)
Returns the length of the public key.
Syntax
ANSI (Cross Platform) int GetCurrentCACertKeyBits(); Unicode (Windows) INT GetCurrentCACertKeyBits();
int secureblackbox_certificatevalidator_getcurrentcacertkeybits(void* lpObj);
int GetCurrentCACertKeyBits();
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
CurrentCACertKeyFingerprint Property (CertificateValidator Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
ANSI (Cross Platform) int GetCurrentCACertKeyFingerprint(char* &lpCurrentCACertKeyFingerprint, int &lenCurrentCACertKeyFingerprint); Unicode (Windows) INT GetCurrentCACertKeyFingerprint(LPSTR &lpCurrentCACertKeyFingerprint, INT &lenCurrentCACertKeyFingerprint);
int secureblackbox_certificatevalidator_getcurrentcacertkeyfingerprint(void* lpObj, char** lpCurrentCACertKeyFingerprint, int* lenCurrentCACertKeyFingerprint);
QByteArray GetCurrentCACertKeyFingerprint();
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
CurrentCACertKeyUsage Property (CertificateValidator 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 GetCurrentCACertKeyUsage(); Unicode (Windows) INT GetCurrentCACertKeyUsage();
int secureblackbox_certificatevalidator_getcurrentcacertkeyusage(void* lpObj);
int GetCurrentCACertKeyUsage();
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertKeyValid Property (CertificateValidator Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
ANSI (Cross Platform) int GetCurrentCACertKeyValid(); Unicode (Windows) BOOL GetCurrentCACertKeyValid();
int secureblackbox_certificatevalidator_getcurrentcacertkeyvalid(void* lpObj);
bool GetCurrentCACertKeyValid();
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
CurrentCACertOCSPLocations Property (CertificateValidator 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* GetCurrentCACertOCSPLocations(); Unicode (Windows) LPWSTR GetCurrentCACertOCSPLocations();
char* secureblackbox_certificatevalidator_getcurrentcacertocsplocations(void* lpObj);
QString GetCurrentCACertOCSPLocations();
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
CurrentCACertOCSPNoCheck Property (CertificateValidator Class)
Accessor to the value of the certificates ocsp-no-check extension.
Syntax
ANSI (Cross Platform) int GetCurrentCACertOCSPNoCheck(); Unicode (Windows) BOOL GetCurrentCACertOCSPNoCheck();
int secureblackbox_certificatevalidator_getcurrentcacertocspnocheck(void* lpObj);
bool GetCurrentCACertOCSPNoCheck();
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
CurrentCACertOrigin Property (CertificateValidator Class)
Returns the origin of this certificate.
Syntax
ANSI (Cross Platform) int GetCurrentCACertOrigin(); Unicode (Windows) INT GetCurrentCACertOrigin();
int secureblackbox_certificatevalidator_getcurrentcacertorigin(void* lpObj);
int GetCurrentCACertOrigin();
Default Value
0
Remarks
Returns the origin of this certificate.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertPolicyIDs Property (CertificateValidator Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertPolicyIDs(); Unicode (Windows) LPWSTR GetCurrentCACertPolicyIDs();
char* secureblackbox_certificatevalidator_getcurrentcacertpolicyids(void* lpObj);
QString GetCurrentCACertPolicyIDs();
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
CurrentCACertPrivateKeyBytes Property (CertificateValidator Class)
Contains the certificate's private key.
Syntax
ANSI (Cross Platform) int GetCurrentCACertPrivateKeyBytes(char* &lpCurrentCACertPrivateKeyBytes, int &lenCurrentCACertPrivateKeyBytes); Unicode (Windows) INT GetCurrentCACertPrivateKeyBytes(LPSTR &lpCurrentCACertPrivateKeyBytes, INT &lenCurrentCACertPrivateKeyBytes);
int secureblackbox_certificatevalidator_getcurrentcacertprivatekeybytes(void* lpObj, char** lpCurrentCACertPrivateKeyBytes, int* lenCurrentCACertPrivateKeyBytes);
QByteArray GetCurrentCACertPrivateKeyBytes();
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
CurrentCACertPrivateKeyExists Property (CertificateValidator Class)
Indicates whether the certificate has an associated private key.
Syntax
ANSI (Cross Platform) int GetCurrentCACertPrivateKeyExists(); Unicode (Windows) BOOL GetCurrentCACertPrivateKeyExists();
int secureblackbox_certificatevalidator_getcurrentcacertprivatekeyexists(void* lpObj);
bool GetCurrentCACertPrivateKeyExists();
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
CurrentCACertPrivateKeyExtractable Property (CertificateValidator Class)
Indicates whether the private key is extractable.
Syntax
ANSI (Cross Platform) int GetCurrentCACertPrivateKeyExtractable(); Unicode (Windows) BOOL GetCurrentCACertPrivateKeyExtractable();
int secureblackbox_certificatevalidator_getcurrentcacertprivatekeyextractable(void* lpObj);
bool GetCurrentCACertPrivateKeyExtractable();
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
CurrentCACertPublicKeyBytes Property (CertificateValidator Class)
Contains the certificate's public key in DER format.
Syntax
ANSI (Cross Platform) int GetCurrentCACertPublicKeyBytes(char* &lpCurrentCACertPublicKeyBytes, int &lenCurrentCACertPublicKeyBytes); Unicode (Windows) INT GetCurrentCACertPublicKeyBytes(LPSTR &lpCurrentCACertPublicKeyBytes, INT &lenCurrentCACertPublicKeyBytes);
int secureblackbox_certificatevalidator_getcurrentcacertpublickeybytes(void* lpObj, char** lpCurrentCACertPublicKeyBytes, int* lenCurrentCACertPublicKeyBytes);
QByteArray GetCurrentCACertPublicKeyBytes();
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
CurrentCACertQualifiedStatements Property (CertificateValidator Class)
Returns the qualified status of the certificate.
Syntax
ANSI (Cross Platform) int GetCurrentCACertQualifiedStatements(); Unicode (Windows) INT GetCurrentCACertQualifiedStatements();
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
int secureblackbox_certificatevalidator_getcurrentcacertqualifiedstatements(void* lpObj);
int GetCurrentCACertQualifiedStatements();
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
CurrentCACertSelfSigned Property (CertificateValidator Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
ANSI (Cross Platform) int GetCurrentCACertSelfSigned(); Unicode (Windows) BOOL GetCurrentCACertSelfSigned();
int secureblackbox_certificatevalidator_getcurrentcacertselfsigned(void* lpObj);
bool GetCurrentCACertSelfSigned();
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
CurrentCACertSerialNumber Property (CertificateValidator Class)
Returns the certificate's serial number.
Syntax
ANSI (Cross Platform) int GetCurrentCACertSerialNumber(char* &lpCurrentCACertSerialNumber, int &lenCurrentCACertSerialNumber); Unicode (Windows) INT GetCurrentCACertSerialNumber(LPSTR &lpCurrentCACertSerialNumber, INT &lenCurrentCACertSerialNumber);
int secureblackbox_certificatevalidator_getcurrentcacertserialnumber(void* lpObj, char** lpCurrentCACertSerialNumber, int* lenCurrentCACertSerialNumber);
QByteArray GetCurrentCACertSerialNumber();
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertSigAlgorithm Property (CertificateValidator Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertSigAlgorithm(); Unicode (Windows) LPWSTR GetCurrentCACertSigAlgorithm();
char* secureblackbox_certificatevalidator_getcurrentcacertsigalgorithm(void* lpObj);
QString GetCurrentCACertSigAlgorithm();
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
CurrentCACertSubject Property (CertificateValidator 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* GetCurrentCACertSubject(); Unicode (Windows) LPWSTR GetCurrentCACertSubject();
char* secureblackbox_certificatevalidator_getcurrentcacertsubject(void* lpObj);
QString GetCurrentCACertSubject();
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
CurrentCACertSubjectAlternativeName Property (CertificateValidator Class)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertSubjectAlternativeName(); Unicode (Windows) LPWSTR GetCurrentCACertSubjectAlternativeName();
char* secureblackbox_certificatevalidator_getcurrentcacertsubjectalternativename(void* lpObj);
QString GetCurrentCACertSubjectAlternativeName();
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
CurrentCACertSubjectKeyID Property (CertificateValidator Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
ANSI (Cross Platform) int GetCurrentCACertSubjectKeyID(char* &lpCurrentCACertSubjectKeyID, int &lenCurrentCACertSubjectKeyID); Unicode (Windows) INT GetCurrentCACertSubjectKeyID(LPSTR &lpCurrentCACertSubjectKeyID, INT &lenCurrentCACertSubjectKeyID);
int secureblackbox_certificatevalidator_getcurrentcacertsubjectkeyid(void* lpObj, char** lpCurrentCACertSubjectKeyID, int* lenCurrentCACertSubjectKeyID);
QByteArray GetCurrentCACertSubjectKeyID();
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
CurrentCACertSubjectRDN Property (CertificateValidator Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
ANSI (Cross Platform) char* GetCurrentCACertSubjectRDN(); Unicode (Windows) LPWSTR GetCurrentCACertSubjectRDN();
char* secureblackbox_certificatevalidator_getcurrentcacertsubjectrdn(void* lpObj);
QString GetCurrentCACertSubjectRDN();
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
CurrentCACertValidFrom Property (CertificateValidator Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertValidFrom(); Unicode (Windows) LPWSTR GetCurrentCACertValidFrom();
char* secureblackbox_certificatevalidator_getcurrentcacertvalidfrom(void* lpObj);
QString GetCurrentCACertValidFrom();
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
CurrentCACertValidTo Property (CertificateValidator Class)
The time point at which the certificate expires, in UTC.
Syntax
ANSI (Cross Platform) char* GetCurrentCACertValidTo(); Unicode (Windows) LPWSTR GetCurrentCACertValidTo();
char* secureblackbox_certificatevalidator_getcurrentcacertvalidto(void* lpObj);
QString GetCurrentCACertValidTo();
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
CurrentCertBytes Property (CertificateValidator Class)
Returns raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetCurrentCertBytes(char* &lpCurrentCertBytes, int &lenCurrentCertBytes); Unicode (Windows) INT GetCurrentCertBytes(LPSTR &lpCurrentCertBytes, INT &lenCurrentCertBytes);
int secureblackbox_certificatevalidator_getcurrentcertbytes(void* lpObj, char** lpCurrentCertBytes, int* lenCurrentCertBytes);
QByteArray GetCurrentCertBytes();
Remarks
Returns raw certificate data in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertCA Property (CertificateValidator Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
ANSI (Cross Platform) int GetCurrentCertCA(); Unicode (Windows) BOOL GetCurrentCertCA();
int secureblackbox_certificatevalidator_getcurrentcertca(void* lpObj);
bool GetCurrentCertCA();
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
CurrentCertCAKeyID Property (CertificateValidator Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
ANSI (Cross Platform) int GetCurrentCertCAKeyID(char* &lpCurrentCertCAKeyID, int &lenCurrentCertCAKeyID); Unicode (Windows) INT GetCurrentCertCAKeyID(LPSTR &lpCurrentCertCAKeyID, INT &lenCurrentCertCAKeyID);
int secureblackbox_certificatevalidator_getcurrentcertcakeyid(void* lpObj, char** lpCurrentCertCAKeyID, int* lenCurrentCertCAKeyID);
QByteArray GetCurrentCertCAKeyID();
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
CurrentCertCRLDistributionPoints Property (CertificateValidator Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
ANSI (Cross Platform) char* GetCurrentCertCRLDistributionPoints(); Unicode (Windows) LPWSTR GetCurrentCertCRLDistributionPoints();
char* secureblackbox_certificatevalidator_getcurrentcertcrldistributionpoints(void* lpObj);
QString GetCurrentCertCRLDistributionPoints();
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
CurrentCertCurve Property (CertificateValidator Class)
Specifies the elliptic curve of the EC public key.
Syntax
ANSI (Cross Platform) char* GetCurrentCertCurve(); Unicode (Windows) LPWSTR GetCurrentCertCurve();
char* secureblackbox_certificatevalidator_getcurrentcertcurve(void* lpObj);
QString GetCurrentCertCurve();
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
This property is read-only and not available at design time.
Data Type
String
CurrentCertFingerprint Property (CertificateValidator Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
ANSI (Cross Platform) int GetCurrentCertFingerprint(char* &lpCurrentCertFingerprint, int &lenCurrentCertFingerprint); Unicode (Windows) INT GetCurrentCertFingerprint(LPSTR &lpCurrentCertFingerprint, INT &lenCurrentCertFingerprint);
int secureblackbox_certificatevalidator_getcurrentcertfingerprint(void* lpObj, char** lpCurrentCertFingerprint, int* lenCurrentCertFingerprint);
QByteArray GetCurrentCertFingerprint();
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
CurrentCertFriendlyName Property (CertificateValidator Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
ANSI (Cross Platform) char* GetCurrentCertFriendlyName(); Unicode (Windows) LPWSTR GetCurrentCertFriendlyName();
char* secureblackbox_certificatevalidator_getcurrentcertfriendlyname(void* lpObj);
QString GetCurrentCertFriendlyName();
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
CurrentCertHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetCurrentCertHandle(); Unicode (Windows) LONG64 GetCurrentCertHandle();
int64 secureblackbox_certificatevalidator_getcurrentcerthandle(void* lpObj);
qint64 GetCurrentCertHandle();
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
CurrentCertHashAlgorithm Property (CertificateValidator 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* GetCurrentCertHashAlgorithm(); Unicode (Windows) LPWSTR GetCurrentCertHashAlgorithm();
char* secureblackbox_certificatevalidator_getcurrentcerthashalgorithm(void* lpObj);
QString GetCurrentCertHashAlgorithm();
Default Value
""
Remarks
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 |
This property is read-only and not available at design time.
Data Type
String
CurrentCertIssuer Property (CertificateValidator Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
ANSI (Cross Platform) char* GetCurrentCertIssuer(); Unicode (Windows) LPWSTR GetCurrentCertIssuer();
char* secureblackbox_certificatevalidator_getcurrentcertissuer(void* lpObj);
QString GetCurrentCertIssuer();
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
CurrentCertIssuerRDN Property (CertificateValidator Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
ANSI (Cross Platform) char* GetCurrentCertIssuerRDN(); Unicode (Windows) LPWSTR GetCurrentCertIssuerRDN();
char* secureblackbox_certificatevalidator_getcurrentcertissuerrdn(void* lpObj);
QString GetCurrentCertIssuerRDN();
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
CurrentCertKeyAlgorithm Property (CertificateValidator Class)
Specifies the public key algorithm of this certificate.
Syntax
ANSI (Cross Platform) char* GetCurrentCertKeyAlgorithm(); Unicode (Windows) LPWSTR GetCurrentCertKeyAlgorithm();
char* secureblackbox_certificatevalidator_getcurrentcertkeyalgorithm(void* lpObj);
QString GetCurrentCertKeyAlgorithm();
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
This property is read-only and not available at design time.
Data Type
String
CurrentCertKeyBits Property (CertificateValidator Class)
Returns the length of the public key.
Syntax
ANSI (Cross Platform) int GetCurrentCertKeyBits(); Unicode (Windows) INT GetCurrentCertKeyBits();
int secureblackbox_certificatevalidator_getcurrentcertkeybits(void* lpObj);
int GetCurrentCertKeyBits();
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
CurrentCertKeyFingerprint Property (CertificateValidator Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
ANSI (Cross Platform) int GetCurrentCertKeyFingerprint(char* &lpCurrentCertKeyFingerprint, int &lenCurrentCertKeyFingerprint); Unicode (Windows) INT GetCurrentCertKeyFingerprint(LPSTR &lpCurrentCertKeyFingerprint, INT &lenCurrentCertKeyFingerprint);
int secureblackbox_certificatevalidator_getcurrentcertkeyfingerprint(void* lpObj, char** lpCurrentCertKeyFingerprint, int* lenCurrentCertKeyFingerprint);
QByteArray GetCurrentCertKeyFingerprint();
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
CurrentCertKeyUsage Property (CertificateValidator 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 GetCurrentCertKeyUsage(); Unicode (Windows) INT GetCurrentCertKeyUsage();
int secureblackbox_certificatevalidator_getcurrentcertkeyusage(void* lpObj);
int GetCurrentCertKeyUsage();
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertKeyValid Property (CertificateValidator Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
ANSI (Cross Platform) int GetCurrentCertKeyValid(); Unicode (Windows) BOOL GetCurrentCertKeyValid();
int secureblackbox_certificatevalidator_getcurrentcertkeyvalid(void* lpObj);
bool GetCurrentCertKeyValid();
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
CurrentCertOCSPLocations Property (CertificateValidator 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* GetCurrentCertOCSPLocations(); Unicode (Windows) LPWSTR GetCurrentCertOCSPLocations();
char* secureblackbox_certificatevalidator_getcurrentcertocsplocations(void* lpObj);
QString GetCurrentCertOCSPLocations();
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
CurrentCertOCSPNoCheck Property (CertificateValidator Class)
Accessor to the value of the certificates ocsp-no-check extension.
Syntax
ANSI (Cross Platform) int GetCurrentCertOCSPNoCheck(); Unicode (Windows) BOOL GetCurrentCertOCSPNoCheck();
int secureblackbox_certificatevalidator_getcurrentcertocspnocheck(void* lpObj);
bool GetCurrentCertOCSPNoCheck();
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
CurrentCertOrigin Property (CertificateValidator Class)
Returns the origin of this certificate.
Syntax
ANSI (Cross Platform) int GetCurrentCertOrigin(); Unicode (Windows) INT GetCurrentCertOrigin();
int secureblackbox_certificatevalidator_getcurrentcertorigin(void* lpObj);
int GetCurrentCertOrigin();
Default Value
0
Remarks
Returns the origin of this certificate.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertPolicyIDs Property (CertificateValidator Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
ANSI (Cross Platform) char* GetCurrentCertPolicyIDs(); Unicode (Windows) LPWSTR GetCurrentCertPolicyIDs();
char* secureblackbox_certificatevalidator_getcurrentcertpolicyids(void* lpObj);
QString GetCurrentCertPolicyIDs();
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
CurrentCertPrivateKeyBytes Property (CertificateValidator Class)
Contains the certificate's private key.
Syntax
ANSI (Cross Platform) int GetCurrentCertPrivateKeyBytes(char* &lpCurrentCertPrivateKeyBytes, int &lenCurrentCertPrivateKeyBytes); Unicode (Windows) INT GetCurrentCertPrivateKeyBytes(LPSTR &lpCurrentCertPrivateKeyBytes, INT &lenCurrentCertPrivateKeyBytes);
int secureblackbox_certificatevalidator_getcurrentcertprivatekeybytes(void* lpObj, char** lpCurrentCertPrivateKeyBytes, int* lenCurrentCertPrivateKeyBytes);
QByteArray GetCurrentCertPrivateKeyBytes();
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
CurrentCertPrivateKeyExists Property (CertificateValidator Class)
Indicates whether the certificate has an associated private key.
Syntax
ANSI (Cross Platform) int GetCurrentCertPrivateKeyExists(); Unicode (Windows) BOOL GetCurrentCertPrivateKeyExists();
int secureblackbox_certificatevalidator_getcurrentcertprivatekeyexists(void* lpObj);
bool GetCurrentCertPrivateKeyExists();
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
CurrentCertPrivateKeyExtractable Property (CertificateValidator Class)
Indicates whether the private key is extractable.
Syntax
ANSI (Cross Platform) int GetCurrentCertPrivateKeyExtractable(); Unicode (Windows) BOOL GetCurrentCertPrivateKeyExtractable();
int secureblackbox_certificatevalidator_getcurrentcertprivatekeyextractable(void* lpObj);
bool GetCurrentCertPrivateKeyExtractable();
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
CurrentCertPublicKeyBytes Property (CertificateValidator Class)
Contains the certificate's public key in DER format.
Syntax
ANSI (Cross Platform) int GetCurrentCertPublicKeyBytes(char* &lpCurrentCertPublicKeyBytes, int &lenCurrentCertPublicKeyBytes); Unicode (Windows) INT GetCurrentCertPublicKeyBytes(LPSTR &lpCurrentCertPublicKeyBytes, INT &lenCurrentCertPublicKeyBytes);
int secureblackbox_certificatevalidator_getcurrentcertpublickeybytes(void* lpObj, char** lpCurrentCertPublicKeyBytes, int* lenCurrentCertPublicKeyBytes);
QByteArray GetCurrentCertPublicKeyBytes();
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
CurrentCertQualifiedStatements Property (CertificateValidator Class)
Returns the qualified status of the certificate.
Syntax
ANSI (Cross Platform) int GetCurrentCertQualifiedStatements(); Unicode (Windows) INT GetCurrentCertQualifiedStatements();
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
int secureblackbox_certificatevalidator_getcurrentcertqualifiedstatements(void* lpObj);
int GetCurrentCertQualifiedStatements();
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
CurrentCertSelfSigned Property (CertificateValidator Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
ANSI (Cross Platform) int GetCurrentCertSelfSigned(); Unicode (Windows) BOOL GetCurrentCertSelfSigned();
int secureblackbox_certificatevalidator_getcurrentcertselfsigned(void* lpObj);
bool GetCurrentCertSelfSigned();
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
CurrentCertSerialNumber Property (CertificateValidator Class)
Returns the certificate's serial number.
Syntax
ANSI (Cross Platform) int GetCurrentCertSerialNumber(char* &lpCurrentCertSerialNumber, int &lenCurrentCertSerialNumber); Unicode (Windows) INT GetCurrentCertSerialNumber(LPSTR &lpCurrentCertSerialNumber, INT &lenCurrentCertSerialNumber);
int secureblackbox_certificatevalidator_getcurrentcertserialnumber(void* lpObj, char** lpCurrentCertSerialNumber, int* lenCurrentCertSerialNumber);
QByteArray GetCurrentCertSerialNumber();
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertSigAlgorithm Property (CertificateValidator Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
ANSI (Cross Platform) char* GetCurrentCertSigAlgorithm(); Unicode (Windows) LPWSTR GetCurrentCertSigAlgorithm();
char* secureblackbox_certificatevalidator_getcurrentcertsigalgorithm(void* lpObj);
QString GetCurrentCertSigAlgorithm();
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
CurrentCertSubject Property (CertificateValidator 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* GetCurrentCertSubject(); Unicode (Windows) LPWSTR GetCurrentCertSubject();
char* secureblackbox_certificatevalidator_getcurrentcertsubject(void* lpObj);
QString GetCurrentCertSubject();
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
CurrentCertSubjectAlternativeName Property (CertificateValidator Class)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
ANSI (Cross Platform) char* GetCurrentCertSubjectAlternativeName(); Unicode (Windows) LPWSTR GetCurrentCertSubjectAlternativeName();
char* secureblackbox_certificatevalidator_getcurrentcertsubjectalternativename(void* lpObj);
QString GetCurrentCertSubjectAlternativeName();
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
CurrentCertSubjectKeyID Property (CertificateValidator Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
ANSI (Cross Platform) int GetCurrentCertSubjectKeyID(char* &lpCurrentCertSubjectKeyID, int &lenCurrentCertSubjectKeyID); Unicode (Windows) INT GetCurrentCertSubjectKeyID(LPSTR &lpCurrentCertSubjectKeyID, INT &lenCurrentCertSubjectKeyID);
int secureblackbox_certificatevalidator_getcurrentcertsubjectkeyid(void* lpObj, char** lpCurrentCertSubjectKeyID, int* lenCurrentCertSubjectKeyID);
QByteArray GetCurrentCertSubjectKeyID();
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
CurrentCertSubjectRDN Property (CertificateValidator Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
ANSI (Cross Platform) char* GetCurrentCertSubjectRDN(); Unicode (Windows) LPWSTR GetCurrentCertSubjectRDN();
char* secureblackbox_certificatevalidator_getcurrentcertsubjectrdn(void* lpObj);
QString GetCurrentCertSubjectRDN();
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
CurrentCertValidFrom Property (CertificateValidator Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
ANSI (Cross Platform) char* GetCurrentCertValidFrom(); Unicode (Windows) LPWSTR GetCurrentCertValidFrom();
char* secureblackbox_certificatevalidator_getcurrentcertvalidfrom(void* lpObj);
QString GetCurrentCertValidFrom();
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
CurrentCertValidTo Property (CertificateValidator Class)
The time point at which the certificate expires, in UTC.
Syntax
ANSI (Cross Platform) char* GetCurrentCertValidTo(); Unicode (Windows) LPWSTR GetCurrentCertValidTo();
char* secureblackbox_certificatevalidator_getcurrentcertvalidto(void* lpObj);
QString GetCurrentCertValidTo();
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
FIPSMode Property (CertificateValidator Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_certificatevalidator_getfipsmode(void* lpObj);
int secureblackbox_certificatevalidator_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
GracePeriod Property (CertificateValidator Class)
Specifies a grace period to apply during certificate validation.
Syntax
ANSI (Cross Platform) int GetGracePeriod();
int SetGracePeriod(int iGracePeriod); Unicode (Windows) INT GetGracePeriod();
INT SetGracePeriod(INT iGracePeriod);
int secureblackbox_certificatevalidator_getgraceperiod(void* lpObj);
int secureblackbox_certificatevalidator_setgraceperiod(void* lpObj, int iGracePeriod);
int GetGracePeriod();
int SetGracePeriod(int iGracePeriod);
Default Value
0
Remarks
Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.
Data Type
Integer
InterimValidationDetails Property (CertificateValidator Class)
Contains the validation details of the moment.
Syntax
ANSI (Cross Platform) int GetInterimValidationDetails();
int SetInterimValidationDetails(int iInterimValidationDetails); Unicode (Windows) INT GetInterimValidationDetails();
INT SetInterimValidationDetails(INT iInterimValidationDetails);
int secureblackbox_certificatevalidator_getinterimvalidationdetails(void* lpObj);
int secureblackbox_certificatevalidator_setinterimvalidationdetails(void* lpObj, int iInterimValidationDetails);
int GetInterimValidationDetails();
int SetInterimValidationDetails(int iInterimValidationDetails);
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity details mid-flight.
The value of this property is a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is not available at design time.
Data Type
Integer
InterimValidationResult Property (CertificateValidator Class)
Contains the validation status of the moment.
Syntax
ANSI (Cross Platform) int GetInterimValidationResult();
int SetInterimValidationResult(int iInterimValidationResult); Unicode (Windows) INT GetInterimValidationResult();
INT SetInterimValidationResult(INT iInterimValidationResult);
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_certificatevalidator_getinterimvalidationresult(void* lpObj);
int secureblackbox_certificatevalidator_setinterimvalidationresult(void* lpObj, int iInterimValidationResult);
int GetInterimValidationResult();
int SetInterimValidationResult(int iInterimValidationResult);
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity status mid-flight.
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
This property is not available at design time.
Data Type
Integer
KnownCertCount Property (CertificateValidator 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_certificatevalidator_getknowncertcount(void* lpObj);
int secureblackbox_certificatevalidator_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 (CertificateValidator 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_certificatevalidator_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 (CertificateValidator 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_certificatevalidator_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_certificatevalidator_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
KnownCRLCount Property (CertificateValidator Class)
The number of records in the KnownCRL arrays.
Syntax
ANSI (Cross Platform) int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); Unicode (Windows) INT GetKnownCRLCount();
INT SetKnownCRLCount(INT iKnownCRLCount);
int secureblackbox_certificatevalidator_getknowncrlcount(void* lpObj);
int secureblackbox_certificatevalidator_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCRLCount - 1.This property is not available at design time.
Data Type
Integer
KnownCRLBytes Property (CertificateValidator Class)
Returns raw CRL data in DER format.
Syntax
ANSI (Cross Platform) int GetKnownCRLBytes(int iKnownCRLIndex, char* &lpKnownCRLBytes, int &lenKnownCRLBytes); Unicode (Windows) INT GetKnownCRLBytes(INT iKnownCRLIndex, LPSTR &lpKnownCRLBytes, INT &lenKnownCRLBytes);
int secureblackbox_certificatevalidator_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
QByteArray GetKnownCRLBytes(int iKnownCRLIndex);
Remarks
Returns raw CRL data in DER format.
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownCRLHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, int64 lKnownCRLHandle); Unicode (Windows) LONG64 GetKnownCRLHandle(INT iKnownCRLIndex);
INT SetKnownCRLHandle(INT iKnownCRLIndex, LONG64 lKnownCRLHandle);
int64 secureblackbox_certificatevalidator_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_certificatevalidator_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is not available at design time.
Data Type
Long64
KnownOCSPCount Property (CertificateValidator Class)
The number of records in the KnownOCSP arrays.
Syntax
ANSI (Cross Platform) int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); Unicode (Windows) INT GetKnownOCSPCount();
INT SetKnownOCSPCount(INT iKnownOCSPCount);
int secureblackbox_certificatevalidator_getknownocspcount(void* lpObj);
int secureblackbox_certificatevalidator_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownOCSPCount - 1.This property is not available at design time.
Data Type
Integer
KnownOCSPBytes Property (CertificateValidator Class)
Buffer containing raw OCSP response data.
Syntax
ANSI (Cross Platform) int GetKnownOCSPBytes(int iKnownOCSPIndex, char* &lpKnownOCSPBytes, int &lenKnownOCSPBytes); Unicode (Windows) INT GetKnownOCSPBytes(INT iKnownOCSPIndex, LPSTR &lpKnownOCSPBytes, INT &lenKnownOCSPBytes);
int secureblackbox_certificatevalidator_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex);
Remarks
Buffer containing raw OCSP response data.
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
KnownOCSPHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, int64 lKnownOCSPHandle); Unicode (Windows) LONG64 GetKnownOCSPHandle(INT iKnownOCSPIndex);
INT SetKnownOCSPHandle(INT iKnownOCSPIndex, LONG64 lKnownOCSPHandle);
int64 secureblackbox_certificatevalidator_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_certificatevalidator_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is not available at design time.
Data Type
Long64
MaxValidationTime Property (CertificateValidator Class)
Specifies the maximum time the validation process may take.
Syntax
ANSI (Cross Platform) int GetMaxValidationTime();
int SetMaxValidationTime(int iMaxValidationTime); Unicode (Windows) INT GetMaxValidationTime();
INT SetMaxValidationTime(INT iMaxValidationTime);
int secureblackbox_certificatevalidator_getmaxvalidationtime(void* lpObj);
int secureblackbox_certificatevalidator_setmaxvalidationtime(void* lpObj, int iMaxValidationTime);
int GetMaxValidationTime();
int SetMaxValidationTime(int iMaxValidationTime);
Default Value
0
Remarks
Use this property to limit the amount of time available for the validator to carry out the validation. If the validation process exceeds this time, it is terminated and the validation error is returned.
Data Type
Integer
OfflineMode Property (CertificateValidator Class)
Switches the class to the offline mode.
Syntax
ANSI (Cross Platform) int GetOfflineMode();
int SetOfflineMode(int bOfflineMode); Unicode (Windows) BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);
int secureblackbox_certificatevalidator_getofflinemode(void* lpObj);
int secureblackbox_certificatevalidator_setofflinemode(void* lpObj, int bOfflineMode);
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);
Default Value
FALSE
Remarks
When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.
Data Type
Boolean
ProxyAddress Property (CertificateValidator Class)
The IP address of the proxy server.
Syntax
ANSI (Cross Platform) char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress); Unicode (Windows) LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);
char* secureblackbox_certificatevalidator_getproxyaddress(void* lpObj);
int secureblackbox_certificatevalidator_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
ProxyAuthentication Property (CertificateValidator Class)
The authentication type used by the proxy server.
Syntax
ANSI (Cross Platform) int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); Unicode (Windows) INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);
Possible Values
PAT_NO_AUTHENTICATION(0),
PAT_BASIC(1),
PAT_DIGEST(2),
PAT_NTLM(3)
int secureblackbox_certificatevalidator_getproxyauthentication(void* lpObj);
int secureblackbox_certificatevalidator_setproxyauthentication(void* lpObj, int iProxyAuthentication);
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);
Default Value
0
Remarks
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Data Type
Integer
ProxyPassword Property (CertificateValidator Class)
The password to authenticate to the proxy server.
Syntax
ANSI (Cross Platform) char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* secureblackbox_certificatevalidator_getproxypassword(void* lpObj);
int secureblackbox_certificatevalidator_setproxypassword(void* lpObj, const char* lpszProxyPassword);
QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
ProxyPort Property (CertificateValidator Class)
The port on the proxy server to connect to.
Syntax
ANSI (Cross Platform) int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int secureblackbox_certificatevalidator_getproxyport(void* lpObj);
int secureblackbox_certificatevalidator_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
Integer
ProxyProxyType Property (CertificateValidator Class)
The type of the proxy server.
Syntax
ANSI (Cross Platform) int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); Unicode (Windows) INT GetProxyProxyType();
INT SetProxyProxyType(INT iProxyProxyType);
Possible Values
CPT_NONE(0),
CPT_SOCKS_4(1),
CPT_SOCKS_5(2),
CPT_WEB_TUNNEL(3),
CPT_HTTP(4)
int secureblackbox_certificatevalidator_getproxyproxytype(void* lpObj);
int secureblackbox_certificatevalidator_setproxyproxytype(void* lpObj, int iProxyProxyType);
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);
Default Value
0
Remarks
The type of the proxy server.
The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
Data Type
Integer
ProxyRequestHeaders Property (CertificateValidator Class)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
ANSI (Cross Platform) char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders); Unicode (Windows) LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);
char* secureblackbox_certificatevalidator_getproxyrequestheaders(void* lpObj);
int secureblackbox_certificatevalidator_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
ProxyResponseBody Property (CertificateValidator Class)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
ANSI (Cross Platform) char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody); Unicode (Windows) LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);
char* secureblackbox_certificatevalidator_getproxyresponsebody(void* lpObj);
int secureblackbox_certificatevalidator_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
ProxyResponseHeaders Property (CertificateValidator Class)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
ANSI (Cross Platform) char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders); Unicode (Windows) LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);
char* secureblackbox_certificatevalidator_getproxyresponseheaders(void* lpObj);
int secureblackbox_certificatevalidator_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
ProxyUseIPv6 Property (CertificateValidator Class)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
ANSI (Cross Platform) int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6); Unicode (Windows) BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);
int secureblackbox_certificatevalidator_getproxyuseipv6(void* lpObj);
int secureblackbox_certificatevalidator_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);
Default Value
FALSE
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
Boolean
ProxyUseProxy Property (CertificateValidator Class)
Enables or disables proxy-driven connection.
Syntax
ANSI (Cross Platform) int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy); Unicode (Windows) BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);
int secureblackbox_certificatevalidator_getproxyuseproxy(void* lpObj);
int secureblackbox_certificatevalidator_setproxyuseproxy(void* lpObj, int bProxyUseProxy);
bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);
Default Value
FALSE
Remarks
Enables or disables proxy-driven connection.
Data Type
Boolean
ProxyUsername Property (CertificateValidator Class)
Specifies the username credential for proxy authentication.
Syntax
ANSI (Cross Platform) char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername); Unicode (Windows) LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);
char* secureblackbox_certificatevalidator_getproxyusername(void* lpObj);
int secureblackbox_certificatevalidator_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
QualifiedInfoAddress Property (CertificateValidator Class)
Contains the address of the TSL provider.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoAddress(); Unicode (Windows) LPWSTR GetQualifiedInfoAddress();
char* secureblackbox_certificatevalidator_getqualifiedinfoaddress(void* lpObj);
QString GetQualifiedInfoAddress();
Default Value
""
Remarks
Contains the address of the TSL provider.
Use this property to check the address of the TSL provider.
This property is read-only.
Data Type
String
QualifiedInfoCustomTSLs Property (CertificateValidator Class)
The list of custom TSLs to use.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoCustomTSLs();
int SetQualifiedInfoCustomTSLs(const char* lpszQualifiedInfoCustomTSLs); Unicode (Windows) LPWSTR GetQualifiedInfoCustomTSLs();
INT SetQualifiedInfoCustomTSLs(LPCWSTR lpszQualifiedInfoCustomTSLs);
char* secureblackbox_certificatevalidator_getqualifiedinfocustomtsls(void* lpObj);
int secureblackbox_certificatevalidator_setqualifiedinfocustomtsls(void* lpObj, const char* lpszQualifiedInfoCustomTSLs);
QString GetQualifiedInfoCustomTSLs();
int SetQualifiedInfoCustomTSLs(QString qsQualifiedInfoCustomTSLs);
Default Value
""
Remarks
The list of custom TSLs to use.
Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.
Data Type
String
QualifiedInfoDownloadLog Property (CertificateValidator Class)
Contains the TLS download log.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoDownloadLog(); Unicode (Windows) LPWSTR GetQualifiedInfoDownloadLog();
char* secureblackbox_certificatevalidator_getqualifiedinfodownloadlog(void* lpObj);
QString GetQualifiedInfoDownloadLog();
Default Value
""
Remarks
Contains the TLS download log.
This log may be useful in investigating TSL retrieval failures.
This property is read-only.
Data Type
String
QualifiedInfoInformationURI Property (CertificateValidator Class)
Contains the URI of the provider information.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoInformationURI(); Unicode (Windows) LPWSTR GetQualifiedInfoInformationURI();
char* secureblackbox_certificatevalidator_getqualifiedinfoinformationuri(void* lpObj);
QString GetQualifiedInfoInformationURI();
Default Value
""
Remarks
Contains the URI of the provider information.
Use this property to get the URI of the TSL provider information.
This property is read-only.
Data Type
String
QualifiedInfoLanguages Property (CertificateValidator Class)
The preferred language(s) for TSL data.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoLanguages();
int SetQualifiedInfoLanguages(const char* lpszQualifiedInfoLanguages); Unicode (Windows) LPWSTR GetQualifiedInfoLanguages();
INT SetQualifiedInfoLanguages(LPCWSTR lpszQualifiedInfoLanguages);
char* secureblackbox_certificatevalidator_getqualifiedinfolanguages(void* lpObj);
int secureblackbox_certificatevalidator_setqualifiedinfolanguages(void* lpObj, const char* lpszQualifiedInfoLanguages);
QString GetQualifiedInfoLanguages();
int SetQualifiedInfoLanguages(QString qsQualifiedInfoLanguages);
Default Value
""
Remarks
The preferred language(s) for TSL data.
Use this property to pass a list of languages, in order of preference, which will be considered when returning TSL properties. Many trust providers return qualified information in several languages. By tuning up this property you can choose a selection of preferred languages (such as "it,en") in which you would like to read the qualified details.
Data Type
String
QualifiedInfoNextUpdate Property (CertificateValidator Class)
Returns the next update date and time of the TSL.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoNextUpdate(); Unicode (Windows) LPWSTR GetQualifiedInfoNextUpdate();
char* secureblackbox_certificatevalidator_getqualifiedinfonextupdate(void* lpObj);
QString GetQualifiedInfoNextUpdate();
Default Value
""
Remarks
Returns the next update date and time of the TSL.
Use this property to check the next update value for the TSL.
This property is read-only.
Data Type
String
QualifiedInfoProvider Property (CertificateValidator Class)
Contains the name of the TSL provider.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoProvider(); Unicode (Windows) LPWSTR GetQualifiedInfoProvider();
char* secureblackbox_certificatevalidator_getqualifiedinfoprovider(void* lpObj);
QString GetQualifiedInfoProvider();
Default Value
""
Remarks
Contains the name of the TSL provider.
Use this property to check the name of the TSL provider.
This property is read-only.
Data Type
String
QualifiedInfoQualified Property (CertificateValidator Class)
Indicates whether the certificate is qualified.
Syntax
ANSI (Cross Platform) int GetQualifiedInfoQualified(); Unicode (Windows) BOOL GetQualifiedInfoQualified();
int secureblackbox_certificatevalidator_getqualifiedinfoqualified(void* lpObj);
bool GetQualifiedInfoQualified();
Default Value
FALSE
Remarks
Indicates whether the certificate is qualified.
This property is set to true if the certificate is confirmed by a TSL to be qualified.
This property is read-only.
Data Type
Boolean
QualifiedInfoQualifiers Property (CertificateValidator Class)
A list of qualifiers.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoQualifiers(); Unicode (Windows) LPWSTR GetQualifiedInfoQualifiers();
char* secureblackbox_certificatevalidator_getqualifiedinfoqualifiers(void* lpObj);
QString GetQualifiedInfoQualifiers();
Default Value
""
Remarks
A list of qualifiers.
Contains a comma-separated list of qualifiers for the certificate, for example QCP-n-qscd,QCWithSSCD.
This property is read-only.
Data Type
String
QualifiedInfoServiceName Property (CertificateValidator Class)
Contains the name of the TSL service.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoServiceName(); Unicode (Windows) LPWSTR GetQualifiedInfoServiceName();
char* secureblackbox_certificatevalidator_getqualifiedinfoservicename(void* lpObj);
QString GetQualifiedInfoServiceName();
Default Value
""
Remarks
Contains the name of the TSL service.
Use this property to check the name of the TSL service.
This property is read-only.
Data Type
String
QualifiedInfoServiceTypeId Property (CertificateValidator Class)
Contains the TSL service type identifier.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoServiceTypeId(); Unicode (Windows) LPWSTR GetQualifiedInfoServiceTypeId();
char* secureblackbox_certificatevalidator_getqualifiedinfoservicetypeid(void* lpObj);
QString GetQualifiedInfoServiceTypeId();
Default Value
""
Remarks
Contains the TSL service type identifier.
Use this property to check the service type identifier of the TSL.
This property is read-only.
Data Type
String
QualifiedInfoSource Property (CertificateValidator Class)
The source of qualified information.
Syntax
ANSI (Cross Platform) int GetQualifiedInfoSource(); Unicode (Windows) INT GetQualifiedInfoSource();
Possible Values
QIS_UNKNOWN(0),
QIS_CERTIFICATE(1),
QIS_TSL(2),
QIS_BOTH(3)
int secureblackbox_certificatevalidator_getqualifiedinfosource(void* lpObj);
int GetQualifiedInfoSource();
Default Value
0
Remarks
The source of qualified information.
Available options:
qisUnknown | 0 | The source is unknown |
qisCertificate | 1 | The information was taken from the certificate |
qisTSL | 2 | The information was taken from an online TSL |
qisBoth | 3 | The information was taken from both the certificate and an online TSL |
Use the Source property to establish the origin of the qualified information.
This property is read-only and not available at design time.
Data Type
Integer
QualifiedInfoStatus Property (CertificateValidator Class)
Indicates a qualified electronic signature.
Syntax
ANSI (Cross Platform) int GetQualifiedInfoStatus(); Unicode (Windows) INT GetQualifiedInfoStatus();
Possible Values
SQS_UNKNOWN(0),
SQS_NONE(1),
SQS_GRANTED(2),
SQS_WITHDRAWN(3),
SQS_SET_BY_NATIONAL_LAW(4),
SQS_DEPRECATED_BY_NATIONAL_LAW(5),
SQS_RECOGNIZED_AT_NATIONAL_LEVEL(6),
SQS_DEPRECATED_AT_NATIONAL_LEVEL(7),
SQS_UNDER_SUPERVISION(8),
SQS_SUPERVISION_IN_CESSATION(9),
SQS_SUPERVISION_CEASED(10),
SQS_SUPERVISION_REVOKED(11),
SQS_ACCREDITED(12),
SQS_ACCREDITATION_CEASED(13),
SQS_ACCREDITATION_REVOKED(14),
SQS_IN_ACCORDANCE(15),
SQS_EXPIRED(16),
SQS_SUSPENDED(17),
SQS_REVOKED(18),
SQS_NOT_IN_ACCORDANCE(19)
int secureblackbox_certificatevalidator_getqualifiedinfostatus(void* lpObj);
int GetQualifiedInfoStatus();
Default Value
0
Remarks
Indicates a qualified electronic signature.
Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.
Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.
The following qualified statuses are supported:
sqsUnknown | 0 | Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI. |
sqsNone | 1 | None |
sqsGranted | 2 | Granted |
sqsWithdrawn | 3 | Withdrawn |
sqsSetByNationalLaw | 4 | Set by national law |
sqsDeprecatedByNationalLaw | 5 | Deprecated by national law |
sqsRecognizedAtNationalLevel | 6 | Recognized at national level |
sqsDeprecatedAtNationalLevel | 7 | Deprecated at national level |
sqsUnderSupervision | 8 | Under supervision |
sqsSupervisionInCessation | 9 | Supervision in cessation |
sqsSupervisionCeased | 10 | Supervision ceased |
sqsSupervisionRevoked | 11 | Supervision revoked |
sqsAccredited | 12 | Accredited |
sqsAccreditationCeased | 13 | Accreditation ceased |
sqsAccreditationRevoked | 14 | Accreditation revoked |
sqsInAccordance | 15 | Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
sqsExpired | 16 | Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations. |
sqsSuspended | 17 | Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria. |
sqsRevoked | 18 | Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
sqsNotInAccordance | 19 | Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes). |
This property is read-only and not available at design time.
Data Type
Integer
QualifiedInfoTradeName Property (CertificateValidator Class)
Contains the trade name of the TSL provider.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoTradeName(); Unicode (Windows) LPWSTR GetQualifiedInfoTradeName();
char* secureblackbox_certificatevalidator_getqualifiedinfotradename(void* lpObj);
QString GetQualifiedInfoTradeName();
Default Value
""
Remarks
Contains the trade name of the TSL provider.
Use this property to check the trade name of the TSL provider.
This property is read-only.
Data Type
String
QualifiedInfoUseDefaultTSLs Property (CertificateValidator Class)
Use this setting to enable or disable the use of the default TSLs.
Syntax
ANSI (Cross Platform) int GetQualifiedInfoUseDefaultTSLs();
int SetQualifiedInfoUseDefaultTSLs(int bQualifiedInfoUseDefaultTSLs); Unicode (Windows) BOOL GetQualifiedInfoUseDefaultTSLs();
INT SetQualifiedInfoUseDefaultTSLs(BOOL bQualifiedInfoUseDefaultTSLs);
int secureblackbox_certificatevalidator_getqualifiedinfousedefaulttsls(void* lpObj);
int secureblackbox_certificatevalidator_setqualifiedinfousedefaulttsls(void* lpObj, int bQualifiedInfoUseDefaultTSLs);
bool GetQualifiedInfoUseDefaultTSLs();
int SetQualifiedInfoUseDefaultTSLs(bool bQualifiedInfoUseDefaultTSLs);
Default Value
TRUE
Remarks
Use this setting to enable or disable the use of the default TSLs.
Use this setting to enable or disable the use of the default TSLs.
Data Type
Boolean
QualifiedInfoValidationLog Property (CertificateValidator Class)
Contains the TLS validation log.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoValidationLog(); Unicode (Windows) LPWSTR GetQualifiedInfoValidationLog();
char* secureblackbox_certificatevalidator_getqualifiedinfovalidationlog(void* lpObj);
QString GetQualifiedInfoValidationLog();
Default Value
""
Remarks
Contains the TLS validation log.
This log may be useful in investigating TSL validation failures.
This property is read-only.
Data Type
String
QualifiedInfoXML Property (CertificateValidator Class)
Contains the XML of the TSL.
Syntax
ANSI (Cross Platform) char* GetQualifiedInfoXML(); Unicode (Windows) LPWSTR GetQualifiedInfoXML();
char* secureblackbox_certificatevalidator_getqualifiedinfoxml(void* lpObj);
QString GetQualifiedInfoXML();
Default Value
""
Remarks
Contains the XML of the TSL.
Use this property to obtain the original body of the TSL in XML format.
This property is read-only.
Data Type
String
RevocationCheck Property (CertificateValidator Class)
Specifies the kind(s) of revocation check to perform.
Syntax
ANSI (Cross Platform) int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck); Unicode (Windows) INT GetRevocationCheck();
INT SetRevocationCheck(INT iRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
int secureblackbox_certificatevalidator_getrevocationcheck(void* lpObj);
int secureblackbox_certificatevalidator_setrevocationcheck(void* lpObj, int iRevocationCheck);
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);
Default Value
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (CRL) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
crcNone | 0 | No revocation checking |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP | 3 | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP | 4 | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL | 5 | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP | 6 | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP | 7 | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Data Type
Integer
SocketDNSMode Property (CertificateValidator Class)
Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
Syntax
ANSI (Cross Platform) int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); Unicode (Windows) INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);
Possible Values
DM_AUTO(0),
DM_PLATFORM(1),
DM_OWN(2),
DM_OWN_SECURE(3)
int secureblackbox_certificatevalidator_getsocketdnsmode(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);
Default Value
0
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
Data Type
Integer
SocketDNSPort Property (CertificateValidator Class)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
ANSI (Cross Platform) int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); Unicode (Windows) INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);
int secureblackbox_certificatevalidator_getsocketdnsport(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
Data Type
Integer
SocketDNSQueryTimeout Property (CertificateValidator Class)
The timeout (in milliseconds) for each DNS query.
Syntax
ANSI (Cross Platform) int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); Unicode (Windows) INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);
int secureblackbox_certificatevalidator_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for each DNS query. The value of 0 indicates the infinite timeout.
Data Type
Integer
SocketDNSServers Property (CertificateValidator Class)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
ANSI (Cross Platform) char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers); Unicode (Windows) LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);
char* secureblackbox_certificatevalidator_getsocketdnsservers(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Data Type
String
SocketDNSTotalTimeout Property (CertificateValidator Class)
The timeout (in milliseconds) for the whole resolution process.
Syntax
ANSI (Cross Platform) int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); Unicode (Windows) INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);
int secureblackbox_certificatevalidator_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);
Default Value
0
Remarks
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates the infinite timeout.
Data Type
Integer
SocketIncomingSpeedLimit Property (CertificateValidator Class)
The maximum number of bytes to read from the socket, per second.
Syntax
ANSI (Cross Platform) int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); Unicode (Windows) INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);
int secureblackbox_certificatevalidator_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_certificatevalidator_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (CertificateValidator Class)
The local network interface to bind the socket to.
Syntax
ANSI (Cross Platform) char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress); Unicode (Windows) LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);
char* secureblackbox_certificatevalidator_getsocketlocaladdress(void* lpObj);
int secureblackbox_certificatevalidator_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (CertificateValidator Class)
The local port number to bind the socket to.
Syntax
ANSI (Cross Platform) int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); Unicode (Windows) INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);
int secureblackbox_certificatevalidator_getsocketlocalport(void* lpObj);
int secureblackbox_certificatevalidator_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (CertificateValidator Class)
The maximum number of bytes to write to the socket, per second.
Syntax
ANSI (Cross Platform) int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); Unicode (Windows) INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);
int secureblackbox_certificatevalidator_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_certificatevalidator_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (CertificateValidator Class)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
ANSI (Cross Platform) int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); Unicode (Windows) INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);
int secureblackbox_certificatevalidator_getsockettimeout(void* lpObj);
int secureblackbox_certificatevalidator_setsockettimeout(void* lpObj, int iSocketTimeout);
int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
Integer
SocketUseIPv6 Property (CertificateValidator Class)
Enables or disables IP protocol version 6.
Syntax
ANSI (Cross Platform) int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6); Unicode (Windows) BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);
int secureblackbox_certificatevalidator_getsocketuseipv6(void* lpObj);
int secureblackbox_certificatevalidator_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Default Value
FALSE
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
TLSClientCertCount Property (CertificateValidator Class)
The number of records in the TLSClientCert arrays.
Syntax
ANSI (Cross Platform) int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount); Unicode (Windows) INT GetTLSClientCertCount();
INT SetTLSClientCertCount(INT iTLSClientCertCount);
int secureblackbox_certificatevalidator_gettlsclientcertcount(void* lpObj);
int secureblackbox_certificatevalidator_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSClientCertCount - 1.This property is not available at design time.
Data Type
Integer
TLSClientCertBytes Property (CertificateValidator Class)
Returns raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetTLSClientCertBytes(int iTLSClientCertIndex, char* &lpTLSClientCertBytes, int &lenTLSClientCertBytes); Unicode (Windows) INT GetTLSClientCertBytes(INT iTLSClientCertIndex, LPSTR &lpTLSClientCertBytes, INT &lenTLSClientCertBytes);
int secureblackbox_certificatevalidator_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex);
Remarks
Returns raw certificate data in DER format.
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TLSClientCertHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, int64 lTLSClientCertHandle); Unicode (Windows) LONG64 GetTLSClientCertHandle(INT iTLSClientCertIndex);
INT SetTLSClientCertHandle(INT iTLSClientCertIndex, LONG64 lTLSClientCertHandle);
int64 secureblackbox_certificatevalidator_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_certificatevalidator_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);
qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
This property is not available at design time.
Data Type
Long64
TLSServerCertCount Property (CertificateValidator Class)
The number of records in the TLSServerCert arrays.
Syntax
ANSI (Cross Platform) int GetTLSServerCertCount(); Unicode (Windows) INT GetTLSServerCertCount();
int secureblackbox_certificatevalidator_gettlsservercertcount(void* lpObj);
int GetTLSServerCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSServerCertCount - 1.This property is read-only and not available at design time.
Data Type
Integer
TLSServerCertBytes Property (CertificateValidator Class)
Returns raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetTLSServerCertBytes(int iTLSServerCertIndex, char* &lpTLSServerCertBytes, int &lenTLSServerCertBytes); Unicode (Windows) INT GetTLSServerCertBytes(INT iTLSServerCertIndex, LPSTR &lpTLSServerCertBytes, INT &lenTLSServerCertBytes);
int secureblackbox_certificatevalidator_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex);
Remarks
Returns raw certificate data in DER format.
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TLSServerCertHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetTLSServerCertHandle(int iTLSServerCertIndex); Unicode (Windows) LONG64 GetTLSServerCertHandle(INT iTLSServerCertIndex);
int64 secureblackbox_certificatevalidator_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
qint64 GetTLSServerCertHandle(int iTLSServerCertIndex);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
TLSAutoValidateCertificates Property (CertificateValidator Class)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
ANSI (Cross Platform) int GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(int bTLSAutoValidateCertificates); Unicode (Windows) BOOL GetTLSAutoValidateCertificates();
INT SetTLSAutoValidateCertificates(BOOL bTLSAutoValidateCertificates);
int secureblackbox_certificatevalidator_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_certificatevalidator_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates);
Default Value
TRUE
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (CertificateValidator Class)
Selects the base configuration for the TLS settings.
Syntax
ANSI (Cross Platform) int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); Unicode (Windows) INT GetTLSBaseConfiguration();
INT SetTLSBaseConfiguration(INT iTLSBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
int secureblackbox_certificatevalidator_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_certificatevalidator_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration);
Default Value
0
Remarks
Selects the base configuration for the TLS settings. Several profiles are on offer, tuned up for different purposes, such as high security or higher compatibility.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (CertificateValidator Class)
A list of ciphersuites separated with commas or semicolons.
Syntax
ANSI (Cross Platform) char* GetTLSCiphersuites();
int SetTLSCiphersuites(const char* lpszTLSCiphersuites); Unicode (Windows) LPWSTR GetTLSCiphersuites();
INT SetTLSCiphersuites(LPCWSTR lpszTLSCiphersuites);
char* secureblackbox_certificatevalidator_gettlsciphersuites(void* lpObj);
int secureblackbox_certificatevalidator_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites);
Default Value
""
Remarks
A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases that allow to blanketly enable or disable all ciphersuites at once.
Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by BaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:
- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256
Data Type
String
TLSECCurves Property (CertificateValidator Class)
Defines the elliptic curves to enable.
Syntax
ANSI (Cross Platform) char* GetTLSECCurves();
int SetTLSECCurves(const char* lpszTLSECCurves); Unicode (Windows) LPWSTR GetTLSECCurves();
INT SetTLSECCurves(LPCWSTR lpszTLSECCurves);
char* secureblackbox_certificatevalidator_gettlseccurves(void* lpObj);
int secureblackbox_certificatevalidator_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves);
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (CertificateValidator Class)
Provides access to TLS extensions.
Syntax
ANSI (Cross Platform) char* GetTLSExtensions();
int SetTLSExtensions(const char* lpszTLSExtensions); Unicode (Windows) LPWSTR GetTLSExtensions();
INT SetTLSExtensions(LPCWSTR lpszTLSExtensions);
char* secureblackbox_certificatevalidator_gettlsextensions(void* lpObj);
int secureblackbox_certificatevalidator_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions);
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (CertificateValidator Class)
Whether to force TLS session resumption when the destination address changes.
Syntax
ANSI (Cross Platform) int GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(int bTLSForceResumeIfDestinationChanges); Unicode (Windows) BOOL GetTLSForceResumeIfDestinationChanges();
INT SetTLSForceResumeIfDestinationChanges(BOOL bTLSForceResumeIfDestinationChanges);
int secureblackbox_certificatevalidator_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_certificatevalidator_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges);
Default Value
FALSE
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (CertificateValidator Class)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (CertificateValidator Class)
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
Default Value
""
Remarks
Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
This property is not available at design time.
Data Type
String
TLSPreSharedKeyCiphersuite Property (CertificateValidator Class)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (CertificateValidator Class)
Selects renegotiation attack prevention mechanism.
Syntax
ANSI (Cross Platform) int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); Unicode (Windows) INT GetTLSRenegotiationAttackPreventionMode();
INT SetTLSRenegotiationAttackPreventionMode(INT iTLSRenegotiationAttackPreventionMode);
Possible Values
CRAPM_COMPATIBLE(0),
CRAPM_STRICT(1),
CRAPM_AUTO(2)
int secureblackbox_certificatevalidator_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_certificatevalidator_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode);
Default Value
0
Remarks
Selects renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
Integer
TLSRevocationCheck Property (CertificateValidator Class)
Specifies the kind(s) of revocation check to perform.
Syntax
ANSI (Cross Platform) int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); Unicode (Windows) INT GetTLSRevocationCheck();
INT SetTLSRevocationCheck(INT iTLSRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
int secureblackbox_certificatevalidator_gettlsrevocationcheck(void* lpObj);
int secureblackbox_certificatevalidator_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck);
Default Value
1
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | Check all provided CRL endpoints for all chain certificates. |
crcAllOCSP | 3 | Check all provided OCSP endpoints for all chain certificates. |
crcAllCRLAndOCSP | 4 | Check all CRL and OCSP endpoints for all chain certificates. |
crcAnyCRL | 5 | At least one CRL check for every certificate in the chain must succeed. |
crcAnyOCSP | 6 | At least one OCSP check for every certificate in the chain must succeed. |
crcAnyCRLOrOCSP | 7 | At least one CRL or OCSP check for every certificate in the chain must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | At least one CRL or OCSP check for every certificate in the chain must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to faster OCSP route and only demand one source to succeed) is a good choice for most of typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
This property is not available at design time.
Data Type
Integer
TLSSSLOptions Property (CertificateValidator Class)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
ANSI (Cross Platform) int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); Unicode (Windows) INT GetTLSSSLOptions();
INT SetTLSSSLOptions(INT iTLSSSLOptions);
int secureblackbox_certificatevalidator_gettlsssloptions(void* lpObj);
int secureblackbox_certificatevalidator_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions);
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce use of client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (not send) signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (CertificateValidator Class)
Specifies the TLS mode to use.
Syntax
ANSI (Cross Platform) int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); Unicode (Windows) INT GetTLSTLSMode();
INT SetTLSTLSMode(INT iTLSTLSMode);
Possible Values
SM_DEFAULT(0),
SM_NO_TLS(1),
SM_EXPLICIT_TLS(2),
SM_IMPLICIT_TLS(3),
SM_MIXED_TLS(4)
int secureblackbox_certificatevalidator_gettlstlsmode(void* lpObj);
int secureblackbox_certificatevalidator_settlstlsmode(void* lpObj, int iTLSTLSMode);
int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode);
Default Value
0
Remarks
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (CertificateValidator Class)
Enables Extended Master Secret Extension, as defined in RFC 7627.
Syntax
ANSI (Cross Platform) int GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(int bTLSUseExtendedMasterSecret); Unicode (Windows) BOOL GetTLSUseExtendedMasterSecret();
INT SetTLSUseExtendedMasterSecret(BOOL bTLSUseExtendedMasterSecret);
int secureblackbox_certificatevalidator_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_certificatevalidator_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret);
Default Value
FALSE
Remarks
Enables Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (CertificateValidator Class)
Enables or disables TLS session resumption capability.
Syntax
ANSI (Cross Platform) int GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(int bTLSUseSessionResumption); Unicode (Windows) BOOL GetTLSUseSessionResumption();
INT SetTLSUseSessionResumption(BOOL bTLSUseSessionResumption);
int secureblackbox_certificatevalidator_gettlsusesessionresumption(void* lpObj);
int secureblackbox_certificatevalidator_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption);
Default Value
FALSE
Remarks
Enables or disables TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (CertificateValidator Class)
The SSL/TLS versions to enable by default.
Syntax
ANSI (Cross Platform) int GetTLSVersions();
int SetTLSVersions(int iTLSVersions); Unicode (Windows) INT GetTLSVersions();
INT SetTLSVersions(INT iTLSVersions);
int secureblackbox_certificatevalidator_gettlsversions(void* lpObj);
int secureblackbox_certificatevalidator_settlsversions(void* lpObj, int iTLSVersions);
int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Default Value
16
Remarks
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Data Type
Integer
TrustedCertCount Property (CertificateValidator Class)
The number of records in the TrustedCert arrays.
Syntax
ANSI (Cross Platform) int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); Unicode (Windows) INT GetTrustedCertCount();
INT SetTrustedCertCount(INT iTrustedCertCount);
int secureblackbox_certificatevalidator_gettrustedcertcount(void* lpObj);
int secureblackbox_certificatevalidator_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TrustedCertCount - 1.This property is not available at design time.
Data Type
Integer
TrustedCertBytes Property (CertificateValidator Class)
Returns raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetTrustedCertBytes(int iTrustedCertIndex, char* &lpTrustedCertBytes, int &lenTrustedCertBytes); Unicode (Windows) INT GetTrustedCertBytes(INT iTrustedCertIndex, LPSTR &lpTrustedCertBytes, INT &lenTrustedCertBytes);
int secureblackbox_certificatevalidator_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
QByteArray GetTrustedCertBytes(int iTrustedCertIndex);
Remarks
Returns raw certificate data in DER format.
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
TrustedCertHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, int64 lTrustedCertHandle); Unicode (Windows) LONG64 GetTrustedCertHandle(INT iTrustedCertIndex);
INT SetTrustedCertHandle(INT iTrustedCertIndex, LONG64 lTrustedCertHandle);
int64 secureblackbox_certificatevalidator_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_certificatevalidator_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is not available at design time.
Data Type
Long64
UsedCertCount Property (CertificateValidator Class)
The number of records in the UsedCert arrays.
Syntax
ANSI (Cross Platform) int GetUsedCertCount(); Unicode (Windows) INT GetUsedCertCount();
int secureblackbox_certificatevalidator_getusedcertcount(void* lpObj);
int GetUsedCertCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- UsedCertBytes
- UsedCertCA
- UsedCertCAKeyID
- UsedCertCRLDistributionPoints
- UsedCertCurve
- UsedCertFingerprint
- UsedCertFriendlyName
- UsedCertHandle
- UsedCertHashAlgorithm
- UsedCertIssuer
- UsedCertIssuerRDN
- UsedCertKeyAlgorithm
- UsedCertKeyBits
- UsedCertKeyFingerprint
- UsedCertKeyUsage
- UsedCertKeyValid
- UsedCertOCSPLocations
- UsedCertOCSPNoCheck
- UsedCertOrigin
- UsedCertPolicyIDs
- UsedCertPrivateKeyBytes
- UsedCertPrivateKeyExists
- UsedCertPrivateKeyExtractable
- UsedCertPublicKeyBytes
- UsedCertQualifiedStatements
- UsedCertSelfSigned
- UsedCertSerialNumber
- UsedCertSigAlgorithm
- UsedCertSubject
- UsedCertSubjectAlternativeName
- UsedCertSubjectKeyID
- UsedCertSubjectRDN
- UsedCertValidFrom
- UsedCertValidTo
This property is read-only and not available at design time.
Data Type
Integer
UsedCertBytes Property (CertificateValidator Class)
Returns raw certificate data in DER format.
Syntax
ANSI (Cross Platform) int GetUsedCertBytes(int iUsedCertIndex, char* &lpUsedCertBytes, int &lenUsedCertBytes); Unicode (Windows) INT GetUsedCertBytes(INT iUsedCertIndex, LPSTR &lpUsedCertBytes, INT &lenUsedCertBytes);
int secureblackbox_certificatevalidator_getusedcertbytes(void* lpObj, int usedcertindex, char** lpUsedCertBytes, int* lenUsedCertBytes);
QByteArray GetUsedCertBytes(int iUsedCertIndex);
Remarks
Returns raw certificate data in DER format.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertCA Property (CertificateValidator Class)
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
Syntax
ANSI (Cross Platform) int GetUsedCertCA(int iUsedCertIndex); Unicode (Windows) BOOL GetUsedCertCA(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertca(void* lpObj, int usedcertindex);
bool GetUsedCertCA(int iUsedCertIndex);
Default Value
FALSE
Remarks
Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertCAKeyID Property (CertificateValidator Class)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
ANSI (Cross Platform) int GetUsedCertCAKeyID(int iUsedCertIndex, char* &lpUsedCertCAKeyID, int &lenUsedCertCAKeyID); Unicode (Windows) INT GetUsedCertCAKeyID(INT iUsedCertIndex, LPSTR &lpUsedCertCAKeyID, INT &lenUsedCertCAKeyID);
int secureblackbox_certificatevalidator_getusedcertcakeyid(void* lpObj, int usedcertindex, char** lpUsedCertCAKeyID, int* lenUsedCertCAKeyID);
QByteArray GetUsedCertCAKeyID(int iUsedCertIndex);
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 UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertCRLDistributionPoints Property (CertificateValidator Class)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
ANSI (Cross Platform) char* GetUsedCertCRLDistributionPoints(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertCRLDistributionPoints(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertcrldistributionpoints(void* lpObj, int usedcertindex);
QString GetUsedCertCRLDistributionPoints(int iUsedCertIndex);
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertCurve Property (CertificateValidator Class)
Specifies the elliptic curve of the EC public key.
Syntax
ANSI (Cross Platform) char* GetUsedCertCurve(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertCurve(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertcurve(void* lpObj, int usedcertindex);
QString GetUsedCertCurve(int iUsedCertIndex);
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertFingerprint Property (CertificateValidator Class)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
ANSI (Cross Platform) int GetUsedCertFingerprint(int iUsedCertIndex, char* &lpUsedCertFingerprint, int &lenUsedCertFingerprint); Unicode (Windows) INT GetUsedCertFingerprint(INT iUsedCertIndex, LPSTR &lpUsedCertFingerprint, INT &lenUsedCertFingerprint);
int secureblackbox_certificatevalidator_getusedcertfingerprint(void* lpObj, int usedcertindex, char** lpUsedCertFingerprint, int* lenUsedCertFingerprint);
QByteArray GetUsedCertFingerprint(int iUsedCertIndex);
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertFriendlyName Property (CertificateValidator Class)
Contains an associated alias (friendly name) of the certificate.
Syntax
ANSI (Cross Platform) char* GetUsedCertFriendlyName(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertFriendlyName(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertfriendlyname(void* lpObj, int usedcertindex);
QString GetUsedCertFriendlyName(int iUsedCertIndex);
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetUsedCertHandle(int iUsedCertIndex); Unicode (Windows) LONG64 GetUsedCertHandle(INT iUsedCertIndex);
int64 secureblackbox_certificatevalidator_getusedcerthandle(void* lpObj, int usedcertindex);
qint64 GetUsedCertHandle(int iUsedCertIndex);
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 UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
UsedCertHashAlgorithm Property (CertificateValidator 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* GetUsedCertHashAlgorithm(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertHashAlgorithm(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcerthashalgorithm(void* lpObj, int usedcertindex);
QString GetUsedCertHashAlgorithm(int iUsedCertIndex);
Default Value
""
Remarks
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 |
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertIssuer Property (CertificateValidator Class)
The common name of the certificate issuer (CA), typically a company name.
Syntax
ANSI (Cross Platform) char* GetUsedCertIssuer(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertIssuer(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertissuer(void* lpObj, int usedcertindex);
QString GetUsedCertIssuer(int iUsedCertIndex);
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertIssuerRDN Property (CertificateValidator Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
ANSI (Cross Platform) char* GetUsedCertIssuerRDN(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertIssuerRDN(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertissuerrdn(void* lpObj, int usedcertindex);
QString GetUsedCertIssuerRDN(int iUsedCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertKeyAlgorithm Property (CertificateValidator Class)
Specifies the public key algorithm of this certificate.
Syntax
ANSI (Cross Platform) char* GetUsedCertKeyAlgorithm(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertKeyAlgorithm(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertkeyalgorithm(void* lpObj, int usedcertindex);
QString GetUsedCertKeyAlgorithm(int iUsedCertIndex);
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertKeyBits Property (CertificateValidator Class)
Returns the length of the public key.
Syntax
ANSI (Cross Platform) int GetUsedCertKeyBits(int iUsedCertIndex); Unicode (Windows) INT GetUsedCertKeyBits(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertkeybits(void* lpObj, int usedcertindex);
int GetUsedCertKeyBits(int iUsedCertIndex);
Default Value
0
Remarks
Returns the length of the public key.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
UsedCertKeyFingerprint Property (CertificateValidator Class)
Returns a fingerprint of the public key contained in the certificate.
Syntax
ANSI (Cross Platform) int GetUsedCertKeyFingerprint(int iUsedCertIndex, char* &lpUsedCertKeyFingerprint, int &lenUsedCertKeyFingerprint); Unicode (Windows) INT GetUsedCertKeyFingerprint(INT iUsedCertIndex, LPSTR &lpUsedCertKeyFingerprint, INT &lenUsedCertKeyFingerprint);
int secureblackbox_certificatevalidator_getusedcertkeyfingerprint(void* lpObj, int usedcertindex, char** lpUsedCertKeyFingerprint, int* lenUsedCertKeyFingerprint);
QByteArray GetUsedCertKeyFingerprint(int iUsedCertIndex);
Remarks
Returns a fingerprint of the public key contained in the certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertKeyUsage Property (CertificateValidator 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 GetUsedCertKeyUsage(int iUsedCertIndex); Unicode (Windows) INT GetUsedCertKeyUsage(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertkeyusage(void* lpObj, int usedcertindex);
int GetUsedCertKeyUsage(int iUsedCertIndex);
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
UsedCertKeyValid Property (CertificateValidator Class)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
ANSI (Cross Platform) int GetUsedCertKeyValid(int iUsedCertIndex); Unicode (Windows) BOOL GetUsedCertKeyValid(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertkeyvalid(void* lpObj, int usedcertindex);
bool GetUsedCertKeyValid(int iUsedCertIndex);
Default Value
FALSE
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertOCSPLocations Property (CertificateValidator 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* GetUsedCertOCSPLocations(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertOCSPLocations(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertocsplocations(void* lpObj, int usedcertindex);
QString GetUsedCertOCSPLocations(int iUsedCertIndex);
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 UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertOCSPNoCheck Property (CertificateValidator Class)
Accessor to the value of the certificates ocsp-no-check extension.
Syntax
ANSI (Cross Platform) int GetUsedCertOCSPNoCheck(int iUsedCertIndex); Unicode (Windows) BOOL GetUsedCertOCSPNoCheck(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertocspnocheck(void* lpObj, int usedcertindex);
bool GetUsedCertOCSPNoCheck(int iUsedCertIndex);
Default Value
FALSE
Remarks
Accessor to the value of the certificates ocsp-no-check extension.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertOrigin Property (CertificateValidator Class)
Returns the origin of this certificate.
Syntax
ANSI (Cross Platform) int GetUsedCertOrigin(int iUsedCertIndex); Unicode (Windows) INT GetUsedCertOrigin(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertorigin(void* lpObj, int usedcertindex);
int GetUsedCertOrigin(int iUsedCertIndex);
Default Value
0
Remarks
Returns the origin of this certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
UsedCertPolicyIDs Property (CertificateValidator Class)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
ANSI (Cross Platform) char* GetUsedCertPolicyIDs(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertPolicyIDs(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertpolicyids(void* lpObj, int usedcertindex);
QString GetUsedCertPolicyIDs(int iUsedCertIndex);
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 UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertPrivateKeyBytes Property (CertificateValidator Class)
Contains the certificate's private key.
Syntax
ANSI (Cross Platform) int GetUsedCertPrivateKeyBytes(int iUsedCertIndex, char* &lpUsedCertPrivateKeyBytes, int &lenUsedCertPrivateKeyBytes); Unicode (Windows) INT GetUsedCertPrivateKeyBytes(INT iUsedCertIndex, LPSTR &lpUsedCertPrivateKeyBytes, INT &lenUsedCertPrivateKeyBytes);
int secureblackbox_certificatevalidator_getusedcertprivatekeybytes(void* lpObj, int usedcertindex, char** lpUsedCertPrivateKeyBytes, int* lenUsedCertPrivateKeyBytes);
QByteArray GetUsedCertPrivateKeyBytes(int iUsedCertIndex);
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertPrivateKeyExists Property (CertificateValidator Class)
Indicates whether the certificate has an associated private key.
Syntax
ANSI (Cross Platform) int GetUsedCertPrivateKeyExists(int iUsedCertIndex); Unicode (Windows) BOOL GetUsedCertPrivateKeyExists(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertprivatekeyexists(void* lpObj, int usedcertindex);
bool GetUsedCertPrivateKeyExists(int iUsedCertIndex);
Default Value
FALSE
Remarks
Indicates whether the certificate has an associated private key.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertPrivateKeyExtractable Property (CertificateValidator Class)
Indicates whether the private key is extractable.
Syntax
ANSI (Cross Platform) int GetUsedCertPrivateKeyExtractable(int iUsedCertIndex); Unicode (Windows) BOOL GetUsedCertPrivateKeyExtractable(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertprivatekeyextractable(void* lpObj, int usedcertindex);
bool GetUsedCertPrivateKeyExtractable(int iUsedCertIndex);
Default Value
FALSE
Remarks
Indicates whether the private key is extractable
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertPublicKeyBytes Property (CertificateValidator Class)
Contains the certificate's public key in DER format.
Syntax
ANSI (Cross Platform) int GetUsedCertPublicKeyBytes(int iUsedCertIndex, char* &lpUsedCertPublicKeyBytes, int &lenUsedCertPublicKeyBytes); Unicode (Windows) INT GetUsedCertPublicKeyBytes(INT iUsedCertIndex, LPSTR &lpUsedCertPublicKeyBytes, INT &lenUsedCertPublicKeyBytes);
int secureblackbox_certificatevalidator_getusedcertpublickeybytes(void* lpObj, int usedcertindex, char** lpUsedCertPublicKeyBytes, int* lenUsedCertPublicKeyBytes);
QByteArray GetUsedCertPublicKeyBytes(int iUsedCertIndex);
Remarks
Contains the certificate's public key in DER format.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertQualifiedStatements Property (CertificateValidator Class)
Returns the qualified status of the certificate.
Syntax
ANSI (Cross Platform) int GetUsedCertQualifiedStatements(int iUsedCertIndex); Unicode (Windows) INT GetUsedCertQualifiedStatements(INT iUsedCertIndex);
Possible Values
QST_NON_QUALIFIED(0),
QST_QUALIFIED_HARDWARE(1),
QST_QUALIFIED_SOFTWARE(2)
int secureblackbox_certificatevalidator_getusedcertqualifiedstatements(void* lpObj, int usedcertindex);
int GetUsedCertQualifiedStatements(int iUsedCertIndex);
Default Value
0
Remarks
Returns the qualified status of the certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
UsedCertSelfSigned Property (CertificateValidator Class)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
ANSI (Cross Platform) int GetUsedCertSelfSigned(int iUsedCertIndex); Unicode (Windows) BOOL GetUsedCertSelfSigned(INT iUsedCertIndex);
int secureblackbox_certificatevalidator_getusedcertselfsigned(void* lpObj, int usedcertindex);
bool GetUsedCertSelfSigned(int iUsedCertIndex);
Default Value
FALSE
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertSerialNumber Property (CertificateValidator Class)
Returns the certificate's serial number.
Syntax
ANSI (Cross Platform) int GetUsedCertSerialNumber(int iUsedCertIndex, char* &lpUsedCertSerialNumber, int &lenUsedCertSerialNumber); Unicode (Windows) INT GetUsedCertSerialNumber(INT iUsedCertIndex, LPSTR &lpUsedCertSerialNumber, INT &lenUsedCertSerialNumber);
int secureblackbox_certificatevalidator_getusedcertserialnumber(void* lpObj, int usedcertindex, char** lpUsedCertSerialNumber, int* lenUsedCertSerialNumber);
QByteArray GetUsedCertSerialNumber(int iUsedCertIndex);
Remarks
Returns the certificate's serial number.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertSigAlgorithm Property (CertificateValidator Class)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
ANSI (Cross Platform) char* GetUsedCertSigAlgorithm(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertSigAlgorithm(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertsigalgorithm(void* lpObj, int usedcertindex);
QString GetUsedCertSigAlgorithm(int iUsedCertIndex);
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertSubject Property (CertificateValidator 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* GetUsedCertSubject(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertSubject(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertsubject(void* lpObj, int usedcertindex);
QString GetUsedCertSubject(int iUsedCertIndex);
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 UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertSubjectAlternativeName Property (CertificateValidator Class)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
ANSI (Cross Platform) char* GetUsedCertSubjectAlternativeName(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertSubjectAlternativeName(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertsubjectalternativename(void* lpObj, int usedcertindex);
QString GetUsedCertSubjectAlternativeName(int iUsedCertIndex);
Default Value
""
Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertSubjectKeyID Property (CertificateValidator Class)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
ANSI (Cross Platform) int GetUsedCertSubjectKeyID(int iUsedCertIndex, char* &lpUsedCertSubjectKeyID, int &lenUsedCertSubjectKeyID); Unicode (Windows) INT GetUsedCertSubjectKeyID(INT iUsedCertIndex, LPSTR &lpUsedCertSubjectKeyID, INT &lenUsedCertSubjectKeyID);
int secureblackbox_certificatevalidator_getusedcertsubjectkeyid(void* lpObj, int usedcertindex, char** lpUsedCertSubjectKeyID, int* lenUsedCertSubjectKeyID);
QByteArray GetUsedCertSubjectKeyID(int iUsedCertIndex);
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 UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertSubjectRDN Property (CertificateValidator Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
ANSI (Cross Platform) char* GetUsedCertSubjectRDN(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertSubjectRDN(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertsubjectrdn(void* lpObj, int usedcertindex);
QString GetUsedCertSubjectRDN(int iUsedCertIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertValidFrom Property (CertificateValidator Class)
The time point at which the certificate becomes valid, in UTC.
Syntax
ANSI (Cross Platform) char* GetUsedCertValidFrom(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertValidFrom(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertvalidfrom(void* lpObj, int usedcertindex);
QString GetUsedCertValidFrom(int iUsedCertIndex);
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertValidTo Property (CertificateValidator Class)
The time point at which the certificate expires, in UTC.
Syntax
ANSI (Cross Platform) char* GetUsedCertValidTo(int iUsedCertIndex); Unicode (Windows) LPWSTR GetUsedCertValidTo(INT iUsedCertIndex);
char* secureblackbox_certificatevalidator_getusedcertvalidto(void* lpObj, int usedcertindex);
QString GetUsedCertValidTo(int iUsedCertIndex);
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLCount Property (CertificateValidator Class)
The number of records in the UsedCRL arrays.
Syntax
ANSI (Cross Platform) int GetUsedCRLCount(); Unicode (Windows) INT GetUsedCRLCount();
int secureblackbox_certificatevalidator_getusedcrlcount(void* lpObj);
int GetUsedCRLCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- UsedCRLBytes
- UsedCRLHandle
- UsedCRLIssuer
- UsedCRLIssuerRDN
- UsedCRLLocation
- UsedCRLNextUpdate
- UsedCRLThisUpdate
This property is read-only and not available at design time.
Data Type
Integer
UsedCRLBytes Property (CertificateValidator Class)
Returns raw CRL data in DER format.
Syntax
ANSI (Cross Platform) int GetUsedCRLBytes(int iUsedCRLIndex, char* &lpUsedCRLBytes, int &lenUsedCRLBytes); Unicode (Windows) INT GetUsedCRLBytes(INT iUsedCRLIndex, LPSTR &lpUsedCRLBytes, INT &lenUsedCRLBytes);
int secureblackbox_certificatevalidator_getusedcrlbytes(void* lpObj, int usedcrlindex, char** lpUsedCRLBytes, int* lenUsedCRLBytes);
QByteArray GetUsedCRLBytes(int iUsedCRLIndex);
Remarks
Returns raw CRL data in DER format.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCRLHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetUsedCRLHandle(int iUsedCRLIndex); Unicode (Windows) LONG64 GetUsedCRLHandle(INT iUsedCRLIndex);
int64 secureblackbox_certificatevalidator_getusedcrlhandle(void* lpObj, int usedcrlindex);
qint64 GetUsedCRLHandle(int iUsedCRLIndex);
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 UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
Long64
UsedCRLIssuer Property (CertificateValidator Class)
The common name of the CRL issuer (CA), typically a company name.
Syntax
ANSI (Cross Platform) char* GetUsedCRLIssuer(int iUsedCRLIndex); Unicode (Windows) LPWSTR GetUsedCRLIssuer(INT iUsedCRLIndex);
char* secureblackbox_certificatevalidator_getusedcrlissuer(void* lpObj, int usedcrlindex);
QString GetUsedCRLIssuer(int iUsedCRLIndex);
Default Value
""
Remarks
The common name of the CRL issuer (CA), typically a company name.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLIssuerRDN Property (CertificateValidator Class)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Syntax
ANSI (Cross Platform) char* GetUsedCRLIssuerRDN(int iUsedCRLIndex); Unicode (Windows) LPWSTR GetUsedCRLIssuerRDN(INT iUsedCRLIndex);
char* secureblackbox_certificatevalidator_getusedcrlissuerrdn(void* lpObj, int usedcrlindex);
QString GetUsedCRLIssuerRDN(int iUsedCRLIndex);
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLLocation Property (CertificateValidator Class)
The URL that the CRL was downloaded from.
Syntax
ANSI (Cross Platform) char* GetUsedCRLLocation(int iUsedCRLIndex); Unicode (Windows) LPWSTR GetUsedCRLLocation(INT iUsedCRLIndex);
char* secureblackbox_certificatevalidator_getusedcrllocation(void* lpObj, int usedcrlindex);
QString GetUsedCRLLocation(int iUsedCRLIndex);
Default Value
""
Remarks
The URL that the CRL was downloaded from.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLNextUpdate Property (CertificateValidator Class)
The planned time and date of the next version of this CRL to be published.
Syntax
ANSI (Cross Platform) char* GetUsedCRLNextUpdate(int iUsedCRLIndex); Unicode (Windows) LPWSTR GetUsedCRLNextUpdate(INT iUsedCRLIndex);
char* secureblackbox_certificatevalidator_getusedcrlnextupdate(void* lpObj, int usedcrlindex);
QString GetUsedCRLNextUpdate(int iUsedCRLIndex);
Default Value
""
Remarks
The planned time and date of the next version of this CRL to be published.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLThisUpdate Property (CertificateValidator Class)
The date and time at which this version of the CRL was published.
Syntax
ANSI (Cross Platform) char* GetUsedCRLThisUpdate(int iUsedCRLIndex); Unicode (Windows) LPWSTR GetUsedCRLThisUpdate(INT iUsedCRLIndex);
char* secureblackbox_certificatevalidator_getusedcrlthisupdate(void* lpObj, int usedcrlindex);
QString GetUsedCRLThisUpdate(int iUsedCRLIndex);
Default Value
""
Remarks
The date and time at which this version of the CRL was published.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UseDefaultTSLs Property (CertificateValidator Class)
Enables or disables the use of the default TSLs.
Syntax
ANSI (Cross Platform) int GetUseDefaultTSLs();
int SetUseDefaultTSLs(int bUseDefaultTSLs); Unicode (Windows) BOOL GetUseDefaultTSLs();
INT SetUseDefaultTSLs(BOOL bUseDefaultTSLs);
int secureblackbox_certificatevalidator_getusedefaulttsls(void* lpObj);
int secureblackbox_certificatevalidator_setusedefaulttsls(void* lpObj, int bUseDefaultTSLs);
bool GetUseDefaultTSLs();
int SetUseDefaultTSLs(bool bUseDefaultTSLs);
Default Value
FALSE
Remarks
Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists). The result of this check reported in Qualified property.
The following default TSLs are used: EU (European Union) TSL.
Data Type
Boolean
UsedOCSPCount Property (CertificateValidator Class)
The number of records in the UsedOCSP arrays.
Syntax
ANSI (Cross Platform) int GetUsedOCSPCount(); Unicode (Windows) INT GetUsedOCSPCount();
int secureblackbox_certificatevalidator_getusedocspcount(void* lpObj);
int GetUsedOCSPCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at UsedOCSPCount - 1.This property is read-only and not available at design time.
Data Type
Integer
UsedOCSPBytes Property (CertificateValidator Class)
Buffer containing raw OCSP response data.
Syntax
ANSI (Cross Platform) int GetUsedOCSPBytes(int iUsedOCSPIndex, char* &lpUsedOCSPBytes, int &lenUsedOCSPBytes); Unicode (Windows) INT GetUsedOCSPBytes(INT iUsedOCSPIndex, LPSTR &lpUsedOCSPBytes, INT &lenUsedOCSPBytes);
int secureblackbox_certificatevalidator_getusedocspbytes(void* lpObj, int usedocspindex, char** lpUsedOCSPBytes, int* lenUsedOCSPBytes);
QByteArray GetUsedOCSPBytes(int iUsedOCSPIndex);
Remarks
Buffer containing raw OCSP response data.
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedOCSPHandle Property (CertificateValidator Class)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
ANSI (Cross Platform) int64 GetUsedOCSPHandle(int iUsedOCSPIndex); Unicode (Windows) LONG64 GetUsedOCSPHandle(INT iUsedOCSPIndex);
int64 secureblackbox_certificatevalidator_getusedocsphandle(void* lpObj, int usedocspindex);
qint64 GetUsedOCSPHandle(int iUsedOCSPIndex);
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 UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
Long64
UsedOCSPIssuer Property (CertificateValidator Class)
Indicates the issuer of this response (a CA or its authorized representative).
Syntax
ANSI (Cross Platform) char* GetUsedOCSPIssuer(int iUsedOCSPIndex); Unicode (Windows) LPWSTR GetUsedOCSPIssuer(INT iUsedOCSPIndex);
char* secureblackbox_certificatevalidator_getusedocspissuer(void* lpObj, int usedocspindex);
QString GetUsedOCSPIssuer(int iUsedOCSPIndex);
Default Value
""
Remarks
Indicates the issuer of this response (a CA or its authorized representative).
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
String
UsedOCSPIssuerRDN Property (CertificateValidator Class)
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Syntax
ANSI (Cross Platform) char* GetUsedOCSPIssuerRDN(int iUsedOCSPIndex); Unicode (Windows) LPWSTR GetUsedOCSPIssuerRDN(INT iUsedOCSPIndex);
char* secureblackbox_certificatevalidator_getusedocspissuerrdn(void* lpObj, int usedocspindex);
QString GetUsedOCSPIssuerRDN(int iUsedOCSPIndex);
Default Value
""
Remarks
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
String
UsedOCSPLocation Property (CertificateValidator Class)
Location of the OCSP responder.
Syntax
ANSI (Cross Platform) char* GetUsedOCSPLocation(int iUsedOCSPIndex); Unicode (Windows) LPWSTR GetUsedOCSPLocation(INT iUsedOCSPIndex);
char* secureblackbox_certificatevalidator_getusedocsplocation(void* lpObj, int usedocspindex);
QString GetUsedOCSPLocation(int iUsedOCSPIndex);
Default Value
""
Remarks
Location of the OCSP responder.
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
String
UsedOCSPProducedAt Property (CertificateValidator Class)
Specifies the time when the response was produced, in UTC.
Syntax
ANSI (Cross Platform) char* GetUsedOCSPProducedAt(int iUsedOCSPIndex); Unicode (Windows) LPWSTR GetUsedOCSPProducedAt(INT iUsedOCSPIndex);
char* secureblackbox_certificatevalidator_getusedocspproducedat(void* lpObj, int usedocspindex);
QString GetUsedOCSPProducedAt(int iUsedOCSPIndex);
Default Value
""
Remarks
Specifies the time when the response was produced, in UTC.
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
String
UseSystemCertificates Property (CertificateValidator Class)
Enables or disables the use of the system certificates.
Syntax
ANSI (Cross Platform) int GetUseSystemCertificates();
int SetUseSystemCertificates(int bUseSystemCertificates); Unicode (Windows) BOOL GetUseSystemCertificates();
INT SetUseSystemCertificates(BOOL bUseSystemCertificates);
int secureblackbox_certificatevalidator_getusesystemcertificates(void* lpObj);
int secureblackbox_certificatevalidator_setusesystemcertificates(void* lpObj, int bUseSystemCertificates);
bool GetUseSystemCertificates();
int SetUseSystemCertificates(bool bUseSystemCertificates);
Default Value
FALSE
Remarks
Use this property to tell the validator to use (or not to use) the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.
Data Type
Boolean
ValidationLog Property (CertificateValidator Class)
Contains the complete log of the certificate validation routine.
Syntax
ANSI (Cross Platform) char* GetValidationLog(); Unicode (Windows) LPWSTR GetValidationLog();
char* secureblackbox_certificatevalidator_getvalidationlog(void* lpObj);
QString GetValidationLog();
Default Value
""
Remarks
Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
This property is read-only and not available at design time.
Data Type
String
ValidationMoment Property (CertificateValidator Class)
The time point at which chain validity is to be established.
Syntax
ANSI (Cross Platform) char* GetValidationMoment();
int SetValidationMoment(const char* lpszValidationMoment); Unicode (Windows) LPWSTR GetValidationMoment();
INT SetValidationMoment(LPCWSTR lpszValidationMoment);
char* secureblackbox_certificatevalidator_getvalidationmoment(void* lpObj);
int secureblackbox_certificatevalidator_setvalidationmoment(void* lpObj, const char* lpszValidationMoment);
QString GetValidationMoment();
int SetValidationMoment(QString qsValidationMoment);
Default Value
""
Remarks
Use this property to specify the moment in time at which chain validity should be established. The time is in UTC. Leave the setting empty to stick to the current moment.
The validity of the same chain may differ depending on the time point chosen due to temporal changes in subchain validities and revocation statuses.
Data Type
String
Config Method (CertificateValidator Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_certificatevalidator_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 (CertificateValidator 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_certificatevalidator_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.
GetQualifiedStatus Method (CertificateValidator Class)
Obtains the qualified information for Certificate .
Syntax
ANSI (Cross Platform) int GetQualifiedStatus(); Unicode (Windows) INT GetQualifiedStatus();
int secureblackbox_certificatevalidator_getqualifiedstatus(void* lpObj);
int GetQualifiedStatus();
Remarks
Use this method to obtain a fresh qualified status for the certificate.
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.)
GetTSLProperty Method (CertificateValidator Class)
Returns a specific TSL property.
Syntax
ANSI (Cross Platform) char* GetTSLProperty(const char* lpszPropName, const char* lpszLanguage); Unicode (Windows) LPWSTR GetTSLProperty(LPCWSTR lpszPropName, LPCWSTR lpszLanguage);
char* secureblackbox_certificatevalidator_gettslproperty(void* lpObj, const char* lpszPropName, const char* lpszLanguage);
QString GetTSLProperty(const QString& qsPropName, const QString& qsLanguage);
Remarks
Use this method to obtain the value of a specific TSL property. Use the Language parameter to specify the language identifier (e.g. it) in which you would like to have the property returned (if supported by the TSL). Leave the parameter empty to return the value in the default language.
Please find a list of common TSL properties below:
- VersionIdentifier
- SequenceNumber
- Type
- SchemeName
- SchemeOperatorName
- SchemeOperatorAddress
- SchemeInformationURI
- StatusDeterminationApproach
- SchemeTypeCommunityRules
- SchemeTerritory
- Policies
- LegalNotices
- HistoricalInformationPeriod
- ListIssueDateTime
- NextUpdate
- DistributionPoints
- SchemeExtensions
- TSPXML
- TSPName
- TSPTradeName
- TSPInformationURI
- TSPAddress
- TSPInformationExtensions
- TSPServiceXML
- TSPServiceTypeIdentifier
- TSPServiceName
- TSPServiceStatus
- TSPServiceStatusStartingTime
- TSPSchemeServiceDefinitionURI
- TSPServiceDefinitionURI
- TSPServiceSupplyPoints
- TSPServiceInformationExtensions
- TSPServiceQualifiers
- TSPAdditionalServiceInformation
- TSPHistoryInstance
- TSPHistoryInstanceXML
- TSPHistoryInstanceServiceTypeIdentifier
- TSPHistoryInstanceServiceName
- TSPHistoryInstanceServiceStatus
- TSPHistoryInstanceServiceStatusStartingTime
- TSPHistoryInstanceServiceInformationExtensions
- TSPHistoryInstanceQualifiers
- TSPHistoryInstanceAdditionalServiceInformation
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.
RefreshCache Method (CertificateValidator Class)
Refreshes the certificate cache.
Syntax
ANSI (Cross Platform) int RefreshCache(); Unicode (Windows) INT RefreshCache();
int secureblackbox_certificatevalidator_refreshcache(void* lpObj);
int RefreshCache();
Remarks
Use this method to remove obsolete information from the validation cache (only makes sense if CacheValidationResults is on).
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.)
ResetCache Method (CertificateValidator Class)
Clears all data contained in the validation cache.
Syntax
ANSI (Cross Platform) int ResetCache(); Unicode (Windows) INT ResetCache();
int secureblackbox_certificatevalidator_resetcache(void* lpObj);
int ResetCache();
Remarks
Use this method to clear the validation cache (only makes sense if CacheValidationResults is on).
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.)
Terminate Method (CertificateValidator Class)
Terminates the validation process.
Syntax
ANSI (Cross Platform) int Terminate(); Unicode (Windows) INT Terminate();
int secureblackbox_certificatevalidator_terminate(void* lpObj);
int Terminate();
Remarks
Call this method if you would like to stop the validation process.
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.)
Validate Method (CertificateValidator Class)
Validates the certificate chain.
Syntax
ANSI (Cross Platform) int Validate(); Unicode (Windows) INT Validate();
int secureblackbox_certificatevalidator_validate(void* lpObj);
int Validate();
Remarks
Use this method to validate the certificate chain that starts with Certificate.
The chain validation is a multi-step process which includes validation of each certificate in the chain up to the trusted anchor. The ultimate goal of this process is to establish the integrity of the chain and its trustworthiness.
Depending on the component tuneup, the validation process may differ drastically, even for the same certificate: it may be more or less rigorous, may include or exclude revocation checks, and may be more or less tolerant to minor chain issues.
When this process is completed, the final decision on the validity of the checked certificate is returned from this method, and also saved in ChainValidationResult property. Another property, ChainValidationDetails, provides insight into the reasons that contributed to that decision. Use ValidationLog to get a detailed step-by-step log of the entire validation process.
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.
ValidateForSMIME Method (CertificateValidator Class)
Validates an e-mail signing certificate.
Syntax
ANSI (Cross Platform) int ValidateForSMIME(const char* lpszEmailAddress); Unicode (Windows) INT ValidateForSMIME(LPCWSTR lpszEmailAddress);
int secureblackbox_certificatevalidator_validateforsmime(void* lpObj, const char* lpszEmailAddress);
int ValidateForSMIME(const QString& qsEmailAddress);
Remarks
Use this method to validate an e-mail security certificate.
This is a variant of Validate method that performs some additional e-mail specific checks, imposed by e-mail certificate rules. This method returns the overall chain validation result.
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.
ValidateForSSL Method (CertificateValidator Class)
Validates a server-side SSL/TLS certificate.
Syntax
ANSI (Cross Platform) int ValidateForSSL(const char* lpszURL, const char* lpszIPAddress); Unicode (Windows) INT ValidateForSSL(LPCWSTR lpszURL, LPCWSTR lpszIPAddress);
int secureblackbox_certificatevalidator_validateforssl(void* lpObj, const char* lpszURL, const char* lpszIPAddress);
int ValidateForSSL(const QString& qsURL, const QString& qsIPAddress);
Remarks
Use this method to validate a server-side SSL/TLS certificate.
This is a variant of Validate method that performs some additional TLS-specific checks. It is important that you provide a correct URL or IPAddress for the check to return a reasonable and justified result.
This method returns the overall result of the chain validation.
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.
AfterCertificateProcessing Event (CertificateValidator Class)
Marks the end of a single certificate processing step.
Syntax
ANSI (Cross Platform) virtual int FireAfterCertificateProcessing(CertificateValidatorAfterCertificateProcessingEventParams *e);
typedef struct {
const char *Cert;
int Validity;
int ValidationDetails; int reserved; } CertificateValidatorAfterCertificateProcessingEventParams;
Unicode (Windows) virtual INT FireAfterCertificateProcessing(CertificateValidatorAfterCertificateProcessingEventParams *e);
typedef struct {
LPCWSTR Cert;
INT Validity;
INT ValidationDetails; INT reserved; } CertificateValidatorAfterCertificateProcessingEventParams;
#define EID_CERTIFICATEVALIDATOR_AFTERCERTIFICATEPROCESSING 1 virtual INT SECUREBLACKBOX_CALL FireAfterCertificateProcessing(LPSTR &lpszCert, INT &iValidity, INT &iValidationDetails);
class CertificateValidatorAfterCertificateProcessingEventParams { public: const QString &Cert(); int Validity(); int ValidationDetails(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCertificateProcessing(CertificateValidatorAfterCertificateProcessingEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireAfterCertificateProcessing(CertificateValidatorAfterCertificateProcessingEventParams *e) {...}
Remarks
This event is fired when the class has finished processing Cert, and returns its Validity status and ValidationDetails.
'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via AfterCertificateValidation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.
You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via InterimValidationResult and InterimValidationDetails properties.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
AfterCertificateValidation Event (CertificateValidator Class)
Marks the end of a single certificate validation step.
Syntax
ANSI (Cross Platform) virtual int FireAfterCertificateValidation(CertificateValidatorAfterCertificateValidationEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
int Validity;
int ValidationDetails; int reserved; } CertificateValidatorAfterCertificateValidationEventParams;
Unicode (Windows) virtual INT FireAfterCertificateValidation(CertificateValidatorAfterCertificateValidationEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
INT Validity;
INT ValidationDetails; INT reserved; } CertificateValidatorAfterCertificateValidationEventParams;
#define EID_CERTIFICATEVALIDATOR_AFTERCERTIFICATEVALIDATION 2 virtual INT SECUREBLACKBOX_CALL FireAfterCertificateValidation(LPSTR &lpszCert, LPSTR &lpszCACert, INT &iValidity, INT &iValidationDetails);
class CertificateValidatorAfterCertificateValidationEventParams { public: const QString &Cert(); const QString &CACert(); int Validity(); int ValidationDetails(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCertificateValidation(CertificateValidatorAfterCertificateValidationEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireAfterCertificateValidation(CertificateValidatorAfterCertificateValidationEventParams *e) {...}
Remarks
This event is fired when the class has finished validation of Cert with CACert, and returns its Validity status and ValidationDetails.
'Validation', in this context, means a single validation of a certificate with its CA certificate. For certificates with multiple CAs, validations are grouped into 'processings.' Each processing, therefore, is a set of validations of the same certificate with all its CAs.
You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via InterimValidationResult and InterimValidationDetails properties.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
BeforeCACertificateDownload Event (CertificateValidator Class)
Fires when a CA certificate is about to be downloaded.
Syntax
ANSI (Cross Platform) virtual int FireBeforeCACertificateDownload(CertificateValidatorBeforeCACertificateDownloadEventParams *e);
typedef struct {
const char *Cert;
const char *Location; int reserved; } CertificateValidatorBeforeCACertificateDownloadEventParams;
Unicode (Windows) virtual INT FireBeforeCACertificateDownload(CertificateValidatorBeforeCACertificateDownloadEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR Location; INT reserved; } CertificateValidatorBeforeCACertificateDownloadEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFORECACERTIFICATEDOWNLOAD 3 virtual INT SECUREBLACKBOX_CALL FireBeforeCACertificateDownload(LPSTR &lpszCert, LPSTR &lpszLocation);
class CertificateValidatorBeforeCACertificateDownloadEventParams { public: const QString &Cert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCACertificateDownload(CertificateValidatorBeforeCACertificateDownloadEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeCACertificateDownload(CertificateValidatorBeforeCACertificateDownloadEventParams *e) {...}
Remarks
This event is fired when a CA certificate that is needed to validate Cert is about to be downloaded from Location.
BeforeCertificateProcessing Event (CertificateValidator Class)
Reports the start of certificate processing.
Syntax
ANSI (Cross Platform) virtual int FireBeforeCertificateProcessing(CertificateValidatorBeforeCertificateProcessingEventParams *e);
typedef struct {
const char *Cert;
int Validity;
int ValidationDetails; int reserved; } CertificateValidatorBeforeCertificateProcessingEventParams;
Unicode (Windows) virtual INT FireBeforeCertificateProcessing(CertificateValidatorBeforeCertificateProcessingEventParams *e);
typedef struct {
LPCWSTR Cert;
INT Validity;
INT ValidationDetails; INT reserved; } CertificateValidatorBeforeCertificateProcessingEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFORECERTIFICATEPROCESSING 4 virtual INT SECUREBLACKBOX_CALL FireBeforeCertificateProcessing(LPSTR &lpszCert, INT &iValidity, INT &iValidationDetails);
class CertificateValidatorBeforeCertificateProcessingEventParams { public: const QString &Cert(); int Validity(); int ValidationDetails(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCertificateProcessing(CertificateValidatorBeforeCertificateProcessingEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeCertificateProcessing(CertificateValidatorBeforeCertificateProcessingEventParams *e) {...}
Remarks
This event is fired when the class is about to start the processing of Cert.
'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via AfterCertificateValidation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.
The firing of AfterCertificateProcessing marks the end of the certificate processing.
Validity and ValidationDetails specify the current validation status.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
BeforeCertificateValidation Event (CertificateValidator Class)
Reports the start of certificate validation.
Syntax
ANSI (Cross Platform) virtual int FireBeforeCertificateValidation(CertificateValidatorBeforeCertificateValidationEventParams *e);
typedef struct {
const char *Cert;
const char *CACert; int reserved; } CertificateValidatorBeforeCertificateValidationEventParams;
Unicode (Windows) virtual INT FireBeforeCertificateValidation(CertificateValidatorBeforeCertificateValidationEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert; INT reserved; } CertificateValidatorBeforeCertificateValidationEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFORECERTIFICATEVALIDATION 5 virtual INT SECUREBLACKBOX_CALL FireBeforeCertificateValidation(LPSTR &lpszCert, LPSTR &lpszCACert);
class CertificateValidatorBeforeCertificateValidationEventParams { public: const QString &Cert(); const QString &CACert(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCertificateValidation(CertificateValidatorBeforeCertificateValidationEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeCertificateValidation(CertificateValidatorBeforeCertificateValidationEventParams *e) {...}
Remarks
This event is fired when the class is about to start validating Cert with CACert.
A 'validation' is a single step of validating a certificate with its CA certificate. A row of consecutive validations of the same certificate with different CAs are grouped into 'processings.'
The firing of AfterCertificateValidation marks the end of the certificate validation step.
BeforeCRLDownload Event (CertificateValidator Class)
Fires when a CRL is about to be downloaded.
Syntax
ANSI (Cross Platform) virtual int FireBeforeCRLDownload(CertificateValidatorBeforeCRLDownloadEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
const char *Location; int reserved; } CertificateValidatorBeforeCRLDownloadEventParams;
Unicode (Windows) virtual INT FireBeforeCRLDownload(CertificateValidatorBeforeCRLDownloadEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
LPCWSTR Location; INT reserved; } CertificateValidatorBeforeCRLDownloadEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFORECRLDOWNLOAD 6 virtual INT SECUREBLACKBOX_CALL FireBeforeCRLDownload(LPSTR &lpszCert, LPSTR &lpszCACert, LPSTR &lpszLocation);
class CertificateValidatorBeforeCRLDownloadEventParams { public: const QString &Cert(); const QString &CACert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCRLDownload(CertificateValidatorBeforeCRLDownloadEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeCRLDownload(CertificateValidatorBeforeCRLDownloadEventParams *e) {...}
Remarks
This event is fired when a CRL (Certificate Revocation List) needed to validate Cert is going to be downloaded from Location.
BeforeOCSPDownload Event (CertificateValidator Class)
Fires when a certificate's OCSP status is about to be requested.
Syntax
ANSI (Cross Platform) virtual int FireBeforeOCSPDownload(CertificateValidatorBeforeOCSPDownloadEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
const char *Location; int reserved; } CertificateValidatorBeforeOCSPDownloadEventParams;
Unicode (Windows) virtual INT FireBeforeOCSPDownload(CertificateValidatorBeforeOCSPDownloadEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
LPCWSTR Location; INT reserved; } CertificateValidatorBeforeOCSPDownloadEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFOREOCSPDOWNLOAD 7 virtual INT SECUREBLACKBOX_CALL FireBeforeOCSPDownload(LPSTR &lpszCert, LPSTR &lpszCACert, LPSTR &lpszLocation);
class CertificateValidatorBeforeOCSPDownloadEventParams { public: const QString &Cert(); const QString &CACert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeOCSPDownload(CertificateValidatorBeforeOCSPDownloadEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeOCSPDownload(CertificateValidatorBeforeOCSPDownloadEventParams *e) {...}
Remarks
This event is fired when the validator is about to request a fresh revocation status from an OCSP responder.
CACertificateDownloaded Event (CertificateValidator Class)
Marks the success of a certificate download.
Syntax
ANSI (Cross Platform) virtual int FireCACertificateDownloaded(CertificateValidatorCACertificateDownloadedEventParams *e);
typedef struct {
const char *Cert;
const char *Location; int reserved; } CertificateValidatorCACertificateDownloadedEventParams;
Unicode (Windows) virtual INT FireCACertificateDownloaded(CertificateValidatorCACertificateDownloadedEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR Location; INT reserved; } CertificateValidatorCACertificateDownloadedEventParams;
#define EID_CERTIFICATEVALIDATOR_CACERTIFICATEDOWNLOADED 8 virtual INT SECUREBLACKBOX_CALL FireCACertificateDownloaded(LPSTR &lpszCert, LPSTR &lpszLocation);
class CertificateValidatorCACertificateDownloadedEventParams { public: const QString &Cert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CACertificateDownloaded(CertificateValidatorCACertificateDownloadedEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireCACertificateDownloaded(CertificateValidatorCACertificateDownloadedEventParams *e) {...}
Remarks
This event is fired when a CA certificate has been successfully downloaded from Location. This event is preceded with BeforeCACertificateDownload event.
CACertificateNeeded Event (CertificateValidator Class)
Requests a missing certificate from the user.
Syntax
ANSI (Cross Platform) virtual int FireCACertificateNeeded(CertificateValidatorCACertificateNeededEventParams *e);
typedef struct {
const char *Cert; int reserved; } CertificateValidatorCACertificateNeededEventParams;
Unicode (Windows) virtual INT FireCACertificateNeeded(CertificateValidatorCACertificateNeededEventParams *e);
typedef struct {
LPCWSTR Cert; INT reserved; } CertificateValidatorCACertificateNeededEventParams;
#define EID_CERTIFICATEVALIDATOR_CACERTIFICATENEEDED 9 virtual INT SECUREBLACKBOX_CALL FireCACertificateNeeded(LPSTR &lpszCert);
class CertificateValidatorCACertificateNeededEventParams { public: const QString &Cert(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CACertificateNeeded(CertificateValidatorCACertificateNeededEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireCACertificateNeeded(CertificateValidatorCACertificateNeededEventParams *e) {...}
Remarks
This event is fired when a CA certificate that is needed to validate Cert is not found at any of the available locations. If you have access to the missing certificate, please add it to the KnownCertificates collection to make it available to the validator.
When this event fires, the CurrentCertificate property is assigned with the certificate being validated. It is the CA that issued that certificate that the validator is looking for.
CRLDownloaded Event (CertificateValidator Class)
Marks the success of a CRL download.
Syntax
ANSI (Cross Platform) virtual int FireCRLDownloaded(CertificateValidatorCRLDownloadedEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
const char *Location; int reserved; } CertificateValidatorCRLDownloadedEventParams;
Unicode (Windows) virtual INT FireCRLDownloaded(CertificateValidatorCRLDownloadedEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
LPCWSTR Location; INT reserved; } CertificateValidatorCRLDownloadedEventParams;
#define EID_CERTIFICATEVALIDATOR_CRLDOWNLOADED 10 virtual INT SECUREBLACKBOX_CALL FireCRLDownloaded(LPSTR &lpszCert, LPSTR &lpszCACert, LPSTR &lpszLocation);
class CertificateValidatorCRLDownloadedEventParams { public: const QString &Cert(); const QString &CACert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CRLDownloaded(CertificateValidatorCRLDownloadedEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireCRLDownloaded(CertificateValidatorCRLDownloadedEventParams *e) {...}
Remarks
This event is fired when a CRL containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with BeforeCRLDownload event.
CRLNeeded Event (CertificateValidator Class)
Requests a missing CRL from the user.
Syntax
ANSI (Cross Platform) virtual int FireCRLNeeded(CertificateValidatorCRLNeededEventParams *e);
typedef struct {
const char *Cert;
const char *CACert; int reserved; } CertificateValidatorCRLNeededEventParams;
Unicode (Windows) virtual INT FireCRLNeeded(CertificateValidatorCRLNeededEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert; INT reserved; } CertificateValidatorCRLNeededEventParams;
#define EID_CERTIFICATEVALIDATOR_CRLNEEDED 11 virtual INT SECUREBLACKBOX_CALL FireCRLNeeded(LPSTR &lpszCert, LPSTR &lpszCACert);
class CertificateValidatorCRLNeededEventParams { public: const QString &Cert(); const QString &CACert(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CRLNeeded(CertificateValidatorCRLNeededEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireCRLNeeded(CertificateValidatorCRLNeededEventParams *e) {...}
Remarks
This event is fired when a CRL that is needed to validate Cert is not found at any of the available locations. If you have access to the missing CRL, please add it to the KnownCRLs collection to make it available to the validator.
When this event fires, the CurrentCertificate and CurrentCACertificate properties are assigned with the certificate being validated and its issuer certificate.
Error Event (CertificateValidator Class)
Information about errors during certificate validation.
Syntax
ANSI (Cross Platform) virtual int FireError(CertificateValidatorErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } CertificateValidatorErrorEventParams;
Unicode (Windows) virtual INT FireError(CertificateValidatorErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } CertificateValidatorErrorEventParams;
#define EID_CERTIFICATEVALIDATOR_ERROR 12 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class CertificateValidatorErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(CertificateValidatorErrorEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireError(CertificateValidatorErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during certificate processing or online information retrieval.
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 corresponding section.
Notification Event (CertificateValidator Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(CertificateValidatorNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } CertificateValidatorNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(CertificateValidatorNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } CertificateValidatorNotificationEventParams;
#define EID_CERTIFICATEVALIDATOR_NOTIFICATION 13 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class CertificateValidatorNotificationEventParams { 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(CertificateValidatorNotificationEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireNotification(CertificateValidatorNotificationEventParams *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.
This class can fire this event with the following EventID values:
DownloadTSL | This event is fired if a Trusted List is requested. The EventParam parameter contains the URL value from where to retrieve the TrustedList. The downloaded Trusted List content should be assigned to the TSLContent or TSLContentHex configuration settings. The class automatically downloads Trusted List if OfflineMode is disabled and no Trusted List content is provided. It is important to note that if you are caching the Trusted List content, you should check the NextUpdate field of the Trusted List and update it in a timely manner, otherwise the outdated Trusted List will be discarded. |
StoreTSL | This event is fired if the Trusted List should be stored for offline usage. The EventParam parameter contains the URL value from where the Trusted List was retrieved. The TrustedList content could be read using TSLContent or TSLContentHex configuration settings. |
OCSPDownloaded Event (CertificateValidator Class)
Marks the success of an OCSP request.
Syntax
ANSI (Cross Platform) virtual int FireOCSPDownloaded(CertificateValidatorOCSPDownloadedEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
const char *Location; int reserved; } CertificateValidatorOCSPDownloadedEventParams;
Unicode (Windows) virtual INT FireOCSPDownloaded(CertificateValidatorOCSPDownloadedEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
LPCWSTR Location; INT reserved; } CertificateValidatorOCSPDownloadedEventParams;
#define EID_CERTIFICATEVALIDATOR_OCSPDOWNLOADED 14 virtual INT SECUREBLACKBOX_CALL FireOCSPDownloaded(LPSTR &lpszCert, LPSTR &lpszCACert, LPSTR &lpszLocation);
class CertificateValidatorOCSPDownloadedEventParams { public: const QString &Cert(); const QString &CACert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void OCSPDownloaded(CertificateValidatorOCSPDownloadedEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireOCSPDownloaded(CertificateValidatorOCSPDownloadedEventParams *e) {...}
Remarks
This event is fired when an OCSP response containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with BeforeOCSPDownload event.
TLSCertNeeded Event (CertificateValidator Class)
Fires when a remote TLS party requests a client certificate.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertNeeded(CertificateValidatorTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } CertificateValidatorTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(CertificateValidatorTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } CertificateValidatorTLSCertNeededEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSCERTNEEDED 15 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class CertificateValidatorTLSCertNeededEventParams { public: const QString &Host(); const QString &CANames(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertNeeded(CertificateValidatorTLSCertNeededEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSCertNeeded(CertificateValidatorTLSCertNeededEventParams *e) {...}
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.
TLSCertValidate Event (CertificateValidator Class)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertValidate(CertificateValidatorTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } CertificateValidatorTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(CertificateValidatorTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } CertificateValidatorTLSCertValidateEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSCERTVALIDATE 16 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class CertificateValidatorTLSCertValidateEventParams { public: const QString &ServerHost(); const QString &ServerIP(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(CertificateValidatorTLSCertValidateEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSCertValidate(CertificateValidatorTLSCertValidateEventParams *e) {...}
Remarks
This event is fired during a TLS handshake. Use TLSServerChain property to access the certificate chain. In general case, components may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.
TLSEstablished Event (CertificateValidator Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(CertificateValidatorTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } CertificateValidatorTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(CertificateValidatorTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } CertificateValidatorTLSEstablishedEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSESTABLISHED 17 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class CertificateValidatorTLSEstablishedEventParams { public: const QString &Host(); const QString &Version(); const QString &Ciphersuite(); const QByteArray &ConnectionId(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(CertificateValidatorTLSEstablishedEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSEstablished(CertificateValidatorTLSEstablishedEventParams *e) {...}
Remarks
The class uses this event to notify the application about successful completion of a TLS handshake.
The Version, Ciphersuite, and ConnectionId parameters indicate security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.
TLSHandshake Event (CertificateValidator Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(CertificateValidatorTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } CertificateValidatorTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(CertificateValidatorTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } CertificateValidatorTLSHandshakeEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSHANDSHAKE 18 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class CertificateValidatorTLSHandshakeEventParams { public: const QString &Host(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(CertificateValidatorTLSHandshakeEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSHandshake(CertificateValidatorTLSHandshakeEventParams *e) {...}
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed with TLSEstablished event. If the server chooses to request a client certificate, TLSCertNeeded event will also be fired.
TLSShutdown Event (CertificateValidator Class)
Reports the graceful closure of a TLS connection.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(CertificateValidatorTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } CertificateValidatorTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(CertificateValidatorTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } CertificateValidatorTLSShutdownEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSSHUTDOWN 19 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class CertificateValidatorTLSShutdownEventParams { public: const QString &Host(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(CertificateValidatorTLSShutdownEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSShutdown(CertificateValidatorTLSShutdownEventParams *e) {...}
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
Config Settings (CertificateValidator 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.CertificateValidator Config Settings
In the optimistic strategy, positive validation results are kept, and negative ones are ignored. If there are no good certificates in the chain, the validation proceeds using self-signed certificates. Smart is the same as optimistic.
In the pessimistic strategy, even one negative validation result makes the whole process to fail.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as TrustedCertificates property) are considered trusted.
When ValidateInvalidCertificates is False and a certificate is found to be not valid, further checks of this certificate are not performed.
Supported values: wahmIgnore = 0 wahmWarning = 1 wahmError = 2
TrustedLists Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (CertificateValidator 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.
CertificateValidator 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) |