CertificateValidator Class

Properties   Methods   Events   Config Settings   Errors  

The CertificateValidator class provides fine-grained validation of X.509 certificates.

Class Name

SecureBlackbox_CertificateValidator

Procedural Interface

 secureblackbox_certificatevalidator_open();
 secureblackbox_certificatevalidator_close($res);
 secureblackbox_certificatevalidator_register_callback($res, $id, $function);
 secureblackbox_certificatevalidator_get_last_error($res);
 secureblackbox_certificatevalidator_get_last_error_code($res);
 secureblackbox_certificatevalidator_set($res, $id, $index, $value);
 secureblackbox_certificatevalidator_get($res, $id, $index);
 secureblackbox_certificatevalidator_do_config($res, $configurationstring);
 secureblackbox_certificatevalidator_do_doaction($res, $actionid, $actionparams);
 secureblackbox_certificatevalidator_do_getqualifiedstatus($res);
 secureblackbox_certificatevalidator_do_gettslproperty($res, $propname, $language);
 secureblackbox_certificatevalidator_do_refreshcache($res);
 secureblackbox_certificatevalidator_do_resetcache($res);
 secureblackbox_certificatevalidator_do_terminate($res);
 secureblackbox_certificatevalidator_do_validate($res);
 secureblackbox_certificatevalidator_do_validateforsmime($res, $emailaddress);
 secureblackbox_certificatevalidator_do_validateforssl($res, $url, $ipaddress);

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.
Apart from these two parameters, you can check the low-level validation details by consulting the ValidationLog property. The validation log is often a great source for tracking and reacting to various validation issues.

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.

BlockedCertCountThe number of records in the BlockedCert arrays.
BlockedCertBytesReturns the raw certificate data in DER format.
BlockedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CacheValidationResultsEnables or disables validation result caching.
CertBytesReturns the raw certificate data in DER format.
CertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
ChainValidationDetailsThe details of a certificate chain validation outcome.
ChainValidationResultThe general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
CurrentCACertBytesReturns the raw certificate data in DER format.
CurrentCACertCAIndicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
CurrentCACertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
CurrentCACertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
CurrentCACertCurveSpecifies the elliptic curve of the EC public key.
CurrentCACertFingerprintContains the fingerprint (a hash imprint) of this certificate.
CurrentCACertFriendlyNameContains an associated alias (friendly name) of the certificate.
CurrentCACertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CurrentCACertHashAlgorithmSpecifies 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 .
CurrentCACertIssuerThe common name of the certificate issuer (CA), typically a company name.
CurrentCACertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
CurrentCACertKeyAlgorithmSpecifies the public key algorithm of this certificate.
CurrentCACertKeyBitsReturns the length of the public key.
CurrentCACertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
CurrentCACertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
CurrentCACertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
CurrentCACertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
CurrentCACertOCSPNoCheckAccessor to the value of the certificate's ocsp-no-check extension.
CurrentCACertOriginReturns the origin of this certificate.
CurrentCACertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
CurrentCACertPrivateKeyBytesContains the certificate's private key.
CurrentCACertPrivateKeyExistsIndicates whether the certificate has an associated private key.
CurrentCACertPrivateKeyExtractableIndicates whether the private key is extractable.
CurrentCACertPublicKeyBytesContains the certificate's public key in DER format.
CurrentCACertQualifiedStatementsReturns the qualified status of the certificate.
CurrentCACertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
CurrentCACertSerialNumberReturns the certificate's serial number.
CurrentCACertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
CurrentCACertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
CurrentCACertSubjectAlternativeNameReturns or sets the value of the Subject Alternative Name extension of the certificate.
CurrentCACertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
CurrentCACertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
CurrentCACertValidFromThe time point at which the certificate becomes valid, in UTC.
CurrentCACertValidToThe time point at which the certificate expires, in UTC.
CurrentCertBytesReturns the raw certificate data in DER format.
CurrentCertCAIndicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
CurrentCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
CurrentCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
CurrentCertCurveSpecifies the elliptic curve of the EC public key.
CurrentCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
CurrentCertFriendlyNameContains an associated alias (friendly name) of the certificate.
CurrentCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
CurrentCertHashAlgorithmSpecifies 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 .
CurrentCertIssuerThe common name of the certificate issuer (CA), typically a company name.
CurrentCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
CurrentCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
CurrentCertKeyBitsReturns the length of the public key.
CurrentCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
CurrentCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
CurrentCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
CurrentCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
CurrentCertOCSPNoCheckAccessor to the value of the certificate's ocsp-no-check extension.
CurrentCertOriginReturns the origin of this certificate.
CurrentCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
CurrentCertPrivateKeyBytesContains the certificate's private key.
CurrentCertPrivateKeyExistsIndicates whether the certificate has an associated private key.
CurrentCertPrivateKeyExtractableIndicates whether the private key is extractable.
CurrentCertPublicKeyBytesContains the certificate's public key in DER format.
CurrentCertQualifiedStatementsReturns the qualified status of the certificate.
CurrentCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
CurrentCertSerialNumberReturns the certificate's serial number.
CurrentCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
CurrentCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
CurrentCertSubjectAlternativeNameReturns or sets the value of the Subject Alternative Name extension of the certificate.
CurrentCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
CurrentCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
CurrentCertValidFromThe time point at which the certificate becomes valid, in UTC.
CurrentCertValidToThe time point at which the certificate expires, in UTC.
FIPSModeReserved.
GracePeriodSpecifies a grace period to apply during certificate validation.
InterimValidationDetailsContains the validation details of the moment.
InterimValidationResultContains the validation status of the moment.
KnownCertCountThe number of records in the KnownCert arrays.
KnownCertBytesReturns the raw certificate data in DER format.
KnownCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownCRLCountThe number of records in the KnownCRL arrays.
KnownCRLBytesReturns the raw CRL data in DER format.
KnownCRLHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
KnownOCSPCountThe number of records in the KnownOCSP arrays.
KnownOCSPBytesA buffer containing the raw OCSP response data.
KnownOCSPHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
MaxValidationTimeSpecifies the maximum time the validation process may take.
OfflineModeSwitches the class to offline mode.
ProxyAddressThe IP address of the proxy server.
ProxyAuthenticationThe authentication type used by the proxy server.
ProxyPasswordThe password to authenticate to the proxy server.
ProxyPortThe port on the proxy server to connect to.
ProxyProxyTypeThe type of the proxy server.
ProxyRequestHeadersContains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBodyContains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeadersContains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUseProxyEnables or disables proxy-driven connection.
ProxyUsernameSpecifies the username credential for proxy authentication.
QualifiedInfoAddressContains the address of the TSL provider.
QualifiedInfoCustomTSLsThe list of custom TSLs to use.
QualifiedInfoDownloadLogContains the TLS download log.
QualifiedInfoInformationURIContains the URI of the provider information.
QualifiedInfoLanguagesThe preferred language(s) for TSL data.
QualifiedInfoNextUpdateReturns the next update date and time of the TSL.
QualifiedInfoProviderContains the name of the TSL provider.
QualifiedInfoQualifiedIndicates whether the certificate is qualified.
QualifiedInfoQualifiersA list of qualifiers.
QualifiedInfoServiceNameContains the name of the TSL service.
QualifiedInfoServiceTypeIdContains the TSL service type identifier.
QualifiedInfoSourceThe source of qualified information.
QualifiedInfoStatusIndicates a qualified electronic signature.
QualifiedInfoTradeNameContains the trade name of the TSL provider.
QualifiedInfoUseDefaultTSLsUse this setting to enable or disable the use of the default TSLs.
QualifiedInfoValidationLogContains the TLS validation log.
QualifiedInfoXMLContains the XML of the TSL.
RevocationCheckSpecifies the kind(s) of revocation check to perform for all chain certificates.
SocketDNSModeSelects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPortSpecifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeoutThe timeout (in milliseconds) for each DNS query.
SocketDNSServersThe addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeoutThe timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimitThe maximum number of bytes to read from the socket, per second.
SocketLocalAddressThe local network interface to bind the socket to.
SocketLocalPortThe local port number to bind the socket to.
SocketOutgoingSpeedLimitThe maximum number of bytes to write to the socket, per second.
SocketTimeoutThe maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6Enables or disables IP protocol version 6.
TLSClientCertCountThe number of records in the TLSClientCert arrays.
TLSClientCertBytesReturns the raw certificate data in DER format.
TLSClientCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertCountThe number of records in the TLSServerCert arrays.
TLSServerCertBytesReturns the raw certificate data in DER format.
TLSServerCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
TLSAutoValidateCertificatesSpecifies whether server-side TLS certificates should be validated automatically using internal validation rules.
TLSBaseConfigurationSelects the base configuration for the TLS settings.
TLSCiphersuitesA list of ciphersuites separated with commas or semicolons.
TLSECCurvesDefines the elliptic curves to enable.
TLSExtensionsProvides access to TLS extensions.
TLSForceResumeIfDestinationChangesWhether to force TLS session resumption when the destination address changes.
TLSPreSharedIdentityDefines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
TLSPreSharedKeyContains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
TLSPreSharedKeyCiphersuiteDefines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
TLSRenegotiationAttackPreventionModeSelects the renegotiation attack prevention mechanism.
TLSRevocationCheckSpecifies the kind(s) of revocation check to perform.
TLSSSLOptionsVarious 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.
TLSTLSModeSpecifies the TLS mode to use.
TLSUseExtendedMasterSecretEnables the Extended Master Secret Extension, as defined in RFC 7627.
TLSUseSessionResumptionEnables or disables the TLS session resumption capability.
TLSVersionsThe SSL/TLS versions to enable by default.
TrustedCertCountThe number of records in the TrustedCert arrays.
TrustedCertBytesReturns the raw certificate data in DER format.
TrustedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UsedCertCountThe number of records in the UsedCert arrays.
UsedCertBytesReturns the raw certificate data in DER format.
UsedCertCAIndicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
UsedCertCAKeyIDA unique identifier (fingerprint) of the CA certificate's private key.
UsedCertCRLDistributionPointsLocations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
UsedCertCurveSpecifies the elliptic curve of the EC public key.
UsedCertFingerprintContains the fingerprint (a hash imprint) of this certificate.
UsedCertFriendlyNameContains an associated alias (friendly name) of the certificate.
UsedCertHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UsedCertHashAlgorithmSpecifies 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 .
UsedCertIssuerThe common name of the certificate issuer (CA), typically a company name.
UsedCertIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
UsedCertKeyAlgorithmSpecifies the public key algorithm of this certificate.
UsedCertKeyBitsReturns the length of the public key.
UsedCertKeyFingerprintReturns a fingerprint of the public key contained in the certificate.
UsedCertKeyUsageIndicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
UsedCertKeyValidReturns True if the certificate's key is cryptographically valid, and False otherwise.
UsedCertOCSPLocationsLocations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
UsedCertOCSPNoCheckAccessor to the value of the certificate's ocsp-no-check extension.
UsedCertOriginReturns the origin of this certificate.
UsedCertPolicyIDsContains identifiers (OIDs) of the applicable certificate policies.
UsedCertPrivateKeyBytesContains the certificate's private key.
UsedCertPrivateKeyExistsIndicates whether the certificate has an associated private key.
UsedCertPrivateKeyExtractableIndicates whether the private key is extractable.
UsedCertPublicKeyBytesContains the certificate's public key in DER format.
UsedCertQualifiedStatementsReturns the qualified status of the certificate.
UsedCertSelfSignedIndicates whether the certificate is self-signed (root) or signed by an external CA.
UsedCertSerialNumberReturns the certificate's serial number.
UsedCertSigAlgorithmIndicates the algorithm that was used by the CA to sign this certificate.
UsedCertSubjectThe common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
UsedCertSubjectAlternativeNameReturns or sets the value of the Subject Alternative Name extension of the certificate.
UsedCertSubjectKeyIDContains a unique identifier (fingerprint) of the certificate's private key.
UsedCertSubjectRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
UsedCertValidFromThe time point at which the certificate becomes valid, in UTC.
UsedCertValidToThe time point at which the certificate expires, in UTC.
UsedCRLCountThe number of records in the UsedCRL arrays.
UsedCRLBytesReturns the raw CRL data in DER format.
UsedCRLHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UsedCRLIssuerThe common name of the CRL issuer (CA), typically a company name.
UsedCRLIssuerRDNA collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
UsedCRLLocationThe URL that the CRL was downloaded from.
UsedCRLNextUpdateThe planned time and date of the next version of this CRL to be published.
UsedCRLThisUpdateThe date and time at which this version of the CRL was published.
UseDefaultTSLsEnables or disables the use of the default TSLs.
UsedOCSPCountThe number of records in the UsedOCSP arrays.
UsedOCSPBytesA buffer containing the raw OCSP response data.
UsedOCSPHandleAllows to get or set a 'handle', a unique identifier of the underlying property object.
UsedOCSPIssuerIndicates the issuer of this response (a CA or its authorized representative).
UsedOCSPIssuerRDNIndicates the RDN of the issuer of this response (a CA or its authorized representative).
UsedOCSPLocationThe location of the OCSP responder.
UsedOCSPProducedAtSpecifies the time when the response was produced, in UTC.
UseSystemCertificatesEnables or disables the use of the system certificates.
ValidationLogContains the complete log of the certificate validation routine.
ValidationMomentThe 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.

