CertificateValidator Component

Properties Methods Events Config Settings Errors

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

Syntax

secureblackbox.CertificateValidator

Remarks

This is a powerful and configurable struct which can be used to validate all kinds of certificates and their chains.

The purpose of CertificateValidator is to validate certificate chains according to the X.509 specification. It supports a variety of technologies, including CRL and OCSP services, and can provide a comprehensive output on the certificate cryptographic validity, chain integrity, and trust levels. CertificateValidator is used internally in many other SecureBlackbox components, such as PDFSigner, HTTPClient, and OfficeVerifier.

To validate a certificate, please tune up the component as following:

Assign the certificate to be validated to the Certificate property.
Set RevocationCheck in accordance with your revocation check preferences.
Enable UseSystemCertificates property to trust certificates that are trusted by the operating system. Copy any certificates that are not available in the standard system locations to KnownCertificates and TrustedCertificates collections (see Note 1 below).
Optionally, adjust TLSSettings and SocketSettings.
Adjust ValidationMoment if you would like to check the certificate validity at a different moment in time. Leave it unchanged to validate the certificate at the current time moment.
Call Validate or ValidateForSSL method to initiate chain validation.

Depending on the complexity of the chain and the configuration of the component, the validation routine may take certain amount of time. The validator reports chain validation progress using a selection of events, such as BeforeCertificateProcessing, AfterCertificateProcessing, and CRLDownloaded events. It may also ask you for missing objects using CRLNeeded or CACertificateNeeded events. In each such event handler you can access the currently validated certificate via the CurrentCertificate property, and the interim validity figures via the InterimValidationResult and InterimValidationDetails property.

The return of the Validate (or similar) method indicates the completion of the validation procedure. The outcome of the chain validation is represented with the two parameters:

ChainValidationResult reports the general validation outcome: valid, valid-but-untrusted, invalid, and unknown. As a rule, only the valid result can be taken as a good reason to consider the chain valid.
ChainValidationDetails provides insights into the factors that caused the validation to fail.

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

Note 1: On Windows, CertificateValidator can use CA and ROOT system stores to look for any missing CA certificates and trust anchors. No similar functionality is currently available for other platforms, so in most cases you must provide your own list of trusted and CA certificates via TrustedCertificates and KnownCertificates collections to have your chains validate fully in Linux and macOS projects.

Note 2: The OfflineMode property is a handy way to check the completeness of your revocation/validation information. When the offline mode is on, CertificateValidator won't go online for any missing certificates, CRLs, and OCSP responses. Paired with a switched-off UseSystemCertificates property, it allows to make sure that any content provided via KnownCertificates, KnownCRLs, and KnownOCSPs represents the complete set of validation information required to validate the chain.

Property List

The following is the full list of the properties of the 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.
CheckTrustedLists	Specifies whether the class should attempt to validate chain trust via a known Trusted List.
CurrentCACertBytes	Returns the raw certificate data in DER format.
CurrentCACertCA	Indicates whether the certificate has a CA capability.
CurrentCACertCAKeyID	A unique identifier (fingerprint) of the CA certificate's cryptographic key.
CurrentCACertCertType	Returns the type of the entity contained in the Certificate object.
CurrentCACertCRLDistributionPoints	Contains a list of locations of CRL distribution points used to check this certificate's validity.
CurrentCACertCurve	Specifies the elliptic curve associated with the certificate's 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	Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
CurrentCACertIssuer	The common name of the certificate issuer (CA), typically a company name.
CurrentCACertIssuerRDN	A list of Property=Value pairs that uniquely identify the certificate issuer.
CurrentCACertKeyAlgorithm	Specifies the public key algorithm of this certificate.
CurrentCACertKeyBits	Returns the length of the public key in bits.
CurrentCACertKeyFingerprint	Returns a SHA1 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 services that can be used to check this certificate's validity in real time, as recorded by the CA.
CurrentCACertOCSPNoCheck	Accessor to the value of the certificate's ocsp-no-check extension.
CurrentCACertOrigin	Returns the location that the certificate was taken or loaded from.
CurrentCACertPolicyIDs	Contains identifiers (OIDs) of the applicable certificate policies.
CurrentCACertPrivateKeyBytes	Returns the certificate's private key in DER-encoded format.
CurrentCACertPrivateKeyExists	Indicates whether the certificate has a usable private key associated with it.
CurrentCACertPrivateKeyExtractable	Indicates whether the private key is extractable (exportable).
CurrentCACertPublicKeyBytes	Contains the certificate's public key in DER format.
CurrentCACertQualified	Indicates whether the certificate is qualified.
CurrentCACertQualifiedStatements	Returns a simplified qualified status of the certificate.
CurrentCACertQualifiers	A list of qualifiers.
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.
CurrentCACertSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
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 of the certificate's cryptographic key.
CurrentCACertSubjectRDN	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
CurrentCACertValid	Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
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.
CurrentCertCAKeyID	A unique identifier (fingerprint) of the CA certificate's cryptographic key.
CurrentCertCertType	Returns the type of the entity contained in the Certificate object.
CurrentCertCRLDistributionPoints	Contains a list of locations of CRL distribution points used to check this certificate's validity.
CurrentCertCurve	Specifies the elliptic curve associated with the certificate's 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	Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
CurrentCertIssuer	The common name of the certificate issuer (CA), typically a company name.
CurrentCertIssuerRDN	A list of Property=Value pairs that uniquely identify the certificate issuer.
CurrentCertKeyAlgorithm	Specifies the public key algorithm of this certificate.
CurrentCertKeyBits	Returns the length of the public key in bits.
CurrentCertKeyFingerprint	Returns a SHA1 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 services that can be used to check this certificate's validity in real time, as recorded by the CA.
CurrentCertOCSPNoCheck	Accessor to the value of the certificate's ocsp-no-check extension.
CurrentCertOrigin	Returns the location that the certificate was taken or loaded from.
CurrentCertPolicyIDs	Contains identifiers (OIDs) of the applicable certificate policies.
CurrentCertPrivateKeyBytes	Returns the certificate's private key in DER-encoded format.
CurrentCertPrivateKeyExists	Indicates whether the certificate has a usable private key associated with it.
CurrentCertPrivateKeyExtractable	Indicates whether the private key is extractable (exportable).
CurrentCertPublicKeyBytes	Contains the certificate's public key in DER format.
CurrentCertQualified	Indicates whether the certificate is qualified.
CurrentCertQualifiedStatements	Returns a simplified qualified status of the certificate.
CurrentCertQualifiers	A list of qualifiers.
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.
CurrentCertSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
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 of the certificate's cryptographic key.
CurrentCertSubjectRDN	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
CurrentCertValid	Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
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 class 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.
ProxyType	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.
ProxyUsername	Specifies the username credential for proxy authentication.
QualifiedInfoAddress	Contains the address of the TSL provider.
QualifiedInfoCustomTrustedLists	The list of custom TrustedLists 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.
QualifiedInfoTrusted	Indicates whether the certificate is trusted.
QualifiedInfoUseDefaultTrustedLists	Use this setting to enable or disable the use of the default TrustedLists.
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 class's (secure) built-in one, or the one provided by the system.
SocketDNSPort	Specifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeout	The timeout (in milliseconds) for each DNS query.
SocketDNSServers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeout	The timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimit	The maximum number of bytes to read from the socket, per second.
SocketLocalAddress	The local network interface to bind the socket to.
SocketLocalPort	The local port number to bind the socket to.
SocketOutgoingSpeedLimit	The maximum number of bytes to write to the socket, per second.
SocketTimeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6	Enables or disables IP protocol version 6.
TLSClientCertCount	The number of records in the TLSClientCert arrays.
TLSClientCertBytes	Returns 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.
TLSServerCertFingerprint	Contains the fingerprint (a hash imprint) of this certificate.
TLSServerCertHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
TLSServerCertIssuer	The common name of the certificate issuer (CA), typically a company name.
TLSServerCertIssuerRDN	A list of Property=Value pairs that uniquely identify the certificate issuer.
TLSServerCertKeyAlgorithm	Specifies the public key algorithm of this certificate.
TLSServerCertKeyBits	Returns the length of the public key in bits.
TLSServerCertKeyUsage	Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.
TLSServerCertSelfSigned	Indicates whether the certificate is self-signed (root) or signed by an external CA.
TLSServerCertSerialNumber	Returns the certificate's serial number.
TLSServerCertSigAlgorithm	Indicates the algorithm that was used by the CA to sign this certificate.
TLSServerCertSubject	The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.
TLSServerCertSubjectRDN	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
TLSServerCertValidFrom	The time point at which the certificate becomes valid, in UTC.
TLSServerCertValidTo	The time point at which the certificate expires, in UTC.
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.
TLSClientAuth	Enables or disables certificate-based client authentication.
TLSExtensions	Provides access to TLS extensions.
TLSForceResumeIfDestinationChanges	Whether to force TLS session resumption when the destination address changes.
TLSGroups	Specifies a list of key exchange groups to attempt during the TLS key exchange.
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.
TLSMode	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.
UsedCertCAKeyID	A unique identifier (fingerprint) of the CA certificate's cryptographic key.
UsedCertCertType	Returns the type of the entity contained in the Certificate object.
UsedCertCRLDistributionPoints	Contains a list of locations of CRL distribution points used to check this certificate's validity.
UsedCertCurve	Specifies the elliptic curve associated with the certificate's 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	Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).
UsedCertIssuer	The common name of the certificate issuer (CA), typically a company name.
UsedCertIssuerRDN	A list of Property=Value pairs that uniquely identify the certificate issuer.
UsedCertKeyAlgorithm	Specifies the public key algorithm of this certificate.
UsedCertKeyBits	Returns the length of the public key in bits.
UsedCertKeyFingerprint	Returns a SHA1 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 services that can be used to check this certificate's validity in real time, as recorded by the CA.
UsedCertOCSPNoCheck	Accessor to the value of the certificate's ocsp-no-check extension.
UsedCertOrigin	Returns the location that the certificate was taken or loaded from.
UsedCertPolicyIDs	Contains identifiers (OIDs) of the applicable certificate policies.
UsedCertPrivateKeyBytes	Returns the certificate's private key in DER-encoded format.
UsedCertPrivateKeyExists	Indicates whether the certificate has a usable private key associated with it.
UsedCertPrivateKeyExtractable	Indicates whether the private key is extractable (exportable).
UsedCertPublicKeyBytes	Contains the certificate's public key in DER format.
UsedCertQualified	Indicates whether the certificate is qualified.
UsedCertQualifiedStatements	Returns a simplified qualified status of the certificate.
UsedCertQualifiers	A list of qualifiers.
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.
UsedCertSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
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 of the certificate's cryptographic key.
UsedCertSubjectRDN	A list of Property=Value pairs that uniquely identify the certificate holder (subject).
UsedCertValid	Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.
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.
UsedCRLSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
UsedCRLThisUpdate	The date and time at which this version of the CRL was published.
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.
UsedOCSPSource	Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
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 .
GetTrustedListProperty	Returns a specific TrustedList property.
RefreshCache	Refreshes the certificate cache.
Reset	Resets the class settings.
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.


