CertificateValidator Component
Properties Methods Events Config Settings Errors
The CertificateValidator component provides fine-grained validation of X.509 certificates.
Syntax
TsbxCertificateValidator
Remarks
This is a powerful and configurable component which can be used to validate all kinds of certificates and their chains.
The purpose of CertificateValidator is to validate certificate chains according to the X.509 specification. It supports a variety of technologies, including CRL and OCSP services, and can provide a comprehensive output on the certificate cryptographic validity, chain integrity, and trust levels. CertificateValidator is used internally in many other SecureBlackbox components, such as PDFSigner, HTTPClient, and OfficeVerifier.
To validate a certificate, please tune up the component as following:
- Assign the certificate to be validated to the Certificate property.
- Set RevocationCheck in accordance with your revocation check preferences.
- Enable UseSystemCertificates property to trust certificates that are trusted by the operating system. Copy any certificates that are not available in the standard system locations to KnownCertificates and TrustedCertificates collections (see Note 1 below).
- Optionally, adjust TLSSettings and SocketSettings.
- Adjust ValidationMoment if you would like to check the certificate validity at a different moment in time. Leave it unchanged to validate the certificate at the current time moment.
- Call Validate or ValidateForSSL method to initiate chain validation.
Depending on the complexity of the chain and the configuration of the component, the validation routine may take certain amount of time. The validator reports chain validation progress using a selection of events, such as BeforeCertificateProcessing, AfterCertificateProcessing, and CRLDownloaded events. It may also ask you for missing objects using CRLNeeded or CACertificateNeeded events. In each such event handler you can access the currently validated certificate via the CurrentCertificate property, and the interim validity figures via the InterimValidationResult and InterimValidationDetails property.
The return of the Validate (or similar) method indicates the completion of the validation procedure. The outcome of the chain validation is represented with the two parameters:
- ChainValidationResult reports the general validation outcome: valid, valid-but-untrusted, invalid, and unknown. As a rule, only the valid result can be taken as a good reason to consider the chain valid.
- ChainValidationDetails provides insights into the factors that caused the validation to fail.
Note 1: On Windows, CertificateValidator can use CA and ROOT system stores to look for any missing CA certificates and trust anchors. No similar functionality is currently available for other platforms, so in most cases you must provide your own list of trusted and CA certificates via TrustedCertificates and KnownCertificates collections to have your chains validate fully in Linux and macOS projects.
Note 2: The OfflineMode property is a handy way to check the completeness of your revocation/validation information. When the offline mode is on, CertificateValidator won't go online for any missing certificates, CRLs, and OCSP responses. Paired with a switched-off UseSystemCertificates property, it allows to make sure that any content provided via KnownCertificates, KnownCRLs, and KnownOCSPs represents the complete set of validation information required to validate the chain.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
BlockedCertCount | The number of records in the BlockedCert arrays. |
BlockedCertBytes | Returns the raw certificate data in DER format. |
BlockedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CacheValidationResults | Enables or disables validation result caching. |
CertBytes | Returns the raw certificate data in DER format. |
CertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
ChainValidationDetails | The details of a certificate chain validation outcome. |
ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
CurrentCACertBytes | Returns the raw certificate data in DER format. |
CurrentCACertCA | Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension). |
CurrentCACertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CurrentCACertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CurrentCACertCurve | Specifies the elliptic curve of the EC public key. |
CurrentCACertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CurrentCACertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CurrentCACertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CurrentCACertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
CurrentCACertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CurrentCACertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CurrentCACertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CurrentCACertKeyBits | Returns the length of the public key. |
CurrentCACertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CurrentCACertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CurrentCACertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CurrentCACertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CurrentCACertOCSPNoCheck | Accessor to the value of the certificate's ocsp-no-check extension. |
CurrentCACertOrigin | Returns the origin of this certificate. |
CurrentCACertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CurrentCACertPrivateKeyBytes | Contains the certificate's private key. |
CurrentCACertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
CurrentCACertPrivateKeyExtractable | Indicates whether the private key is extractable. |
CurrentCACertPublicKeyBytes | Contains the certificate's public key in DER format. |
CurrentCACertQualifiedStatements | Returns the qualified status of the certificate. |
CurrentCACertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CurrentCACertSerialNumber | Returns the certificate's serial number. |
CurrentCACertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CurrentCACertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CurrentCACertSubjectAlternativeName | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
CurrentCACertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CurrentCACertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CurrentCACertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CurrentCACertValidTo | The time point at which the certificate expires, in UTC. |
CurrentCertBytes | Returns the raw certificate data in DER format. |
CurrentCertCA | Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension). |
CurrentCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
CurrentCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
CurrentCertCurve | Specifies the elliptic curve of the EC public key. |
CurrentCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
CurrentCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
CurrentCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
CurrentCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
CurrentCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
CurrentCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
CurrentCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
CurrentCertKeyBits | Returns the length of the public key. |
CurrentCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
CurrentCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
CurrentCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
CurrentCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
CurrentCertOCSPNoCheck | Accessor to the value of the certificate's ocsp-no-check extension. |
CurrentCertOrigin | Returns the origin of this certificate. |
CurrentCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
CurrentCertPrivateKeyBytes | Contains the certificate's private key. |
CurrentCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
CurrentCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
CurrentCertPublicKeyBytes | Contains the certificate's public key in DER format. |
CurrentCertQualifiedStatements | Returns the qualified status of the certificate. |
CurrentCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
CurrentCertSerialNumber | Returns the certificate's serial number. |
CurrentCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
CurrentCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
CurrentCertSubjectAlternativeName | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
CurrentCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
CurrentCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
CurrentCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
CurrentCertValidTo | The time point at which the certificate expires, in UTC. |
FIPSMode | Reserved. |
GracePeriod | Specifies a grace period to apply during certificate validation. |
InterimValidationDetails | Contains the validation details of the moment. |
InterimValidationResult | Contains the validation status of the moment. |
KnownCertCount | The number of records in the KnownCert arrays. |
KnownCertBytes | Returns the raw certificate data in DER format. |
KnownCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownCRLCount | The number of records in the KnownCRL arrays. |
KnownCRLBytes | Returns the raw CRL data in DER format. |
KnownCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
KnownOCSPCount | The number of records in the KnownOCSP arrays. |
KnownOCSPBytes | A buffer containing the raw OCSP response data. |
KnownOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
MaxValidationTime | Specifies the maximum time the validation process may take. |
OfflineMode | Switches the component to offline mode. |
ProxyAddress | The IP address of the proxy server. |
ProxyAuthentication | The authentication type used by the proxy server. |
ProxyPassword | The password to authenticate to the proxy server. |
ProxyPort | The port on the proxy server to connect to. |
ProxyProxyType | The type of the proxy server. |
ProxyRequestHeaders | Contains HTTP request headers for WebTunnel and HTTP proxy. |
ProxyResponseBody | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
ProxyResponseHeaders | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
ProxyUseIPv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
ProxyUseProxy | Enables or disables proxy-driven connection. |
ProxyUsername | Specifies the username credential for proxy authentication. |
QualifiedInfoAddress | Contains the address of the TSL provider. |
QualifiedInfoCustomTSLs | The list of custom TSLs to use. |
QualifiedInfoDownloadLog | Contains the TLS download log. |
QualifiedInfoInformationURI | Contains the URI of the provider information. |
QualifiedInfoLanguages | The preferred language(s) for TSL data. |
QualifiedInfoNextUpdate | Returns the next update date and time of the TSL. |
QualifiedInfoProvider | Contains the name of the TSL provider. |
QualifiedInfoQualified | Indicates whether the certificate is qualified. |
QualifiedInfoQualifiers | A list of qualifiers. |
QualifiedInfoServiceName | Contains the name of the TSL service. |
QualifiedInfoServiceTypeId | Contains the TSL service type identifier. |
QualifiedInfoSource | The source of qualified information. |
QualifiedInfoStatus | Indicates a qualified electronic signature. |
QualifiedInfoTradeName | Contains the trade name of the TSL provider. |
QualifiedInfoUseDefaultTSLs | Use this setting to enable or disable the use of the default TSLs. |
QualifiedInfoValidationLog | Contains the TLS validation log. |
QualifiedInfoXML | Contains the XML of the TSL. |
RevocationCheck | Specifies the kind(s) of revocation check to perform for all chain certificates. |
SocketDNSMode | Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. |
SocketDNSPort | Specifies the port number to be used for sending queries to the DNS server. |
SocketDNSQueryTimeout | The timeout (in milliseconds) for each DNS query. |
SocketDNSServers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
SocketDNSTotalTimeout | The timeout (in milliseconds) for the whole resolution process. |
SocketIncomingSpeedLimit | The maximum number of bytes to read from the socket, per second. |
SocketLocalAddress | The local network interface to bind the socket to. |
SocketLocalPort | The local port number to bind the socket to. |
SocketOutgoingSpeedLimit | The maximum number of bytes to write to the socket, per second. |
SocketTimeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
SocketUseIPv6 | Enables or disables IP protocol version 6. |
TLSClientCertCount | The number of records in the TLSClientCert arrays. |
TLSClientCertBytes | Returns the raw certificate data in DER format. |
TLSClientCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSServerCertCount | The number of records in the TLSServerCert arrays. |
TLSServerCertBytes | Returns the raw certificate data in DER format. |
TLSServerCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
TLSAutoValidateCertificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
TLSBaseConfiguration | Selects the base configuration for the TLS settings. |
TLSCiphersuites | A list of ciphersuites separated with commas or semicolons. |
TLSECCurves | Defines the elliptic curves to enable. |
TLSExtensions | Provides access to TLS extensions. |
TLSForceResumeIfDestinationChanges | Whether to force TLS session resumption when the destination address changes. |
TLSPreSharedIdentity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
TLSPreSharedKey | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
TLSPreSharedKeyCiphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
TLSRenegotiationAttackPreventionMode | Selects the renegotiation attack prevention mechanism. |
TLSRevocationCheck | Specifies the kind(s) of revocation check to perform. |
TLSSSLOptions | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
TLSTLSMode | Specifies the TLS mode to use. |
TLSUseExtendedMasterSecret | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
TLSUseSessionResumption | Enables or disables the TLS session resumption capability. |
TLSVersions | The SSL/TLS versions to enable by default. |
TrustedCertCount | The number of records in the TrustedCert arrays. |
TrustedCertBytes | Returns the raw certificate data in DER format. |
TrustedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UsedCertCount | The number of records in the UsedCert arrays. |
UsedCertBytes | Returns the raw certificate data in DER format. |
UsedCertCA | Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension). |
UsedCertCAKeyID | A unique identifier (fingerprint) of the CA certificate's private key. |
UsedCertCRLDistributionPoints | Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity. |
UsedCertCurve | Specifies the elliptic curve of the EC public key. |
UsedCertFingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
UsedCertFriendlyName | Contains an associated alias (friendly name) of the certificate. |
UsedCertHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UsedCertHashAlgorithm | Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN . |
UsedCertIssuer | The common name of the certificate issuer (CA), typically a company name. |
UsedCertIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
UsedCertKeyAlgorithm | Specifies the public key algorithm of this certificate. |
UsedCertKeyBits | Returns the length of the public key. |
UsedCertKeyFingerprint | Returns a fingerprint of the public key contained in the certificate. |
UsedCertKeyUsage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
UsedCertKeyValid | Returns True if the certificate's key is cryptographically valid, and False otherwise. |
UsedCertOCSPLocations | Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA. |
UsedCertOCSPNoCheck | Accessor to the value of the certificate's ocsp-no-check extension. |
UsedCertOrigin | Returns the origin of this certificate. |
UsedCertPolicyIDs | Contains identifiers (OIDs) of the applicable certificate policies. |
UsedCertPrivateKeyBytes | Contains the certificate's private key. |
UsedCertPrivateKeyExists | Indicates whether the certificate has an associated private key. |
UsedCertPrivateKeyExtractable | Indicates whether the private key is extractable. |
UsedCertPublicKeyBytes | Contains the certificate's public key in DER format. |
UsedCertQualifiedStatements | Returns the qualified status of the certificate. |
UsedCertSelfSigned | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
UsedCertSerialNumber | Returns the certificate's serial number. |
UsedCertSigAlgorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
UsedCertSubject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
UsedCertSubjectAlternativeName | Returns or sets the value of the Subject Alternative Name extension of the certificate. |
UsedCertSubjectKeyID | Contains a unique identifier (fingerprint) of the certificate's private key. |
UsedCertSubjectRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
UsedCertValidFrom | The time point at which the certificate becomes valid, in UTC. |
UsedCertValidTo | The time point at which the certificate expires, in UTC. |
UsedCRLCount | The number of records in the UsedCRL arrays. |
UsedCRLBytes | Returns the raw CRL data in DER format. |
UsedCRLHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UsedCRLIssuer | The common name of the CRL issuer (CA), typically a company name. |
UsedCRLIssuerRDN | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. |
UsedCRLLocation | The URL that the CRL was downloaded from. |
UsedCRLNextUpdate | The planned time and date of the next version of this CRL to be published. |
UsedCRLThisUpdate | The date and time at which this version of the CRL was published. |
UseDefaultTSLs | Enables or disables the use of the default TSLs. |
UsedOCSPCount | The number of records in the UsedOCSP arrays. |
UsedOCSPBytes | A buffer containing the raw OCSP response data. |
UsedOCSPHandle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
UsedOCSPIssuer | Indicates the issuer of this response (a CA or its authorized representative). |
UsedOCSPIssuerRDN | Indicates the RDN of the issuer of this response (a CA or its authorized representative). |
UsedOCSPLocation | The location of the OCSP responder. |
UsedOCSPProducedAt | Specifies the time when the response was produced, in UTC. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
ValidationLog | Contains the complete log of the certificate validation routine. |
ValidationMoment | The time point at which chain validity is to be established. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
GetQualifiedStatus | Obtains the qualified information for Certificate . |
GetTSLProperty | Returns a specific TSL property. |
RefreshCache | Refreshes the certificate cache. |
ResetCache | Clears all data contained in the validation cache. |
Terminate | Terminates the validation process. |
Validate | Validates the certificate chain. |
ValidateForSMIME | Validates an e-mail signing certificate. |
ValidateForSSL | Validates a server-side SSL/TLS certificate. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
AfterCertificateProcessing | Marks the end of a single certificate processing step. |
AfterCertificateValidation | Marks the end of a single certificate validation step. |
BeforeCACertificateDownload | Fires when a CA certificate is about to be downloaded. |
BeforeCertificateProcessing | Reports the start of certificate processing. |
BeforeCertificateValidation | Reports the start of certificate validation. |
BeforeCRLDownload | Fires when a CRL is about to be downloaded. |
BeforeOCSPDownload | Fires when a certificate's OCSP status is about to be requested. |
CACertificateDownloaded | Marks the success of a certificate download. |
CACertificateNeeded | Requests a missing certificate from the user. |
CRLDownloaded | Marks the success of a CRL download. |
CRLNeeded | Requests a missing CRL from the user. |
Error | Information about errors during certificate validation. |
Notification | This event notifies the application about an underlying control flow event. |
OCSPDownloaded | Marks the success of an OCSP request. |
TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
CacheValidityTime | Time period during which to keep validation cache. |
CheckStrongAlgorithmForTrusted | Whether to check a 'strong' hash algorithm for trusted certificates. |
CheckValidityPeriodForTrusted | Whether to check validity period for trusted certificates. |
CrossCertificationValidationStrategy | Defines how the cross certification validation is performed. |
DislikeOpenEndedOCSPs | Tells the component to discourage OCSP responses without an explicit NextUpdate parameter. |
ForceCompleteChainValidationForTrusted | Whether to validate the whole chain. |
ForceRevocationCheckForRoot | Whether to check revocation info for root certificates. |
IgnoreBadOCSPChains | Whether to ignore bad OCSP chains during validation. |
IgnoreCABasicConstraints | Whether to ignore the Basic Constraints extension for the CA certificates. |
IgnoreCAKeyUsage | Whether to ignore Key Usage extension for CA certificates. |
IgnoreCANameConstraints | Whether to ignore the Name Constraints extension for the CA certificates. |
IgnoreChainLoops | Whether chain loops should be ignored. |
IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
IgnoreRevocationKeyUsage | Whether to check the CA certs used to sign revocation info. |
IgnoreSSLKeyUsage | Whether to check the CA certs used in SSL/TLS. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
LookupCRLByNameIfDPNotPresent | Whether to look for implicit CRL Distribution Points. |
PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
RevocationMomentGracePeriod | Grace period for revocation information propagation. |
SkipSubjectNameIfAltNameExists | Whether to check CommonName if SubjectAltName is present. |
UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
ValidateInvalidCertificates | Whether to do all checks on invalid certificates. |
WeakAlgorithmHandlingMode | How to handle certificates signed with a 'weak' hash algorithm. |
CustomTSLs | Specifies the custom TSLs. |
QualifiedStatus | Indicates a qualified electronic signature. |
TSLContent | Specifies the TrustedList content. |
TSLContentHex | Specifies the TrustedList content. |
TSLDistributionPoints | Contains XML content of distribution points of the TSL used. |
TSLDistributionPoints[Idx] | Contains distribution point of the specified index of the TSL used. |
TSLHistoricalInformationPeriod | Contains historical information period of the TSL used. |
TSLLegalNotices | Contains XML content of legal notices of the TSL used. |
TSLLegalNotices[lang] | Contains legal notices for the specified language of the TSL used. |
TSLListIssueDateTime | Contains list issue date and time of the TSL used. |
TSLNextUpdate | Contains next update date and time of the TSL used. |
TSLPolicies | Contains XML content of policies of the TSL used. |
TSLPolicies[lang] | Contains policies for the specified language of the TSL used. |
TSLSchemeExtensions | Contains XML content of scheme extensions of the TSL used. |
TSLSchemeExtensions[Idx] | Contains XML content of scheme extension of the specified index of the TSL used. |
TSLSchemeInformationURI | Contains XML content of scheme information URI of the TSL used. |
TSLSchemeInformationURI[lang] | Contains scheme information URI for the specified language of the TSL used. |
TSLSchemeName | Contains XML content of scheme name of the TSL used. |
TSLSchemeName[lang] | Contains scheme name for the specified language of the TSL used. |
TSLSchemeOperatorAddress | Contains XML content of scheme operator address of the TSL used. |
TSLSchemeOperatorName | Contains XML content of scheme operator name of the TSL used. |
TSLSchemeOperatorName[lang] | Contains scheme operator name for the specified language of the TSL used. |
TSLSchemeTerritory | Contains scheme territory of the TSL used. |
TSLSchemeTypeCommunityRules | Contains XML content of scheme type/community/rules of the TSL used. |
TSLSchemeTypeCommunityRules[lang] | Contains scheme type/community/rules for the specified language of the TSL used. |
TSLSequenceNumber | Contains sequence number of the TSL used. |
TSLsRetrieveLog | Contains the complete log of the TSLs retrieve. |
TSLStatusDeterminationApproach | Contains status determination approach of the TSL used. |
TSLsValidationLog | Contains the complete log of the TSLs validation. |
TSLTSPAdditionalServiceInformation | Contains addtional service information of the TSP service used. |
TSLTSPAddress | Contains XML content of the address of the TSP used. |
TSLTSPHistoryInstance | Indicates that TSP service history instance used. |
TSLTSPHistoryInstanceAdditionalServiceInformation | Contains addtional service information of the TSP service history instance used. |
TSLTSPHistoryInstanceQualifiers | Contains list of qualifiers of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceInformationExtensions | Contains XML content of information extensions of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceName | Contains XML content of name of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceName[lang] | Contains name for the specified language of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceStatus | Contains status of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceStatusStartingTime | Contains status starting time of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceTypeIdentifier | Contains type identifier of the TSP service history instance used. |
TSLTSPHistoryInstanceXML | Contains XML content of the TSP service history instance used. |
TSLTSPInformationExtensions | Contains XML content of information extensions of the TSP used. |
TSLTSPInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP used. |
TSLTSPInformationURI | Contains XML content of information URI of the TSP used. |
TSLTSPInformationURI[lang] | Contains information URI for the specified language of the TSP used. |
TSLTSPName | Contains XML content of name of the TSP used. |
TSLTSPName[lang] | Contains name for the specified language of the TSP used. |
TSLTSPSchemeServiceDefinitionURI | Contains XML content of scheme service definition URI of the TSP service used. |
TSLTSPSchemeServiceDefinitionURI[lang] | Contains scheme service definition URI for the specified language of the TSP service used. |
TSLTSPServiceDefinitionURI | Contains XML content of definition URI of the TSP service used. |
TSLTSPServiceDefinitionURI[lang] | Contains definition URI for the specified language of the TSP service used. |
TSLTSPServiceInformationExtensions | Contains XML content of information extensions of the TSP service used. |
TSLTSPServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service used. |
TSLTSPServiceName | Contains XML content of name of the TSP service used. |
TSLTSPServiceName[lang] | Contains name for the specified language of the TSP service used. |
TSLTSPServiceQualifiers | Contains list of qualifiers of the TSP service used. |
TSLTSPServiceStatus | Contains status of the TSP service used. |
TSLTSPServiceStatusStartingTime | Contains status starting time of the TSP service used. |
TSLTSPServiceSupplyPoints | Contains XML content of the supply points of the TSP service used. |
TSLTSPServiceTypeIdentifier | Contains type identifier of the TSP service used. |
TSLTSPServiceXML | Contains XML content of the TSP service used. |
TSLTSPTradeName | Contains XML content of trade name of the TSP used. |
TSLTSPTradeName[lang] | Contains trade name for the specified language of the TSP used. |
TSLTSPXML | Contains XML content of the TSP used. |
TSLType | Contains TSL type of the TSL used. |
TSLVersionIdentifier | Contains version identifier of the TSL used. |
TSLXML | Contains XML content of the TSL used. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the component. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
BlockedCertCount Property (CertificateValidator Component)
The number of records in the BlockedCert arrays.
Syntax
__property int BlockedCertCount = { read=FBlockedCertCount, write=FSetBlockedCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at BlockedCertCount - 1.
This property is not available at design time.
Data Type
Integer
BlockedCertBytes Property (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayBlockedCertBytes[int BlockedCertIndex] = { read=FBlockedCertBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 BlockedCertHandle[int BlockedCertIndex] = { read=FBlockedCertHandle, write=FSetBlockedCertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.
This property is not available at design time.
Data Type
Long64
CacheValidationResults Property (CertificateValidator Component)
Enables or disables validation result caching.
Syntax
__property bool CacheValidationResults = { read=FCacheValidationResults, write=FSetCacheValidationResults };
Default Value
false
Remarks
Set this property to True to enable caching of validation results.
Data Type
Boolean
CertBytes Property (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayCertBytes = { read=FCertBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 CertHandle = { read=FCertHandle, write=FSetCertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
ChainValidationDetails Property (CertificateValidator Component)
The details of a certificate chain validation outcome.
Syntax
__property int ChainValidationDetails = { read=FChainValidationDetails };
Default Value
0
Remarks
Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
ChainValidationResult Property (CertificateValidator Component)
The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
Syntax
__property TsbxCertificateValidatorChainValidationResults ChainValidationResult = { read=FChainValidationResult };
enum TsbxCertificateValidatorChainValidationResults { cvtValid=0, cvtValidButUntrusted=1, cvtInvalid=2, cvtCantBeEstablished=3 };
Default Value
cvtValid
Remarks
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertBytes Property (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayCurrentCACertBytes = { read=FCurrentCACertBytes };
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 (CertificateValidator Component)
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
Syntax
__property bool CurrentCACertCA = { read=FCurrentCACertCA };
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 (CertificateValidator Component)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
__property DynamicArrayCurrentCACertCAKeyID = { read=FCurrentCACertCAKeyID };
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertCRLDistributionPoints Property (CertificateValidator Component)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
__property String CurrentCACertCRLDistributionPoints = { read=FCurrentCACertCRLDistributionPoints };
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertCurve Property (CertificateValidator Component)
Specifies the elliptic curve of the EC public key.
Syntax
__property String CurrentCACertCurve = { read=FCurrentCACertCurve };
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertFingerprint Property (CertificateValidator Component)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
__property DynamicArrayCurrentCACertFingerprint = { read=FCurrentCACertFingerprint };
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertFriendlyName Property (CertificateValidator Component)
Contains an associated alias (friendly name) of the certificate.
Syntax
__property String CurrentCACertFriendlyName = { read=FCurrentCACertFriendlyName };
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertHandle Property (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 CurrentCACertHandle = { read=FCurrentCACertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
CurrentCACertHashAlgorithm Property (CertificateValidator Component)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
__property String CurrentCACertHashAlgorithm = { read=FCurrentCACertHashAlgorithm };
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertIssuer Property (CertificateValidator Component)
The common name of the certificate issuer (CA), typically a company name.
Syntax
__property String CurrentCACertIssuer = { read=FCurrentCACertIssuer };
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertIssuerRDN Property (CertificateValidator Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
__property String CurrentCACertIssuerRDN = { read=FCurrentCACertIssuerRDN };
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertKeyAlgorithm Property (CertificateValidator Component)
Specifies the public key algorithm of this certificate.
Syntax
__property String CurrentCACertKeyAlgorithm = { read=FCurrentCACertKeyAlgorithm };
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
This property is read-only and not available at design time.
Data Type
String
CurrentCACertKeyBits Property (CertificateValidator Component)
Returns the length of the public key.
Syntax
__property int CurrentCACertKeyBits = { read=FCurrentCACertKeyBits };
Default Value
0
Remarks
Returns the length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertKeyFingerprint Property (CertificateValidator Component)
Returns a fingerprint of the public key contained in the certificate.
Syntax
__property DynamicArrayCurrentCACertKeyFingerprint = { read=FCurrentCACertKeyFingerprint };
Remarks
Returns a fingerprint of the public key contained in the certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertKeyUsage Property (CertificateValidator Component)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
__property int CurrentCACertKeyUsage = { read=FCurrentCACertKeyUsage };
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertKeyValid Property (CertificateValidator Component)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
__property bool CurrentCACertKeyValid = { read=FCurrentCACertKeyValid };
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertOCSPLocations Property (CertificateValidator Component)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
__property String CurrentCACertOCSPLocations = { read=FCurrentCACertOCSPLocations };
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertOCSPNoCheck Property (CertificateValidator Component)
Accessor to the value of the certificate's ocsp-no-check extension.
Syntax
__property bool CurrentCACertOCSPNoCheck = { read=FCurrentCACertOCSPNoCheck };
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 (CertificateValidator Component)
Returns the origin of this certificate.
Syntax
__property int CurrentCACertOrigin = { read=FCurrentCACertOrigin };
Default Value
0
Remarks
Returns the origin of this certificate.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertPolicyIDs Property (CertificateValidator Component)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
__property String CurrentCACertPolicyIDs = { read=FCurrentCACertPolicyIDs };
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertPrivateKeyBytes Property (CertificateValidator Component)
Contains the certificate's private key.
Syntax
__property DynamicArrayCurrentCACertPrivateKeyBytes = { read=FCurrentCACertPrivateKeyBytes };
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertPrivateKeyExists Property (CertificateValidator Component)
Indicates whether the certificate has an associated private key.
Syntax
__property bool CurrentCACertPrivateKeyExists = { read=FCurrentCACertPrivateKeyExists };
Default Value
false
Remarks
Indicates whether the certificate has an associated private key.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertPrivateKeyExtractable Property (CertificateValidator Component)
Indicates whether the private key is extractable.
Syntax
__property bool CurrentCACertPrivateKeyExtractable = { read=FCurrentCACertPrivateKeyExtractable };
Default Value
false
Remarks
Indicates whether the private key is extractable.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertPublicKeyBytes Property (CertificateValidator Component)
Contains the certificate's public key in DER format.
Syntax
__property DynamicArrayCurrentCACertPublicKeyBytes = { read=FCurrentCACertPublicKeyBytes };
Remarks
Contains the certificate's public key in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertQualifiedStatements Property (CertificateValidator Component)
Returns the qualified status of the certificate.
Syntax
__property TsbxCertificateValidatorCurrentCACertQualifiedStatements CurrentCACertQualifiedStatements = { read=FCurrentCACertQualifiedStatements };
enum TsbxCertificateValidatorCurrentCACertQualifiedStatements { qstNonQualified=0, qstQualifiedHardware=1, qstQualifiedSoftware=2 };
Default Value
qstNonQualified
Remarks
Returns the qualified status of the certificate.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCACertSelfSigned Property (CertificateValidator Component)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
__property bool CurrentCACertSelfSigned = { read=FCurrentCACertSelfSigned };
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCACertSerialNumber Property (CertificateValidator Component)
Returns the certificate's serial number.
Syntax
__property DynamicArrayCurrentCACertSerialNumber = { read=FCurrentCACertSerialNumber };
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertSigAlgorithm Property (CertificateValidator Component)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
__property String CurrentCACertSigAlgorithm = { read=FCurrentCACertSigAlgorithm };
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertSubject Property (CertificateValidator Component)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
__property String CurrentCACertSubject = { read=FCurrentCACertSubject };
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertSubjectAlternativeName Property (CertificateValidator Component)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
__property String CurrentCACertSubjectAlternativeName = { read=FCurrentCACertSubjectAlternativeName };
Default Value
""
Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertSubjectKeyID Property (CertificateValidator Component)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
__property DynamicArrayCurrentCACertSubjectKeyID = { read=FCurrentCACertSubjectKeyID };
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCACertSubjectRDN Property (CertificateValidator Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
__property String CurrentCACertSubjectRDN = { read=FCurrentCACertSubjectRDN };
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
This property is read-only and not available at design time.
Data Type
String
CurrentCACertValidFrom Property (CertificateValidator Component)
The time point at which the certificate becomes valid, in UTC.
Syntax
__property String CurrentCACertValidFrom = { read=FCurrentCACertValidFrom };
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
This property is read-only and not available at design time.
Data Type
String
CurrentCACertValidTo Property (CertificateValidator Component)
The time point at which the certificate expires, in UTC.
Syntax
__property String CurrentCACertValidTo = { read=FCurrentCACertValidTo };
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
This property is read-only and not available at design time.
Data Type
String
CurrentCertBytes Property (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayCurrentCertBytes = { read=FCurrentCertBytes };
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 (CertificateValidator Component)
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
Syntax
__property bool CurrentCertCA = { read=FCurrentCertCA };
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 (CertificateValidator Component)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
__property DynamicArrayCurrentCertCAKeyID = { read=FCurrentCertCAKeyID };
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertCRLDistributionPoints Property (CertificateValidator Component)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
__property String CurrentCertCRLDistributionPoints = { read=FCurrentCertCRLDistributionPoints };
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
This property is read-only and not available at design time.
Data Type
String
CurrentCertCurve Property (CertificateValidator Component)
Specifies the elliptic curve of the EC public key.
Syntax
__property String CurrentCertCurve = { read=FCurrentCertCurve };
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
This property is read-only and not available at design time.
Data Type
String
CurrentCertFingerprint Property (CertificateValidator Component)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
__property DynamicArrayCurrentCertFingerprint = { read=FCurrentCertFingerprint };
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertFriendlyName Property (CertificateValidator Component)
Contains an associated alias (friendly name) of the certificate.
Syntax
__property String CurrentCertFriendlyName = { read=FCurrentCertFriendlyName };
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCertHandle Property (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 CurrentCertHandle = { read=FCurrentCertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
CurrentCertHashAlgorithm Property (CertificateValidator Component)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
__property String CurrentCertHashAlgorithm = { read=FCurrentCertHashAlgorithm };
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
This property is read-only and not available at design time.
Data Type
String
CurrentCertIssuer Property (CertificateValidator Component)
The common name of the certificate issuer (CA), typically a company name.
Syntax
__property String CurrentCertIssuer = { read=FCurrentCertIssuer };
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
This property is read-only and not available at design time.
Data Type
String
CurrentCertIssuerRDN Property (CertificateValidator Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
__property String CurrentCertIssuerRDN = { read=FCurrentCertIssuerRDN };
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
This property is read-only and not available at design time.
Data Type
String
CurrentCertKeyAlgorithm Property (CertificateValidator Component)
Specifies the public key algorithm of this certificate.
Syntax
__property String CurrentCertKeyAlgorithm = { read=FCurrentCertKeyAlgorithm };
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
This property is read-only and not available at design time.
Data Type
String
CurrentCertKeyBits Property (CertificateValidator Component)
Returns the length of the public key.
Syntax
__property int CurrentCertKeyBits = { read=FCurrentCertKeyBits };
Default Value
0
Remarks
Returns the length of the public key.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertKeyFingerprint Property (CertificateValidator Component)
Returns a fingerprint of the public key contained in the certificate.
Syntax
__property DynamicArrayCurrentCertKeyFingerprint = { read=FCurrentCertKeyFingerprint };
Remarks
Returns a fingerprint of the public key contained in the certificate.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertKeyUsage Property (CertificateValidator Component)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
__property int CurrentCertKeyUsage = { read=FCurrentCertKeyUsage };
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertKeyValid Property (CertificateValidator Component)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
__property bool CurrentCertKeyValid = { read=FCurrentCertKeyValid };
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertOCSPLocations Property (CertificateValidator Component)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
__property String CurrentCertOCSPLocations = { read=FCurrentCertOCSPLocations };
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
This property is read-only and not available at design time.
Data Type
String
CurrentCertOCSPNoCheck Property (CertificateValidator Component)
Accessor to the value of the certificate's ocsp-no-check extension.
Syntax
__property bool CurrentCertOCSPNoCheck = { read=FCurrentCertOCSPNoCheck };
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 (CertificateValidator Component)
Returns the origin of this certificate.
Syntax
__property int CurrentCertOrigin = { read=FCurrentCertOrigin };
Default Value
0
Remarks
Returns the origin of this certificate.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertPolicyIDs Property (CertificateValidator Component)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
__property String CurrentCertPolicyIDs = { read=FCurrentCertPolicyIDs };
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
This property is read-only and not available at design time.
Data Type
String
CurrentCertPrivateKeyBytes Property (CertificateValidator Component)
Contains the certificate's private key.
Syntax
__property DynamicArrayCurrentCertPrivateKeyBytes = { read=FCurrentCertPrivateKeyBytes };
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertPrivateKeyExists Property (CertificateValidator Component)
Indicates whether the certificate has an associated private key.
Syntax
__property bool CurrentCertPrivateKeyExists = { read=FCurrentCertPrivateKeyExists };
Default Value
false
Remarks
Indicates whether the certificate has an associated private key.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertPrivateKeyExtractable Property (CertificateValidator Component)
Indicates whether the private key is extractable.
Syntax
__property bool CurrentCertPrivateKeyExtractable = { read=FCurrentCertPrivateKeyExtractable };
Default Value
false
Remarks
Indicates whether the private key is extractable.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertPublicKeyBytes Property (CertificateValidator Component)
Contains the certificate's public key in DER format.
Syntax
__property DynamicArrayCurrentCertPublicKeyBytes = { read=FCurrentCertPublicKeyBytes };
Remarks
Contains the certificate's public key in DER format.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertQualifiedStatements Property (CertificateValidator Component)
Returns the qualified status of the certificate.
Syntax
__property TsbxCertificateValidatorCurrentCertQualifiedStatements CurrentCertQualifiedStatements = { read=FCurrentCertQualifiedStatements };
enum TsbxCertificateValidatorCurrentCertQualifiedStatements { qstNonQualified=0, qstQualifiedHardware=1, qstQualifiedSoftware=2 };
Default Value
qstNonQualified
Remarks
Returns the qualified status of the certificate.
This property is read-only and not available at design time.
Data Type
Integer
CurrentCertSelfSigned Property (CertificateValidator Component)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
__property bool CurrentCertSelfSigned = { read=FCurrentCertSelfSigned };
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
This property is read-only and not available at design time.
Data Type
Boolean
CurrentCertSerialNumber Property (CertificateValidator Component)
Returns the certificate's serial number.
Syntax
__property DynamicArrayCurrentCertSerialNumber = { read=FCurrentCertSerialNumber };
Remarks
Returns the certificate's serial number.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertSigAlgorithm Property (CertificateValidator Component)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
__property String CurrentCertSigAlgorithm = { read=FCurrentCertSigAlgorithm };
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCertSubject Property (CertificateValidator Component)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
__property String CurrentCertSubject = { read=FCurrentCertSubject };
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
This property is read-only and not available at design time.
Data Type
String
CurrentCertSubjectAlternativeName Property (CertificateValidator Component)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
__property String CurrentCertSubjectAlternativeName = { read=FCurrentCertSubjectAlternativeName };
Default Value
""
Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
This property is read-only and not available at design time.
Data Type
String
CurrentCertSubjectKeyID Property (CertificateValidator Component)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
__property DynamicArrayCurrentCertSubjectKeyID = { read=FCurrentCertSubjectKeyID };
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
This property is read-only and not available at design time.
Data Type
Byte Array
CurrentCertSubjectRDN Property (CertificateValidator Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
__property String CurrentCertSubjectRDN = { read=FCurrentCertSubjectRDN };
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
This property is read-only and not available at design time.
Data Type
String
CurrentCertValidFrom Property (CertificateValidator Component)
The time point at which the certificate becomes valid, in UTC.
Syntax
__property String CurrentCertValidFrom = { read=FCurrentCertValidFrom };
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
This property is read-only and not available at design time.
Data Type
String
CurrentCertValidTo Property (CertificateValidator Component)
The time point at which the certificate expires, in UTC.
Syntax
__property String CurrentCertValidTo = { read=FCurrentCertValidTo };
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
This property is read-only and not available at design time.
Data Type
String
FIPSMode Property (CertificateValidator Component)
Reserved.
Syntax
__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };
Default Value
false
Remarks
This property is reserved for future use.
Data Type
Boolean
GracePeriod Property (CertificateValidator Component)
Specifies a grace period to apply during certificate validation.
Syntax
__property int GracePeriod = { read=FGracePeriod, write=FSetGracePeriod };
Default Value
0
Remarks
Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.
Data Type
Integer
InterimValidationDetails Property (CertificateValidator Component)
Contains the validation details of the moment.
Syntax
__property int InterimValidationDetails = { read=FInterimValidationDetails, write=FSetInterimValidationDetails };
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity details mid-flight.
The value of this property is a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is not available at design time.
Data Type
Integer
InterimValidationResult Property (CertificateValidator Component)
Contains the validation status of the moment.
Syntax
__property TsbxCertificateValidatorInterimValidationResults InterimValidationResult = { read=FInterimValidationResult, write=FSetInterimValidationResult };
enum TsbxCertificateValidatorInterimValidationResults { cvtValid=0, cvtValidButUntrusted=1, cvtInvalid=2, cvtCantBeEstablished=3 };
Default Value
cvtValid
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity status mid-flight.
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
This property is not available at design time.
Data Type
Integer
KnownCertCount Property (CertificateValidator Component)
The number of records in the KnownCert arrays.
Syntax
__property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCertCount - 1.
This property is not available at design time.
Data Type
Integer
KnownCertBytes Property (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayKnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 KnownCertHandle[int KnownCertIndex] = { read=FKnownCertHandle, write=FSetKnownCertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.
This property is not available at design time.
Data Type
Long64
KnownCRLCount Property (CertificateValidator Component)
The number of records in the KnownCRL arrays.
Syntax
__property int KnownCRLCount = { read=FKnownCRLCount, write=FSetKnownCRLCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownCRLCount - 1.
This property is not available at design time.
Data Type
Integer
KnownCRLBytes Property (CertificateValidator Component)
Returns the raw CRL data in DER format.
Syntax
__property DynamicArrayKnownCRLBytes[int KnownCRLIndex] = { read=FKnownCRLBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 KnownCRLHandle[int KnownCRLIndex] = { read=FKnownCRLHandle, write=FSetKnownCRLHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.
This property is not available at design time.
Data Type
Long64
KnownOCSPCount Property (CertificateValidator Component)
The number of records in the KnownOCSP arrays.
Syntax
__property int KnownOCSPCount = { read=FKnownOCSPCount, write=FSetKnownOCSPCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at KnownOCSPCount - 1.
This property is not available at design time.
Data Type
Integer
KnownOCSPBytes Property (CertificateValidator Component)
A buffer containing the raw OCSP response data.
Syntax
__property DynamicArrayKnownOCSPBytes[int KnownOCSPIndex] = { read=FKnownOCSPBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 KnownOCSPHandle[int KnownOCSPIndex] = { read=FKnownOCSPHandle, write=FSetKnownOCSPHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.
This property is not available at design time.
Data Type
Long64
MaxValidationTime Property (CertificateValidator Component)
Specifies the maximum time the validation process may take.
Syntax
__property int MaxValidationTime = { read=FMaxValidationTime, write=FSetMaxValidationTime };
Default Value
0
Remarks
Use this property to limit the amount of time available for the validator to carry out the validation. If the validation process exceeds this time, it is terminated and the validation error is returned.
Data Type
Integer
OfflineMode Property (CertificateValidator Component)
Switches the component to offline mode.
Syntax
__property bool OfflineMode = { read=FOfflineMode, write=FSetOfflineMode };
Default Value
false
Remarks
When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.
Data Type
Boolean
ProxyAddress Property (CertificateValidator Component)
The IP address of the proxy server.
Syntax
__property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress };
Default Value
""
Remarks
The IP address of the proxy server.
Data Type
String
ProxyAuthentication Property (CertificateValidator Component)
The authentication type used by the proxy server.
Syntax
__property TsbxCertificateValidatorProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication };
enum TsbxCertificateValidatorProxyAuthentications { patNoAuthentication=0, patBasic=1, patDigest=2, patNTLM=3 };
Default Value
patNoAuthentication
Remarks
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Data Type
Integer
ProxyPassword Property (CertificateValidator Component)
The password to authenticate to the proxy server.
Syntax
__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };
Default Value
""
Remarks
The password to authenticate to the proxy server.
Data Type
String
ProxyPort Property (CertificateValidator Component)
The port on the proxy server to connect to.
Syntax
__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
Integer
ProxyProxyType Property (CertificateValidator Component)
The type of the proxy server.
Syntax
__property TsbxCertificateValidatorProxyProxyTypes ProxyProxyType = { read=FProxyProxyType, write=FSetProxyProxyType };
enum TsbxCertificateValidatorProxyProxyTypes { cptNone=0, cptSocks4=1, cptSocks5=2, cptWebTunnel=3, cptHTTP=4 };
Default Value
cptNone
Remarks
The type of the proxy server.
The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
Data Type
Integer
ProxyRequestHeaders Property (CertificateValidator Component)
Contains HTTP request headers for WebTunnel and HTTP proxy.
Syntax
__property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders };
Default Value
""
Remarks
Contains HTTP request headers for WebTunnel and HTTP proxy.
Data Type
String
ProxyResponseBody Property (CertificateValidator Component)
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Syntax
__property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody };
Default Value
""
Remarks
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
Data Type
String
ProxyResponseHeaders Property (CertificateValidator Component)
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Syntax
__property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders };
Default Value
""
Remarks
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
Data Type
String
ProxyUseIPv6 Property (CertificateValidator Component)
Specifies whether IPv6 should be used when connecting through the proxy.
Syntax
__property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 };
Default Value
false
Remarks
Specifies whether IPv6 should be used when connecting through the proxy.
Data Type
Boolean
ProxyUseProxy Property (CertificateValidator Component)
Enables or disables proxy-driven connection.
Syntax
__property bool ProxyUseProxy = { read=FProxyUseProxy, write=FSetProxyUseProxy };
Default Value
false
Remarks
Enables or disables proxy-driven connection.
Data Type
Boolean
ProxyUsername Property (CertificateValidator Component)
Specifies the username credential for proxy authentication.
Syntax
__property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername };
Default Value
""
Remarks
Specifies the username credential for proxy authentication.
Data Type
String
QualifiedInfoAddress Property (CertificateValidator Component)
Contains the address of the TSL provider.
Syntax
__property String QualifiedInfoAddress = { read=FQualifiedInfoAddress };
Default Value
""
Remarks
Contains the address of the TSL provider.
Use this property to check the address of the TSL provider.
This property is read-only.
Data Type
String
QualifiedInfoCustomTSLs Property (CertificateValidator Component)
The list of custom TSLs to use.
Syntax
__property String QualifiedInfoCustomTSLs = { read=FQualifiedInfoCustomTSLs, write=FSetQualifiedInfoCustomTSLs };
Default Value
""
Remarks
The list of custom TSLs to use.
Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.
Data Type
String
QualifiedInfoDownloadLog Property (CertificateValidator Component)
Contains the TLS download log.
Syntax
__property String QualifiedInfoDownloadLog = { read=FQualifiedInfoDownloadLog };
Default Value
""
Remarks
Contains the TLS download log.
This log may be useful in investigating TSL retrieval failures.
This property is read-only.
Data Type
String
QualifiedInfoInformationURI Property (CertificateValidator Component)
Contains the URI of the provider information.
Syntax
__property String QualifiedInfoInformationURI = { read=FQualifiedInfoInformationURI };
Default Value
""
Remarks
Contains the URI of the provider information.
Use this property to get the URI of the TSL provider information.
This property is read-only.
Data Type
String
QualifiedInfoLanguages Property (CertificateValidator Component)
The preferred language(s) for TSL data.
Syntax
__property String QualifiedInfoLanguages = { read=FQualifiedInfoLanguages, write=FSetQualifiedInfoLanguages };
Default Value
""
Remarks
The preferred language(s) for TSL data.
Use this property to pass a list of languages, in order of preference, which will be considered when returning TSL properties. Many trust providers return qualified information in several languages. By tuning up this property you can choose a selection of preferred languages (such as "it,en") in which you would like to read the qualified details.
Data Type
String
QualifiedInfoNextUpdate Property (CertificateValidator Component)
Returns the next update date and time of the TSL.
Syntax
__property String QualifiedInfoNextUpdate = { read=FQualifiedInfoNextUpdate };
Default Value
""
Remarks
Returns the next update date and time of the TSL.
Use this property to check the next update value for the TSL.
This property is read-only.
Data Type
String
QualifiedInfoProvider Property (CertificateValidator Component)
Contains the name of the TSL provider.
Syntax
__property String QualifiedInfoProvider = { read=FQualifiedInfoProvider };
Default Value
""
Remarks
Contains the name of the TSL provider.
Use this property to check the name of the TSL provider.
This property is read-only.
Data Type
String
QualifiedInfoQualified Property (CertificateValidator Component)
Indicates whether the certificate is qualified.
Syntax
__property bool QualifiedInfoQualified = { read=FQualifiedInfoQualified };
Default Value
false
Remarks
Indicates whether the certificate is qualified.
This property is set to true if the certificate is confirmed by a TSL to be qualified.
This property is read-only.
Data Type
Boolean
QualifiedInfoQualifiers Property (CertificateValidator Component)
A list of qualifiers.
Syntax
__property String QualifiedInfoQualifiers = { read=FQualifiedInfoQualifiers };
Default Value
""
Remarks
A list of qualifiers.
Contains a comma-separated list of qualifiers for the certificate, for example QCP-n-qscd,QCWithSSCD.
This property is read-only.
Data Type
String
QualifiedInfoServiceName Property (CertificateValidator Component)
Contains the name of the TSL service.
Syntax
__property String QualifiedInfoServiceName = { read=FQualifiedInfoServiceName };
Default Value
""
Remarks
Contains the name of the TSL service.
Use this property to check the name of the TSL service.
This property is read-only.
Data Type
String
QualifiedInfoServiceTypeId Property (CertificateValidator Component)
Contains the TSL service type identifier.
Syntax
__property String QualifiedInfoServiceTypeId = { read=FQualifiedInfoServiceTypeId };
Default Value
""
Remarks
Contains the TSL service type identifier.
Use this property to check the service type identifier of the TSL.
This property is read-only.
Data Type
String
QualifiedInfoSource Property (CertificateValidator Component)
The source of qualified information.
Syntax
__property TsbxCertificateValidatorQualifiedInfoSources QualifiedInfoSource = { read=FQualifiedInfoSource };
enum TsbxCertificateValidatorQualifiedInfoSources { qisUnknown=0, qisCertificate=1, qisTSL=2, qisBoth=3 };
Default Value
qisUnknown
Remarks
The source of qualified information.
Available options:
qisUnknown | 0 | The source is unknown |
qisCertificate | 1 | The information was taken from the certificate |
qisTSL | 2 | The information was taken from an online TSL |
qisBoth | 3 | The information was taken from both the certificate and an online TSL |
Use the Source property to establish the origin of the qualified information.
This property is read-only and not available at design time.
Data Type
Integer
QualifiedInfoStatus Property (CertificateValidator Component)
Indicates a qualified electronic signature.
Syntax
__property TsbxCertificateValidatorQualifiedInfoStatus QualifiedInfoStatus = { read=FQualifiedInfoStatus };
enum TsbxCertificateValidatorQualifiedInfoStatus { sqsUnknown=0, sqsNone=1, sqsGranted=2, sqsWithdrawn=3, sqsSetByNationalLaw=4, sqsDeprecatedByNationalLaw=5, sqsRecognizedAtNationalLevel=6, sqsDeprecatedAtNationalLevel=7, sqsUnderSupervision=8, sqsSupervisionInCessation=9, sqsSupervisionCeased=10, sqsSupervisionRevoked=11, sqsAccredited=12, sqsAccreditationCeased=13, sqsAccreditationRevoked=14, sqsInAccordance=15, sqsExpired=16, sqsSuspended=17, sqsRevoked=18, sqsNotInAccordance=19 };
Default Value
sqsUnknown
Remarks
Indicates a qualified electronic signature.
Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate.
Adjust UseDefaultTSLs property and/or CustomTSLs property before validating the signature/certificate to properly obtain TSP (Trust Service Provider) service status. Use Qualified* and TSL* config properties to obtain extended information.
The following qualified statuses are supported:
sqsUnknown | 0 | Qualified status unknown. Use config's QualifiedInfo setting to obtain service status URI. |
sqsNone | 1 | None |
sqsGranted | 2 | Granted |
sqsWithdrawn | 3 | Withdrawn |
sqsSetByNationalLaw | 4 | Set by national law |
sqsDeprecatedByNationalLaw | 5 | Deprecated by national law |
sqsRecognizedAtNationalLevel | 6 | Recognized at national level |
sqsDeprecatedAtNationalLevel | 7 | Deprecated at national level |
sqsUnderSupervision | 8 | Under supervision |
sqsSupervisionInCessation | 9 | Supervision in cessation |
sqsSupervisionCeased | 10 | Supervision ceased |
sqsSupervisionRevoked | 11 | Supervision revoked |
sqsAccredited | 12 | Accredited |
sqsAccreditationCeased | 13 | Accreditation ceased |
sqsAccreditationRevoked | 14 | Accreditation revoked |
sqsInAccordance | 15 | Deprecated. The subject service is in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
sqsExpired | 16 | Deprecated. The subject service is no longer overseen by the scheme, e.g. due to nonrenewal or withdrawal by the TSP, or cessation of the service or the scheme's operations. |
sqsSuspended | 17 | Deprecated. The subject service's status is temporarily uncertain whilst checks are made by the scheme operator (typically e.g. while a revocation request is being investigated or if action is required to resolve a deficiency in the service fulfilling the scheme's criteria. |
sqsRevoked | 18 | Deprecated. The subject service's approved status has been revoked because it is no longer in accordance with the scheme's specific status determination criteria (only for use in positive approval schemes). |
sqsNotInAccordance | 19 | Deprecated. The subject service is not in accordance with the scheme's specific status determination criteria (only for use in negative approval schemes). |
This property is read-only and not available at design time.
Data Type
Integer
QualifiedInfoTradeName Property (CertificateValidator Component)
Contains the trade name of the TSL provider.
Syntax
__property String QualifiedInfoTradeName = { read=FQualifiedInfoTradeName };
Default Value
""
Remarks
Contains the trade name of the TSL provider.
Use this property to check the trade name of the TSL provider.
This property is read-only.
Data Type
String
QualifiedInfoUseDefaultTSLs Property (CertificateValidator Component)
Use this setting to enable or disable the use of the default TSLs.
Syntax
__property bool QualifiedInfoUseDefaultTSLs = { read=FQualifiedInfoUseDefaultTSLs, write=FSetQualifiedInfoUseDefaultTSLs };
Default Value
true
Remarks
Use this setting to enable or disable the use of the default TSLs.
Use this setting to enable or disable the use of the default TSLs.
Data Type
Boolean
QualifiedInfoValidationLog Property (CertificateValidator Component)
Contains the TLS validation log.
Syntax
__property String QualifiedInfoValidationLog = { read=FQualifiedInfoValidationLog };
Default Value
""
Remarks
Contains the TLS validation log.
This log may be useful in investigating TSL validation failures.
This property is read-only.
Data Type
String
QualifiedInfoXML Property (CertificateValidator Component)
Contains the XML of the TSL.
Syntax
__property String QualifiedInfoXML = { read=FQualifiedInfoXML };
Default Value
""
Remarks
Contains the XML of the TSL.
Use this property to obtain the original body of the TSL in XML format.
This property is read-only.
Data Type
String
RevocationCheck Property (CertificateValidator Component)
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
__property TsbxCertificateValidatorRevocationChecks RevocationCheck = { read=FRevocationCheck, write=FSetRevocationCheck };
enum TsbxCertificateValidatorRevocationChecks { crcNone=0, crcAuto=1, crcAllCRL=2, crcAllOCSP=3, crcAllCRLAndOCSP=4, crcAnyCRL=5, crcAnyOCSP=6, crcAnyCRLOrOCSP=7, crcAnyOCSPOrCRL=8 };
Default Value
crcAuto
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.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All 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 (CertificateValidator Component)
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
Syntax
__property TsbxCertificateValidatorSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode };
enum TsbxCertificateValidatorSocketDNSModes { dmAuto=0, dmPlatform=1, dmOwn=2, dmOwnSecure=3 };
Default Value
dmAuto
Remarks
Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.
dmAuto | 0 |
dmPlatform | 1 |
dmOwn | 2 |
dmOwnSecure | 3 |
Data Type
Integer
SocketDNSPort Property (CertificateValidator Component)
Specifies the port number to be used for sending queries to the DNS server.
Syntax
__property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort };
Default Value
0
Remarks
Specifies the port number to be used for sending queries to the DNS server.
Data Type
Integer
SocketDNSQueryTimeout Property (CertificateValidator Component)
The timeout (in milliseconds) for each DNS query.
Syntax
__property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout };
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 (CertificateValidator Component)
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Syntax
__property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers };
Default Value
""
Remarks
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
Data Type
String
SocketDNSTotalTimeout Property (CertificateValidator Component)
The timeout (in milliseconds) for the whole resolution process.
Syntax
__property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout };
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 (CertificateValidator Component)
The maximum number of bytes to read from the socket, per second.
Syntax
__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };
Default Value
0
Remarks
The maximum number of bytes to read from the socket, per second.
Data Type
Integer
SocketLocalAddress Property (CertificateValidator Component)
The local network interface to bind the socket to.
Syntax
__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };
Default Value
""
Remarks
The local network interface to bind the socket to.
Data Type
String
SocketLocalPort Property (CertificateValidator Component)
The local port number to bind the socket to.
Syntax
__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };
Default Value
0
Remarks
The local port number to bind the socket to.
Data Type
Integer
SocketOutgoingSpeedLimit Property (CertificateValidator Component)
The maximum number of bytes to write to the socket, per second.
Syntax
__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };
Default Value
0
Remarks
The maximum number of bytes to write to the socket, per second.
Data Type
Integer
SocketTimeout Property (CertificateValidator Component)
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
Syntax
__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };
Default Value
60000
Remarks
The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).
Data Type
Integer
SocketUseIPv6 Property (CertificateValidator Component)
Enables or disables IP protocol version 6.
Syntax
__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };
Default Value
false
Remarks
Enables or disables IP protocol version 6.
Data Type
Boolean
TLSClientCertCount Property (CertificateValidator Component)
The number of records in the TLSClientCert arrays.
Syntax
__property int TLSClientCertCount = { read=FTLSClientCertCount, write=FSetTLSClientCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSClientCertCount - 1.
This property is not available at design time.
Data Type
Integer
TLSClientCertBytes Property (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayTLSClientCertBytes[int TLSClientCertIndex] = { read=FTLSClientCertBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 TLSClientCertHandle[int TLSClientCertIndex] = { read=FTLSClientCertHandle, write=FSetTLSClientCertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.
This property is not available at design time.
Data Type
Long64
TLSServerCertCount Property (CertificateValidator Component)
The number of records in the TLSServerCert arrays.
Syntax
__property int TLSServerCertCount = { read=FTLSServerCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TLSServerCertCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
TLSServerCertBytes Property (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayTLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
TLSAutoValidateCertificates Property (CertificateValidator Component)
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Syntax
__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };
Default Value
true
Remarks
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
Data Type
Boolean
TLSBaseConfiguration Property (CertificateValidator Component)
Selects the base configuration for the TLS settings.
Syntax
__property TsbxCertificateValidatorTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };
enum TsbxCertificateValidatorTLSBaseConfigurations { stpcDefault=0, stpcCompatible=1, stpcComprehensiveInsecure=2, stpcHighlySecure=3 };
Default Value
stpcDefault
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.
stpcDefault | 0 | |
stpcCompatible | 1 | |
stpcComprehensiveInsecure | 2 | |
stpcHighlySecure | 3 |
Data Type
Integer
TLSCiphersuites Property (CertificateValidator Component)
A list of ciphersuites separated with commas or semicolons.
Syntax
__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };
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 (CertificateValidator Component)
Defines the elliptic curves to enable.
Syntax
__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };
Default Value
""
Remarks
Defines the elliptic curves to enable.
Data Type
String
TLSExtensions Property (CertificateValidator Component)
Provides access to TLS extensions.
Syntax
__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };
Default Value
""
Remarks
Provides access to TLS extensions.
Data Type
String
TLSForceResumeIfDestinationChanges Property (CertificateValidator Component)
Whether to force TLS session resumption when the destination address changes.
Syntax
__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };
Default Value
false
Remarks
Whether to force TLS session resumption when the destination address changes.
Data Type
Boolean
TLSPreSharedIdentity Property (CertificateValidator Component)
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
Syntax
__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };
Default Value
""
Remarks
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
This property is not available at design time.
Data Type
String
TLSPreSharedKey Property (CertificateValidator Component)
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
Syntax
__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };
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 (CertificateValidator Component)
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Syntax
__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };
Default Value
""
Remarks
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
Data Type
String
TLSRenegotiationAttackPreventionMode Property (CertificateValidator Component)
Selects the renegotiation attack prevention mechanism.
Syntax
__property TsbxCertificateValidatorTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };
enum TsbxCertificateValidatorTLSRenegotiationAttackPreventionModes { crapmCompatible=0, crapmStrict=1, crapmAuto=2 };
Default Value
crapmCompatible
Remarks
Selects the renegotiation attack prevention mechanism.
The following options are available:
crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |
Data Type
Integer
TLSRevocationCheck Property (CertificateValidator Component)
Specifies the kind(s) of revocation check to perform.
Syntax
__property TsbxCertificateValidatorTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };
enum TsbxCertificateValidatorTLSRevocationChecks { crcNone=0, crcAuto=1, crcAllCRL=2, crcAllOCSP=3, crcAllCRLAndOCSP=4, crcAnyCRL=5, crcAnyOCSP=6, crcAnyCRLOrOCSP=7, crcAnyOCSPOrCRL=8 };
Default Value
crcAuto
Remarks
Specifies the kind(s) of revocation check to perform.
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All 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 (CertificateValidator Component)
Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.
Syntax
__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };
Default Value
16
Remarks
Various SSL (TLS) protocol options, set of
cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |
Data Type
Integer
TLSTLSMode Property (CertificateValidator Component)
Specifies the TLS mode to use.
Syntax
__property TsbxCertificateValidatorTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };
enum TsbxCertificateValidatorTLSTLSModes { smDefault=0, smNoTLS=1, smExplicitTLS=2, smImplicitTLS=3, smMixedTLS=4 };
Default Value
smDefault
Remarks
Specifies the TLS mode to use.
smDefault | 0 | |
smNoTLS | 1 | Do not use TLS |
smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |
Data Type
Integer
TLSUseExtendedMasterSecret Property (CertificateValidator Component)
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Syntax
__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };
Default Value
false
Remarks
Enables the Extended Master Secret Extension, as defined in RFC 7627.
Data Type
Boolean
TLSUseSessionResumption Property (CertificateValidator Component)
Enables or disables the TLS session resumption capability.
Syntax
__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };
Default Value
false
Remarks
Enables or disables the TLS session resumption capability.
Data Type
Boolean
TLSVersions Property (CertificateValidator Component)
The SSL/TLS versions to enable by default.
Syntax
__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };
Default Value
16
Remarks
The SSL/TLS versions to enable by default.
csbSSL2 | 0x01 | SSL 2 |
csbSSL3 | 0x02 | SSL 3 |
csbTLS1 | 0x04 | TLS 1.0 |
csbTLS11 | 0x08 | TLS 1.1 |
csbTLS12 | 0x10 | TLS 1.2 |
csbTLS13 | 0x20 | TLS 1.3 |
Data Type
Integer
TrustedCertCount Property (CertificateValidator Component)
The number of records in the TrustedCert arrays.
Syntax
__property int TrustedCertCount = { read=FTrustedCertCount, write=FSetTrustedCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at TrustedCertCount - 1.
This property is not available at design time.
Data Type
Integer
TrustedCertBytes Property (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayTrustedCertBytes[int TrustedCertIndex] = { read=FTrustedCertBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 TrustedCertHandle[int TrustedCertIndex] = { read=FTrustedCertHandle, write=FSetTrustedCertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.
This property is not available at design time.
Data Type
Long64
UsedCertCount Property (CertificateValidator Component)
The number of records in the UsedCert arrays.
Syntax
__property int UsedCertCount = { read=FUsedCertCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- UsedCertBytes
- UsedCertCA
- UsedCertCAKeyID
- UsedCertCRLDistributionPoints
- UsedCertCurve
- UsedCertFingerprint
- UsedCertFriendlyName
- UsedCertHandle
- UsedCertHashAlgorithm
- UsedCertIssuer
- UsedCertIssuerRDN
- UsedCertKeyAlgorithm
- UsedCertKeyBits
- UsedCertKeyFingerprint
- UsedCertKeyUsage
- UsedCertKeyValid
- UsedCertOCSPLocations
- UsedCertOCSPNoCheck
- UsedCertOrigin
- UsedCertPolicyIDs
- UsedCertPrivateKeyBytes
- UsedCertPrivateKeyExists
- UsedCertPrivateKeyExtractable
- UsedCertPublicKeyBytes
- UsedCertQualifiedStatements
- UsedCertSelfSigned
- UsedCertSerialNumber
- UsedCertSigAlgorithm
- UsedCertSubject
- UsedCertSubjectAlternativeName
- UsedCertSubjectKeyID
- UsedCertSubjectRDN
- UsedCertValidFrom
- UsedCertValidTo
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 (CertificateValidator Component)
Returns the raw certificate data in DER format.
Syntax
__property DynamicArrayUsedCertBytes[int UsedCertIndex] = { read=FUsedCertBytes };
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 (CertificateValidator Component)
Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).
Syntax
__property bool UsedCertCA[int UsedCertIndex] = { read=FUsedCertCA };
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 (CertificateValidator Component)
A unique identifier (fingerprint) of the CA certificate's private key.
Syntax
__property DynamicArrayUsedCertCAKeyID[int UsedCertIndex] = { read=FUsedCertCAKeyID };
Remarks
A unique identifier (fingerprint) of the CA certificate's private key.
Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertCRLDistributionPoints Property (CertificateValidator Component)
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
Syntax
__property String UsedCertCRLDistributionPoints[int UsedCertIndex] = { read=FUsedCertCRLDistributionPoints };
Default Value
""
Remarks
Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertCurve Property (CertificateValidator Component)
Specifies the elliptic curve of the EC public key.
Syntax
__property String UsedCertCurve[int UsedCertIndex] = { read=FUsedCertCurve };
Default Value
""
Remarks
Specifies the elliptic curve of the EC public key.
SB_EC_SECP112R1 | SECP112R1 | |
SB_EC_SECP112R2 | SECP112R2 | |
SB_EC_SECP128R1 | SECP128R1 | |
SB_EC_SECP128R2 | SECP128R2 | |
SB_EC_SECP160K1 | SECP160K1 | |
SB_EC_SECP160R1 | SECP160R1 | |
SB_EC_SECP160R2 | SECP160R2 | |
SB_EC_SECP192K1 | SECP192K1 | |
SB_EC_SECP192R1 | SECP192R1 | |
SB_EC_SECP224K1 | SECP224K1 | |
SB_EC_SECP224R1 | SECP224R1 | |
SB_EC_SECP256K1 | SECP256K1 | |
SB_EC_SECP256R1 | SECP256R1 | |
SB_EC_SECP384R1 | SECP384R1 | |
SB_EC_SECP521R1 | SECP521R1 | |
SB_EC_SECT113R1 | SECT113R1 | |
SB_EC_SECT113R2 | SECT113R2 | |
SB_EC_SECT131R1 | SECT131R1 | |
SB_EC_SECT131R2 | SECT131R2 | |
SB_EC_SECT163K1 | SECT163K1 | |
SB_EC_SECT163R1 | SECT163R1 | |
SB_EC_SECT163R2 | SECT163R2 | |
SB_EC_SECT193R1 | SECT193R1 | |
SB_EC_SECT193R2 | SECT193R2 | |
SB_EC_SECT233K1 | SECT233K1 | |
SB_EC_SECT233R1 | SECT233R1 | |
SB_EC_SECT239K1 | SECT239K1 | |
SB_EC_SECT283K1 | SECT283K1 | |
SB_EC_SECT283R1 | SECT283R1 | |
SB_EC_SECT409K1 | SECT409K1 | |
SB_EC_SECT409R1 | SECT409R1 | |
SB_EC_SECT571K1 | SECT571K1 | |
SB_EC_SECT571R1 | SECT571R1 | |
SB_EC_PRIME192V1 | PRIME192V1 | |
SB_EC_PRIME192V2 | PRIME192V2 | |
SB_EC_PRIME192V3 | PRIME192V3 | |
SB_EC_PRIME239V1 | PRIME239V1 | |
SB_EC_PRIME239V2 | PRIME239V2 | |
SB_EC_PRIME239V3 | PRIME239V3 | |
SB_EC_PRIME256V1 | PRIME256V1 | |
SB_EC_C2PNB163V1 | C2PNB163V1 | |
SB_EC_C2PNB163V2 | C2PNB163V2 | |
SB_EC_C2PNB163V3 | C2PNB163V3 | |
SB_EC_C2PNB176W1 | C2PNB176W1 | |
SB_EC_C2TNB191V1 | C2TNB191V1 | |
SB_EC_C2TNB191V2 | C2TNB191V2 | |
SB_EC_C2TNB191V3 | C2TNB191V3 | |
SB_EC_C2ONB191V4 | C2ONB191V4 | |
SB_EC_C2ONB191V5 | C2ONB191V5 | |
SB_EC_C2PNB208W1 | C2PNB208W1 | |
SB_EC_C2TNB239V1 | C2TNB239V1 | |
SB_EC_C2TNB239V2 | C2TNB239V2 | |
SB_EC_C2TNB239V3 | C2TNB239V3 | |
SB_EC_C2ONB239V4 | C2ONB239V4 | |
SB_EC_C2ONB239V5 | C2ONB239V5 | |
SB_EC_C2PNB272W1 | C2PNB272W1 | |
SB_EC_C2PNB304W1 | C2PNB304W1 | |
SB_EC_C2TNB359V1 | C2TNB359V1 | |
SB_EC_C2PNB368W1 | C2PNB368W1 | |
SB_EC_C2TNB431R1 | C2TNB431R1 | |
SB_EC_NISTP192 | NISTP192 | |
SB_EC_NISTP224 | NISTP224 | |
SB_EC_NISTP256 | NISTP256 | |
SB_EC_NISTP384 | NISTP384 | |
SB_EC_NISTP521 | NISTP521 | |
SB_EC_NISTB163 | NISTB163 | |
SB_EC_NISTB233 | NISTB233 | |
SB_EC_NISTB283 | NISTB283 | |
SB_EC_NISTB409 | NISTB409 | |
SB_EC_NISTB571 | NISTB571 | |
SB_EC_NISTK163 | NISTK163 | |
SB_EC_NISTK233 | NISTK233 | |
SB_EC_NISTK283 | NISTK283 | |
SB_EC_NISTK409 | NISTK409 | |
SB_EC_NISTK571 | NISTK571 | |
SB_EC_GOSTCPTEST | GOSTCPTEST | |
SB_EC_GOSTCPA | GOSTCPA | |
SB_EC_GOSTCPB | GOSTCPB | |
SB_EC_GOSTCPC | GOSTCPC | |
SB_EC_GOSTCPXCHA | GOSTCPXCHA | |
SB_EC_GOSTCPXCHB | GOSTCPXCHB | |
SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | |
SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | |
SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | |
SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | |
SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | |
SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | |
SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | |
SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | |
SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | |
SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | |
SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | |
SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | |
SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | |
SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | |
SB_EC_CURVE25519 | CURVE25519 | |
SB_EC_CURVE448 | CURVE448 |
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertFingerprint Property (CertificateValidator Component)
Contains the fingerprint (a hash imprint) of this certificate.
Syntax
__property DynamicArrayUsedCertFingerprint[int UsedCertIndex] = { read=FUsedCertFingerprint };
Remarks
Contains the fingerprint (a hash imprint) of this certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertFriendlyName Property (CertificateValidator Component)
Contains an associated alias (friendly name) of the certificate.
Syntax
__property String UsedCertFriendlyName[int UsedCertIndex] = { read=FUsedCertFriendlyName };
Default Value
""
Remarks
Contains an associated alias (friendly name) of the certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertHandle Property (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 UsedCertHandle[int UsedCertIndex] = { read=FUsedCertHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Long64
UsedCertHashAlgorithm Property (CertificateValidator Component)
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .
Syntax
__property String UsedCertHashAlgorithm[int UsedCertIndex] = { read=FUsedCertHashAlgorithm };
Default Value
""
Remarks
Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)
SB_HASH_ALGORITHM_SHA1 | SHA1 | |
SB_HASH_ALGORITHM_SHA224 | SHA224 | |
SB_HASH_ALGORITHM_SHA256 | SHA256 | |
SB_HASH_ALGORITHM_SHA384 | SHA384 | |
SB_HASH_ALGORITHM_SHA512 | SHA512 | |
SB_HASH_ALGORITHM_MD2 | MD2 | |
SB_HASH_ALGORITHM_MD4 | MD4 | |
SB_HASH_ALGORITHM_MD5 | MD5 | |
SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | |
SB_HASH_ALGORITHM_CRC32 | CRC32 | |
SB_HASH_ALGORITHM_SSL3 | SSL3 | |
SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | |
SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | |
SB_HASH_ALGORITHM_POLY1305 | POLY1305 | |
SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | |
SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | |
SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | |
SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | |
SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | |
SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | |
SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | |
SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | |
SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | |
SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | |
SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | |
SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | |
SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | |
SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | |
SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | |
SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN |
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertIssuer Property (CertificateValidator Component)
The common name of the certificate issuer (CA), typically a company name.
Syntax
__property String UsedCertIssuer[int UsedCertIndex] = { read=FUsedCertIssuer };
Default Value
""
Remarks
The common name of the certificate issuer (CA), typically a company name.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertIssuerRDN Property (CertificateValidator Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
Syntax
__property String UsedCertIssuerRDN[int UsedCertIndex] = { read=FUsedCertIssuerRDN };
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertKeyAlgorithm Property (CertificateValidator Component)
Specifies the public key algorithm of this certificate.
Syntax
__property String UsedCertKeyAlgorithm[int UsedCertIndex] = { read=FUsedCertKeyAlgorithm };
Default Value
"0"
Remarks
Specifies the public key algorithm of this certificate.
SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | |
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | |
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | |
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA | id-dsa | |
SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | |
SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | |
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | |
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | |
SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | |
SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | |
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | |
SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | |
SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | |
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | |
SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | |
SB_CERT_ALGORITHM_EC | id-ecPublicKey | |
SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | |
SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | |
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | |
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | |
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | |
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | |
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | |
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | |
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | |
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | |
SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | |
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | |
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | |
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | |
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | |
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | |
SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | |
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | |
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | |
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | |
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | |
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | |
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | |
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | |
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | |
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | |
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | |
SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | |
SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | |
SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | |
SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | |
SB_CERT_ALGORITHM_EDDSA | id-EdDSA | |
SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig |
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertKeyBits Property (CertificateValidator Component)
Returns the length of the public key.
Syntax
__property int UsedCertKeyBits[int UsedCertIndex] = { read=FUsedCertKeyBits };
Default Value
0
Remarks
Returns the length of the public key.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
UsedCertKeyFingerprint Property (CertificateValidator Component)
Returns a fingerprint of the public key contained in the certificate.
Syntax
__property DynamicArrayUsedCertKeyFingerprint[int UsedCertIndex] = { read=FUsedCertKeyFingerprint };
Remarks
Returns a fingerprint of the public key contained in the certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertKeyUsage Property (CertificateValidator Component)
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
Syntax
__property int UsedCertKeyUsage[int UsedCertIndex] = { read=FUsedCertKeyUsage };
Default Value
0
Remarks
Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
This value is a bit mask of the following values:
ckuUnknown | 0x00000 | Unknown key usage |
ckuDigitalSignature | 0x00001 | Digital signature |
ckuNonRepudiation | 0x00002 | Non-repudiation |
ckuKeyEncipherment | 0x00004 | Key encipherment |
ckuDataEncipherment | 0x00008 | Data encipherment |
ckuKeyAgreement | 0x00010 | Key agreement |
ckuKeyCertSign | 0x00020 | Certificate signing |
ckuCRLSign | 0x00040 | Revocation signing |
ckuEncipherOnly | 0x00080 | Encipher only |
ckuDecipherOnly | 0x00100 | Decipher only |
ckuServerAuthentication | 0x00200 | Server authentication |
ckuClientAuthentication | 0x00400 | Client authentication |
ckuCodeSigning | 0x00800 | Code signing |
ckuEmailProtection | 0x01000 | Email protection |
ckuTimeStamping | 0x02000 | Timestamping |
ckuOCSPSigning | 0x04000 | OCSP signing |
ckuSmartCardLogon | 0x08000 | Smartcard logon |
ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication |
ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC |
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
UsedCertKeyValid Property (CertificateValidator Component)
Returns True if the certificate's key is cryptographically valid, and False otherwise.
Syntax
__property bool UsedCertKeyValid[int UsedCertIndex] = { read=FUsedCertKeyValid };
Default Value
false
Remarks
Returns True if the certificate's key is cryptographically valid, and False otherwise.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertOCSPLocations Property (CertificateValidator Component)
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
Syntax
__property String UsedCertOCSPLocations[int UsedCertIndex] = { read=FUsedCertOCSPLocations };
Default Value
""
Remarks
Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertOCSPNoCheck Property (CertificateValidator Component)
Accessor to the value of the certificate's ocsp-no-check extension.
Syntax
__property bool UsedCertOCSPNoCheck[int UsedCertIndex] = { read=FUsedCertOCSPNoCheck };
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 (CertificateValidator Component)
Returns the origin of this certificate.
Syntax
__property int UsedCertOrigin[int UsedCertIndex] = { read=FUsedCertOrigin };
Default Value
0
Remarks
Returns the origin of this certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
UsedCertPolicyIDs Property (CertificateValidator Component)
Contains identifiers (OIDs) of the applicable certificate policies.
Syntax
__property String UsedCertPolicyIDs[int UsedCertIndex] = { read=FUsedCertPolicyIDs };
Default Value
""
Remarks
Contains identifiers (OIDs) of the applicable certificate policies.
The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertPrivateKeyBytes Property (CertificateValidator Component)
Contains the certificate's private key.
Syntax
__property DynamicArrayUsedCertPrivateKeyBytes[int UsedCertIndex] = { read=FUsedCertPrivateKeyBytes };
Remarks
Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertPrivateKeyExists Property (CertificateValidator Component)
Indicates whether the certificate has an associated private key.
Syntax
__property bool UsedCertPrivateKeyExists[int UsedCertIndex] = { read=FUsedCertPrivateKeyExists };
Default Value
false
Remarks
Indicates whether the certificate has an associated private key.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertPrivateKeyExtractable Property (CertificateValidator Component)
Indicates whether the private key is extractable.
Syntax
__property bool UsedCertPrivateKeyExtractable[int UsedCertIndex] = { read=FUsedCertPrivateKeyExtractable };
Default Value
false
Remarks
Indicates whether the private key is extractable.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertPublicKeyBytes Property (CertificateValidator Component)
Contains the certificate's public key in DER format.
Syntax
__property DynamicArrayUsedCertPublicKeyBytes[int UsedCertIndex] = { read=FUsedCertPublicKeyBytes };
Remarks
Contains the certificate's public key in DER format.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertQualifiedStatements Property (CertificateValidator Component)
Returns the qualified status of the certificate.
Syntax
__property TsbxCertificateValidatorUsedCertQualifiedStatements UsedCertQualifiedStatements[int UsedCertIndex] = { read=FUsedCertQualifiedStatements };
enum TsbxCertificateValidatorUsedCertQualifiedStatements { qstNonQualified=0, qstQualifiedHardware=1, qstQualifiedSoftware=2 };
Default Value
qstNonQualified
Remarks
Returns the qualified status of the certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Integer
UsedCertSelfSigned Property (CertificateValidator Component)
Indicates whether the certificate is self-signed (root) or signed by an external CA.
Syntax
__property bool UsedCertSelfSigned[int UsedCertIndex] = { read=FUsedCertSelfSigned };
Default Value
false
Remarks
Indicates whether the certificate is self-signed (root) or signed by an external CA.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Boolean
UsedCertSerialNumber Property (CertificateValidator Component)
Returns the certificate's serial number.
Syntax
__property DynamicArrayUsedCertSerialNumber[int UsedCertIndex] = { read=FUsedCertSerialNumber };
Remarks
Returns the certificate's serial number.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertSigAlgorithm Property (CertificateValidator Component)
Indicates the algorithm that was used by the CA to sign this certificate.
Syntax
__property String UsedCertSigAlgorithm[int UsedCertIndex] = { read=FUsedCertSigAlgorithm };
Default Value
""
Remarks
Indicates the algorithm that was used by the CA to sign this certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertSubject Property (CertificateValidator Component)
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
Syntax
__property String UsedCertSubject[int UsedCertIndex] = { read=FUsedCertSubject };
Default Value
""
Remarks
The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertSubjectAlternativeName Property (CertificateValidator Component)
Returns or sets the value of the Subject Alternative Name extension of the certificate.
Syntax
__property String UsedCertSubjectAlternativeName[int UsedCertIndex] = { read=FUsedCertSubjectAlternativeName };
Default Value
""
Remarks
Returns or sets the value of the Subject Alternative Name extension of the certificate.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertSubjectKeyID Property (CertificateValidator Component)
Contains a unique identifier (fingerprint) of the certificate's private key.
Syntax
__property DynamicArrayUsedCertSubjectKeyID[int UsedCertIndex] = { read=FUsedCertSubjectKeyID };
Remarks
Contains a unique identifier (fingerprint) of the certificate's private key.
Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
Byte Array
UsedCertSubjectRDN Property (CertificateValidator Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
Syntax
__property String UsedCertSubjectRDN[int UsedCertIndex] = { read=FUsedCertSubjectRDN };
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertValidFrom Property (CertificateValidator Component)
The time point at which the certificate becomes valid, in UTC.
Syntax
__property String UsedCertValidFrom[int UsedCertIndex] = { read=FUsedCertValidFrom };
Default Value
""
Remarks
The time point at which the certificate becomes valid, in UTC.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCertValidTo Property (CertificateValidator Component)
The time point at which the certificate expires, in UTC.
Syntax
__property String UsedCertValidTo[int UsedCertIndex] = { read=FUsedCertValidTo };
Default Value
""
Remarks
The time point at which the certificate expires, in UTC.
The UsedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCertCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLCount Property (CertificateValidator Component)
The number of records in the UsedCRL arrays.
Syntax
__property int UsedCRLCount = { read=FUsedCRLCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- UsedCRLBytes
- UsedCRLHandle
- UsedCRLIssuer
- UsedCRLIssuerRDN
- UsedCRLLocation
- UsedCRLNextUpdate
- UsedCRLThisUpdate
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 (CertificateValidator Component)
Returns the raw CRL data in DER format.
Syntax
__property DynamicArrayUsedCRLBytes[int UsedCRLIndex] = { read=FUsedCRLBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 UsedCRLHandle[int UsedCRLIndex] = { read=FUsedCRLHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
Long64
UsedCRLIssuer Property (CertificateValidator Component)
The common name of the CRL issuer (CA), typically a company name.
Syntax
__property String UsedCRLIssuer[int UsedCRLIndex] = { read=FUsedCRLIssuer };
Default Value
""
Remarks
The common name of the CRL issuer (CA), typically a company name.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLIssuerRDN Property (CertificateValidator Component)
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Syntax
__property String UsedCRLIssuerRDN[int UsedCRLIndex] = { read=FUsedCRLIssuerRDN };
Default Value
""
Remarks
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLLocation Property (CertificateValidator Component)
The URL that the CRL was downloaded from.
Syntax
__property String UsedCRLLocation[int UsedCRLIndex] = { read=FUsedCRLLocation };
Default Value
""
Remarks
The URL that the CRL was downloaded from.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLNextUpdate Property (CertificateValidator Component)
The planned time and date of the next version of this CRL to be published.
Syntax
__property String UsedCRLNextUpdate[int UsedCRLIndex] = { read=FUsedCRLNextUpdate };
Default Value
""
Remarks
The planned time and date of the next version of this CRL to be published.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UsedCRLThisUpdate Property (CertificateValidator Component)
The date and time at which this version of the CRL was published.
Syntax
__property String UsedCRLThisUpdate[int UsedCRLIndex] = { read=FUsedCRLThisUpdate };
Default Value
""
Remarks
The date and time at which this version of the CRL was published.
The UsedCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedCRLCount property.
This property is read-only and not available at design time.
Data Type
String
UseDefaultTSLs Property (CertificateValidator Component)
Enables or disables the use of the default TSLs.
Syntax
__property bool UseDefaultTSLs = { read=FUseDefaultTSLs, write=FSetUseDefaultTSLs };
Default Value
false
Remarks
Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists). The result of this check reported in Qualified property.
The following default TSLs are used: EU (European Union) TSL.
Data Type
Boolean
UsedOCSPCount Property (CertificateValidator Component)
The number of records in the UsedOCSP arrays.
Syntax
__property int UsedOCSPCount = { read=FUsedOCSPCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at UsedOCSPCount - 1.
This property is read-only and not available at design time.
Data Type
Integer
UsedOCSPBytes Property (CertificateValidator Component)
A buffer containing the raw OCSP response data.
Syntax
__property DynamicArrayUsedOCSPBytes[int UsedOCSPIndex] = { read=FUsedOCSPBytes };
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 (CertificateValidator Component)
Allows to get or set a 'handle', a unique identifier of the underlying property object.
Syntax
__property __int64 UsedOCSPHandle[int UsedOCSPIndex] = { read=FUsedOCSPHandle };
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
Long64
UsedOCSPIssuer Property (CertificateValidator Component)
Indicates the issuer of this response (a CA or its authorized representative).
Syntax
__property String UsedOCSPIssuer[int UsedOCSPIndex] = { read=FUsedOCSPIssuer };
Default Value
""
Remarks
Indicates the issuer of this response (a CA or its authorized representative).
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
String
UsedOCSPIssuerRDN Property (CertificateValidator Component)
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Syntax
__property String UsedOCSPIssuerRDN[int UsedOCSPIndex] = { read=FUsedOCSPIssuerRDN };
Default Value
""
Remarks
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
String
UsedOCSPLocation Property (CertificateValidator Component)
The location of the OCSP responder.
Syntax
__property String UsedOCSPLocation[int UsedOCSPIndex] = { read=FUsedOCSPLocation };
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 (CertificateValidator Component)
Specifies the time when the response was produced, in UTC.
Syntax
__property String UsedOCSPProducedAt[int UsedOCSPIndex] = { read=FUsedOCSPProducedAt };
Default Value
""
Remarks
Specifies the time when the response was produced, in UTC.
The UsedOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UsedOCSPCount property.
This property is read-only and not available at design time.
Data Type
String
UseSystemCertificates Property (CertificateValidator Component)
Enables or disables the use of the system certificates.
Syntax
__property bool UseSystemCertificates = { read=FUseSystemCertificates, write=FSetUseSystemCertificates };
Default Value
false
Remarks
Use this property to tell the validator to use (or not to use) the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.
Data Type
Boolean
ValidationLog Property (CertificateValidator Component)
Contains the complete log of the certificate validation routine.
Syntax
__property String ValidationLog = { read=FValidationLog };
Default Value
""
Remarks
Use this property to access the chain validation log produced by the component. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
This property is read-only and not available at design time.
Data Type
String
ValidationMoment Property (CertificateValidator Component)
The time point at which chain validity is to be established.
Syntax
__property String ValidationMoment = { read=FValidationMoment, write=FSetValidationMoment };
Default Value
""
Remarks
Use this property to specify the moment in time at which chain validity should be established. The time is in UTC. Leave the setting empty to stick to the current moment.
The validity of the same chain may differ depending on the time point chosen due to temporal changes in subchain validities and revocation statuses.
Data Type
String
Config Method (CertificateValidator Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (CertificateValidator Component)
Performs an additional action.
Syntax
String __fastcall DoAction(String ActionID, String ActionParams);
Remarks
DoAction is a generic method available in every component. 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 (CertificateValidator Component)
Obtains the qualified information for Certificate .
Syntax
void __fastcall GetQualifiedStatus();
Remarks
Use this method to obtain a fresh qualified status for the certificate.
GetTSLProperty Method (CertificateValidator Component)
Returns a specific TSL property.
Syntax
String __fastcall GetTSLProperty(String PropName, String 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 (CertificateValidator Component)
Refreshes the certificate cache.
Syntax
void __fastcall RefreshCache();
Remarks
Use this method to remove obsolete information from the validation cache (only makes sense if CacheValidationResults is on).
ResetCache Method (CertificateValidator Component)
Clears all data contained in the validation cache.
Syntax
void __fastcall ResetCache();
Remarks
Use this method to clear the validation cache (only makes sense if CacheValidationResults is on).
Terminate Method (CertificateValidator Component)
Terminates the validation process.
Syntax
void __fastcall Terminate();
Remarks
Call this method if you would like to stop the validation process.
Validate Method (CertificateValidator Component)
Validates the certificate chain.
Syntax
int __fastcall Validate();
Remarks
Use this method to validate the certificate chain that starts with Certificate.
The chain validation is a multi-step process which includes validation of each certificate in the chain up to the trusted anchor. The ultimate goal of this process is to establish the integrity of the chain and its trustworthiness.
Depending on the component tuneup, the validation process may differ drastically, even for the same certificate: it may be more or less rigorous, may include or exclude revocation checks, and may be more or less tolerant to minor chain issues.
When this process is completed, the final decision on the validity of the checked certificate is returned from this method, and also saved in ChainValidationResult property. Another property, ChainValidationDetails, provides insight into the reasons that contributed to that decision. Use ValidationLog to get a detailed step-by-step log of the entire validation process.
ValidateForSMIME Method (CertificateValidator Component)
Validates an e-mail signing certificate.
Syntax
int __fastcall ValidateForSMIME(String 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 (CertificateValidator Component)
Validates a server-side SSL/TLS certificate.
Syntax
int __fastcall ValidateForSSL(String URL, String 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 (CertificateValidator Component)
Marks the end of a single certificate processing step.
Syntax
typedef struct { String Cert; int Validity; int ValidationDetails; } TsbxCertificateValidatorAfterCertificateProcessingEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorAfterCertificateProcessingEvent)(System::TObject* Sender, TsbxCertificateValidatorAfterCertificateProcessingEventParams *e); __property TsbxCertificateValidatorAfterCertificateProcessingEvent OnAfterCertificateProcessing = { read=FOnAfterCertificateProcessing, write=FOnAfterCertificateProcessing };
Remarks
This event is fired when the component has finished processing Cert, and returns its Validity status and ValidationDetails.
'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via AfterCertificateValidation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.
You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via InterimValidationResult and InterimValidationDetails properties.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
AfterCertificateValidation Event (CertificateValidator Component)
Marks the end of a single certificate validation step.
Syntax
typedef struct { String Cert; String CACert; int Validity; int ValidationDetails; } TsbxCertificateValidatorAfterCertificateValidationEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorAfterCertificateValidationEvent)(System::TObject* Sender, TsbxCertificateValidatorAfterCertificateValidationEventParams *e); __property TsbxCertificateValidatorAfterCertificateValidationEvent OnAfterCertificateValidation = { read=FOnAfterCertificateValidation, write=FOnAfterCertificateValidation };
Remarks
This event is fired when the component has finished validation of Cert with CACert, and returns its Validity status and ValidationDetails.
'Validation', in this context, means a single validation of a certificate with its CA certificate. For certificates with multiple CAs, validations are grouped into 'processings.' Each processing, therefore, is a set of validations of the same certificate with all its CAs.
You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via InterimValidationResult and InterimValidationDetails properties.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
BeforeCACertificateDownload Event (CertificateValidator Component)
Fires when a CA certificate is about to be downloaded.
Syntax
typedef struct { String Cert; String Location; } TsbxCertificateValidatorBeforeCACertificateDownloadEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeCACertificateDownloadEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeCACertificateDownloadEventParams *e); __property TsbxCertificateValidatorBeforeCACertificateDownloadEvent OnBeforeCACertificateDownload = { read=FOnBeforeCACertificateDownload, write=FOnBeforeCACertificateDownload };
Remarks
This event is fired when a CA certificate that is needed to validate Cert is about to be downloaded from Location.
BeforeCertificateProcessing Event (CertificateValidator Component)
Reports the start of certificate processing.
Syntax
typedef struct { String Cert; int Validity; int ValidationDetails; } TsbxCertificateValidatorBeforeCertificateProcessingEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeCertificateProcessingEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeCertificateProcessingEventParams *e); __property TsbxCertificateValidatorBeforeCertificateProcessingEvent OnBeforeCertificateProcessing = { read=FOnBeforeCertificateProcessing, write=FOnBeforeCertificateProcessing };
Remarks
This event is fired when the component is about to start the processing of Cert.
'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via AfterCertificateValidation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.
The firing of AfterCertificateProcessing marks the end of the certificate processing.
Validity and ValidationDetails specify the current validation status.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
BeforeCertificateValidation Event (CertificateValidator Component)
Reports the start of certificate validation.
Syntax
typedef struct { String Cert; String CACert; } TsbxCertificateValidatorBeforeCertificateValidationEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeCertificateValidationEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeCertificateValidationEventParams *e); __property TsbxCertificateValidatorBeforeCertificateValidationEvent OnBeforeCertificateValidation = { read=FOnBeforeCertificateValidation, write=FOnBeforeCertificateValidation };
Remarks
This event is fired when the component is about to start validating Cert with CACert.
A 'validation' is a single step of validating a certificate with its CA certificate. A row of consecutive validations of the same certificate with different CAs are grouped into 'processings.'
The firing of AfterCertificateValidation marks the end of the certificate validation step.
BeforeCRLDownload Event (CertificateValidator Component)
Fires when a CRL is about to be downloaded.
Syntax
typedef struct { String Cert; String CACert; String Location; } TsbxCertificateValidatorBeforeCRLDownloadEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeCRLDownloadEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeCRLDownloadEventParams *e); __property TsbxCertificateValidatorBeforeCRLDownloadEvent OnBeforeCRLDownload = { read=FOnBeforeCRLDownload, write=FOnBeforeCRLDownload };
Remarks
This event is fired when a CRL (Certificate Revocation List) needed to validate Cert is going to be downloaded from Location.
BeforeOCSPDownload Event (CertificateValidator Component)
Fires when a certificate's OCSP status is about to be requested.
Syntax
typedef struct { String Cert; String CACert; String Location; } TsbxCertificateValidatorBeforeOCSPDownloadEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorBeforeOCSPDownloadEvent)(System::TObject* Sender, TsbxCertificateValidatorBeforeOCSPDownloadEventParams *e); __property TsbxCertificateValidatorBeforeOCSPDownloadEvent OnBeforeOCSPDownload = { read=FOnBeforeOCSPDownload, write=FOnBeforeOCSPDownload };
Remarks
This event is fired when the validator is about to request a fresh revocation status from an OCSP responder.
CACertificateDownloaded Event (CertificateValidator Component)
Marks the success of a certificate download.
Syntax
typedef struct { String Cert; String Location; } TsbxCertificateValidatorCACertificateDownloadedEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorCACertificateDownloadedEvent)(System::TObject* Sender, TsbxCertificateValidatorCACertificateDownloadedEventParams *e); __property TsbxCertificateValidatorCACertificateDownloadedEvent OnCACertificateDownloaded = { read=FOnCACertificateDownloaded, write=FOnCACertificateDownloaded };
Remarks
This event is fired when a CA certificate has been successfully downloaded from Location. This event is preceded with BeforeCACertificateDownload event.
CACertificateNeeded Event (CertificateValidator Component)
Requests a missing certificate from the user.
Syntax
typedef struct { String Cert; } TsbxCertificateValidatorCACertificateNeededEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorCACertificateNeededEvent)(System::TObject* Sender, TsbxCertificateValidatorCACertificateNeededEventParams *e); __property TsbxCertificateValidatorCACertificateNeededEvent OnCACertificateNeeded = { read=FOnCACertificateNeeded, write=FOnCACertificateNeeded };
Remarks
This event is fired when a CA certificate that is needed to validate Cert is not found at any of the available locations. If you have access to the missing certificate, please add it to the KnownCertificates collection to make it available to the validator.
When this event fires, the CurrentCertificate property is assigned with the certificate being validated. It is the CA that issued that certificate that the validator is looking for.
CRLDownloaded Event (CertificateValidator Component)
Marks the success of a CRL download.
Syntax
typedef struct { String Cert; String CACert; String Location; } TsbxCertificateValidatorCRLDownloadedEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorCRLDownloadedEvent)(System::TObject* Sender, TsbxCertificateValidatorCRLDownloadedEventParams *e); __property TsbxCertificateValidatorCRLDownloadedEvent OnCRLDownloaded = { read=FOnCRLDownloaded, write=FOnCRLDownloaded };
Remarks
This event is fired when a CRL containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with BeforeCRLDownload event.
CRLNeeded Event (CertificateValidator Component)
Requests a missing CRL from the user.
Syntax
typedef struct { String Cert; String CACert; } TsbxCertificateValidatorCRLNeededEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorCRLNeededEvent)(System::TObject* Sender, TsbxCertificateValidatorCRLNeededEventParams *e); __property TsbxCertificateValidatorCRLNeededEvent OnCRLNeeded = { read=FOnCRLNeeded, write=FOnCRLNeeded };
Remarks
This event is fired when a CRL that is needed to validate Cert is not found at any of the available locations. If you have access to the missing CRL, please add it to the KnownCRLs collection to make it available to the validator.
When this event fires, the CurrentCertificate and CurrentCACertificate properties are assigned with the certificate being validated and its issuer certificate.
Error Event (CertificateValidator Component)
Information about errors during certificate validation.
Syntax
typedef struct { int ErrorCode; String Description; } TsbxCertificateValidatorErrorEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorErrorEvent)(System::TObject* Sender, TsbxCertificateValidatorErrorEventParams *e); __property TsbxCertificateValidatorErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The event is fired in case of exceptional conditions during certificate processing or online information retrieval.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the corresponding section.
Notification Event (CertificateValidator Component)
This event notifies the application about an underlying control flow event.
Syntax
typedef struct { String EventID; String EventParam; } TsbxCertificateValidatorNotificationEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorNotificationEvent)(System::TObject* Sender, TsbxCertificateValidatorNotificationEventParams *e); __property TsbxCertificateValidatorNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };
Remarks
The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.
This component can fire this event with the following EventID values:
DownloadTSL | This event is fired if a Trusted List is requested. The EventParam parameter contains the URL value from where to retrieve the TrustedList. The downloaded Trusted List content should be assigned to the TSLContent or TSLContentHex configuration settings. The component automatically downloads Trusted List if OfflineMode is disabled and no Trusted List content is provided. It is important to note that if you are caching the Trusted List content, you should check the NextUpdate field of the Trusted List and update it in a timely manner, otherwise the outdated Trusted List will be discarded. |
StoreTSL | This event is fired if the Trusted List should be stored for offline usage. The EventParam parameter contains the URL value from where the Trusted List was retrieved. The TrustedList content could be read using TSLContent or TSLContentHex configuration settings. |
OCSPDownloaded Event (CertificateValidator Component)
Marks the success of an OCSP request.
Syntax
typedef struct { String Cert; String CACert; String Location; } TsbxCertificateValidatorOCSPDownloadedEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorOCSPDownloadedEvent)(System::TObject* Sender, TsbxCertificateValidatorOCSPDownloadedEventParams *e); __property TsbxCertificateValidatorOCSPDownloadedEvent OnOCSPDownloaded = { read=FOnOCSPDownloaded, write=FOnOCSPDownloaded };
Remarks
This event is fired when an OCSP response containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with BeforeOCSPDownload event.
TLSCertNeeded Event (CertificateValidator Component)
Fires when a remote TLS party requests a client certificate.
Syntax
typedef struct { String Host; String CANames; } TsbxCertificateValidatorTLSCertNeededEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorTLSCertNeededEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSCertNeededEventParams *e); __property TsbxCertificateValidatorTLSCertNeededEvent OnTLSCertNeeded = { read=FOnTLSCertNeeded, write=FOnTLSCertNeeded };
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 (CertificateValidator Component)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
typedef struct { String ServerHost; String ServerIP; bool Accept; } TsbxCertificateValidatorTLSCertValidateEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorTLSCertValidateEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSCertValidateEventParams *e); __property TsbxCertificateValidatorTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };
Remarks
This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, components may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.
TLSEstablished Event (CertificateValidator Component)
Fires when a TLS handshake with Host successfully completes.
Syntax
typedef struct { String Host; String Version; String Ciphersuite; DynamicArrayConnectionId; bool Abort; } TsbxCertificateValidatorTLSEstablishedEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorTLSEstablishedEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSEstablishedEventParams *e); __property TsbxCertificateValidatorTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };
Remarks
The component 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 (CertificateValidator Component)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
typedef struct { String Host; bool Abort; } TsbxCertificateValidatorTLSHandshakeEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorTLSHandshakeEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSHandshakeEventParams *e); __property TsbxCertificateValidatorTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };
Remarks
The component 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 (CertificateValidator Component)
Reports the graceful closure of a TLS connection.
Syntax
typedef struct { String Host; } TsbxCertificateValidatorTLSShutdownEventParams; typedef void __fastcall (__closure *TsbxCertificateValidatorTLSShutdownEvent)(System::TObject* Sender, TsbxCertificateValidatorTLSShutdownEventParams *e); __property TsbxCertificateValidatorTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };
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 Component)
The component 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 component, access to these internal properties is provided through the Config method.CertificateValidator Config Settings
The validity period of the cached validation results in milliseconds.
Whether to check a 'strong' hash algorithm for trusted certificates.
Whether to check validity period for trusted certificates.
This property tells the component 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.
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 component 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).
Whether the whole certificate chain down to the CA certificate should be validated for trusted certificates.
Specifies if revocation information should be checked for the root certificate.
Whether to ignore bad OCSP chains during validation.
Whether to ignore the Basic Constraints extension for the CA certificates.
Whether to ignore Key Usage extension for CA certificates.
Whether to ignore the Name Constraints extension for the CA certificates.
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.
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.
Whether the issuer (CA) certificates should be checked if their key usage extension (when available) allows using them to sign revocation information.
Whether the issuer (CA) certificates should be checked if their key usage extension (when available) allows using these certificates in SSL protocol communications.
Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component 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.
Set this property to True to implicitly trust all self-signed certificates.
Whether to look for implicit CRL Distribution Points (DPs) if no DPs are available.
Set this property to True to force the component to publish 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted.
Use this property to specify the grace period (in seconds). Grace period allows the certificate revocation information to propagate through the revocation process.
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".
Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository.
Use this property to enable or disable the use of the global chain validation cache. If enabled, the component will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the component, 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.
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.
Defines how to handle the certificates signed using a 'weak' hash algorithm.
Supported values: wahmIgnore = 0 wahmWarning = 1 wahmError = 2
TrustedLists Config Settings
Use this property to specify the custom TSLs (Trust Service status Lists) to the validator. The URLs list is comma-separated.
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.
Assign or read this property in your Notification event handler with the Trusted List content.
Assign or read this property in your Notification event handler with the Trusted List content in Hex encoding.
Use this property to get XML content of distribution points of the TSL used to obtain the qualified status of the certificate.
Use this property to get distribution point of the specified index of the TSL used to obtain the qualified status of the certificate.
Use this property to get historical information period of the TSL used to obtain the qualified status of the certificate.
Use this property to get XML content of multilingual legal notices of the TSL used to obtain the qualified status of the certificate.
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.
Use this property to get list issue date and time of the TSL used to obtain the qualified status of the certificate.
Use this property to get next update date and time of the TSL used to obtain the qualified status of the certificate.
Use this property to get XML content of multilingual policies of the TSL used to obtain the qualified status of the certificate.
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.
Use this property to get XML content of scheme extensions of the TSL used to obtain the qualified status of the certificate.
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.
Use this property to get XML content of multilingual scheme information URI of the TSL used to obtain the qualified status of the certificate.
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.
Use this property to get XML content of multilingual scheme name of the TSL used to obtain the qualified status of the certificate.
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.
Use this property to get XML content of scheme operator address of the TSL used to obtain the qualified status of the certificate.
Use this property to get XML content of multilingual scheme operator name of the TSL used to obtain the qualified status of the certificate.
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.
Use this property to get scheme territory of the TSL used to obtain the qualified status of the certificate.
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.
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.
Use this property to get sequence number of the TSL used to obtain the qualified status of the certificate.
Use this property to access the TSLs retrieve log produced by the component. The log can be very useful when investigating issues with TSL retrieve.
Use this property to get status determination approach of the TSL used to obtain the qualified status of the certificate.
Use this property to access the TSLs validation log produced by the component. The log can be very useful when investigating issues with TSL validation.
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.
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.
Indicates whether or not the qualified status was obtained from the TSP (Trust Service Provider) service history instance.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Use this property to get the status of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.
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.
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.
Use this property to get type identifier of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.
Use this property to get XML content of the TSP (Trust Service Provider) service used to obtain the qualified status of the certificate.
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.
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.
Use this property to get XML content of the TSP (Trust Service Provider) used to obtain the qualified status of the certificate.
Use this property to get TSL type of the TSL used to obtain the qualified status of the certificate.
Use this property to get version identifier of the TSL used to obtain the qualified status of the certificate.
Use this property to get XML content of the TSL used to obtain the qualified status of the certificate.
Base Config Settings
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.
Set this property to enable or disable cookies caching for the component.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions.
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.
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.
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 components that have its CookieCaching property set to "global".
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 components.
Contains a comma-separated list of values that specifies where debug log should be dumped.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Contains a comma-separated list of values that specifies which debug log details to dump.
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Use this property to provide a path to the log file.
Contains a comma-separated list of value pairs ("name:value") that describe filters.
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
Use this property to set the log flush mode. The following values are defined:
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Use this property to provide the desired debug log level.
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
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.
Use this property to set the log rotation mode. The following values are defined:
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
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.
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.
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.
Set this property to enable or disable static DNS rules for the component. Works only if UseOwnDNSResolver is set to true.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
Use this property to get or set an IP address for the specified domain name in the internal (of the component) 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.
Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the component is set to "local", the property returns/restores the rules from/to the internal storage of the component. If StaticDNS of the component 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.
Use this config property to store any custom data.
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 components.
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).
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).
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.
Set this global property to false to make each validation run use its own copy of system certificate stores.
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.
Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.
Trappable Errors (CertificateValidator Component)
CertificateValidator Errors
1048577 Invalid parameter value (SB_ERROR_INVALID_PARAMETER) | |
1048578 Component 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) |