ConfigSets or retrieves a configuration setting.
DoActionPerforms an additional action.
GetQualifiedStatusObtains the qualified information for Certificate .
GetTSLPropertyReturns a specific TSL property.
RefreshCacheRefreshes the certificate cache.
ResetCacheClears all data contained in the validation cache.
TerminateTerminates the validation process.
ValidateValidates the certificate chain.
ValidateForSMIMEValidates an e-mail signing certificate.
ValidateForSSLValidates 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.

AfterCertificateProcessingMarks the end of a single certificate processing step.
AfterCertificateValidationMarks the end of a single certificate validation step.
BeforeCACertificateDownloadFires when a CA certificate is about to be downloaded.
BeforeCertificateProcessingReports the start of certificate processing.
BeforeCertificateValidationReports the start of certificate validation.
BeforeCRLDownloadFires when a CRL is about to be downloaded.
BeforeOCSPDownloadFires when a certificate's OCSP status is about to be requested.
CACertificateDownloadedMarks the success of a certificate download.
CACertificateNeededRequests a missing certificate from the user.
CRLDownloadedMarks the success of a CRL download.
CRLNeededRequests a missing CRL from the user.
ErrorInformation about errors during certificate validation.
NotificationThis event notifies the application about an underlying control flow event.
OCSPDownloadedMarks the success of an OCSP request.
TLSCertNeededFires when a remote TLS party requests a client certificate.
TLSCertValidateThis event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
TLSEstablishedFires when a TLS handshake with Host successfully completes.
TLSHandshakeFires when a new TLS handshake is initiated, before the handshake commences.
TLSShutdownReports 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.

CacheValidityTimeTime period during which to keep validation cache.
CheckStrongAlgorithmForTrustedWhether to check a 'strong' hash algorithm for trusted certificates.
CheckValidityPeriodForTrustedWhether to check validity period for trusted certificates.
CrossCertificationValidationStrategyDefines how the cross certification validation is performed.
DislikeOpenEndedOCSPsTells the class to discourage OCSP responses without an explicit NextUpdate parameter.
ForceCompleteChainValidationForTrustedWhether to validate the whole chain.
ForceRevocationCheckForRootWhether to check revocation info for root certificates.
IgnoreBadOCSPChainsWhether to ignore bad OCSP chains during validation.
IgnoreCABasicConstraintsWhether to ignore the Basic Constraints extension for the CA certificates.
IgnoreCAKeyUsageWhether to ignore Key Usage extension for CA certificates.
IgnoreCANameConstraintsWhether to ignore the Name Constraints extension for the CA certificates.
IgnoreChainLoopsWhether chain loops should be ignored.
IgnoreOCSPNoCheckExtensionWhether the OCSP NoCheck extension should be ignored.
IgnoreRevocationKeyUsageWhether to check the CA certs used to sign revocation info.
IgnoreSSLKeyUsageWhether to check the CA certs used in SSL/TLS.
IgnoreSystemTrustWhether trusted Windows Certificate Stores should be treated as trusted.
ImplicitlyTrustSelfSignedCertificatesWhether to trust self-signed certificates.
LookupCRLByNameIfDPNotPresentWhether to look for implicit CRL Distribution Points.
PromoteLongOCSPResponsesWhether long OCSP responses are requested.
RevocationMomentGracePeriodGrace period for revocation information propagation.
SkipSubjectNameIfAltNameExistsWhether to check CommonName if SubjectAltName is present.
UseMicrosoftCTLEnables or disables the automatic use of the Microsoft online certificate trust list.
UseValidationCacheEnables or disable the use of the product-wide certificate chain validation cache.
ValidateInvalidCertificatesWhether to do all checks on invalid certificates.
WeakAlgorithmHandlingModeHow to handle certificates signed with a 'weak' hash algorithm.
CustomTSLsSpecifies the custom TSLs.
QualifiedStatusIndicates a qualified electronic signature.
TSLContentSpecifies the TrustedList content.
TSLContentHexSpecifies the TrustedList content.
TSLDistributionPointsContains XML content of distribution points of the TSL used.
TSLDistributionPoints[Idx]Contains distribution point of the specified index of the TSL used.
TSLHistoricalInformationPeriodContains historical information period of the TSL used.
TSLLegalNoticesContains XML content of legal notices of the TSL used.
TSLLegalNotices[lang]Contains legal notices for the specified language of the TSL used.
TSLListIssueDateTimeContains list issue date and time of the TSL used.
TSLNextUpdateContains next update date and time of the TSL used.
TSLPoliciesContains XML content of policies of the TSL used.
TSLPolicies[lang]Contains policies for the specified language of the TSL used.
TSLSchemeExtensionsContains 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.
TSLSchemeInformationURIContains XML content of scheme information URI of the TSL used.
TSLSchemeInformationURI[lang]Contains scheme information URI for the specified language of the TSL used.
TSLSchemeNameContains XML content of scheme name of the TSL used.
TSLSchemeName[lang]Contains scheme name for the specified language of the TSL used.
TSLSchemeOperatorAddressContains XML content of scheme operator address of the TSL used.
TSLSchemeOperatorNameContains XML content of scheme operator name of the TSL used.
TSLSchemeOperatorName[lang]Contains scheme operator name for the specified language of the TSL used.
TSLSchemeTerritoryContains scheme territory of the TSL used.
TSLSchemeTypeCommunityRulesContains 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.
TSLSequenceNumberContains sequence number of the TSL used.
TSLsRetrieveLogContains the complete log of the TSLs retrieve.
TSLStatusDeterminationApproachContains status determination approach of the TSL used.
TSLsValidationLogContains the complete log of the TSLs validation.
TSLTSPAdditionalServiceInformationContains addtional service information of the TSP service used.
TSLTSPAddressContains XML content of the address of the TSP used.
TSLTSPHistoryInstanceIndicates that TSP service history instance used.
TSLTSPHistoryInstanceAdditionalServiceInformationContains addtional service information of the TSP service history instance used.
TSLTSPHistoryInstanceQualifiersContains list of qualifiers of the TSP service history instance used.
TSLTSPHistoryInstanceServiceInformationExtensionsContains 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.
TSLTSPHistoryInstanceServiceNameContains 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.
TSLTSPHistoryInstanceServiceStatusContains status of the TSP service history instance used.
TSLTSPHistoryInstanceServiceStatusStartingTimeContains status starting time of the TSP service history instance used.
TSLTSPHistoryInstanceServiceTypeIdentifierContains type identifier of the TSP service history instance used.
TSLTSPHistoryInstanceXMLContains XML content of the TSP service history instance used.
TSLTSPInformationExtensionsContains 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.
TSLTSPInformationURIContains XML content of information URI of the TSP used.
TSLTSPInformationURI[lang]Contains information URI for the specified language of the TSP used.
TSLTSPNameContains XML content of name of the TSP used.
TSLTSPName[lang]Contains name for the specified language of the TSP used.
TSLTSPSchemeServiceDefinitionURIContains 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.
TSLTSPServiceDefinitionURIContains XML content of definition URI of the TSP service used.
TSLTSPServiceDefinitionURI[lang]Contains definition URI for the specified language of the TSP service used.
TSLTSPServiceInformationExtensionsContains 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.
TSLTSPServiceNameContains XML content of name of the TSP service used.
TSLTSPServiceName[lang]Contains name for the specified language of the TSP service used.
TSLTSPServiceQualifiersContains list of qualifiers of the TSP service used.
TSLTSPServiceStatusContains status of the TSP service used.
TSLTSPServiceStatusStartingTimeContains status starting time of the TSP service used.
TSLTSPServiceSupplyPointsContains XML content of the supply points of the TSP service used.
TSLTSPServiceTypeIdentifierContains type identifier of the TSP service used.
TSLTSPServiceXMLContains XML content of the TSP service used.
TSLTSPTradeNameContains XML content of trade name of the TSP used.
TSLTSPTradeName[lang]Contains trade name for the specified language of the TSP used.
TSLTSPXMLContains XML content of the TSP used.
TSLTypeContains TSL type of the TSL used.
TSLVersionIdentifierContains version identifier of the TSL used.
TSLXMLContains XML content of the TSL used.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the class.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client classes should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

BlockedCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the BlockedCert arrays.

Object Oriented Interface


public function getBlockedCertCount();


public function setBlockedCertCount($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 1 );


secureblackbox_certificatevalidator_set($res, 1, $value );

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

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getBlockedCertBytes($blockedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 2 , $blockedcertindex);


Remarks

Returns the raw certificate data in DER format.

The $blockedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

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

Data Type

Byte Array

BlockedCertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getBlockedCertHandle($blockedcertindex);


public function setBlockedCertHandle($blockedcertindex, $value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 9 , $blockedcertindex);


secureblackbox_certificatevalidator_set($res, 9, $value , $blockedcertindex);

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

Enables or disables validation result caching.

Object Oriented Interface


public function getCacheValidationResults();


public function setCacheValidationResults($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 36 );


secureblackbox_certificatevalidator_set($res, 36, $value );

Default Value

false

Remarks

Set this property to True to enable caching of validation results.

Data Type

Boolean

CertBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getCertBytes();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 37 );


Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCertHandle();


public function setCertHandle($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 44 );


secureblackbox_certificatevalidator_set($res, 44, $value );

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

The details of a certificate chain validation outcome.

Object Oriented Interface


public function getChainValidationDetails();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 71 );


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:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

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

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

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

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

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

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

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

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

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

Data Type

Integer

ChainValidationResult Property (SecureBlackbox_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.

Object Oriented Interface


public function getChainValidationResult();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 72 );


Default Value

0

Remarks

Available options:

cvtValid0The chain is valid

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

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

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

CurrentCACertBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getCurrentCACertBytes();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 73 );


Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CurrentCACertCA Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCACertCA();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 74 );


Default Value

false

Remarks

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

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

Data Type

Boolean

CurrentCACertCAKeyID Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCACertCAKeyID();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 75 );


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

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

Object Oriented Interface


public function getCurrentCACertCRLDistributionPoints();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 76 );


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

Specifies the elliptic curve of the EC public key.

Object Oriented Interface


public function getCurrentCACertCurve();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 77 );


Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

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

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

Data Type

String

CurrentCACertFingerprint Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCACertFingerprint();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 78 );


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

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

Object Oriented Interface


public function getCurrentCACertFriendlyName();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 79 );


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

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

Object Oriented Interface


public function getCurrentCACertHandle();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 80 );


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

Object Oriented Interface


public function getCurrentCACertHashAlgorithm();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 81 );


Default Value

''

Remarks

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

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

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

Data Type

String

CurrentCACertIssuer Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCACertIssuer();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 82 );


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

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

Object Oriented Interface


public function getCurrentCACertIssuerRDN();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 83 );


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

Specifies the public key algorithm of this certificate.

Object Oriented Interface


public function getCurrentCACertKeyAlgorithm();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 84 );


Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

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

Data Type

String

CurrentCACertKeyBits Property (SecureBlackbox_CertificateValidator Class)

Returns the length of the public key.

Object Oriented Interface


public function getCurrentCACertKeyBits();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 85 );


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

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

Object Oriented Interface


public function getCurrentCACertKeyFingerprint();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 86 );


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

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

Object Oriented Interface


public function getCurrentCACertKeyUsage();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 87 );


Default Value

0

Remarks

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

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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

Data Type

Integer

CurrentCACertKeyValid Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCACertKeyValid();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 88 );


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

Object Oriented Interface


public function getCurrentCACertOCSPLocations();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 89 );


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

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

Object Oriented Interface


public function getCurrentCACertOCSPNoCheck();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 90 );


Default Value

false

Remarks

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

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

Data Type

Boolean

CurrentCACertOrigin Property (SecureBlackbox_CertificateValidator Class)

Returns the origin of this certificate.

Object Oriented Interface


public function getCurrentCACertOrigin();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 91 );


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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface


public function getCurrentCACertPolicyIDs();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 92 );


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

Contains the certificate's private key.

Object Oriented Interface


public function getCurrentCACertPrivateKeyBytes();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 93 );


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

Indicates whether the certificate has an associated private key.

Object Oriented Interface


public function getCurrentCACertPrivateKeyExists();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 94 );


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

Indicates whether the private key is extractable.

Object Oriented Interface


public function getCurrentCACertPrivateKeyExtractable();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 95 );


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

Contains the certificate's public key in DER format.

Object Oriented Interface


public function getCurrentCACertPublicKeyBytes();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 96 );


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

Returns the qualified status of the certificate.

Object Oriented Interface


public function getCurrentCACertQualifiedStatements();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 97 );


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

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

Object Oriented Interface


public function getCurrentCACertSelfSigned();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 98 );


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

Returns the certificate's serial number.

Object Oriented Interface


public function getCurrentCACertSerialNumber();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 99 );


Remarks

Returns the certificate's serial number.

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

Data Type

Byte Array

CurrentCACertSigAlgorithm Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCACertSigAlgorithm();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 100 );


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

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

Object Oriented Interface


public function getCurrentCACertSubject();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 101 );


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

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

Object Oriented Interface


public function getCurrentCACertSubjectAlternativeName();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 102 );


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

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

Object Oriented Interface


public function getCurrentCACertSubjectKeyID();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 103 );


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

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

Object Oriented Interface


public function getCurrentCACertSubjectRDN();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 104 );


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

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

Object Oriented Interface


public function getCurrentCACertValidFrom();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 105 );


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

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

Object Oriented Interface


public function getCurrentCACertValidTo();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 106 );


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

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getCurrentCertBytes();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 107 );


Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

CurrentCertCA Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCertCA();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 108 );


Default Value

false

Remarks

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

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

Data Type

Boolean

CurrentCertCAKeyID Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCertCAKeyID();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 109 );


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

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

Object Oriented Interface


public function getCurrentCertCRLDistributionPoints();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 110 );


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

Specifies the elliptic curve of the EC public key.

Object Oriented Interface


public function getCurrentCertCurve();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 111 );


Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

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

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

Data Type

String

CurrentCertFingerprint Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCertFingerprint();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 112 );


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

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

Object Oriented Interface


public function getCurrentCertFriendlyName();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 113 );


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

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

Object Oriented Interface


public function getCurrentCertHandle();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 114 );


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

Object Oriented Interface


public function getCurrentCertHashAlgorithm();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 115 );


Default Value

''

Remarks

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

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

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

Data Type

String

CurrentCertIssuer Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCertIssuer();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 116 );


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

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

Object Oriented Interface


public function getCurrentCertIssuerRDN();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 117 );


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

Specifies the public key algorithm of this certificate.

Object Oriented Interface


public function getCurrentCertKeyAlgorithm();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 118 );


Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

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

Data Type

String

CurrentCertKeyBits Property (SecureBlackbox_CertificateValidator Class)

Returns the length of the public key.

Object Oriented Interface


public function getCurrentCertKeyBits();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 119 );


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

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

Object Oriented Interface


public function getCurrentCertKeyFingerprint();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 120 );


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

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

Object Oriented Interface


public function getCurrentCertKeyUsage();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 121 );


Default Value

0

Remarks

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

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

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

Data Type

Integer

CurrentCertKeyValid Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCertKeyValid();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 122 );


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

Object Oriented Interface


public function getCurrentCertOCSPLocations();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 123 );


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

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

Object Oriented Interface


public function getCurrentCertOCSPNoCheck();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 124 );


Default Value

false

Remarks

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

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

Data Type

Boolean

CurrentCertOrigin Property (SecureBlackbox_CertificateValidator Class)

Returns the origin of this certificate.

Object Oriented Interface


public function getCurrentCertOrigin();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 125 );


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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface


public function getCurrentCertPolicyIDs();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 126 );


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

Contains the certificate's private key.

Object Oriented Interface


public function getCurrentCertPrivateKeyBytes();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 127 );


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

Indicates whether the certificate has an associated private key.

Object Oriented Interface


public function getCurrentCertPrivateKeyExists();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 128 );


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

Indicates whether the private key is extractable.

Object Oriented Interface


public function getCurrentCertPrivateKeyExtractable();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 129 );


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

Contains the certificate's public key in DER format.

Object Oriented Interface


public function getCurrentCertPublicKeyBytes();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 130 );


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

Returns the qualified status of the certificate.

Object Oriented Interface


public function getCurrentCertQualifiedStatements();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 131 );


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

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

Object Oriented Interface


public function getCurrentCertSelfSigned();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 132 );


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

Returns the certificate's serial number.

Object Oriented Interface


public function getCurrentCertSerialNumber();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 133 );


Remarks

Returns the certificate's serial number.

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

Data Type

Byte Array

CurrentCertSigAlgorithm Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getCurrentCertSigAlgorithm();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 134 );


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

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

Object Oriented Interface


public function getCurrentCertSubject();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 135 );


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

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

Object Oriented Interface