CachedCRLMaxAge	Specifies the maximum age of a cached CRL.
CachedCRLMaxAgeRatio	Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.
CachedCRLOverlapTime	Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.
CachedOCSPResponseMaxAge	Specifies the maximum age of a cached OCSP response.
CachedOCSPResponseMaxAgeRatio	Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.
CachedOCSPResponseOverlapTime	Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.
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.
DeltaCRLPreference	Specifies whether complete or delta CRLs are preferred.
DislikeOpenEndedOCSPs	Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.
EvaluateSystemTrust	Enables or disables usage of the platform's built-in trust validation facilities.
EvaluateSystemTrustForSelfSignedCertificates	Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.
EvaluateSystemTrustForSSL	Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.
ForceCompleteChainValidationForTrusted	Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.
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.
IgnoreCRLIssuerKeyID	Tells the validator to ignore malformed CRL issuer key IDs.
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.
RevocationCacheAgePolicy	Specifies a preset policy for cached CRL and OCSP response freshness settings.
RevocationMomentGracePeriod	Grace period for revocation information propagation.
SkipSubjectNameIfAltNameExists	Whether to check CommonName if SubjectAltName is present.
UseEnvStorages	Enables or disables use of the environment storages.
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.
CustomTrustedLists	Specifies the custom TrustedLists.
CustomTSLs	Specifies the custom TrustedLists.
DistributionPoints	Contains XML content of distribution points of the TSL used.
HistoricalInformationPeriod	Contains historical information period of the TSL used.
LegalNotices	Contains XML content of legal notices of the TSL used.
ListIssueDateTime	Contains list issue date and time of the TSL used.
NextUpdate	Contains next update date and time of the TSL used.
Policies	Contains XML content of policies of the TSL used.
QualifiedStatus	Indicates a qualified electronic signature.
SchemeExtensions	Contains XML content of scheme extensions of the TSL used.
SchemeInformationURI	Contains XML content of scheme information URI of the TSL used.
SchemeName	Contains XML content of scheme name of the TSL used.
SchemeOperatorAddress	Contains XML content of scheme operator address of the TSL used.
SchemeOperatorName	Contains XML content of scheme operator name of the TSL used.
SchemeTerritory	Contains scheme territory of the TSL used.
SchemeTypeCommunityRules	Contains XML content of scheme type/community/rules of the TSL used.
SequenceNumber	Contains sequence number of the TSL used.
StatusDeterminationApproach	Contains status determination approach of the TSL used.
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 additional 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 additional 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.
TSPAdditionalServiceInformation	Contains additional service information of the TSP service used.
TSPAddress	Contains XML content of the address of the TSP used.
TSPHistoryInstance	Indicates that TSP service history instance used.
TSPHistoryInstanceAdditionalServiceInformation	Contains additional service information of the TSP service history instance used.
TSPHistoryInstanceQualifiers	Contains list of qualifiers of the TSP service history instance used.
TSPHistoryInstanceServiceInformationExtensions	Contains XML content of information extensions of the TSP service history instance used.
TSPHistoryInstanceServiceName	Contains XML content of name of the TSP service history instance used.
TSPHistoryInstanceServiceStatus	Contains status of the TSP service history instance used.
TSPHistoryInstanceServiceStatusStartingTime	Contains status starting time of the TSP service history instance used.
TSPHistoryInstanceServiceTypeIdentifier	Contains type identifier of the TSP service history instance used.
TSPHistoryInstanceXML	Contains XML content of the TSP service history instance used.
TSPInformationExtensions	Contains XML content of information extensions of the TSP used.
TSPInformationURI	Contains XML content of information URI of the TSP used.
TSPName	Contains XML content of name of the TSP used.
TSPSchemeServiceDefinitionURI	Contains XML content of scheme service definition URI of the TSP service used.
TSPServiceDefinitionURI	Contains XML content of definition URI of the TSP service used.
TSPServiceInformationExtensions	Contains XML content of information extensions of the TSP service used.
TSPServiceName	Contains XML content of name of the TSP service used.
TSPServiceQualifiers	Contains list of qualifiers of the TSP service used.
TSPServiceStatus	Contains status of the TSP service used.
TSPServiceStatusStartingTime	Contains status starting time of the TSP service used.
TSPServiceSupplyPoints	Contains XML content of the supply points of the TSP service used.
TSPServiceTypeIdentifier	Contains type identifier of the TSP service used.
TSPServiceXML	Contains XML content of the TSP service used.
TSPTradeName	Contains XML content of trade name of the TSP used.
TSPXML	Contains XML content of the TSP used.
Type	Contains TSL type of the TSL used.
VersionIdentifier	Contains version identifier of the TSL used.
ASN1UseGlobalTagCache	Controls whether ASN.1 module should use a global object cache.
AssignSystemSmartCardPins	Specifies whether CSP-level PINs should be assigned to CNG keys.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class.
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
DNSLocalSuffix	The suffix to assign for TLD names.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
EnableSSHMLKEM	Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes.
EnableTLSMLKEM	Enables support for ML-KEM and hybrid groups in TLS client and server classes.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HardwareCryptoUsePolicy	The hardware crypto usage policy.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
HttpVersion	The HTTP version to use in any inner HTTP client classes created.
IgnoreExpiredMSCTLSigningCert	Whether to tolerate the expired Windows Update signing certificate.
ListDelimiter	The delimiter character for multi-element lists.
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.
OldClientSideRSAFallback	Specifies whether the SSH client should use a SHA1 fallback.
PKICache	Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.
PKICachePath	Specifies the file system path where cached PKI data is stored.
ProductVersion	Returns the version of the SecureBlackbox library.
ServerSSLDHKeyLength	Sets the size of the TLS DHE key exchange group.
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.
UseCRLObjectCaching	Specifies whether reuse of loaded CRL objects is enabled.
UseInternalRandom	Switches between SecureBlackbox-own and platform PRNGs.
UseLegacyAdESValidation	Enables legacy AdES validation mode.
UseOCSPResponseObjectCaching	Specifies whether reuse of loaded OCSP response objects is enabled.
UseOwnDNSResolver	Specifies whether the client classes should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemNativeSizeCalculation	An internal CryptoAPI access tweak.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.
XMLRDNDescriptorName[OID]	Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.
XMLRDNDescriptorPriority[OID]	Specifies the priority of descriptor names associated with a specific OID.
XMLRDNDescriptorReverseOrder	Specifies whether to reverse the order of descriptors in RDN.
XMLRDNDescriptorSeparator	Specifies the separator used between descriptors in RDN.

BlockedCertCount Property (CertificateValidator Component)

The number of records in the BlockedCert arrays.

Syntax

func (obj *CertificateValidator) BlockedCertCount() (int32, error)
func (obj *CertificateValidator) SetBlockedCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

BlockedCertBytes
BlockedCertHandle

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

Data Type

int32

BlockedCertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) BlockedCertBytes(BlockedCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

BlockedCertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) BlockedCertHandle(BlockedCertIndex int32) (int64, error)
func (obj *CertificateValidator) SetBlockedCertHandle(BlockedCertIndex int32, value int64) error

Default Value

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.

Data Type

int64

CacheValidationResults Property (CertificateValidator Component)

Enables or disables validation result caching.

Syntax

func (obj *CertificateValidator) CacheValidationResults() (bool, error)
func (obj *CertificateValidator) SetCacheValidationResults(value bool) error

Default Value

false

Remarks

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

Data Type

bool

CertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) CertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

CertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CertHandle() (int64, error)
func (obj *CertificateValidator) SetCertHandle(value int64) error

Default Value

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.

Data Type

int64

ChainValidationDetails Property (CertificateValidator Component)

The details of a certificate chain validation outcome.

Syntax

func (obj *CertificateValidator) ChainValidationDetails() (int32, error)

Default Value

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.

Data Type

int32

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

func (obj *CertificateValidator) ChainValidationResult() (int32, error)

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

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.

Data Type

int32

CheckTrustedLists Property (CertificateValidator Component)

Specifies whether the class should attempt to validate chain trust via a known Trusted List.

Syntax

func (obj *CertificateValidator) CheckTrustedLists() (bool, error)
func (obj *CertificateValidator) SetCheckTrustedLists(value bool) error

Default Value

false

Remarks

Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).

Data Type

bool

CurrentCACertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) CurrentCACertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

CurrentCACertCA Property (CertificateValidator Component)

Indicates whether the certificate has a CA capability.

Syntax

func (obj *CertificateValidator) CurrentCACertCA() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

This property is read-only.

Data Type

bool

CurrentCACertCAKeyID Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertCAKeyID() ([]byte, error)

Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the CurrentCACertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

Data Type

[]byte

CurrentCACertCertType Property (CertificateValidator Component)

Returns the type of the entity contained in the Certificate object.

Syntax

func (obj *CertificateValidator) CurrentCACertCertType() (int32, error)

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

Default Value

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager struct to load or create new certificate and certificate requests objects.

This property is read-only.

Data Type

int32