public function getCurrentCertSubjectAlternativeName();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 136 );


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

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

Object Oriented Interface


public function getCurrentCertSubjectKeyID();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 137 );


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

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

Object Oriented Interface


public function getCurrentCertSubjectRDN();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 138 );


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

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

Object Oriented Interface


public function getCurrentCertValidFrom();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 139 );


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

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

Object Oriented Interface


public function getCurrentCertValidTo();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 140 );


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

Reserved.

Object Oriented Interface


public function getFIPSMode();


public function setFIPSMode($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 141 );


secureblackbox_certificatevalidator_set($res, 141, $value );

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

GracePeriod Property (SecureBlackbox_CertificateValidator Class)

Specifies a grace period to apply during certificate validation.

Object Oriented Interface


public function getGracePeriod();


public function setGracePeriod($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 142 );


secureblackbox_certificatevalidator_set($res, 142, $value );

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

Contains the validation details of the moment.

Object Oriented Interface


public function getInterimValidationDetails();


public function setInterimValidationDetails($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 143 );


secureblackbox_certificatevalidator_set($res, 143, $value );

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:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

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

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

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

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

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

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

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

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

This property is not available at design time.

Data Type

Integer

InterimValidationResult Property (SecureBlackbox_CertificateValidator Class)

Contains the validation status of the moment.

Object Oriented Interface


public function getInterimValidationResult();


public function setInterimValidationResult($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 144 );


secureblackbox_certificatevalidator_set($res, 144, $value );

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.

cvtValid0The chain is valid

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

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

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

This property is not available at design time.

Data Type

Integer

KnownCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the KnownCert arrays.

Object Oriented Interface


public function getKnownCertCount();


public function setKnownCertCount($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 145 );


secureblackbox_certificatevalidator_set($res, 145, $value );

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

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getKnownCertBytes($knowncertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 146 , $knowncertindex);


Remarks

Returns the raw certificate data in DER format.

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

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

Data Type

Byte Array

KnownCertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getKnownCertHandle($knowncertindex);


public function setKnownCertHandle($knowncertindex, $value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 153 , $knowncertindex);


secureblackbox_certificatevalidator_set($res, 153, $value , $knowncertindex);

Default Value

0

Remarks

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

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. 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 (SecureBlackbox_CertificateValidator Class)

The number of records in the KnownCRL arrays.

Object Oriented Interface


public function getKnownCRLCount();


public function setKnownCRLCount($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 180 );


secureblackbox_certificatevalidator_set($res, 180, $value );

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

Returns the raw CRL data in DER format.

Object Oriented Interface


public function getKnownCRLBytes($knowncrlindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 181 , $knowncrlindex);


Remarks

Returns the raw CRL data in DER format.

The $knowncrlindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

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

Data Type

Byte Array

KnownCRLHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getKnownCRLHandle($knowncrlindex);


public function setKnownCRLHandle($knowncrlindex, $value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 184 , $knowncrlindex);


secureblackbox_certificatevalidator_set($res, 184, $value , $knowncrlindex);

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

The number of records in the KnownOCSP arrays.

Object Oriented Interface


public function getKnownOCSPCount();


public function setKnownOCSPCount($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 192 );


secureblackbox_certificatevalidator_set($res, 192, $value );

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

A buffer containing the raw OCSP response data.

Object Oriented Interface


public function getKnownOCSPBytes($knownocspindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 193 , $knownocspindex);


Remarks

A buffer containing the raw OCSP response data.

The $knownocspindex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

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

Data Type

Byte Array

KnownOCSPHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getKnownOCSPHandle($knownocspindex);


public function setKnownOCSPHandle($knownocspindex, $value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 195 , $knownocspindex);


secureblackbox_certificatevalidator_set($res, 195, $value , $knownocspindex);

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

Specifies the maximum time the validation process may take.

Object Oriented Interface


public function getMaxValidationTime();


public function setMaxValidationTime($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 200 );


secureblackbox_certificatevalidator_set($res, 200, $value );

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

Switches the class to offline mode.

Object Oriented Interface


public function getOfflineMode();


public function setOfflineMode($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 201 );


secureblackbox_certificatevalidator_set($res, 201, $value );

Default Value

false

Remarks

When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.

Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.

Data Type

Boolean

ProxyAddress Property (SecureBlackbox_CertificateValidator Class)

The IP address of the proxy server.

Object Oriented Interface


public function getProxyAddress();


public function setProxyAddress($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 202 );


secureblackbox_certificatevalidator_set($res, 202, $value );

Default Value

''

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SecureBlackbox_CertificateValidator Class)

The authentication type used by the proxy server.

Object Oriented Interface


public function getProxyAuthentication();


public function setProxyAuthentication($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 203 );


secureblackbox_certificatevalidator_set($res, 203, $value );

Default Value

0

Remarks

The authentication type used by the proxy server.

patNoAuthentication0
patBasic1
patDigest2
patNTLM3

Data Type

Integer

ProxyPassword Property (SecureBlackbox_CertificateValidator Class)

The password to authenticate to the proxy server.

Object Oriented Interface


public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 204 );


secureblackbox_certificatevalidator_set($res, 204, $value );

Default Value

''

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SecureBlackbox_CertificateValidator Class)

The port on the proxy server to connect to.

Object Oriented Interface


public function getProxyPort();


public function setProxyPort($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 205 );


secureblackbox_certificatevalidator_set($res, 205, $value );

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SecureBlackbox_CertificateValidator Class)

The type of the proxy server.

Object Oriented Interface


public function getProxyProxyType();


public function setProxyProxyType($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 206 );


secureblackbox_certificatevalidator_set($res, 206, $value );

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.

cptNone0
cptSocks41
cptSocks52
cptWebTunnel3
cptHTTP4

Data Type

Integer

ProxyRequestHeaders Property (SecureBlackbox_CertificateValidator Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Object Oriented Interface


public function getProxyRequestHeaders();


public function setProxyRequestHeaders($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 207 );


secureblackbox_certificatevalidator_set($res, 207, $value );

Default Value

''

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SecureBlackbox_CertificateValidator Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Object Oriented Interface


public function getProxyResponseBody();


public function setProxyResponseBody($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 208 );


secureblackbox_certificatevalidator_set($res, 208, $value );

Default Value

''

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (SecureBlackbox_CertificateValidator Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Object Oriented Interface


public function getProxyResponseHeaders();


public function setProxyResponseHeaders($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 209 );


secureblackbox_certificatevalidator_set($res, 209, $value );

Default Value

''

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (SecureBlackbox_CertificateValidator Class)

Specifies whether IPv6 should be used when connecting through the proxy.

Object Oriented Interface


public function getProxyUseIPv6();


public function setProxyUseIPv6($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 210 );


secureblackbox_certificatevalidator_set($res, 210, $value );

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUseProxy Property (SecureBlackbox_CertificateValidator Class)

Enables or disables proxy-driven connection.

Object Oriented Interface


public function getProxyUseProxy();


public function setProxyUseProxy($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 211 );


secureblackbox_certificatevalidator_set($res, 211, $value );

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SecureBlackbox_CertificateValidator Class)

Specifies the username credential for proxy authentication.

Object Oriented Interface


public function getProxyUsername();


public function setProxyUsername($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 212 );


secureblackbox_certificatevalidator_set($res, 212, $value );

Default Value

''

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

QualifiedInfoAddress Property (SecureBlackbox_CertificateValidator Class)

Contains the address of the TSL provider.

Object Oriented Interface


public function getQualifiedInfoAddress();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 213 );


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

The list of custom TSLs to use.

Object Oriented Interface


public function getQualifiedInfoCustomTSLs();


public function setQualifiedInfoCustomTSLs($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 214 );


secureblackbox_certificatevalidator_set($res, 214, $value );

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

Contains the TLS download log.

Object Oriented Interface


public function getQualifiedInfoDownloadLog();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 215 );


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

Contains the URI of the provider information.

Object Oriented Interface


public function getQualifiedInfoInformationURI();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 216 );


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

The preferred language(s) for TSL data.

Object Oriented Interface


public function getQualifiedInfoLanguages();


public function setQualifiedInfoLanguages($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 217 );


secureblackbox_certificatevalidator_set($res, 217, $value );

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

Returns the next update date and time of the TSL.

Object Oriented Interface


public function getQualifiedInfoNextUpdate();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 218 );


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

Contains the name of the TSL provider.

Object Oriented Interface


public function getQualifiedInfoProvider();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 219 );


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

Indicates whether the certificate is qualified.

Object Oriented Interface


public function getQualifiedInfoQualified();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 220 );


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

A list of qualifiers.

Object Oriented Interface


public function getQualifiedInfoQualifiers();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 221 );


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

Contains the name of the TSL service.

Object Oriented Interface


public function getQualifiedInfoServiceName();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 222 );


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

Contains the TSL service type identifier.

Object Oriented Interface


public function getQualifiedInfoServiceTypeId();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 223 );


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

The source of qualified information.

Object Oriented Interface


public function getQualifiedInfoSource();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 224 );


Default Value

0

Remarks

The source of qualified information.

Available options:

qisUnknown0The source is unknown

qisCertificate1The information was taken from the certificate

qisTSL2The information was taken from an online TSL

qisBoth3The 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 (SecureBlackbox_CertificateValidator Class)

Indicates a qualified electronic signature.

Object Oriented Interface


public function getQualifiedInfoStatus();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 225 );


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:

sqsUnknown0Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI.

sqsNone1None

sqsGranted2Granted

sqsWithdrawn3Withdrawn

sqsSetByNationalLaw4Set by national law

sqsDeprecatedByNationalLaw5Deprecated by national law

sqsRecognizedAtNationalLevel6Recognized at national level

sqsDeprecatedAtNationalLevel7Deprecated at national level

sqsUnderSupervision8Under supervision

sqsSupervisionInCessation9Supervision in cessation

sqsSupervisionCeased10Supervision ceased

sqsSupervisionRevoked11Supervision revoked

sqsAccredited12Accredited

sqsAccreditationCeased13Accreditation ceased

sqsAccreditationRevoked14Accreditation revoked

sqsInAccordance15Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes).

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

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

sqsRevoked18Deprecated. 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).

sqsNotInAccordance19Deprecated. 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 (SecureBlackbox_CertificateValidator Class)

Contains the trade name of the TSL provider.

Object Oriented Interface


public function getQualifiedInfoTradeName();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 226 );


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

Use this setting to enable or disable the use of the default TSLs.

Object Oriented Interface


public function getQualifiedInfoUseDefaultTSLs();


public function setQualifiedInfoUseDefaultTSLs($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 227 );


secureblackbox_certificatevalidator_set($res, 227, $value );

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

Contains the TLS validation log.

Object Oriented Interface


public function getQualifiedInfoValidationLog();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 228 );


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

Contains the XML of the TSL.

Object Oriented Interface


public function getQualifiedInfoXML();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 229 );


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

Specifies the kind(s) of revocation check to perform for all chain certificates.

Object Oriented Interface


public function getRevocationCheck();


public function setRevocationCheck($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 230 );


secureblackbox_certificatevalidator_set($res, 230, $value );

Default Value

1

Remarks

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Data Type

Integer

SocketDNSMode Property (SecureBlackbox_CertificateValidator Class)

Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.

Object Oriented Interface


public function getSocketDNSMode();


public function setSocketDNSMode($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 231 );


secureblackbox_certificatevalidator_set($res, 231, $value );

Default Value

0

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

dmAuto0
dmPlatform1
dmOwn2
dmOwnSecure3

Data Type

Integer

SocketDNSPort Property (SecureBlackbox_CertificateValidator Class)

Specifies the port number to be used for sending queries to the DNS server.

Object Oriented Interface


public function getSocketDNSPort();


public function setSocketDNSPort($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 232 );


secureblackbox_certificatevalidator_set($res, 232, $value );

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (SecureBlackbox_CertificateValidator Class)

The timeout (in milliseconds) for each DNS query.

Object Oriented Interface


public function getSocketDNSQueryTimeout();


public function setSocketDNSQueryTimeout($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 233 );


secureblackbox_certificatevalidator_set($res, 233, $value );

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketDNSServers Property (SecureBlackbox_CertificateValidator Class)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Object Oriented Interface


public function getSocketDNSServers();


public function setSocketDNSServers($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 234 );


secureblackbox_certificatevalidator_set($res, 234, $value );

Default Value

''

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (SecureBlackbox_CertificateValidator Class)

The timeout (in milliseconds) for the whole resolution process.

Object Oriented Interface


public function getSocketDNSTotalTimeout();


public function setSocketDNSTotalTimeout($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 235 );


secureblackbox_certificatevalidator_set($res, 235, $value );

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (SecureBlackbox_CertificateValidator Class)

The maximum number of bytes to read from the socket, per second.

Object Oriented Interface


public function getSocketIncomingSpeedLimit();


public function setSocketIncomingSpeedLimit($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 236 );


secureblackbox_certificatevalidator_set($res, 236, $value );

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (SecureBlackbox_CertificateValidator Class)

The local network interface to bind the socket to.

Object Oriented Interface


public function getSocketLocalAddress();


public function setSocketLocalAddress($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 237 );


secureblackbox_certificatevalidator_set($res, 237, $value );

Default Value

''

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SecureBlackbox_CertificateValidator Class)

The local port number to bind the socket to.

Object Oriented Interface


public function getSocketLocalPort();


public function setSocketLocalPort($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 238 );


secureblackbox_certificatevalidator_set($res, 238, $value );

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SecureBlackbox_CertificateValidator Class)

The maximum number of bytes to write to the socket, per second.

Object Oriented Interface


public function getSocketOutgoingSpeedLimit();


public function setSocketOutgoingSpeedLimit($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 239 );


secureblackbox_certificatevalidator_set($res, 239, $value );

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (SecureBlackbox_CertificateValidator Class)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Object Oriented Interface


public function getSocketTimeout();


public function setSocketTimeout($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 240 );


secureblackbox_certificatevalidator_set($res, 240, $value );

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

Enables or disables IP protocol version 6.

Object Oriented Interface


public function getSocketUseIPv6();


public function setSocketUseIPv6($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 241 );


secureblackbox_certificatevalidator_set($res, 241, $value );

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSClientCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the TLSClientCert arrays.

Object Oriented Interface


public function getTLSClientCertCount();


public function setTLSClientCertCount($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 242 );


secureblackbox_certificatevalidator_set($res, 242, $value );

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

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getTLSClientCertBytes($tlsclientcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 243 , $tlsclientcertindex);


Remarks

Returns the raw certificate data in DER format.

The $tlsclientcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

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

Data Type

Byte Array

TLSClientCertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getTLSClientCertHandle($tlsclientcertindex);


public function setTLSClientCertHandle($tlsclientcertindex, $value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 250 , $tlsclientcertindex);


secureblackbox_certificatevalidator_set($res, 250, $value , $tlsclientcertindex);

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

The number of records in the TLSServerCert arrays.

Object Oriented Interface


public function getTLSServerCertCount();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 277 );


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

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getTLSServerCertBytes($tlsservercertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 278 , $tlsservercertindex);


Remarks

Returns the raw certificate data in DER format.

The $tlsservercertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getTLSServerCertHandle($tlsservercertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 285 , $tlsservercertindex);


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

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Object Oriented Interface


public function getTLSAutoValidateCertificates();


public function setTLSAutoValidateCertificates($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 312 );


secureblackbox_certificatevalidator_set($res, 312, $value );

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (SecureBlackbox_CertificateValidator Class)

Selects the base configuration for the TLS settings.

Object Oriented Interface


public function getTLSBaseConfiguration();


public function setTLSBaseConfiguration($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 313 );


secureblackbox_certificatevalidator_set($res, 313, $value );

Default Value

0

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

stpcDefault0
stpcCompatible1
stpcComprehensiveInsecure2
stpcHighlySecure3

Data Type

Integer

TLSCiphersuites Property (SecureBlackbox_CertificateValidator Class)

A list of ciphersuites separated with commas or semicolons.

Object Oriented Interface


public function getTLSCiphersuites();


public function setTLSCiphersuites($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 314 );


secureblackbox_certificatevalidator_set($res, 314, $value );

Default Value

''

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. 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 (SecureBlackbox_CertificateValidator Class)

Defines the elliptic curves to enable.

Object Oriented Interface


public function getTLSECCurves();


public function setTLSECCurves($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 315 );


secureblackbox_certificatevalidator_set($res, 315, $value );

Default Value

''

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (SecureBlackbox_CertificateValidator Class)

Provides access to TLS extensions.

Object Oriented Interface


public function getTLSExtensions();


public function setTLSExtensions($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 316 );


secureblackbox_certificatevalidator_set($res, 316, $value );

Default Value

''

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (SecureBlackbox_CertificateValidator Class)

Whether to force TLS session resumption when the destination address changes.

Object Oriented Interface


public function getTLSForceResumeIfDestinationChanges();


public function setTLSForceResumeIfDestinationChanges($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 317 );


secureblackbox_certificatevalidator_set($res, 317, $value );

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (SecureBlackbox_CertificateValidator Class)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Object Oriented Interface


public function getTLSPreSharedIdentity();


public function setTLSPreSharedIdentity($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 318 );


secureblackbox_certificatevalidator_set($res, 318, $value );

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

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Object Oriented Interface


public function getTLSPreSharedKey();


public function setTLSPreSharedKey($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 319 );


secureblackbox_certificatevalidator_set($res, 319, $value );

Default Value

''

Remarks

Contains the pre-shared key 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 (SecureBlackbox_CertificateValidator Class)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Object Oriented Interface


public function getTLSPreSharedKeyCiphersuite();


public function setTLSPreSharedKeyCiphersuite($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 320 );


secureblackbox_certificatevalidator_set($res, 320, $value );

Default Value

''

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (SecureBlackbox_CertificateValidator Class)

Selects the renegotiation attack prevention mechanism.

Object Oriented Interface


public function getTLSRenegotiationAttackPreventionMode();


public function setTLSRenegotiationAttackPreventionMode($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 321 );


secureblackbox_certificatevalidator_set($res, 321, $value );

Default Value

0

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

crapmCompatible0TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled).
crapmStrict1Renegotiation attack prevention is enabled and enforced.
crapmAuto2Automatically choose whether to enable or disable renegotiation attack prevention.

Data Type

Integer

TLSRevocationCheck Property (SecureBlackbox_CertificateValidator Class)

Specifies the kind(s) of revocation check to perform.

Object Oriented Interface


public function getTLSRevocationCheck();


public function setTLSRevocationCheck($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 322 );


secureblackbox_certificatevalidator_set($res, 322, $value );

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.