CurrentCACertCRLDistributionPoints Property (CertificateValidator Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

func (obj *CertificateValidator) CurrentCACertCRLDistributionPoints() (string, error)

Default Value

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is read-only.

Data Type

string

CurrentCACertCurve Property (CertificateValidator Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

func (obj *CertificateValidator) CurrentCACertCurve() (string, error)

Default Value

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

This property is read-only.

Data Type

string

CurrentCACertFingerprint Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertFingerprint() (string, error)

Default Value

Remarks

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

This property is read-only.

Data Type

string

CurrentCACertFriendlyName Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertFriendlyName() (string, error)

Default Value

Remarks

Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

This property is read-only.

Data Type

string

CurrentCACertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertHandle() (int64, error)

Default Value

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.

This property is read-only.

Data Type

int64

CurrentCACertHashAlgorithm Property (CertificateValidator Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

func (obj *CertificateValidator) CurrentCACertHashAlgorithm() (string, error)

Default Value

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use CurrentCACertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

This property is read-only.

Data Type

string

CurrentCACertIssuer Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertIssuer() (string, error)

Default Value

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via CurrentCACertIssuerRDN.

This property is read-only.

Data Type

string

CurrentCACertIssuerRDN Property (CertificateValidator Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *CertificateValidator) CurrentCACertIssuerRDN() (string, error)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

This property is read-only.

Data Type

string

CurrentCACertKeyAlgorithm Property (CertificateValidator Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *CertificateValidator) CurrentCACertKeyAlgorithm() (string, error)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`
SB_CERT_ALGORITHM_MLDSA_44	`id-ml-dsa-44`
SB_CERT_ALGORITHM_MLDSA_65	`id-ml-dsa-65`
SB_CERT_ALGORITHM_MLDSA_87	`id-ml-dsa-87`
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512	`id-hash-ml-dsa-44-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512	`id-hash-ml-dsa-65-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512	`id-hash-ml-dsa-87-with-sha512`
SB_CERT_ALGORITHM_MLKEM_512	`id-ml-kem-512`
SB_CERT_ALGORITHM_MLKEM_768	`id-ml-kem-768`
SB_CERT_ALGORITHM_MLKEM_1024	`id-ml-kem-1024`

Use the CurrentCACertKeyBits, CurrentCACertCurve, and CurrentCACertPublicKeyBytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

string

CurrentCACertKeyBits Property (CertificateValidator Component)

Returns the length of the public key in bits.

Syntax

func (obj *CertificateValidator) CurrentCACertKeyBits() (int32, error)

Default Value

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the CurrentCACertPublicKeyBytes or CurrentCACertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

Data Type

int32

CurrentCACertKeyFingerprint Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertKeyFingerprint() (string, error)

Default Value

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the CurrentCACertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

Data Type

string

CurrentCACertKeyUsage Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertKeyUsage() (int32, error)

Default Value

Remarks

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

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

This property is read-only.

Data Type

int32

CurrentCACertKeyValid Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertKeyValid() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

CurrentCACertOCSPLocations Property (CertificateValidator Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

func (obj *CertificateValidator) CurrentCACertOCSPLocations() (string, error)

Default Value

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is read-only.

Data Type

string

CurrentCACertOCSPNoCheck Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertOCSPNoCheck() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

CurrentCACertOrigin Property (CertificateValidator Component)

Returns the location that the certificate was taken or loaded from.

Syntax

func (obj *CertificateValidator) CurrentCACertOrigin() (int32, error)

Default Value

Remarks

Returns the location that the certificate was taken or loaded from.

This property is read-only.

Data Type

int32

CurrentCACertPolicyIDs Property (CertificateValidator Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

func (obj *CertificateValidator) CurrentCACertPolicyIDs() (string, error)

Default Value

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

This property is read-only.

Data Type

string

CurrentCACertPrivateKeyBytes Property (CertificateValidator Component)

Returns the certificate's private key in DER-encoded format.

Syntax

func (obj *CertificateValidator) CurrentCACertPrivateKeyBytes() ([]byte, error)

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

This property is read-only.

Data Type

[]byte

CurrentCACertPrivateKeyExists Property (CertificateValidator Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

func (obj *CertificateValidator) CurrentCACertPrivateKeyExists() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from CurrentCACertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

This property is read-only.

Data Type

bool

CurrentCACertPrivateKeyExtractable Property (CertificateValidator Component)

Indicates whether the private key is extractable (exportable).

Syntax

func (obj *CertificateValidator) CurrentCACertPrivateKeyExtractable() (bool, error)

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

Data Type

bool

CurrentCACertPublicKeyBytes Property (CertificateValidator Component)

Contains the certificate's public key in DER format.

Syntax

func (obj *CertificateValidator) CurrentCACertPublicKeyBytes() ([]byte, error)

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

This property is read-only.

Data Type

[]byte

CurrentCACertQualified Property (CertificateValidator Component)

Indicates whether the certificate is qualified.

Syntax

func (obj *CertificateValidator) CurrentCACertQualified() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

This property is read-only.

Data Type

bool

CurrentCACertQualifiedStatements Property (CertificateValidator Component)

Returns a simplified qualified status of the certificate.

Syntax

func (obj *CertificateValidator) CurrentCACertQualifiedStatements() (int32, error)

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

Remarks

Returns a simplified qualified status of the certificate.

This property is read-only.

Data Type

int32

CurrentCACertQualifiers Property (CertificateValidator Component)

A list of qualifiers.

Syntax

func (obj *CertificateValidator) CurrentCACertQualifiers() (string, error)

Default Value

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

This property is read-only.

Data Type

string

CurrentCACertSelfSigned Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertSelfSigned() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

CurrentCACertSerialNumber Property (CertificateValidator Component)

Returns the certificate's serial number.

Syntax

func (obj *CertificateValidator) CurrentCACertSerialNumber() ([]byte, error)

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

This property is read-only.

Data Type

[]byte

CurrentCACertSigAlgorithm Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertSigAlgorithm() (string, error)

Default Value

Remarks

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

This property is read-only.

Data Type

string

CurrentCACertSource Property (CertificateValidator Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *CertificateValidator) CurrentCACertSource() (int32, error)

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

This property is read-only.

Data Type

int32

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

func (obj *CertificateValidator) CurrentCACertSubject() (string, error)

Default Value

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via CurrentCACertSubjectRDN.

This property is read-only.

Data Type

string

CurrentCACertSubjectAlternativeName Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertSubjectAlternativeName() (string, error)

Default Value

Remarks

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

Subject alternative names are used to provide additional names that are impractical to store in the main CurrentCACertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

This property is read-only.

Data Type

string

CurrentCACertSubjectKeyID Property (CertificateValidator Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

func (obj *CertificateValidator) CurrentCACertSubjectKeyID() ([]byte, error)

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The CurrentCACertSubjectKeyID and CurrentCACertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only.

Data Type

[]byte

CurrentCACertSubjectRDN Property (CertificateValidator Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *CertificateValidator) CurrentCACertSubjectRDN() (string, error)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

This property is read-only.

Data Type

string

CurrentCACertValid Property (CertificateValidator Component)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

func (obj *CertificateValidator) CurrentCACertValid() (bool, error)

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

This property is read-only.

Data Type

bool

CurrentCACertValidFrom Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertValidFrom() (string, error)

Default Value

Remarks

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

This property is read-only.

Data Type

string

CurrentCACertValidTo Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCACertValidTo() (string, error)

Default Value

Remarks

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

This property is read-only.

Data Type

string

CurrentCertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) CurrentCertBytes() ([]byte, error)

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

[]byte

CurrentCertCA Property (CertificateValidator Component)

Indicates whether the certificate has a CA capability.

Syntax

func (obj *CertificateValidator) CurrentCertCA() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

This property is read-only.

Data Type

bool

CurrentCertCAKeyID Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertCAKeyID() ([]byte, error)

Remarks

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

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the CurrentCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

This property is read-only.

Data Type

[]byte

CurrentCertCertType Property (CertificateValidator Component)

Returns the type of the entity contained in the Certificate object.

Syntax

func (obj *CertificateValidator) CurrentCertCertType() (int32, error)

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

Default Value

Remarks

Returns the type of the entity contained in the Certificate object.

Use the CertificateManager struct to load or create new certificate and certificate requests objects.

This property is read-only.

Data Type

int32

CurrentCertCRLDistributionPoints Property (CertificateValidator Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

func (obj *CertificateValidator) CurrentCertCRLDistributionPoints() (string, error)

Default Value

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is read-only.

Data Type

string

CurrentCertCurve Property (CertificateValidator Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

func (obj *CertificateValidator) CurrentCertCurve() (string, error)

Default Value

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

This property is read-only.

Data Type

string

CurrentCertFingerprint Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertFingerprint() (string, error)

Default Value

Remarks

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

This property is read-only.

Data Type

string

CurrentCertFriendlyName Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertFriendlyName() (string, error)

Default Value

Remarks

This property is read-only.

Data Type

string

CurrentCertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertHandle() (int64, error)

Default Value

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.

This property is read-only.

Data Type

int64

CurrentCertHashAlgorithm Property (CertificateValidator Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

func (obj *CertificateValidator) CurrentCertHashAlgorithm() (string, error)

Default Value

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use CurrentCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

This property is read-only.

Data Type

string

CurrentCertIssuer Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertIssuer() (string, error)

Default Value

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via CurrentCertIssuerRDN.

This property is read-only.

Data Type

string

CurrentCertIssuerRDN Property (CertificateValidator Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *CertificateValidator) CurrentCertIssuerRDN() (string, error)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

This property is read-only.

Data Type

string

CurrentCertKeyAlgorithm Property (CertificateValidator Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *CertificateValidator) CurrentCertKeyAlgorithm() (string, error)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`
SB_CERT_ALGORITHM_MLDSA_44	`id-ml-dsa-44`
SB_CERT_ALGORITHM_MLDSA_65	`id-ml-dsa-65`
SB_CERT_ALGORITHM_MLDSA_87	`id-ml-dsa-87`
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512	`id-hash-ml-dsa-44-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512	`id-hash-ml-dsa-65-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512	`id-hash-ml-dsa-87-with-sha512`
SB_CERT_ALGORITHM_MLKEM_512	`id-ml-kem-512`
SB_CERT_ALGORITHM_MLKEM_768	`id-ml-kem-768`
SB_CERT_ALGORITHM_MLKEM_1024	`id-ml-kem-1024`

Use the CurrentCertKeyBits, CurrentCertCurve, and CurrentCertPublicKeyBytes properties to get more details about the key the certificate contains.

This property is read-only.

Data Type

string

CurrentCertKeyBits Property (CertificateValidator Component)

Returns the length of the public key in bits.

Syntax

func (obj *CertificateValidator) CurrentCertKeyBits() (int32, error)

Default Value

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the CurrentCertPublicKeyBytes or CurrentCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

This property is read-only.

Data Type

int32

CurrentCertKeyFingerprint Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertKeyFingerprint() (string, error)

Default Value

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the CurrentCertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

This property is read-only.

Data Type

string

CurrentCertKeyUsage Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertKeyUsage() (int32, error)

Default Value

Remarks

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

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

This property is read-only.

Data Type

int32

CurrentCertKeyValid Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertKeyValid() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

CurrentCertOCSPLocations Property (CertificateValidator Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

func (obj *CertificateValidator) CurrentCertOCSPLocations() (string, error)

Default Value

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

This property is read-only.

Data Type

string

CurrentCertOCSPNoCheck Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertOCSPNoCheck() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

CurrentCertOrigin Property (CertificateValidator Component)

Returns the location that the certificate was taken or loaded from.

Syntax

func (obj *CertificateValidator) CurrentCertOrigin() (int32, error)

Default Value

Remarks

Returns the location that the certificate was taken or loaded from.

This property is read-only.

Data Type

int32

CurrentCertPolicyIDs Property (CertificateValidator Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

func (obj *CertificateValidator) CurrentCertPolicyIDs() (string, error)

Default Value

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

This property is read-only.

Data Type

string

CurrentCertPrivateKeyBytes Property (CertificateValidator Component)

Returns the certificate's private key in DER-encoded format.

Syntax

func (obj *CertificateValidator) CurrentCertPrivateKeyBytes() ([]byte, error)

Remarks

This property is read-only.

Data Type

[]byte

CurrentCertPrivateKeyExists Property (CertificateValidator Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

func (obj *CertificateValidator) CurrentCertPrivateKeyExists() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from CurrentCertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

This property is read-only.

Data Type

bool

CurrentCertPrivateKeyExtractable Property (CertificateValidator Component)

Indicates whether the private key is extractable (exportable).

Syntax

func (obj *CertificateValidator) CurrentCertPrivateKeyExtractable() (bool, error)

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

This property is read-only.

Data Type

bool

CurrentCertPublicKeyBytes Property (CertificateValidator Component)

Contains the certificate's public key in DER format.

Syntax

func (obj *CertificateValidator) CurrentCertPublicKeyBytes() ([]byte, error)

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

This property is read-only.

Data Type

[]byte

CurrentCertQualified Property (CertificateValidator Component)

Indicates whether the certificate is qualified.

Syntax

func (obj *CertificateValidator) CurrentCertQualified() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

This property is read-only.

Data Type

bool

CurrentCertQualifiedStatements Property (CertificateValidator Component)

Returns a simplified qualified status of the certificate.

Syntax

func (obj *CertificateValidator) CurrentCertQualifiedStatements() (int32, error)

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

Remarks

Returns a simplified qualified status of the certificate.

This property is read-only.

Data Type

int32

CurrentCertQualifiers Property (CertificateValidator Component)

A list of qualifiers.

Syntax

func (obj *CertificateValidator) CurrentCertQualifiers() (string, error)

Default Value

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

This property is read-only.

Data Type

string

CurrentCertSelfSigned Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertSelfSigned() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

CurrentCertSerialNumber Property (CertificateValidator Component)

Returns the certificate's serial number.

Syntax

func (obj *CertificateValidator) CurrentCertSerialNumber() ([]byte, error)

Remarks

Returns the certificate's serial number.

This property is read-only.

Data Type

[]byte

CurrentCertSigAlgorithm Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertSigAlgorithm() (string, error)

Default Value

Remarks

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

This property is read-only.

Data Type

string

CurrentCertSource Property (CertificateValidator Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *CertificateValidator) CurrentCertSource() (int32, error)

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

This property is read-only.

Data Type

int32

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

func (obj *CertificateValidator) CurrentCertSubject() (string, error)

Default Value

Remarks

This property is read-only.

Data Type

string

CurrentCertSubjectAlternativeName Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertSubjectAlternativeName() (string, error)

Default Value

Remarks

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

Subject alternative names are used to provide additional names that are impractical to store in the main CurrentCertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

This property is read-only.

Data Type

string

CurrentCertSubjectKeyID Property (CertificateValidator Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

func (obj *CertificateValidator) CurrentCertSubjectKeyID() ([]byte, error)

Remarks

Contains a unique identifier of the certificate's cryptographic key.

The CurrentCertSubjectKeyID and CurrentCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is read-only.

Data Type

[]byte

CurrentCertSubjectRDN Property (CertificateValidator Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *CertificateValidator) CurrentCertSubjectRDN() (string, error)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

This property is read-only.

Data Type

string

CurrentCertValid Property (CertificateValidator Component)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

func (obj *CertificateValidator) CurrentCertValid() (bool, error)

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

This property is read-only.

Data Type

bool

CurrentCertValidFrom Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertValidFrom() (string, error)

Default Value

Remarks

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

This property is read-only.

Data Type

string

CurrentCertValidTo Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) CurrentCertValidTo() (string, error)

Default Value

Remarks

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

This property is read-only.

Data Type

string

FIPSMode Property (CertificateValidator Component)

Reserved.

Syntax

func (obj *CertificateValidator) FIPSMode() (bool, error)
func (obj *CertificateValidator) SetFIPSMode(value bool) error

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

GracePeriod Property (CertificateValidator Component)

Specifies a grace period to apply during certificate validation.

Syntax

func (obj *CertificateValidator) GracePeriod() (int32, error)
func (obj *CertificateValidator) SetGracePeriod(value int32) error

Default Value

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

int32

InterimValidationDetails Property (CertificateValidator Component)

Contains the validation details of the moment.

Syntax

func (obj *CertificateValidator) InterimValidationDetails() (int32, error)
func (obj *CertificateValidator) SetInterimValidationDetails(value int32) error

Default Value

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

Data Type

int32

InterimValidationResult Property (CertificateValidator Component)

Contains the validation status of the moment.

Syntax

func (obj *CertificateValidator) InterimValidationResult() (int32, error)
func (obj *CertificateValidator) SetInterimValidationResult(value int32) error

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

Remarks

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)

Data Type

int32

KnownCertCount Property (CertificateValidator Component)

The number of records in the KnownCert arrays.

Syntax

func (obj *CertificateValidator) KnownCertCount() (int32, error)
func (obj *CertificateValidator) SetKnownCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

KnownCertBytes
KnownCertHandle

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

Data Type

int32

KnownCertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) KnownCertBytes(KnownCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

KnownCertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) KnownCertHandle(KnownCertIndex int32) (int64, error)
func (obj *CertificateValidator) SetKnownCertHandle(KnownCertIndex int32, value int64) error

Default Value

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.

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

Data Type

int64

KnownCRLCount Property (CertificateValidator Component)

The number of records in the KnownCRL arrays.

Syntax

func (obj *CertificateValidator) KnownCRLCount() (int32, error)
func (obj *CertificateValidator) SetKnownCRLCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

KnownCRLBytes
KnownCRLHandle

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

Data Type

int32

KnownCRLBytes Property (CertificateValidator Component)

Returns the raw CRL data in DER format.

Syntax

func (obj *CertificateValidator) KnownCRLBytes(KnownCRLIndex int32) ([]byte, error)

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.

Data Type

[]byte

KnownCRLHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) KnownCRLHandle(KnownCRLIndex int32) (int64, error)
func (obj *CertificateValidator) SetKnownCRLHandle(KnownCRLIndex int32, value int64) error

Default Value

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.

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

Data Type

int64

KnownOCSPCount Property (CertificateValidator Component)

The number of records in the KnownOCSP arrays.

Syntax

func (obj *CertificateValidator) KnownOCSPCount() (int32, error)
func (obj *CertificateValidator) SetKnownOCSPCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

KnownOCSPBytes
KnownOCSPHandle

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

Data Type

int32

KnownOCSPBytes Property (CertificateValidator Component)

A buffer containing the raw OCSP response data.

Syntax

func (obj *CertificateValidator) KnownOCSPBytes(KnownOCSPIndex int32) ([]byte, error)

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.

Data Type

[]byte

KnownOCSPHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) KnownOCSPHandle(KnownOCSPIndex int32) (int64, error)
func (obj *CertificateValidator) SetKnownOCSPHandle(KnownOCSPIndex int32, value int64) error

Default Value

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.

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

Data Type

int64

MaxValidationTime Property (CertificateValidator Component)

Specifies the maximum time the validation process may take.

Syntax

func (obj *CertificateValidator) MaxValidationTime() (int32, error)
func (obj *CertificateValidator) SetMaxValidationTime(value int32) error

Default Value

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

int32

OfflineMode Property (CertificateValidator Component)

Switches the class to offline mode.

Syntax

func (obj *CertificateValidator) OfflineMode() (bool, error)
func (obj *CertificateValidator) SetOfflineMode(value bool) error

Default Value

false

Remarks

When working in offline mode, the struct 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

bool

ProxyAddress Property (CertificateValidator Component)

The IP address of the proxy server.

Syntax

func (obj *CertificateValidator) ProxyAddress() (string, error)
func (obj *CertificateValidator) SetProxyAddress(value string) error

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

func (obj *CertificateValidator) ProxyAuthentication() (int32, error)
func (obj *CertificateValidator) SetProxyAuthentication(value int32) error

Possible Values

0   // NoAuthentication
1   // Basic
2   // Digest
3   // NTLM

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Data Type

int32

ProxyPassword Property (CertificateValidator Component)

The password to authenticate to the proxy server.

Syntax

func (obj *CertificateValidator) ProxyPassword() (string, error)
func (obj *CertificateValidator) SetProxyPassword(value string) error

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

func (obj *CertificateValidator) ProxyPort() (int32, error)
func (obj *CertificateValidator) SetProxyPort(value int32) error

Default Value

Remarks

The port on the proxy server to connect to.

Data Type

int32

ProxyType Property (CertificateValidator Component)

The type of the proxy server.

Syntax

func (obj *CertificateValidator) ProxyType() (int32, error)
func (obj *CertificateValidator) SetProxyType(value int32) error

Possible Values

0   // None
1   // Socks4
2   // Socks5
3   // WebTunnel
4   // HTTP

Default Value

Remarks

The type of the proxy server.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

Data Type

int32

ProxyRequestHeaders Property (CertificateValidator Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

func (obj *CertificateValidator) ProxyRequestHeaders() (string, error)
func (obj *CertificateValidator) SetProxyRequestHeaders(value string) error

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

func (obj *CertificateValidator) ProxyResponseBody() (string, error)
func (obj *CertificateValidator) SetProxyResponseBody(value string) error

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

func (obj *CertificateValidator) ProxyResponseHeaders() (string, error)
func (obj *CertificateValidator) SetProxyResponseHeaders(value string) error

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

func (obj *CertificateValidator) ProxyUseIPv6() (bool, error)
func (obj *CertificateValidator) SetProxyUseIPv6(value bool) error

Default Value

false

Remarks

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

Data Type

bool

ProxyUsername Property (CertificateValidator Component)

Specifies the username credential for proxy authentication.

Syntax

func (obj *CertificateValidator) ProxyUsername() (string, error)
func (obj *CertificateValidator) SetProxyUsername(value string) error

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

func (obj *CertificateValidator) QualifiedInfoAddress() (string, error)

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

QualifiedInfoCustomTrustedLists Property (CertificateValidator Component)

The list of custom TrustedLists to use.

Syntax

func (obj *CertificateValidator) QualifiedInfoCustomTrustedLists() (string, error)
func (obj *CertificateValidator) SetQualifiedInfoCustomTrustedLists(value string) error

Default Value

Remarks

The list of custom TrustedLists 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

func (obj *CertificateValidator) QualifiedInfoDownloadLog() (string, error)

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

func (obj *CertificateValidator) QualifiedInfoInformationURI() (string, error)

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

func (obj *CertificateValidator) QualifiedInfoLanguages() (string, error)
func (obj *CertificateValidator) SetQualifiedInfoLanguages(value string) error

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

func (obj *CertificateValidator) QualifiedInfoNextUpdate() (string, error)

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

func (obj *CertificateValidator) QualifiedInfoProvider() (string, error)

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

func (obj *CertificateValidator) QualifiedInfoQualified() (bool, error)

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

bool

QualifiedInfoQualifiers Property (CertificateValidator Component)

A list of qualifiers.

Syntax

func (obj *CertificateValidator) QualifiedInfoQualifiers() (string, error)

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

func (obj *CertificateValidator) QualifiedInfoServiceName() (string, error)

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

func (obj *CertificateValidator) QualifiedInfoServiceTypeId() (string, error)

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

func (obj *CertificateValidator) QualifiedInfoSource() (int32, error)

Possible Values

0   // Unknown
1   // Certificate
2   // TSL
3   // Both

Default Value

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.

Data Type

int32

QualifiedInfoStatus Property (CertificateValidator Component)

Indicates a qualified electronic signature.

Syntax

func (obj *CertificateValidator) QualifiedInfoStatus() (int32, error)

Possible Values

0   // Unknown
1   // None
2   // Granted
3   // Withdrawn
4   // SetByNationalLaw
5   // DeprecatedByNationalLaw
6   // RecognizedAtNationalLevel
7   // DeprecatedAtNationalLevel
8   // UnderSupervision
9   // SupervisionInCessation
10   // SupervisionCeased
11   // SupervisionRevoked
12   // Accredited
13   // AccreditationCeased
14   // AccreditationRevoked
15   // InAccordance
16   // Expired
17   // Suspended
18   // Revoked
19   // NotInAccordance

Default Value

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.

Data Type

int32

QualifiedInfoTradeName Property (CertificateValidator Component)

Contains the trade name of the TSL provider.

Syntax

func (obj *CertificateValidator) QualifiedInfoTradeName() (string, error)

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

QualifiedInfoTrusted Property (CertificateValidator Component)

Indicates whether the certificate is trusted.

Syntax

func (obj *CertificateValidator) QualifiedInfoTrusted() (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is trusted.

This property is set to true if the certificate is confirmed by a TSL to be trusted.

This property is read-only.

Data Type

bool

QualifiedInfoUseDefaultTrustedLists Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) QualifiedInfoUseDefaultTrustedLists() (bool, error)
func (obj *CertificateValidator) SetQualifiedInfoUseDefaultTrustedLists(value bool) error

Default Value

true

Remarks

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

Use this property to tell the validator to use (or not to use) the default TSLs (Trust Service status Lists).

The following default TSLs are used: EU (European Union) TSL.

Data Type

bool

QualifiedInfoValidationLog Property (CertificateValidator Component)

Contains the TLS validation log.

Syntax

func (obj *CertificateValidator) QualifiedInfoValidationLog() (string, error)

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

func (obj *CertificateValidator) QualifiedInfoXML() (string, error)

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

func (obj *CertificateValidator) RevocationCheck() (int32, error)
func (obj *CertificateValidator) SetRevocationCheck(value int32) error

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

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

int32

SocketDNSMode Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) SocketDNSMode() (int32, error)
func (obj *CertificateValidator) SetSocketDNSMode(value int32) error

Possible Values

0   // Auto
1   // Platform
2   // Own
3   // OwnSecure

Default Value

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

int32

SocketDNSPort Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) SocketDNSPort() (int32, error)
func (obj *CertificateValidator) SetSocketDNSPort(value int32) error

Default Value

Remarks

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

Data Type

int32

SocketDNSQueryTimeout Property (CertificateValidator Component)

The timeout (in milliseconds) for each DNS query.

Syntax

func (obj *CertificateValidator) SocketDNSQueryTimeout() (int32, error)
func (obj *CertificateValidator) SetSocketDNSQueryTimeout(value int32) error

Default Value

Remarks

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

Data Type

int32

SocketDNSServers Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) SocketDNSServers() (string, error)
func (obj *CertificateValidator) SetSocketDNSServers(value string) error

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

func (obj *CertificateValidator) SocketDNSTotalTimeout() (int32, error)
func (obj *CertificateValidator) SetSocketDNSTotalTimeout(value int32) error

Default Value

Remarks

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

Data Type

int32

SocketIncomingSpeedLimit Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) SocketIncomingSpeedLimit() (int32, error)
func (obj *CertificateValidator) SetSocketIncomingSpeedLimit(value int32) error

Default Value

Remarks

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

Data Type

int32

SocketLocalAddress Property (CertificateValidator Component)

The local network interface to bind the socket to.

Syntax

func (obj *CertificateValidator) SocketLocalAddress() (string, error)
func (obj *CertificateValidator) SetSocketLocalAddress(value string) error

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

func (obj *CertificateValidator) SocketLocalPort() (int32, error)
func (obj *CertificateValidator) SetSocketLocalPort(value int32) error

Default Value

Remarks

The local port number to bind the socket to.

Data Type

int32

SocketOutgoingSpeedLimit Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) SocketOutgoingSpeedLimit() (int32, error)
func (obj *CertificateValidator) SetSocketOutgoingSpeedLimit(value int32) error

Default Value

Remarks

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

Data Type

int32

SocketTimeout Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) SocketTimeout() (int32, error)
func (obj *CertificateValidator) SetSocketTimeout(value int32) error

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

int32

SocketUseIPv6 Property (CertificateValidator Component)

Enables or disables IP protocol version 6.

Syntax

func (obj *CertificateValidator) SocketUseIPv6() (bool, error)
func (obj *CertificateValidator) SetSocketUseIPv6(value bool) error

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

TLSClientCertCount Property (CertificateValidator Component)

The number of records in the TLSClientCert arrays.

Syntax

func (obj *CertificateValidator) TLSClientCertCount() (int32, error)
func (obj *CertificateValidator) SetTLSClientCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

TLSClientCertBytes
TLSClientCertHandle

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

Data Type

int32

TLSClientCertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) TLSClientCertBytes(TLSClientCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

TLSClientCertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSClientCertHandle(TLSClientCertIndex int32) (int64, error)
func (obj *CertificateValidator) SetTLSClientCertHandle(TLSClientCertIndex int32, value int64) error

Default Value

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.

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

Data Type

int64

TLSServerCertCount Property (CertificateValidator Component)

The number of records in the TLSServerCert arrays.

Syntax

func (obj *CertificateValidator) TLSServerCertCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

TLSServerCertBytes
TLSServerCertFingerprint
TLSServerCertHandle
TLSServerCertIssuer
TLSServerCertIssuerRDN
TLSServerCertKeyAlgorithm
TLSServerCertKeyBits
TLSServerCertKeyUsage
TLSServerCertSelfSigned
TLSServerCertSerialNumber
TLSServerCertSigAlgorithm
TLSServerCertSubject
TLSServerCertSubjectRDN
TLSServerCertValidFrom
TLSServerCertValidTo

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

This property is read-only.

Data Type

int32

TLSServerCertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) TLSServerCertBytes(TLSServerCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

TLSServerCertFingerprint Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSServerCertFingerprint(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

Data Type

string

TLSServerCertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSServerCertHandle(TLSServerCertIndex int32) (int64, error)

Default Value

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.

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.

Data Type

int64

TLSServerCertIssuer Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSServerCertIssuer(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via TLSIssuerRDN.

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.

Data Type

string

TLSServerCertIssuerRDN Property (CertificateValidator Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *CertificateValidator) TLSServerCertIssuerRDN(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

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

Data Type

string

TLSServerCertKeyAlgorithm Property (CertificateValidator Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *CertificateValidator) TLSServerCertKeyAlgorithm(TLSServerCertIndex int32) (string, error)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`
SB_CERT_ALGORITHM_MLDSA_44	`id-ml-dsa-44`
SB_CERT_ALGORITHM_MLDSA_65	`id-ml-dsa-65`
SB_CERT_ALGORITHM_MLDSA_87	`id-ml-dsa-87`
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512	`id-hash-ml-dsa-44-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512	`id-hash-ml-dsa-65-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512	`id-hash-ml-dsa-87-with-sha512`
SB_CERT_ALGORITHM_MLKEM_512	`id-ml-kem-512`
SB_CERT_ALGORITHM_MLKEM_768	`id-ml-kem-768`
SB_CERT_ALGORITHM_MLKEM_1024	`id-ml-kem-1024`

Use the TLSKeyBits, TLSCurve, and TLSPublicKeyBytes properties to get more details about the key the certificate contains.

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.

Data Type

string

TLSServerCertKeyBits Property (CertificateValidator Component)

Returns the length of the public key in bits.

Syntax

func (obj *CertificateValidator) TLSServerCertKeyBits(TLSServerCertIndex int32) (int32, error)

Default Value

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the TLSPublicKeyBytes or TLSPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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.

Data Type

int32

TLSServerCertKeyUsage Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSServerCertKeyUsage(TLSServerCertIndex int32) (int32, error)

Default Value

Remarks

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

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

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

Data Type

int32

TLSServerCertSelfSigned Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSServerCertSelfSigned(TLSServerCertIndex int32) (bool, error)

Default Value

false

Remarks

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

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.

Data Type

bool

TLSServerCertSerialNumber Property (CertificateValidator Component)

Returns the certificate's serial number.

Syntax

func (obj *CertificateValidator) TLSServerCertSerialNumber(TLSServerCertIndex int32) ([]byte, error)

Remarks

Returns the certificate's serial number.

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.

Data Type

[]byte

TLSServerCertSigAlgorithm Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSServerCertSigAlgorithm(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

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

Data Type

string

TLSServerCertSubject 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

func (obj *CertificateValidator) TLSServerCertSubject(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via TLSSubjectRDN.

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.

Data Type

string

TLSServerCertSubjectRDN Property (CertificateValidator Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *CertificateValidator) TLSServerCertSubjectRDN(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

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.

Data Type

string

TLSServerCertValidFrom Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSServerCertValidFrom(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

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

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.

Data Type

string

TLSServerCertValidTo Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSServerCertValidTo(TLSServerCertIndex int32) (string, error)

Default Value

Remarks

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

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.

Data Type

string

TLSAutoValidateCertificates Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSAutoValidateCertificates() (bool, error)
func (obj *CertificateValidator) SetTLSAutoValidateCertificates(value bool) error

Default Value

true

Remarks

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

Data Type

bool

TLSBaseConfiguration Property (CertificateValidator Component)

Selects the base configuration for the TLS settings.

Syntax

func (obj *CertificateValidator) TLSBaseConfiguration() (int32, error)
func (obj *CertificateValidator) SetTLSBaseConfiguration(value int32) error

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // HighlySecure

Default Value

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

int32

TLSCiphersuites Property (CertificateValidator Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

func (obj *CertificateValidator) TLSCiphersuites() (string, error)
func (obj *CertificateValidator) SetTLSCiphersuites(value string) error

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

TLSClientAuth Property (CertificateValidator Component)

Enables or disables certificate-based client authentication.

Syntax

func (obj *CertificateValidator) TLSClientAuth() (int32, error)
func (obj *CertificateValidator) SetTLSClientAuth(value int32) error

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:


ccatNoAuth	`0`
ccatRequestCert	`1`
ccatRequireCert	`2`

Data Type

int32

TLSExtensions Property (CertificateValidator Component)

Provides access to TLS extensions.

Syntax

func (obj *CertificateValidator) TLSExtensions() (string, error)
func (obj *CertificateValidator) SetTLSExtensions(value string) error

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

func (obj *CertificateValidator) TLSForceResumeIfDestinationChanges() (bool, error)
func (obj *CertificateValidator) SetTLSForceResumeIfDestinationChanges(value bool) error

Default Value

false

Remarks

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

Data Type

bool

TLSGroups Property (CertificateValidator Component)

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Syntax

func (obj *CertificateValidator) TLSGroups() (string, error)
func (obj *CertificateValidator) SetTLSGroups(value string) error

Default Value

Remarks

Specifies a list of key exchange groups to attempt during the TLS key exchange.

Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the all placeholder:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

SECT163K1
SECT163R1
SECT163R2
SECT193R1
SECT193R2
SECT233K1
SECT233R1
SECT239K1
SECT283K1
SECT283R1
SECT409K1
SECT409R1
SECT571K1
SECT571R1
SECP160K1
SECP160R1
SECP160R2
SECP192K1
SECP192R1
SECP224K1
SECP224R1
SECP256K1
SECP256R1
SECP384R1
SECP521R1
BRAINPOOLP256R1
BRAINPOOLP384R1
BRAINPOOLP512R1
X25519
X448

Finite field-based groups:

FFDHE2048
FFDHE3072
FFDHE4096
FFDHE6144
FFDHE8192

Post-Quantum and Hybrid groups:

MLKEM512
MLKEM768
MLKEM1024
SECP256R1MLKEM768
X25519MLKEM768
SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

string

TLSPreSharedIdentity Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSPreSharedIdentity() (string, error)
func (obj *CertificateValidator) SetTLSPreSharedIdentity(value string) error

Default Value

Remarks

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

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

func (obj *CertificateValidator) TLSPreSharedKey() (string, error)
func (obj *CertificateValidator) SetTLSPreSharedKey(value string) error

Default Value

Remarks

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

Data Type

string

TLSPreSharedKeyCiphersuite Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSPreSharedKeyCiphersuite() (string, error)
func (obj *CertificateValidator) SetTLSPreSharedKeyCiphersuite(value string) error

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

func (obj *CertificateValidator) TLSRenegotiationAttackPreventionMode() (int32, error)
func (obj *CertificateValidator) SetTLSRenegotiationAttackPreventionMode(value int32) error

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

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

int32

TLSRevocationCheck Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSRevocationCheck() (int32, error)
func (obj *CertificateValidator) SetTLSRevocationCheck(value int32) error

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // AnyOCSPOrCRL

Default Value

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.

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

int32

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

func (obj *CertificateValidator) TLSSSLOptions() (int32, error)
func (obj *CertificateValidator) SetTLSSSLOptions(value int32) error

Default Value

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

int32

TLSMode Property (CertificateValidator Component)

Specifies the TLS mode to use.

Syntax

func (obj *CertificateValidator) TLSMode() (int32, error)
func (obj *CertificateValidator) SetTLSMode(value int32) error

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

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

int32

TLSUseExtendedMasterSecret Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TLSUseExtendedMasterSecret() (bool, error)
func (obj *CertificateValidator) SetTLSUseExtendedMasterSecret(value bool) error

Default Value

true

Remarks

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

Data Type

bool

TLSUseSessionResumption Property (CertificateValidator Component)

Enables or disables the TLS session resumption capability.

Syntax

func (obj *CertificateValidator) TLSUseSessionResumption() (bool, error)
func (obj *CertificateValidator) SetTLSUseSessionResumption(value bool) error

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

TLSVersions Property (CertificateValidator Component)

The SSL/TLS versions to enable by default.

Syntax

func (obj *CertificateValidator) TLSVersions() (int32, error)
func (obj *CertificateValidator) SetTLSVersions(value int32) error

Default Value

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

int32

TrustedCertCount Property (CertificateValidator Component)

The number of records in the TrustedCert arrays.

Syntax

func (obj *CertificateValidator) TrustedCertCount() (int32, error)
func (obj *CertificateValidator) SetTrustedCertCount(value int32) error

Default Value

Remarks

This property controls the size of the following arrays:

TrustedCertBytes
TrustedCertHandle

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

Data Type

int32

TrustedCertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) TrustedCertBytes(TrustedCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

TrustedCertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) TrustedCertHandle(TrustedCertIndex int32) (int64, error)
func (obj *CertificateValidator) SetTrustedCertHandle(TrustedCertIndex int32, value int64) error

Default Value

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.

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

Data Type

int64

UsedCertCount Property (CertificateValidator Component)

The number of records in the UsedCert arrays.

Syntax

func (obj *CertificateValidator) UsedCertCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

UsedCertBytes
UsedCertCA
UsedCertCAKeyID
UsedCertCertType
UsedCertCRLDistributionPoints
UsedCertCurve
UsedCertFingerprint
UsedCertFriendlyName
UsedCertHandle
UsedCertHashAlgorithm
UsedCertIssuer
UsedCertIssuerRDN
UsedCertKeyAlgorithm
UsedCertKeyBits
UsedCertKeyFingerprint
UsedCertKeyUsage
UsedCertKeyValid
UsedCertOCSPLocations
UsedCertOCSPNoCheck
UsedCertOrigin
UsedCertPolicyIDs
UsedCertPrivateKeyBytes
UsedCertPrivateKeyExists
UsedCertPrivateKeyExtractable
UsedCertPublicKeyBytes
UsedCertQualified
UsedCertQualifiedStatements
UsedCertQualifiers
UsedCertSelfSigned
UsedCertSerialNumber
UsedCertSigAlgorithm
UsedCertSource
UsedCertSubject
UsedCertSubjectAlternativeName
UsedCertSubjectKeyID
UsedCertSubjectRDN
UsedCertValid
UsedCertValidFrom
UsedCertValidTo

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

This property is read-only.

Data Type

int32

UsedCertBytes Property (CertificateValidator Component)

Returns the raw certificate data in DER format.

Syntax

func (obj *CertificateValidator) UsedCertBytes(UsedCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

UsedCertCA Property (CertificateValidator Component)

Indicates whether the certificate has a CA capability.

Syntax

func (obj *CertificateValidator) UsedCertCA(UsedCertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

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

Data Type

bool

UsedCertCAKeyID Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertCAKeyID(UsedCertIndex int32) ([]byte, error)

Remarks

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

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the UsedCertSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID 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.

Data Type

[]byte

UsedCertCertType Property (CertificateValidator Component)

Returns the type of the entity contained in the Certificate object.

Syntax

func (obj *CertificateValidator) UsedCertCertType(UsedCertIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // X509Certificate
2   // X509CertificateRequest

Default Value

Remarks

Returns the type of the entity contained in the Certificate object.

Use the CertificateManager struct to load or create new certificate and certificate requests objects.

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.

Data Type

int32

UsedCertCRLDistributionPoints Property (CertificateValidator Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

func (obj *CertificateValidator) UsedCertCRLDistributionPoints(UsedCertIndex int32) (string, error)

Default Value

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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

Data Type

string

UsedCertCurve Property (CertificateValidator Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

func (obj *CertificateValidator) UsedCertCurve(UsedCertIndex int32) (string, error)

Default Value

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.


SB_EC_SECP112R1	`SECP112R1`
SB_EC_SECP112R2	`SECP112R2`
SB_EC_SECP128R1	`SECP128R1`
SB_EC_SECP128R2	`SECP128R2`
SB_EC_SECP160K1	`SECP160K1`
SB_EC_SECP160R1	`SECP160R1`
SB_EC_SECP160R2	`SECP160R2`
SB_EC_SECP192K1	`SECP192K1`
SB_EC_SECP192R1	`SECP192R1`
SB_EC_SECP224K1	`SECP224K1`
SB_EC_SECP224R1	`SECP224R1`
SB_EC_SECP256K1	`SECP256K1`
SB_EC_SECP256R1	`SECP256R1`
SB_EC_SECP384R1	`SECP384R1`
SB_EC_SECP521R1	`SECP521R1`
SB_EC_SECT113R1	`SECT113R1`
SB_EC_SECT113R2	`SECT113R2`
SB_EC_SECT131R1	`SECT131R1`
SB_EC_SECT131R2	`SECT131R2`
SB_EC_SECT163K1	`SECT163K1`
SB_EC_SECT163R1	`SECT163R1`
SB_EC_SECT163R2	`SECT163R2`
SB_EC_SECT193R1	`SECT193R1`
SB_EC_SECT193R2	`SECT193R2`
SB_EC_SECT233K1	`SECT233K1`
SB_EC_SECT233R1	`SECT233R1`
SB_EC_SECT239K1	`SECT239K1`
SB_EC_SECT283K1	`SECT283K1`
SB_EC_SECT283R1	`SECT283R1`
SB_EC_SECT409K1	`SECT409K1`
SB_EC_SECT409R1	`SECT409R1`
SB_EC_SECT571K1	`SECT571K1`
SB_EC_SECT571R1	`SECT571R1`
SB_EC_PRIME192V1	`PRIME192V1`
SB_EC_PRIME192V2	`PRIME192V2`
SB_EC_PRIME192V3	`PRIME192V3`
SB_EC_PRIME239V1	`PRIME239V1`
SB_EC_PRIME239V2	`PRIME239V2`
SB_EC_PRIME239V3	`PRIME239V3`
SB_EC_PRIME256V1	`PRIME256V1`
SB_EC_C2PNB163V1	`C2PNB163V1`
SB_EC_C2PNB163V2	`C2PNB163V2`
SB_EC_C2PNB163V3	`C2PNB163V3`
SB_EC_C2PNB176W1	`C2PNB176W1`
SB_EC_C2TNB191V1	`C2TNB191V1`
SB_EC_C2TNB191V2	`C2TNB191V2`
SB_EC_C2TNB191V3	`C2TNB191V3`
SB_EC_C2ONB191V4	`C2ONB191V4`
SB_EC_C2ONB191V5	`C2ONB191V5`
SB_EC_C2PNB208W1	`C2PNB208W1`
SB_EC_C2TNB239V1	`C2TNB239V1`
SB_EC_C2TNB239V2	`C2TNB239V2`
SB_EC_C2TNB239V3	`C2TNB239V3`
SB_EC_C2ONB239V4	`C2ONB239V4`
SB_EC_C2ONB239V5	`C2ONB239V5`
SB_EC_C2PNB272W1	`C2PNB272W1`
SB_EC_C2PNB304W1	`C2PNB304W1`
SB_EC_C2TNB359V1	`C2TNB359V1`
SB_EC_C2PNB368W1	`C2PNB368W1`
SB_EC_C2TNB431R1	`C2TNB431R1`
SB_EC_NISTP192	`NISTP192`
SB_EC_NISTP224	`NISTP224`
SB_EC_NISTP256	`NISTP256`
SB_EC_NISTP384	`NISTP384`
SB_EC_NISTP521	`NISTP521`
SB_EC_NISTB163	`NISTB163`
SB_EC_NISTB233	`NISTB233`
SB_EC_NISTB283	`NISTB283`
SB_EC_NISTB409	`NISTB409`
SB_EC_NISTB571	`NISTB571`
SB_EC_NISTK163	`NISTK163`
SB_EC_NISTK233	`NISTK233`
SB_EC_NISTK283	`NISTK283`
SB_EC_NISTK409	`NISTK409`
SB_EC_NISTK571	`NISTK571`
SB_EC_GOSTCPTEST	`GOSTCPTEST`
SB_EC_GOSTCPA	`GOSTCPA`
SB_EC_GOSTCPB	`GOSTCPB`
SB_EC_GOSTCPC	`GOSTCPC`
SB_EC_GOSTCPXCHA	`GOSTCPXCHA`
SB_EC_GOSTCPXCHB	`GOSTCPXCHB`
SB_EC_BRAINPOOLP160R1	`BRAINPOOLP160R1`
SB_EC_BRAINPOOLP160T1	`BRAINPOOLP160T1`
SB_EC_BRAINPOOLP192R1	`BRAINPOOLP192R1`
SB_EC_BRAINPOOLP192T1	`BRAINPOOLP192T1`
SB_EC_BRAINPOOLP224R1	`BRAINPOOLP224R1`
SB_EC_BRAINPOOLP224T1	`BRAINPOOLP224T1`
SB_EC_BRAINPOOLP256R1	`BRAINPOOLP256R1`
SB_EC_BRAINPOOLP256T1	`BRAINPOOLP256T1`
SB_EC_BRAINPOOLP320R1	`BRAINPOOLP320R1`
SB_EC_BRAINPOOLP320T1	`BRAINPOOLP320T1`
SB_EC_BRAINPOOLP384R1	`BRAINPOOLP384R1`
SB_EC_BRAINPOOLP384T1	`BRAINPOOLP384T1`
SB_EC_BRAINPOOLP512R1	`BRAINPOOLP512R1`
SB_EC_BRAINPOOLP512T1	`BRAINPOOLP512T1`
SB_EC_CURVE25519	`CURVE25519`
SB_EC_CURVE448	`CURVE448`

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

Data Type

string

UsedCertFingerprint Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertFingerprint(UsedCertIndex int32) (string, error)

Default Value

Remarks

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

Data Type

string

UsedCertFriendlyName Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertFriendlyName(UsedCertIndex int32) (string, error)

Default Value

Remarks

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.

Data Type

string

UsedCertHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertHandle(UsedCertIndex int32) (int64, error)

Default Value

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.

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.

Data Type

int64

UsedCertHashAlgorithm Property (CertificateValidator Component)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

func (obj *CertificateValidator) UsedCertHashAlgorithm(UsedCertIndex int32) (string, error)

Default Value

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use UsedCertSigAlgorithm to find out the hash algorithm that is part of the certificate signature.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

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

Data Type

string

UsedCertIssuer Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertIssuer(UsedCertIndex int32) (string, error)

Default Value

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via UsedCertIssuerRDN.

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.

Data Type

string

UsedCertIssuerRDN Property (CertificateValidator Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

func (obj *CertificateValidator) UsedCertIssuerRDN(UsedCertIndex int32) (string, error)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

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

Data Type

string

UsedCertKeyAlgorithm Property (CertificateValidator Component)

Specifies the public key algorithm of this certificate.

Syntax

func (obj *CertificateValidator) UsedCertKeyAlgorithm(UsedCertIndex int32) (string, error)

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`
SB_CERT_ALGORITHM_MLDSA_44	`id-ml-dsa-44`
SB_CERT_ALGORITHM_MLDSA_65	`id-ml-dsa-65`
SB_CERT_ALGORITHM_MLDSA_87	`id-ml-dsa-87`
SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512	`id-hash-ml-dsa-44-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512	`id-hash-ml-dsa-65-with-sha512`
SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512	`id-hash-ml-dsa-87-with-sha512`
SB_CERT_ALGORITHM_MLKEM_512	`id-ml-kem-512`
SB_CERT_ALGORITHM_MLKEM_768	`id-ml-kem-768`
SB_CERT_ALGORITHM_MLKEM_1024	`id-ml-kem-1024`

Use the UsedCertKeyBits, UsedCertCurve, and UsedCertPublicKeyBytes properties to get more details about the key the certificate contains.

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.

Data Type

string

UsedCertKeyBits Property (CertificateValidator Component)

Returns the length of the public key in bits.

Syntax

func (obj *CertificateValidator) UsedCertKeyBits(UsedCertIndex int32) (int32, error)

Default Value

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the UsedCertPublicKeyBytes or UsedCertPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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.

Data Type

int32

UsedCertKeyFingerprint Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertKeyFingerprint(UsedCertIndex int32) (string, error)

Default Value

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the UsedCertFingerprint property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same 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.

Data Type

string

UsedCertKeyUsage Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertKeyUsage(UsedCertIndex int32) (int32, error)

Default Value

Remarks

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

This value is a bit mask of the following values:


ckuUnknown	`0x00000`	Unknown key usage
ckuDigitalSignature	`0x00001`	Digital signature
ckuNonRepudiation	`0x00002`	Non-repudiation
ckuKeyEncipherment	`0x00004`	Key encipherment
ckuDataEncipherment	`0x00008`	Data encipherment
ckuKeyAgreement	`0x00010`	Key agreement
ckuKeyCertSign	`0x00020`	Certificate signing
ckuCRLSign	`0x00040`	Revocation signing
ckuEncipherOnly	`0x00080`	Encipher only
ckuDecipherOnly	`0x00100`	Decipher only
ckuServerAuthentication	`0x00200`	Server authentication
ckuClientAuthentication	`0x00400`	Client authentication
ckuCodeSigning	`0x00800`	Code signing
ckuEmailProtection	`0x01000`	Email protection
ckuTimeStamping	`0x02000`	Timestamping
ckuOCSPSigning	`0x04000`	OCSP signing
ckuSmartCardLogon	`0x08000`	Smartcard logon
ckuKeyPurposeClientAuth	`0x10000`	Kerberos - client authentication
ckuKeyPurposeKDC	`0x20000`	Kerberos - KDC

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

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

Data Type

int32

UsedCertKeyValid Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertKeyValid(UsedCertIndex int32) (bool, error)

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.

Data Type

bool

UsedCertOCSPLocations Property (CertificateValidator Component)

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

func (obj *CertificateValidator) UsedCertOCSPLocations(UsedCertIndex int32) (string, error)

Default Value

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new 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.

Data Type

string

UsedCertOCSPNoCheck Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertOCSPNoCheck(UsedCertIndex int32) (bool, error)

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.

Data Type

bool

UsedCertOrigin Property (CertificateValidator Component)

Returns the location that the certificate was taken or loaded from.

Syntax

func (obj *CertificateValidator) UsedCertOrigin(UsedCertIndex int32) (int32, error)

Default Value

Remarks

Returns the location that the certificate was taken or loaded from.

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.

Data Type

int32

UsedCertPolicyIDs Property (CertificateValidator Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

func (obj *CertificateValidator) UsedCertPolicyIDs(UsedCertIndex int32) (string, error)

Default Value

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

Set this property when generating a certificate to propagate the policies information to the new certificate.

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

Data Type

string

UsedCertPrivateKeyBytes Property (CertificateValidator Component)

Returns the certificate's private key in DER-encoded format.

Syntax

func (obj *CertificateValidator) UsedCertPrivateKeyBytes(UsedCertIndex int32) ([]byte, error)

Remarks

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.

Data Type

[]byte

UsedCertPrivateKeyExists Property (CertificateValidator Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

func (obj *CertificateValidator) UsedCertPrivateKeyExists(UsedCertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from UsedCertPrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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

Data Type

bool

UsedCertPrivateKeyExtractable Property (CertificateValidator Component)

Indicates whether the private key is extractable (exportable).

Syntax

func (obj *CertificateValidator) UsedCertPrivateKeyExtractable(UsedCertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the private key is extractable (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.

Data Type

bool

UsedCertPublicKeyBytes Property (CertificateValidator Component)

Contains the certificate's public key in DER format.

Syntax

func (obj *CertificateValidator) UsedCertPublicKeyBytes(UsedCertIndex int32) ([]byte, error)

Remarks

Contains the certificate's public key in DER format.

This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

Data Type

[]byte

UsedCertQualified Property (CertificateValidator Component)

Indicates whether the certificate is qualified.

Syntax

func (obj *CertificateValidator) UsedCertQualified(UsedCertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

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

Data Type

bool

UsedCertQualifiedStatements Property (CertificateValidator Component)

Returns a simplified qualified status of the certificate.

Syntax

func (obj *CertificateValidator) UsedCertQualifiedStatements(UsedCertIndex int32) (int32, error)

Possible Values

0   // NonQualified
1   // QualifiedHardware
2   // QualifiedSoftware

Default Value

Remarks

Returns a simplified 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.

Data Type

int32

UsedCertQualifiers Property (CertificateValidator Component)

A list of qualifiers.

Syntax

func (obj *CertificateValidator) UsedCertQualifiers(UsedCertIndex int32) (string, error)

Default Value

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

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

Data Type

string

UsedCertSelfSigned Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertSelfSigned(UsedCertIndex int32) (bool, error)

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.

Data Type

bool

UsedCertSerialNumber Property (CertificateValidator Component)

Returns the certificate's serial number.

Syntax

func (obj *CertificateValidator) UsedCertSerialNumber(UsedCertIndex int32) ([]byte, error)

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.

Data Type

[]byte

UsedCertSigAlgorithm Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertSigAlgorithm(UsedCertIndex int32) (string, error)

Default Value

Remarks

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

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

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

Data Type

string

UsedCertSource Property (CertificateValidator Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *CertificateValidator) UsedCertSource(UsedCertIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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.

Data Type

int32

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

func (obj *CertificateValidator) UsedCertSubject(UsedCertIndex int32) (string, error)

Default Value

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via UsedCertSubjectRDN.

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.

Data Type

string

UsedCertSubjectAlternativeName Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertSubjectAlternativeName(UsedCertIndex int32) (string, error)

Default Value

Remarks

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

Subject alternative names are used to provide additional names that are impractical to store in the main UsedCertSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

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.

Data Type

string

UsedCertSubjectKeyID Property (CertificateValidator Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

func (obj *CertificateValidator) UsedCertSubjectKeyID(UsedCertIndex int32) ([]byte, error)

Remarks

Contains a unique identifier of the certificate's cryptographic key.

The UsedCertSubjectKeyID and UsedCertCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

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.

Data Type

[]byte

UsedCertSubjectRDN Property (CertificateValidator Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

func (obj *CertificateValidator) UsedCertSubjectRDN(UsedCertIndex int32) (string, error)

Default Value

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

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.

Data Type

string

UsedCertValid Property (CertificateValidator Component)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

func (obj *CertificateValidator) UsedCertValid(UsedCertIndex int32) (bool, error)

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

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

Data Type

bool

UsedCertValidFrom Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertValidFrom(UsedCertIndex int32) (string, error)

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.

Data Type

string

UsedCertValidTo Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCertValidTo(UsedCertIndex int32) (string, error)

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.

Data Type

string

UsedCRLCount Property (CertificateValidator Component)

The number of records in the UsedCRL arrays.

Syntax

func (obj *CertificateValidator) UsedCRLCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

UsedCRLBytes
UsedCRLHandle
UsedCRLIssuer
UsedCRLIssuerRDN
UsedCRLLocation
UsedCRLNextUpdate
UsedCRLSource
UsedCRLThisUpdate

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

This property is read-only.

Data Type

int32

UsedCRLBytes Property (CertificateValidator Component)

Returns the raw CRL data in DER format.

Syntax

func (obj *CertificateValidator) UsedCRLBytes(UsedCRLIndex int32) ([]byte, error)

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.

Data Type

[]byte

UsedCRLHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCRLHandle(UsedCRLIndex int32) (int64, error)

Default Value

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.

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.

Data Type

int64

UsedCRLIssuer Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCRLIssuer(UsedCRLIndex int32) (string, error)

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.

Data Type

string

UsedCRLIssuerRDN Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCRLIssuerRDN(UsedCRLIndex int32) (string, error)

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.

Data Type

string

UsedCRLLocation Property (CertificateValidator Component)

The URL that the CRL was downloaded from.

Syntax

func (obj *CertificateValidator) UsedCRLLocation(UsedCRLIndex int32) (string, error)

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.

Data Type

string

UsedCRLNextUpdate Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCRLNextUpdate(UsedCRLIndex int32) (string, error)

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.

Data Type

string

UsedCRLSource Property (CertificateValidator Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *CertificateValidator) UsedCRLSource(UsedCRLIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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.

Data Type

int32

UsedCRLThisUpdate Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedCRLThisUpdate(UsedCRLIndex int32) (string, error)

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.

Data Type

string

UsedOCSPCount Property (CertificateValidator Component)

The number of records in the UsedOCSP arrays.

Syntax

func (obj *CertificateValidator) UsedOCSPCount() (int32, error)

Default Value

Remarks

This property controls the size of the following arrays:

UsedOCSPBytes
UsedOCSPHandle
UsedOCSPIssuer
UsedOCSPIssuerRDN
UsedOCSPLocation
UsedOCSPProducedAt
UsedOCSPSource

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

This property is read-only.

Data Type

int32

UsedOCSPBytes Property (CertificateValidator Component)

A buffer containing the raw OCSP response data.

Syntax

func (obj *CertificateValidator) UsedOCSPBytes(UsedOCSPIndex int32) ([]byte, error)

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.

Data Type

[]byte

UsedOCSPHandle Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedOCSPHandle(UsedOCSPIndex int32) (int64, error)

Default Value

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.

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.

Data Type

int64

UsedOCSPIssuer Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedOCSPIssuer(UsedOCSPIndex int32) (string, error)

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.

Data Type

string

UsedOCSPIssuerRDN Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedOCSPIssuerRDN(UsedOCSPIndex int32) (string, error)

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.

Data Type

string

UsedOCSPLocation Property (CertificateValidator Component)

The location of the OCSP responder.

Syntax

func (obj *CertificateValidator) UsedOCSPLocation(UsedOCSPIndex int32) (string, error)

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.

Data Type

string

UsedOCSPProducedAt Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) UsedOCSPProducedAt(UsedOCSPIndex int32) (string, error)

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.

Data Type

string

UsedOCSPSource Property (CertificateValidator Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

func (obj *CertificateValidator) UsedOCSPSource(UsedOCSPIndex int32) (int32, error)

Possible Values

0   // Unknown
1   // Signature
2   // Document
3   // User
4   // Local
5   // Online

Default Value

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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.

Data Type

int32

UseSystemCertificates Property (CertificateValidator Component)

Enables or disables the use of the system certificates.

Syntax

func (obj *CertificateValidator) UseSystemCertificates() (bool, error)
func (obj *CertificateValidator) SetUseSystemCertificates(value bool) error

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

bool

ValidationLog Property (CertificateValidator Component)

Contains the complete log of the certificate validation routine.

Syntax

func (obj *CertificateValidator) ValidationLog() (string, error)

Default Value

Remarks

Use this property to access the chain validation log produced by the struct. 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.

Data Type

string

ValidationMoment Property (CertificateValidator Component)

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

Syntax

func (obj *CertificateValidator) ValidationMoment() (string, error)
func (obj *CertificateValidator) SetValidationMoment(value string) error

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

func (obj *CertificateValidator) Config(ConfigurationString string) (string, error)

Remarks

Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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

func (obj *CertificateValidator) DoAction(ActionID string, ActionParams string) (string, error)

Remarks

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

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

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

Common ActionIDs:


Action	Parameters	Returned value	Description
ResetTrustedListCache	none	none	Clears the cached list of trusted lists.
ResetCertificateCache	none	none	Clears the cached certificates.
ResetCRLCache	none	none	Clears the cached CRLs.
ResetOCSPResponseCache	none	none	Clears the cached OCSP responses.

GetQualifiedStatus Method (CertificateValidator Component)

Obtains the qualified information for Certificate .

Syntax

func (obj *CertificateValidator) GetQualifiedStatus() error

Remarks

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

GetTrustedListProperty Method (CertificateValidator Component)

Returns a specific TrustedList property.

Syntax

func (obj *CertificateValidator) GetTrustedListProperty(PropName string, Language string) (string, error)

Remarks

Use this method to obtain the value of a specific TrustedList 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 TrustedList). Leave the parameter empty to return the value in the default language.

Please find a list of common TrustedList 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

func (obj *CertificateValidator) RefreshCache() error

Remarks

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

Reset Method (CertificateValidator Component)

Resets the class settings.

Syntax

func (obj *CertificateValidator) Reset() error

Remarks

Reset is a generic method available in every struct.

ResetCache Method (CertificateValidator Component)

Clears all data contained in the validation cache.

Syntax

func (obj *CertificateValidator) ResetCache() error

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

func (obj *CertificateValidator) Terminate() error

Remarks

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

Validate Method (CertificateValidator Component)

Validates the certificate chain.

Syntax

func (obj *CertificateValidator) Validate() (int32, error)

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

func (obj *CertificateValidator) ValidateForSMIME(EmailAddress string) (int32, error)

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

func (obj *CertificateValidator) ValidateForSSL(URL string, IPAddress string) (int32, error)

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

// CertificateValidatorAfterCertificateProcessingEventArgs carries the CertificateValidator AfterCertificateProcessing event's parameters.
type CertificateValidatorAfterCertificateProcessingEventArgs struct {...}

func (args *CertificateValidatorAfterCertificateProcessingEventArgs) Cert() string
func (args *CertificateValidatorAfterCertificateProcessingEventArgs) Validity() int32
func (args *CertificateValidatorAfterCertificateProcessingEventArgs) ValidationDetails() int32
// CertificateValidatorAfterCertificateProcessingEvent defines the signature of the CertificateValidator AfterCertificateProcessing event's handler function.
type CertificateValidatorAfterCertificateProcessingEvent func(sender *CertificateValidator, args *CertificateValidatorAfterCertificateProcessingEventArgs)

func (obj *CertificateValidator) GetOnAfterCertificateProcessingHandler() CertificateValidatorAfterCertificateProcessingEvent
func (obj *CertificateValidator) SetOnAfterCertificateProcessingHandler(handlerFunc CertificateValidatorAfterCertificateProcessingEvent)

Remarks

This event is fired when the struct 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

// CertificateValidatorAfterCertificateValidationEventArgs carries the CertificateValidator AfterCertificateValidation event's parameters.
type CertificateValidatorAfterCertificateValidationEventArgs struct {...}

func (args *CertificateValidatorAfterCertificateValidationEventArgs) Cert() string
func (args *CertificateValidatorAfterCertificateValidationEventArgs) CACert() string
func (args *CertificateValidatorAfterCertificateValidationEventArgs) Validity() int32
func (args *CertificateValidatorAfterCertificateValidationEventArgs) ValidationDetails() int32
// CertificateValidatorAfterCertificateValidationEvent defines the signature of the CertificateValidator AfterCertificateValidation event's handler function.
type CertificateValidatorAfterCertificateValidationEvent func(sender *CertificateValidator, args *CertificateValidatorAfterCertificateValidationEventArgs)

func (obj *CertificateValidator) GetOnAfterCertificateValidationHandler() CertificateValidatorAfterCertificateValidationEvent
func (obj *CertificateValidator) SetOnAfterCertificateValidationHandler(handlerFunc CertificateValidatorAfterCertificateValidationEvent)

Remarks

This event is fired when the struct 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.

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

// CertificateValidatorBeforeCACertificateDownloadEventArgs carries the CertificateValidator BeforeCACertificateDownload event's parameters.
type CertificateValidatorBeforeCACertificateDownloadEventArgs struct {...}

func (args *CertificateValidatorBeforeCACertificateDownloadEventArgs) Cert() string
func (args *CertificateValidatorBeforeCACertificateDownloadEventArgs) Location() string
// CertificateValidatorBeforeCACertificateDownloadEvent defines the signature of the CertificateValidator BeforeCACertificateDownload event's handler function.
type CertificateValidatorBeforeCACertificateDownloadEvent func(sender *CertificateValidator, args *CertificateValidatorBeforeCACertificateDownloadEventArgs)

func (obj *CertificateValidator) GetOnBeforeCACertificateDownloadHandler() CertificateValidatorBeforeCACertificateDownloadEvent
func (obj *CertificateValidator) SetOnBeforeCACertificateDownloadHandler(handlerFunc CertificateValidatorBeforeCACertificateDownloadEvent)

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

// CertificateValidatorBeforeCertificateProcessingEventArgs carries the CertificateValidator BeforeCertificateProcessing event's parameters.
type CertificateValidatorBeforeCertificateProcessingEventArgs struct {...}

func (args *CertificateValidatorBeforeCertificateProcessingEventArgs) Cert() string
func (args *CertificateValidatorBeforeCertificateProcessingEventArgs) Validity() int32
func (args *CertificateValidatorBeforeCertificateProcessingEventArgs) ValidationDetails() int32
// CertificateValidatorBeforeCertificateProcessingEvent defines the signature of the CertificateValidator BeforeCertificateProcessing event's handler function.
type CertificateValidatorBeforeCertificateProcessingEvent func(sender *CertificateValidator, args *CertificateValidatorBeforeCertificateProcessingEventArgs)

func (obj *CertificateValidator) GetOnBeforeCertificateProcessingHandler() CertificateValidatorBeforeCertificateProcessingEvent
func (obj *CertificateValidator) SetOnBeforeCertificateProcessingHandler(handlerFunc CertificateValidatorBeforeCertificateProcessingEvent)

Remarks

This event is fired when the struct is about to start the processing of Cert.

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

// CertificateValidatorBeforeCertificateValidationEventArgs carries the CertificateValidator BeforeCertificateValidation event's parameters.
type CertificateValidatorBeforeCertificateValidationEventArgs struct {...}

func (args *CertificateValidatorBeforeCertificateValidationEventArgs) Cert() string
func (args *CertificateValidatorBeforeCertificateValidationEventArgs) CACert() string
// CertificateValidatorBeforeCertificateValidationEvent defines the signature of the CertificateValidator BeforeCertificateValidation event's handler function.
type CertificateValidatorBeforeCertificateValidationEvent func(sender *CertificateValidator, args *CertificateValidatorBeforeCertificateValidationEventArgs)

func (obj *CertificateValidator) GetOnBeforeCertificateValidationHandler() CertificateValidatorBeforeCertificateValidationEvent
func (obj *CertificateValidator) SetOnBeforeCertificateValidationHandler(handlerFunc CertificateValidatorBeforeCertificateValidationEvent)

Remarks

This event is fired when the struct 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

// CertificateValidatorBeforeCRLDownloadEventArgs carries the CertificateValidator BeforeCRLDownload event's parameters.
type CertificateValidatorBeforeCRLDownloadEventArgs struct {...}

func (args *CertificateValidatorBeforeCRLDownloadEventArgs) Cert() string
func (args *CertificateValidatorBeforeCRLDownloadEventArgs) CACert() string
func (args *CertificateValidatorBeforeCRLDownloadEventArgs) Location() string
// CertificateValidatorBeforeCRLDownloadEvent defines the signature of the CertificateValidator BeforeCRLDownload event's handler function.
type CertificateValidatorBeforeCRLDownloadEvent func(sender *CertificateValidator, args *CertificateValidatorBeforeCRLDownloadEventArgs)

func (obj *CertificateValidator) GetOnBeforeCRLDownloadHandler() CertificateValidatorBeforeCRLDownloadEvent
func (obj *CertificateValidator) SetOnBeforeCRLDownloadHandler(handlerFunc CertificateValidatorBeforeCRLDownloadEvent)

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

// CertificateValidatorBeforeOCSPDownloadEventArgs carries the CertificateValidator BeforeOCSPDownload event's parameters.
type CertificateValidatorBeforeOCSPDownloadEventArgs struct {...}

func (args *CertificateValidatorBeforeOCSPDownloadEventArgs) Cert() string
func (args *CertificateValidatorBeforeOCSPDownloadEventArgs) CACert() string
func (args *CertificateValidatorBeforeOCSPDownloadEventArgs) Location() string
// CertificateValidatorBeforeOCSPDownloadEvent defines the signature of the CertificateValidator BeforeOCSPDownload event's handler function.
type CertificateValidatorBeforeOCSPDownloadEvent func(sender *CertificateValidator, args *CertificateValidatorBeforeOCSPDownloadEventArgs)

func (obj *CertificateValidator) GetOnBeforeOCSPDownloadHandler() CertificateValidatorBeforeOCSPDownloadEvent
func (obj *CertificateValidator) SetOnBeforeOCSPDownloadHandler(handlerFunc CertificateValidatorBeforeOCSPDownloadEvent)

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

// CertificateValidatorCACertificateDownloadedEventArgs carries the CertificateValidator CACertificateDownloaded event's parameters.
type CertificateValidatorCACertificateDownloadedEventArgs struct {...}

func (args *CertificateValidatorCACertificateDownloadedEventArgs) Cert() string
func (args *CertificateValidatorCACertificateDownloadedEventArgs) Location() string
// CertificateValidatorCACertificateDownloadedEvent defines the signature of the CertificateValidator CACertificateDownloaded event's handler function.
type CertificateValidatorCACertificateDownloadedEvent func(sender *CertificateValidator, args *CertificateValidatorCACertificateDownloadedEventArgs)

func (obj *CertificateValidator) GetOnCACertificateDownloadedHandler() CertificateValidatorCACertificateDownloadedEvent
func (obj *CertificateValidator) SetOnCACertificateDownloadedHandler(handlerFunc CertificateValidatorCACertificateDownloadedEvent)

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

// CertificateValidatorCACertificateNeededEventArgs carries the CertificateValidator CACertificateNeeded event's parameters.
type CertificateValidatorCACertificateNeededEventArgs struct {...}

func (args *CertificateValidatorCACertificateNeededEventArgs) Cert() string
// CertificateValidatorCACertificateNeededEvent defines the signature of the CertificateValidator CACertificateNeeded event's handler function.
type CertificateValidatorCACertificateNeededEvent func(sender *CertificateValidator, args *CertificateValidatorCACertificateNeededEventArgs)

func (obj *CertificateValidator) GetOnCACertificateNeededHandler() CertificateValidatorCACertificateNeededEvent
func (obj *CertificateValidator) SetOnCACertificateNeededHandler(handlerFunc CertificateValidatorCACertificateNeededEvent)

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

// CertificateValidatorCRLDownloadedEventArgs carries the CertificateValidator CRLDownloaded event's parameters.
type CertificateValidatorCRLDownloadedEventArgs struct {...}

func (args *CertificateValidatorCRLDownloadedEventArgs) Cert() string
func (args *CertificateValidatorCRLDownloadedEventArgs) CACert() string
func (args *CertificateValidatorCRLDownloadedEventArgs) Location() string
// CertificateValidatorCRLDownloadedEvent defines the signature of the CertificateValidator CRLDownloaded event's handler function.
type CertificateValidatorCRLDownloadedEvent func(sender *CertificateValidator, args *CertificateValidatorCRLDownloadedEventArgs)

func (obj *CertificateValidator) GetOnCRLDownloadedHandler() CertificateValidatorCRLDownloadedEvent
func (obj *CertificateValidator) SetOnCRLDownloadedHandler(handlerFunc CertificateValidatorCRLDownloadedEvent)

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

// CertificateValidatorCRLNeededEventArgs carries the CertificateValidator CRLNeeded event's parameters.
type CertificateValidatorCRLNeededEventArgs struct {...}

func (args *CertificateValidatorCRLNeededEventArgs) Cert() string
func (args *CertificateValidatorCRLNeededEventArgs) CACert() string
// CertificateValidatorCRLNeededEvent defines the signature of the CertificateValidator CRLNeeded event's handler function.
type CertificateValidatorCRLNeededEvent func(sender *CertificateValidator, args *CertificateValidatorCRLNeededEventArgs)

func (obj *CertificateValidator) GetOnCRLNeededHandler() CertificateValidatorCRLNeededEvent
func (obj *CertificateValidator) SetOnCRLNeededHandler(handlerFunc CertificateValidatorCRLNeededEvent)

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

// CertificateValidatorErrorEventArgs carries the CertificateValidator Error event's parameters.
type CertificateValidatorErrorEventArgs struct {...}

func (args *CertificateValidatorErrorEventArgs) ErrorCode() int32
func (args *CertificateValidatorErrorEventArgs) Description() string
// CertificateValidatorErrorEvent defines the signature of the CertificateValidator Error event's handler function.
type CertificateValidatorErrorEvent func(sender *CertificateValidator, args *CertificateValidatorErrorEventArgs)

func (obj *CertificateValidator) GetOnErrorHandler() CertificateValidatorErrorEvent
func (obj *CertificateValidator) SetOnErrorHandler(handlerFunc CertificateValidatorErrorEvent)

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

// CertificateValidatorNotificationEventArgs carries the CertificateValidator Notification event's parameters.
type CertificateValidatorNotificationEventArgs struct {...}

func (args *CertificateValidatorNotificationEventArgs) EventID() string
func (args *CertificateValidatorNotificationEventArgs) EventParam() string
// CertificateValidatorNotificationEvent defines the signature of the CertificateValidator Notification event's handler function.
type CertificateValidatorNotificationEvent func(sender *CertificateValidator, args *CertificateValidatorNotificationEventArgs)

func (obj *CertificateValidator) GetOnNotificationHandler() CertificateValidatorNotificationEvent
func (obj *CertificateValidator) SetOnNotificationHandler(handlerFunc CertificateValidatorNotificationEvent)

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.

This struct 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 struct 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

// CertificateValidatorOCSPDownloadedEventArgs carries the CertificateValidator OCSPDownloaded event's parameters.
type CertificateValidatorOCSPDownloadedEventArgs struct {...}

func (args *CertificateValidatorOCSPDownloadedEventArgs) Cert() string
func (args *CertificateValidatorOCSPDownloadedEventArgs) CACert() string
func (args *CertificateValidatorOCSPDownloadedEventArgs) Location() string
// CertificateValidatorOCSPDownloadedEvent defines the signature of the CertificateValidator OCSPDownloaded event's handler function.
type CertificateValidatorOCSPDownloadedEvent func(sender *CertificateValidator, args *CertificateValidatorOCSPDownloadedEventArgs)

func (obj *CertificateValidator) GetOnOCSPDownloadedHandler() CertificateValidatorOCSPDownloadedEvent
func (obj *CertificateValidator) SetOnOCSPDownloadedHandler(handlerFunc CertificateValidatorOCSPDownloadedEvent)

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

// CertificateValidatorTLSCertNeededEventArgs carries the CertificateValidator TLSCertNeeded event's parameters.
type CertificateValidatorTLSCertNeededEventArgs struct {...}

func (args *CertificateValidatorTLSCertNeededEventArgs) Host() string
func (args *CertificateValidatorTLSCertNeededEventArgs) CANames() string
// CertificateValidatorTLSCertNeededEvent defines the signature of the CertificateValidator TLSCertNeeded event's handler function.
type CertificateValidatorTLSCertNeededEvent func(sender *CertificateValidator, args *CertificateValidatorTLSCertNeededEventArgs)

func (obj *CertificateValidator) GetOnTLSCertNeededHandler() CertificateValidatorTLSCertNeededEvent
func (obj *CertificateValidator) SetOnTLSCertNeededHandler(handlerFunc CertificateValidatorTLSCertNeededEvent)

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

// CertificateValidatorTLSCertValidateEventArgs carries the CertificateValidator TLSCertValidate event's parameters.
type CertificateValidatorTLSCertValidateEventArgs struct {...}

func (args *CertificateValidatorTLSCertValidateEventArgs) ServerHost() string
func (args *CertificateValidatorTLSCertValidateEventArgs) ServerIP() string
func (args *CertificateValidatorTLSCertValidateEventArgs) Accept() bool
func (args *CertificateValidatorTLSCertValidateEventArgs) SetAccept(value bool)

// CertificateValidatorTLSCertValidateEvent defines the signature of the CertificateValidator TLSCertValidate event's handler function.
type CertificateValidatorTLSCertValidateEvent func(sender *CertificateValidator, args *CertificateValidatorTLSCertValidateEventArgs)

func (obj *CertificateValidator) GetOnTLSCertValidateHandler() CertificateValidatorTLSCertValidateEvent
func (obj *CertificateValidator) SetOnTLSCertValidateHandler(handlerFunc CertificateValidatorTLSCertValidateEvent)

Remarks

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

TLSEstablished Event (CertificateValidator Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

// CertificateValidatorTLSEstablishedEventArgs carries the CertificateValidator TLSEstablished event's parameters.
type CertificateValidatorTLSEstablishedEventArgs struct {...}

func (args *CertificateValidatorTLSEstablishedEventArgs) Host() string
func (args *CertificateValidatorTLSEstablishedEventArgs) Version() string
func (args *CertificateValidatorTLSEstablishedEventArgs) Ciphersuite() string
func (args *CertificateValidatorTLSEstablishedEventArgs) ConnectionId() []byte
func (args *CertificateValidatorTLSEstablishedEventArgs) Abort() bool
func (args *CertificateValidatorTLSEstablishedEventArgs) SetAbort(value bool)

// CertificateValidatorTLSEstablishedEvent defines the signature of the CertificateValidator TLSEstablished event's handler function.
type CertificateValidatorTLSEstablishedEvent func(sender *CertificateValidator, args *CertificateValidatorTLSEstablishedEventArgs)

func (obj *CertificateValidator) GetOnTLSEstablishedHandler() CertificateValidatorTLSEstablishedEvent
func (obj *CertificateValidator) SetOnTLSEstablishedHandler(handlerFunc CertificateValidatorTLSEstablishedEvent)

Remarks

The struct 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

// CertificateValidatorTLSHandshakeEventArgs carries the CertificateValidator TLSHandshake event's parameters.
type CertificateValidatorTLSHandshakeEventArgs struct {...}

func (args *CertificateValidatorTLSHandshakeEventArgs) Host() string
func (args *CertificateValidatorTLSHandshakeEventArgs) Abort() bool
func (args *CertificateValidatorTLSHandshakeEventArgs) SetAbort(value bool)

// CertificateValidatorTLSHandshakeEvent defines the signature of the CertificateValidator TLSHandshake event's handler function.
type CertificateValidatorTLSHandshakeEvent func(sender *CertificateValidator, args *CertificateValidatorTLSHandshakeEventArgs)

func (obj *CertificateValidator) GetOnTLSHandshakeHandler() CertificateValidatorTLSHandshakeEvent
func (obj *CertificateValidator) SetOnTLSHandshakeHandler(handlerFunc CertificateValidatorTLSHandshakeEvent)

Remarks

The struct 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

// CertificateValidatorTLSShutdownEventArgs carries the CertificateValidator TLSShutdown event's parameters.
type CertificateValidatorTLSShutdownEventArgs struct {...}

func (args *CertificateValidatorTLSShutdownEventArgs) Host() string
// CertificateValidatorTLSShutdownEvent defines the signature of the CertificateValidator TLSShutdown event's handler function.
type CertificateValidatorTLSShutdownEvent func(sender *CertificateValidator, args *CertificateValidatorTLSShutdownEventArgs)

func (obj *CertificateValidator) GetOnTLSShutdownHandler() CertificateValidatorTLSShutdownEvent
func (obj *CertificateValidator) SetOnTLSShutdownHandler(handlerFunc CertificateValidatorTLSShutdownEvent)

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 struct 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 struct, access to these internal properties is provided through the Config method.

CertificateValidator Config Settings

CachedCRLMaxAge: Specifies the maximum age of a cached CRL.

Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched.

The default value is 0, which disables the absolute CRL age check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedCRLMaxAgeRatio: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.

Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched.

The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedCRLOverlapTime: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.

Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched.

The default value is 0, which disables the CRL overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from CachedCRLMaxAge and CachedCRLMaxAgeRatio. If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them.

CachedOCSPResponseMaxAge: Specifies the maximum age of a cached OCSP response.

Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedOCSPResponseMaxAgeRatio: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.

Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use CachedOCSPResponseMaxAge to limit their age. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

CachedOCSPResponseOverlapTime: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.

Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched.

The default value is 0, which disables the OCSP response overlap check. See RevocationCacheAgePolicy for configuring this setting together with the related cached revocation freshness settings.

This setting is evaluated independently from CachedOCSPResponseMaxAge and CachedOCSPResponseMaxAgeRatio. If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them.

CacheValidityTime: Time period during which to keep validation cache.

The validity period of the cached validation results in milliseconds.

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

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

CheckValidityPeriodForTrusted: Whether to check validity period for trusted certificates.

Whether to check validity period for trusted certificates.

CrossCertificationValidationStrategy: Defines how the cross certification validation is performed.

This property tells the struct 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.

DeltaCRLPreference: Specifies whether complete or delta CRLs are preferred.

Use this setting to specify which CRL type should be preferred during revocation checks.

The default value is dcrlpPreferDelta (0).

Supported values:

dcrlpPreferDelta (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed.
dcrlpPreferComplete (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved.

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

When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the struct 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).

EvaluateSystemTrust: Enables or disables usage of the platform's built-in trust validation facilities.

When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is disabled by default, because enabling it may prevent the AdES components from collecting full revocation information required for long-term validation (LTV) signatures.

EvaluateSystemTrustForSelfSignedCertificates: Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.

When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) for self-signed certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

EvaluateSystemTrustForSSL: Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.

When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) specifically for SSL/TLS certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default.

ForceCompleteChainValidationForTrusted: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors.

Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments.

ForceRevocationCheckForRoot: Whether to check revocation info for root certificates.

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

IgnoreBadOCSPChains: Whether to ignore bad OCSP chains during validation.

Whether to ignore bad OCSP chains during validation.

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

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

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

Whether to ignore Key Usage extension for CA certificates.

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

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

IgnoreChainLoops: Whether chain loops should be ignored.

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

IgnoreCRLIssuerKeyID: Tells the validator to ignore malformed CRL issuer key IDs.

Another compatibility/tolerance tweak that tells the validator to ignore the issuer key identifier values recorded in the processed CRLs (occasionally it is recorded there wrongly).

IgnoreOCSPNoCheckExtension: Whether the OCSP NoCheck extension should be ignored.

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

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

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

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

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

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

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

If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.

ImplicitlyTrustSelfSignedCertificates: Whether to trust self-signed certificates.

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

LookupCRLByNameIfDPNotPresent: Whether to look for implicit CRL Distribution Points.

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

PromoteLongOCSPResponses: Whether long OCSP responses are requested.

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

RevocationCacheAgePolicy: Specifies a preset policy for cached CRL and OCSP response freshness settings.

Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled.

Supported values are case-insensitive:


Disabled	Sets CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache.
Default	Applies the component default freshness settings. For this component, Default is equivalent to Disabled.
Short	Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes.
Long	Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour.
N	Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50.
crl:<maxAge>;<ratio>;<overlap>,ocsp:<maxAge>;<ratio>;<overlap>	Sets the CRL and OCSP response freshness values explicitly.

Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual CachedCRLOverlapTime, CachedOCSPResponseOverlapTime, CachedCRLMaxAge, CachedOCSPResponseMaxAge, CachedCRLMaxAgeRatio, and CachedOCSPResponseMaxAgeRatio settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values.

RevocationMomentGracePeriod: Grace period for revocation information propagation.

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

SkipSubjectNameIfAltNameExists: Whether to check CommonName if SubjectAltName is present.

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

UseEnvStorages: Enables or disables use of the environment storages.

Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages.

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

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

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

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

ValidateInvalidCertificates: Whether to do all checks on invalid certificates.

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

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

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

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

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

TrustedLists Config Settings

CustomTrustedLists: Specifies the custom TrustedLists.

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

CustomTSLs: Specifies the custom TrustedLists.

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

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

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

HistoricalInformationPeriod: Contains historical information period of the TSL used.

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

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

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

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

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

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

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

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

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

QualifiedStatus: Indicates a qualified electronic signature.

Use this property to check if an electronic signature is created using a qualified device for creating electronic signatures and that relies on a qualified electronic signature certificate. This property return TSP service status URI.

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

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

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

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

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

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

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

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

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

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

SchemeTerritory: Contains scheme territory of the TSL used.

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

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

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

SequenceNumber: Contains sequence number of the TSL used.

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

StatusDeterminationApproach: Contains status determination approach of the TSL used.

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

TSLContent: Specifies the TrustedList content.

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

TSLContentHex: Specifies the TrustedList content.

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

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

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

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

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

TSLHistoricalInformationPeriod: Contains historical information period of the TSL used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TSLSchemeTerritory: Contains scheme territory of the TSL used.

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

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

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

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

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

TSLSequenceNumber: Contains sequence number of the TSL used.

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

TSLsRetrieveLog: Contains the complete log of the TSLs retrieve.

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

TSLStatusDeterminationApproach: Contains status determination approach of the TSL used.

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

TSLsValidationLog: Contains the complete log of the TSLs validation.

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

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

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

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

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

TSLTSPHistoryInstance: Indicates that TSP service history instance used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TSLTSPServiceStatus: Contains status of the TSP service used.

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

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

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

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

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

TSLTSPServiceTypeIdentifier: Contains type identifier of the TSP service used.

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

TSLTSPServiceXML: Contains XML content of the TSP service used.

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

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

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

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

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

TSLTSPXML: Contains XML content of the TSP used.

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

TSLType: Contains TSL type of the TSL used.

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

TSLVersionIdentifier: Contains version identifier of the TSL used.

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

TSLXML: Contains XML content of the TSL used.

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

TSPAdditionalServiceInformation: Contains additional service information of the TSP service used.

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

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

TSPHistoryInstance: Indicates that TSP service history instance used.

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

TSPHistoryInstanceAdditionalServiceInformation: Contains additional service information of the TSP service history instance used.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TSPServiceStatus: Contains status of the TSP service used.

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

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

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

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

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

TSPServiceTypeIdentifier: Contains type identifier of the TSP service used.

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

TSPServiceXML: Contains XML content of the TSP service used.

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

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

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

TSPXML: Contains XML content of the TSP used.

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

Type: Contains TSL type of the TSL used.

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

VersionIdentifier: Contains version identifier of the TSL used.

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

Base Config Settings

ASN1UseGlobalTagCache: Controls whether ASN.1 module should use a global object cache.

This is a performance setting. It is unlikely that you will ever need to adjust it.

AssignSystemSmartCardPins: Specifies whether CSP-level PINs should be assigned to CNG keys.

This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it.

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

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

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

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

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

Supported values are:


off		No caching (default)
local		Local caching
global		Global caching

Cookies: Gets or sets local cookies for the struct.

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

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

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

DNSLocalSuffix: The suffix to assign for TLD names.

Use this global setting to adjust the default suffix to assign to top-level domain names. The default is .local.

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

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

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

EnableSSHMLKEM: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.

Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components.

EnableTLSMLKEM: Enables support for ML-KEM and hybrid groups in TLS client and server components.

Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components.

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

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

HardwareCryptoUsePolicy: The hardware crypto usage policy.

This global setting controls the hardware cryptography usage policy.

Supported Values:


auto	Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default).
enable	Always attempt to use hardware cryptography. If unavailable, exception will be thrown.
disable	Do not use hardware cryptography.

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

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

HttpVersion: The HTTP version to use in any inner HTTP client components created.

Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use.

IgnoreExpiredMSCTLSigningCert: Whether to tolerate the expired Windows Update signing certificate.

It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account.

ListDelimiter: The delimiter character for multi-element lists.

Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence.

LogDestination: Specifies the debug log destination.

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

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

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

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

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

LogFilters: Specifies the debug log filters.

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

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

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


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

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

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

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

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


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

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

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

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

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

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

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

OldClientSideRSAFallback: Specifies whether the SSH client should use a SHA1 fallback.

Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak.

PKICache: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.

The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached.

Supported Values:


certificate	Enables caching of certificates.
crl	Enables caching of Certificate Revocation Lists (CRLs).
ocsp	Enables caching of OCSP (Online Certificate Status Protocol) responses.

Example (default value): PKICache=certificate,crl,ocsp In this example, the component caches certificates, CRLs, and OCSP responses.

PKICachePath: Specifies the file system path where cached PKI data is stored.

The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts.

The default value is an empty string - no cached PKI data is stored on disk.

Example: PKICachePath=C:\Temp\cache In this example, the cached PKI data is stored in the C:\Temp\cache directory.

ProductVersion: Returns the version of the SecureBlackbox library.

This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision).

ServerSSLDHKeyLength: Sets the size of the TLS DHE key exchange group.

Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server.

StaticDNS: Specifies whether static DNS rules should be used.

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

Supported values are:


none		No static DNS rules (default)
local		Local static DNS rules
global		Global static DNS rules

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

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

StaticIPAddresses: Gets or sets all the static DNS rules.

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

Tag: Allows to store any custom data.

Use this config property to store any custom data.

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

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

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

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

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

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

UseCRLObjectCaching: Specifies whether reuse of loaded CRL objects is enabled.

This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used.

UseInternalRandom: Switches between SecureBlackbox-own and platform PRNGs.

Allows to switch between internal/native PRNG implementation and the one provided by the platform.

UseLegacyAdESValidation: Enables legacy AdES validation mode.

Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details).

UseOCSPResponseObjectCaching: Specifies whether reuse of loaded OCSP response objects is enabled.

This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used.

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

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

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

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

UseSystemNativeSizeCalculation: An internal CryptoAPI access tweak.

This is an internal setting. Please do not use it unless instructed by the support team.

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

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

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

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

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

XMLRDNDescriptorName[OID]: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.

This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures.

The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.

Syntax: Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");

Where:

OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.

PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.

Alias1, Alias2, ...: Optional alternative names recognized during parsing.

Usage Examples:

Map OID 2.5.4.5 to SERIALNUMBER: Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");

Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");

XMLRDNDescriptorPriority[OID]: Specifies the priority of descriptor names associated with a specific OID.

This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing.

XMLRDNDescriptorReverseOrder: Specifies whether to reverse the order of descriptors in RDN.

Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1).

XMLRDNDescriptorSeparator: Specifies the separator used between descriptors in RDN.

Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value.

Trappable Errors (CertificateValidator Component)

CertificateValidator Errors

1048577	Invalid parameter (`SB_ERROR_INVALID_PARAMETER`)
1048578	Invalid configuration (`SB_ERROR_INVALID_SETUP`)
1048579	Invalid state (`SB_ERROR_INVALID_STATE`)
1048580	Invalid value (`SB_ERROR_INVALID_VALUE`)
1048581	Private key not found (`SB_ERROR_NO_PRIVATE_KEY`)
1048582	Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
1048583	The file was not found (`SB_ERROR_NO_SUCH_FILE`)
1048584	Unsupported feature or operation (`SB_ERROR_UNSUPPORTED_FEATURE`)
1048585	General error (`SB_ERROR_GENERAL_ERROR`)