crcNone0No revocation checking.
crcAuto1Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future.
crcAllCRL2All provided CRL endpoints will be checked, and all checks must succeed.
crcAllOCSP3All provided OCSP endpoints will be checked, and all checks must succeed.
crcAllCRLAndOCSP4All provided CRL and OCSP endpoints will be checked, and all checks must succeed.
crcAnyCRL5All provided CRL endpoints will be checked, and at least one check must succeed.
crcAnyOCSP6All provided OCSP endpoints will be checked, and at least one check must succeed.
crcAnyCRLOrOCSP7All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first.
crcAnyOCSPOrCRL8All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (SecureBlackbox_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.

Object Oriented Interface


public function getTLSSSLOptions();


public function setTLSSSLOptions($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 323 );


secureblackbox_certificatevalidator_set($res, 323, $value );

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

cssloExpectShutdownMessage0x001Wait for the close-notify message when shutting down the connection

cssloOpenSSLDTLSWorkaround0x002(DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions

cssloDisableKexLengthAlignment0x004Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it.

cssloForceUseOfClientCertHashAlg0x008Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it.

cssloAutoAddServerNameExtension0x010Automatically add the server name extension when known

cssloAcceptTrustedSRPPrimesOnly0x020Accept trusted SRP primes only

cssloDisableSignatureAlgorithmsExtension0x040Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it.

cssloIntolerateHigherProtocolVersions0x080(server option) Do not allow fallback from TLS versions higher than currently enabled

cssloStickToPrefCertHashAlg0x100Stick to preferred certificate hash algorithms

cssloNoImplicitTLS12Fallback0x200Disable implicit TLS 1.3 to 1.2 fallbacks

cssloUseHandshakeBatches0x400Send the handshake message as large batches rather than individually

Data Type

Integer

TLSTLSMode Property (SecureBlackbox_CertificateValidator Class)

Specifies the TLS mode to use.

Object Oriented Interface


public function getTLSTLSMode();


public function setTLSTLSMode($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 324 );


secureblackbox_certificatevalidator_set($res, 324, $value );

Default Value

0

Remarks

Specifies the TLS mode to use.

smDefault0
smNoTLS1Do not use TLS
smExplicitTLS2Connect to the server without any encryption and then request an SSL session.
smImplicitTLS3Connect to the specified port, and establish the SSL session at once.
smMixedTLS4Connect to the specified port, and establish the SSL session at once, but allow plain data.

Data Type

Integer

TLSUseExtendedMasterSecret Property (SecureBlackbox_CertificateValidator Class)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Object Oriented Interface


public function getTLSUseExtendedMasterSecret();


public function setTLSUseExtendedMasterSecret($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 325 );


secureblackbox_certificatevalidator_set($res, 325, $value );

Default Value

false

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (SecureBlackbox_CertificateValidator Class)

Enables or disables the TLS session resumption capability.

Object Oriented Interface


public function getTLSUseSessionResumption();


public function setTLSUseSessionResumption($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 326 );


secureblackbox_certificatevalidator_set($res, 326, $value );

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (SecureBlackbox_CertificateValidator Class)

The SSL/TLS versions to enable by default.

Object Oriented Interface


public function getTLSVersions();


public function setTLSVersions($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 327 );


secureblackbox_certificatevalidator_set($res, 327, $value );

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

csbSSL20x01SSL 2

csbSSL30x02SSL 3

csbTLS10x04TLS 1.0

csbTLS110x08TLS 1.1

csbTLS120x10TLS 1.2

csbTLS130x20TLS 1.3

Data Type

Integer

TrustedCertCount Property (SecureBlackbox_CertificateValidator Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface


public function getTrustedCertCount();


public function setTrustedCertCount($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 328 );


secureblackbox_certificatevalidator_set($res, 328, $value );

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

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getTrustedCertBytes($trustedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 329 , $trustedcertindex);


Remarks

Returns the raw certificate data in DER format.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

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

Data Type

Byte Array

TrustedCertHandle Property (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getTrustedCertHandle($trustedcertindex);


public function setTrustedCertHandle($trustedcertindex, $value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 336 , $trustedcertindex);


secureblackbox_certificatevalidator_set($res, 336, $value , $trustedcertindex);

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

The number of records in the UsedCert arrays.

Object Oriented Interface


public function getUsedCertCount();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 363 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

UsedCertBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw certificate data in DER format.

Object Oriented Interface


public function getUsedCertBytes($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 364 , $usedcertindex);


Remarks

Returns the 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 (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getUsedCertCA($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 365 , $usedcertindex);


Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in the 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 (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getUsedCertCAKeyID($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 366 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertCRLDistributionPoints($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 367 , $usedcertindex);


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

Specifies the elliptic curve of the EC public key.

Object Oriented Interface


public function getUsedCertCurve($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 368 , $usedcertindex);


Default Value

''

Remarks

Specifies the elliptic curve of the EC public key.

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

The $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 (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getUsedCertFingerprint($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 369 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertFriendlyName($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 370 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertHandle($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 371 , $usedcertindex);


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

Object Oriented Interface


public function getUsedCertHashAlgorithm($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 372 , $usedcertindex);


Default Value

''

Remarks

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

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

The $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 (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getUsedCertIssuer($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 373 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertIssuerRDN($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 374 , $usedcertindex);


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

Specifies the public key algorithm of this certificate.

Object Oriented Interface


public function getUsedCertKeyAlgorithm($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 375 , $usedcertindex);


Default Value

'0'

Remarks

Specifies the public key algorithm of this certificate.

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

The $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 (SecureBlackbox_CertificateValidator Class)

Returns the length of the public key.

Object Oriented Interface


public function getUsedCertKeyBits($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 376 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertKeyFingerprint($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 377 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertKeyUsage($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 378 , $usedcertindex);


Default Value

0

Remarks

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

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

The $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 (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getUsedCertKeyValid($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 379 , $usedcertindex);


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

Object Oriented Interface


public function getUsedCertOCSPLocations($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 380 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertOCSPNoCheck($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 381 , $usedcertindex);


Default Value

false

Remarks

Accessor to the value of the certificate's 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 (SecureBlackbox_CertificateValidator Class)

Returns the origin of this certificate.

Object Oriented Interface


public function getUsedCertOrigin($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 382 , $usedcertindex);


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

Contains identifiers (OIDs) of the applicable certificate policies.

Object Oriented Interface


public function getUsedCertPolicyIDs($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 383 , $usedcertindex);


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

Contains the certificate's private key.

Object Oriented Interface


public function getUsedCertPrivateKeyBytes($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 384 , $usedcertindex);


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

Indicates whether the certificate has an associated private key.

Object Oriented Interface


public function getUsedCertPrivateKeyExists($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 385 , $usedcertindex);


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

Indicates whether the private key is extractable.

Object Oriented Interface


public function getUsedCertPrivateKeyExtractable($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 386 , $usedcertindex);


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

Contains the certificate's public key in DER format.

Object Oriented Interface


public function getUsedCertPublicKeyBytes($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 387 , $usedcertindex);


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

Returns the qualified status of the certificate.

Object Oriented Interface


public function getUsedCertQualifiedStatements($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 388 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertSelfSigned($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 389 , $usedcertindex);


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

Returns the certificate's serial number.

Object Oriented Interface


public function getUsedCertSerialNumber($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 390 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertSigAlgorithm($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 391 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertSubject($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 392 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertSubjectAlternativeName($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 393 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertSubjectKeyID($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 394 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertSubjectRDN($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 395 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertValidFrom($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 396 , $usedcertindex);


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

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

Object Oriented Interface


public function getUsedCertValidTo($usedcertindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 397 , $usedcertindex);


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

The number of records in the UsedCRL arrays.

Object Oriented Interface


public function getUsedCRLCount();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 398 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

UsedCRLBytes Property (SecureBlackbox_CertificateValidator Class)

Returns the raw CRL data in DER format.

Object Oriented Interface


public function getUsedCRLBytes($usedcrlindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 399 , $usedcrlindex);


Remarks

Returns the 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 (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getUsedCRLHandle($usedcrlindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 402 , $usedcrlindex);


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

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

Object Oriented Interface


public function getUsedCRLIssuer($usedcrlindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 403 , $usedcrlindex);


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

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

Object Oriented Interface


public function getUsedCRLIssuerRDN($usedcrlindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 404 , $usedcrlindex);


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

The URL that the CRL was downloaded from.

Object Oriented Interface


public function getUsedCRLLocation($usedcrlindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 405 , $usedcrlindex);


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

The planned time and date of the next version of this CRL to be published.

Object Oriented Interface


public function getUsedCRLNextUpdate($usedcrlindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 406 , $usedcrlindex);


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

The date and time at which this version of the CRL was published.

Object Oriented Interface


public function getUsedCRLThisUpdate($usedcrlindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 409 , $usedcrlindex);


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

Enables or disables the use of the default TSLs.

Object Oriented Interface


public function getUseDefaultTSLs();


public function setUseDefaultTSLs($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 410 );


secureblackbox_certificatevalidator_set($res, 410, $value );

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

The number of records in the UsedOCSP arrays.

Object Oriented Interface


public function getUsedOCSPCount();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 411 );


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

A buffer containing the raw OCSP response data.

Object Oriented Interface


public function getUsedOCSPBytes($usedocspindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 412 , $usedocspindex);


Remarks

A buffer containing the 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 (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface


public function getUsedOCSPHandle($usedocspindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 414 , $usedocspindex);


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

Indicates the issuer of this response (a CA or its authorized representative).

Object Oriented Interface


public function getUsedOCSPIssuer($usedocspindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 415 , $usedocspindex);


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

Indicates the RDN of the issuer of this response (a CA or its authorized representative).

Object Oriented Interface


public function getUsedOCSPIssuerRDN($usedocspindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 416 , $usedocspindex);


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

The location of the OCSP responder.

Object Oriented Interface


public function getUsedOCSPLocation($usedocspindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 417 , $usedocspindex);


Default Value

''

Remarks

The 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 (SecureBlackbox_CertificateValidator Class)

Specifies the time when the response was produced, in UTC.

Object Oriented Interface


public function getUsedOCSPProducedAt($usedocspindex);


Procedural Interface


secureblackbox_certificatevalidator_get($res, 418 , $usedocspindex);


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

Enables or disables the use of the system certificates.

Object Oriented Interface


public function getUseSystemCertificates();


public function setUseSystemCertificates($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 419 );


secureblackbox_certificatevalidator_set($res, 419, $value );

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

Contains the complete log of the certificate validation routine.

Object Oriented Interface


public function getValidationLog();


Procedural Interface


secureblackbox_certificatevalidator_get($res, 420 );


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

The time point at which chain validity is to be established.

Object Oriented Interface


public function getValidationMoment();


public function setValidationMoment($value);

Procedural Interface


secureblackbox_certificatevalidator_get($res, 421 );


secureblackbox_certificatevalidator_set($res, 421, $value );

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

secureblackbox_certificatevalidator_do_config($res, $configurationstring);

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.

DoAction Method (SecureBlackbox_CertificateValidator Class)

Performs an additional action.

Object Oriented Interface

public function doDoAction($actionid, $actionparams);

Procedural Interface

secureblackbox_certificatevalidator_do_doaction($res, $actionid, $actionparams);

Remarks

DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

GetQualifiedStatus Method (SecureBlackbox_CertificateValidator Class)

Obtains the qualified information for Certificate .

Object Oriented Interface

public function doGetQualifiedStatus();

Procedural Interface

secureblackbox_certificatevalidator_do_getqualifiedstatus($res);

Remarks

Use this method to obtain a fresh qualified status for the certificate.

GetTSLProperty Method (SecureBlackbox_CertificateValidator Class)

Returns a specific TSL property.

Object Oriented Interface

public function doGetTSLProperty($propname, $language);

Procedural Interface

secureblackbox_certificatevalidator_do_gettslproperty($res, $propname, $language);

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

RefreshCache Method (SecureBlackbox_CertificateValidator Class)

Refreshes the certificate cache.

Object Oriented Interface

public function doRefreshCache();

Procedural Interface

secureblackbox_certificatevalidator_do_refreshcache($res);

Remarks

Use this method to remove obsolete information from the validation cache (only makes sense if CacheValidationResults is on).

ResetCache Method (SecureBlackbox_CertificateValidator Class)

Clears all data contained in the validation cache.

Object Oriented Interface

public function doResetCache();

Procedural Interface

secureblackbox_certificatevalidator_do_resetcache($res);

Remarks

Use this method to clear the validation cache (only makes sense if CacheValidationResults is on).

Terminate Method (SecureBlackbox_CertificateValidator Class)

Terminates the validation process.

Object Oriented Interface

public function doTerminate();

Procedural Interface

secureblackbox_certificatevalidator_do_terminate($res);

Remarks

Call this method if you would like to stop the validation process.

Validate Method (SecureBlackbox_CertificateValidator Class)

Validates the certificate chain.

Object Oriented Interface

public function doValidate();

Procedural Interface

secureblackbox_certificatevalidator_do_validate($res);

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.

ValidateForSMIME Method (SecureBlackbox_CertificateValidator Class)

Validates an e-mail signing certificate.

Object Oriented Interface

public function doValidateForSMIME($emailaddress);

Procedural Interface

secureblackbox_certificatevalidator_do_validateforsmime($res, $emailaddress);

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.

ValidateForSSL Method (SecureBlackbox_CertificateValidator Class)

Validates a server-side SSL/TLS certificate.

Object Oriented Interface

public function doValidateForSSL($url, $ipaddress);

Procedural Interface

secureblackbox_certificatevalidator_do_validateforssl($res, $url, $ipaddress);

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.

AfterCertificateProcessing Event (SecureBlackbox_CertificateValidator Class)

Marks the end of a single certificate processing step.

Object Oriented Interface

public function fireAfterCertificateProcessing($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 1, array($this, 'fireAfterCertificateProcessing'));

Parameter List

 'cert'
'validity'
'validationdetails'

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:

cvtValid0The chain is valid

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

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

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Validation details:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

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

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

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

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

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

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

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

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

AfterCertificateValidation Event (SecureBlackbox_CertificateValidator Class)

Marks the end of a single certificate validation step.

Object Oriented Interface

public function fireAfterCertificateValidation($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 2, array($this, 'fireAfterCertificateValidation'));

Parameter List

 'cert'
'cacert'
'validity'
'validationdetails'

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:

cvtValid0The chain is valid

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

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

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Validation details:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

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

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

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

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

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

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

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

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

BeforeCACertificateDownload Event (SecureBlackbox_CertificateValidator Class)

Fires when a CA certificate is about to be downloaded.

Object Oriented Interface

public function fireBeforeCACertificateDownload($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 3, array($this, 'fireBeforeCACertificateDownload'));

Parameter List

 'cert'
'location'

Remarks

This event is fired when a CA certificate that is needed to validate Cert is about to be downloaded from Location.

BeforeCertificateProcessing Event (SecureBlackbox_CertificateValidator Class)

Reports the start of certificate processing.

Object Oriented Interface

public function fireBeforeCertificateProcessing($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 4, array($this, 'fireBeforeCertificateProcessing'));

Parameter List

 'cert'
'validity'
'validationdetails'

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:

cvtValid0The chain is valid

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

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

cvtCantBeEstablished3The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses)

Validation details:

cvrBadData0x0001One or more certificates in the validation path are malformed

cvrRevoked0x0002One or more certificates are revoked

cvrNotYetValid0x0004One or more certificates are not yet valid

cvrExpired0x0008One or more certificates are expired

cvrInvalidSignature0x0010A certificate contains a non-valid digital signature

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

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

cvrCRLNotVerified0x0080One or more CRLs could not be verified

cvrOCSPNotVerified0x0100One or more OCSP responses could not be verified

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

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

cvrBlocked0x0800One or more certificates are blocked

cvrFailure0x1000General validation failure

cvrChainLoop0x2000Chain loop: one of the CA certificates recursively signs itself

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

cvrUserEnforced0x8000The chain was considered invalid following intervention from a user code

BeforeCertificateValidation Event (SecureBlackbox_CertificateValidator Class)

Reports the start of certificate validation.

Object Oriented Interface

public function fireBeforeCertificateValidation($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 5, array($this, 'fireBeforeCertificateValidation'));

Parameter List

 'cert'
'cacert'

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

Fires when a CRL is about to be downloaded.

Object Oriented Interface

public function fireBeforeCRLDownload($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 6, array($this, 'fireBeforeCRLDownload'));

Parameter List

 'cert'
'cacert'
'location'

Remarks

This event is fired when a CRL (Certificate Revocation List) needed to validate Cert is going to be downloaded from Location.

BeforeOCSPDownload Event (SecureBlackbox_CertificateValidator Class)

Fires when a certificate's OCSP status is about to be requested.

Object Oriented Interface

public function fireBeforeOCSPDownload($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 7, array($this, 'fireBeforeOCSPDownload'));

Parameter List

 'cert'
'cacert'
'location'

Remarks

This event is fired when the validator is about to request a fresh revocation status from an OCSP responder.

CACertificateDownloaded Event (SecureBlackbox_CertificateValidator Class)

Marks the success of a certificate download.

Object Oriented Interface

public function fireCACertificateDownloaded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 8, array($this, 'fireCACertificateDownloaded'));

Parameter List

 'cert'
'location'

Remarks

This event is fired when a CA certificate has been successfully downloaded from Location. This event is preceded with BeforeCACertificateDownload event.

CACertificateNeeded Event (SecureBlackbox_CertificateValidator Class)

Requests a missing certificate from the user.

Object Oriented Interface

public function fireCACertificateNeeded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 9, array($this, 'fireCACertificateNeeded'));

Parameter List

 'cert'

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

Marks the success of a CRL download.

Object Oriented Interface

public function fireCRLDownloaded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 10, array($this, 'fireCRLDownloaded'));

Parameter List

 'cert'
'cacert'
'location'

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

Requests a missing CRL from the user.

Object Oriented Interface

public function fireCRLNeeded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 11, array($this, 'fireCRLNeeded'));

Parameter List

 'cert'
'cacert'

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

Information about errors during certificate validation.

Object Oriented Interface

public function fireError($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 12, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

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

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 13, array($this, 'fireNotification'));

Parameter List

 'eventid'
'eventparam'

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following EventID values:

DownloadTSLThis 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.
StoreTSLThis 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 (SecureBlackbox_CertificateValidator Class)

Marks the success of an OCSP request.

Object Oriented Interface

public function fireOCSPDownloaded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 14, array($this, 'fireOCSPDownloaded'));

Parameter List

 'cert'
'cacert'
'location'

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

Fires when a remote TLS party requests a client certificate.

Object Oriented Interface

public function fireTLSCertNeeded($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 15, array($this, 'fireTLSCertNeeded'));

Parameter List

 'host'
'canames'

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the 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 (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function fireTLSCertValidate($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 16, array($this, 'fireTLSCertValidate'));

Parameter List

 'serverhost'
'serverip'
'accept'

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes 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 class, and can be adjusted if needed.

TLSEstablished Event (SecureBlackbox_CertificateValidator Class)

Fires when a TLS handshake with Host successfully completes.

Object Oriented Interface

public function fireTLSEstablished($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 17, array($this, 'fireTLSEstablished'));

Parameter List

 'host'
'version'
'ciphersuite'
'connectionid'
'abort'

Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (SecureBlackbox_CertificateValidator Class)

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

Object Oriented Interface

public function fireTLSHandshake($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 18, array($this, 'fireTLSHandshake'));

Parameter List

 'host'
'abort'

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 by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSShutdown Event (SecureBlackbox_CertificateValidator Class)

Reports the graceful closure of a TLS connection.

Object Oriented Interface

public function fireTLSShutdown($param);

Procedural Interface

secureblackbox_certificatevalidator_register_callback($res, 19, array($this, 'fireTLSShutdown'));

Parameter List

 'host'

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

CacheValidityTime:   Time period during which to keep validation cache.

The validity period of the cached validation results in milliseconds.

CheckStrongAlgorithmForTrusted:   Whether to check a 'strong' hash algorithm for trusted certificates.

Whether to check a 'strong' hash algorithm for trusted certificates.

CheckValidityPeriodForTrusted:   Whether to check validity period for trusted certificates.

Whether to check validity period for trusted certificates.

CrossCertificationValidationStrategy:   Defines how the cross certification validation is performed.

This property tells the class how to perform the cross certification validation. Supported values: csvSmart = 0 csvOptimistic = 1 csvPessimistic = 2 csvNoCrossCertification = 3

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.

DislikeOpenEndedOCSPs:   Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.

When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the class is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022).

ForceCompleteChainValidationForTrusted:   Whether to validate the whole chain.

Whether the whole certificate chain down to the CA certificate should be validated for trusted certificates.

ForceRevocationCheckForRoot:   Whether to check revocation info for root certificates.

Specifies if revocation information should be checked for the root certificate.

IgnoreBadOCSPChains:   Whether to ignore bad OCSP chains during validation.

Whether to ignore bad OCSP chains during validation.

IgnoreCABasicConstraints:   Whether to ignore the Basic Constraints extension for the CA certificates.

Whether to ignore the Basic Constraints extension for the CA certificates.

IgnoreCAKeyUsage:   Whether to ignore Key Usage extension for CA certificates.

Whether to ignore Key Usage extension for CA certificates.

IgnoreCANameConstraints:   Whether to ignore the Name Constraints extension for the CA certificates.

Whether to ignore the Name Constraints extension for the CA certificates.

IgnoreChainLoops:   Whether chain loops should be ignored.

Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves.

IgnoreOCSPNoCheckExtension:   Whether the OCSP NoCheck extension should be ignored.

Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues.

IgnoreRevocationKeyUsage:   Whether to check the CA certs used to sign revocation info.

Whether the issuer (CA) certificates should be checked if their key usage extension (when available) allows using them to sign revocation information.

IgnoreSSLKeyUsage:   Whether to check the CA certs used in SSL/TLS.

Whether the issuer (CA) certificates should be checked if their key usage extension (when available) allows using these certificates in SSL protocol communications.

IgnoreSystemTrust:   Whether trusted Windows Certificate Stores should be treated as trusted.

Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store.

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 the TrustedCertificates property) are considered trusted.

ImplicitlyTrustSelfSignedCertificates:   Whether to trust self-signed certificates.

Set this property to True to implicitly trust all self-signed certificates.

LookupCRLByNameIfDPNotPresent:   Whether to look for implicit CRL Distribution Points.

Whether to look for implicit CRL Distribution Points (DPs) if no DPs are available.

PromoteLongOCSPResponses:   Whether long OCSP responses are requested.

Set this property to True to force the class to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.

RevocationMomentGracePeriod:   Grace period for revocation information propagation.

Use this property to specify the grace period (in seconds). Grace period allows the certificate revocation information to propagate through the revocation process.

SkipSubjectNameIfAltNameExists:   Whether to check CommonName if SubjectAltName is present.

RFC 6125 requires that the SubjectAltName (SAN) extension should be checked if it is present. In such case, SubjectName.CommonName (CN) should not be checked. This contradicts to some existing certificates where, for instance, CN contains "a.com" and SAN is "www.a.com".

UseMicrosoftCTL:   Enables or disables the automatic use of the Microsoft online certificate trust list.

Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.

UseValidationCache:   Enables or disable the use of the product-wide certificate chain validation cache.

Use this property to enable or disable the use of the global chain validation cache. If enabled, the class will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the class, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start.

ValidateInvalidCertificates:   Whether to do all checks on invalid certificates.

If ValidateInvalidCertificates is True and certain certificate check determines that the certificate is not valid, further checks are done anyway. This allows to create a full validation report.

When ValidateInvalidCertificates is False and a certificate is found to be not valid, further checks of this certificate are not performed.

WeakAlgorithmHandlingMode:   How to handle certificates signed with a 'weak' hash algorithm.

Defines how to handle the certificates signed using a 'weak' hash algorithm.

Supported values: wahmIgnore = 0 wahmWarning = 1 wahmError = 2

TrustedLists Config Settings

CustomTSLs:   Specifies the custom TSLs.

Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.

QualifiedStatus:   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. This property return TSP service status URI.

TSLContent:   Specifies the TrustedList content.

Assign or read this property in your Notification event handler with the Trusted List content.

TSLContentHex:   Specifies the TrustedList content.

Assign or read this property in your Notification event handler with the Trusted List content in Hex encoding.

TSLDistributionPoints:   Contains XML content of distribution points of the TSL used.

Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate.

TSLDistributionPoints[Idx]:   Contains distribution point of the specified index of the TSL used.

Use this property to get distribution point of the specified index of the TSL used to obtain the qualified status of the certificate.

TSLHistoricalInformationPeriod:   Contains historical information period of the TSL used.

Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate.

TSLLegalNotices:   Contains XML content of legal notices of the TSL used.

Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate.

TSLLegalNotices[lang]:   Contains legal notices for the specified language of the TSL used.

Use this property to get legal notices for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLListIssueDateTime:   Contains list issue date and time of the TSL used.

Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate.

TSLNextUpdate:   Contains next update date and time of the TSL used.

Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate.

TSLPolicies:   Contains XML content of policies of the TSL used.

Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate.

TSLPolicies[lang]:   Contains policies for the specified language of the TSL used.

Use this property to get policies for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeExtensions:   Contains XML content of scheme extensions of the TSL used.

Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate.

TSLSchemeExtensions[Idx]:   Contains XML content of scheme extension of the specified index of the TSL used.

Use this property to get XML content of scheme extension of the specified index of the TSL used to obtain the qualified status of the certificate.

TSLSchemeInformationURI:   Contains XML content of scheme information URI of the TSL used.

Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate.

TSLSchemeInformationURI[lang]:   Contains scheme information URI for the specified language of the TSL used.

Use this property to get scheme information URI for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeName:   Contains XML content of scheme name of the TSL used.

Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate.

TSLSchemeName[lang]:   Contains scheme name for the specified language of the TSL used.

Use this property to get scheme name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorAddress:   Contains XML content of scheme operator address of the TSL used.

Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorName:   Contains XML content of scheme operator name of the TSL used.

Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate.

TSLSchemeOperatorName[lang]:   Contains scheme operator name for the specified language of the TSL used.

Use this property to get scheme operator name for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTerritory:   Contains scheme territory of the TSL used.

Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTypeCommunityRules:   Contains XML content of scheme type/community/rules of the TSL used.

Use this property to get XML content of multilingual scheme type/community/rules of the TSL used to obtain the qualified status of the certificate.

TSLSchemeTypeCommunityRules[lang]:   Contains scheme type/community/rules for the specified language of the TSL used.

Use this property to get scheme type/community/rules for the specified language code (e.g. 'en') of the TSL used to obtain the qualified status of the certificate.

TSLSequenceNumber:   Contains sequence number of the TSL used.

Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate.

TSLsRetrieveLog:   Contains the complete log of the TSLs retrieve.

Use this property to access the TSLs retrieve log produced by the class. The log can be very useful when investigating issues with TSL retrieve.

TSLStatusDeterminationApproach:   Contains status determination approach of the TSL used.

Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate.

TSLsValidationLog:   Contains the complete log of the TSLs validation.

Use this property to access the TSLs validation log produced by the class. The log can be very useful when investigating issues with TSL validation.

TSLTSPAdditionalServiceInformation:   Contains addtional service information of the TSP service used.

Use this property to get the list of addtional service information of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPAddress:   Contains XML content of the address of the TSP used.

Use this property to get XML content of the address of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPHistoryInstance:   Indicates that TSP service history instance used.

Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance.

TSLTSPHistoryInstanceAdditionalServiceInformation:   Contains addtional service information of the TSP service history instance used.

Use this property to get the list of addtional service information of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPHistoryInstanceQualifiers:   Contains list of qualifiers of the TSP service history instance used.

Use this property to get the list of qualifiers of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPHistoryInstanceServiceInformationExtensions:   Contains XML content of information extensions of the TSP service history instance used.

Use this property to get XML content of information extensions of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP service history instance used.

Use this property to get XML content of information extension of the specified index of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceName:   Contains XML content of name of the TSP service history instance used.

Use this property to get XML content of multilingual name of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceName[lang]:   Contains name for the specified language of the TSP service history instance used.

Use this property to get the name for the specified language code (e.g. 'en') of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceStatus:   Contains status of the TSP service history instance used.

Use this property to get the status of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceStatusStartingTime:   Contains status starting time of the TSP service history instance used.

Use this property to get the status starting time of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceServiceTypeIdentifier:   Contains type identifier of the TSP service history instance used.

Use this property to get type identifier of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPHistoryInstanceXML:   Contains XML content of the TSP service history instance used.

Use this property to get XML content of the history instance of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPInformationExtensions:   Contains XML content of information extensions of the TSP used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP used.

Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationURI:   Contains XML content of information URI of the TSP used.

Use this property to get XML content of multilingual information URI of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPInformationURI[lang]:   Contains information URI for the specified language of the TSP used.

Use this property to get the information URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPName:   Contains XML content of name of the TSP used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPName[lang]:   Contains name for the specified language of the TSP used.

Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPSchemeServiceDefinitionURI:   Contains XML content of scheme service definition URI of the TSP service used.

Use this property to get XML content of multilingual scheme service definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPSchemeServiceDefinitionURI[lang]:   Contains scheme service definition URI for the specified language of the TSP service used.

Use this property to get the scheme service definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceDefinitionURI:   Contains XML content of definition URI of the TSP service used.

Use this property to get XML content of multilingual definition URI of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceDefinitionURI[lang]:   Contains definition URI for the specified language of the TSP service used.

Use this property to get the definition URI for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceInformationExtensions:   Contains XML content of information extensions of the TSP service used.

Use this property to get XML content of information extensions of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceInformationExtensions[Idx]:   Contains XML content of information extension of the specified index of the TSP service used.

Use this property to get XML content of information extension of the specified index of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceName:   Contains XML content of name of the TSP service used.

Use this property to get XML content of multilingual name of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceName[lang]:   Contains name for the specified language of the TSP service used.

Use this property to get the name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceQualifiers:   Contains list of qualifiers of the TSP service used.

Use this property to get the list of qualifiers of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate. The URIs list is comma-separated.

TSLTSPServiceStatus:   Contains status of the TSP service used.

Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceStatusStartingTime:   Contains status starting time of the TSP service used.

Use this property to get the status starting time of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceSupplyPoints:   Contains XML content of the supply points of the TSP service used.

Use this property to get XML content of the supply points of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceTypeIdentifier:   Contains type identifier of the TSP service used.

Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPServiceXML:   Contains XML content of the TSP service used.

Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.

TSLTSPTradeName:   Contains XML content of trade name of the TSP used.

Use this property to get XML content of multilingual trade name of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPTradeName[lang]:   Contains trade name for the specified language of the TSP used.

Use this property to get the trade name for the specified language code (e.g. 'en') of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLTSPXML:   Contains XML content of the TSP used.

Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.

TSLType:   Contains TSL type of the TSL used.

Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate.

TSLVersionIdentifier:   Contains version identifier of the TSL used.

Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate.

TSLXML:   Contains XML content of the TSL used.

Use this property to get XML content of the TSL used to obtain the qualified status of the certificate.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

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

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

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

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (CertificateValidator Class)

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)