# CertificateValidator Component The CertificateValidator component provides fine-grained validation of X.509 certificates. ## Syntax ```text nsoftware.SecureBlackbox.CertificateValidator ``` ## Remarks This is a powerful and configurable component which can be used to validate all kinds of certificates and their chains. The purpose of CertificateValidator is to validate certificate chains according to the X.509 specification. It supports a variety of technologies, including CRL and OCSP services, and can provide a comprehensive output on the certificate cryptographic validity, chain integrity, and trust levels. CertificateValidator is used internally in many other SecureBlackbox components, such as PDFSigner, HTTPClient, and OfficeVerifier. To validate a certificate, please tune up the component as following: - Assign the certificate to be validated to the [Certificate](#certificate-property-certificatevalidator-component) property. - Set [RevocationCheck](#revocationcheck-property-certificatevalidator-component) in accordance with your revocation check preferences. - Enable [UseSystemCertificates](#usesystemcertificates-property-certificatevalidator-component) 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](#knowncertificates-property-certificatevalidator-component) and [TrustedCertificates](#trustedcertificates-property-certificatevalidator-component) collections (see Note 1 below). - Optionally, adjust [TLSSettings](#tlssettings-property-certificatevalidator-component) and [SocketSettings](#socketsettings-property-certificatevalidator-component). - Adjust [ValidationMoment](#validationmoment-property-certificatevalidator-component) 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](#validate-method-certificatevalidator-component) or [ValidateForSSL](#validateforssl-method-certificatevalidator-component) 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](#beforecertificateprocessing-event-certificatevalidator-component), [AfterCertificateProcessing](#aftercertificateprocessing-event-certificatevalidator-component), and [CRLDownloaded](#crldownloaded-event-certificatevalidator-component) events. It may also ask you for missing objects using [CRLNeeded](#crlneeded-event-certificatevalidator-component) or [CACertificateNeeded](#cacertificateneeded-event-certificatevalidator-component) events. In each such event handler you can access the currently validated certificate via the [CurrentCertificate](#currentcertificate-property-certificatevalidator-component) property, and the interim validity figures via the [InterimValidationResult](#interimvalidationresult-property-certificatevalidator-component) and [InterimValidationDetails](#interimvalidationdetails-property-certificatevalidator-component) property. The return of the [Validate](#validate-method-certificatevalidator-component) (or similar) method indicates the completion of the validation procedure. The outcome of the chain validation is represented with the two parameters: - [ChainValidationResult](#chainvalidationresult-property-certificatevalidator-component) 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](#chainvalidationdetails-property-certificatevalidator-component) 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](#validationlog-property-certificatevalidator-component) 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](#trustedcertificates-property-certificatevalidator-component) and [KnownCertificates](#knowncertificates-property-certificatevalidator-component) collections to have your chains validate fully in Linux and macOS projects. Note 2: The [OfflineMode](#offlinemode-property-certificatevalidator-component) 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](#usesystemcertificates-property-certificatevalidator-component) property, it allows to make sure that any content provided via [KnownCertificates](#knowncertificates-property-certificatevalidator-component), [KnownCRLs](#knowncrls-property-certificatevalidator-component), and [KnownOCSPs](#knownocsps-property-certificatevalidator-component) 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.* | | | | --- | --- | | [BlockedCertificates](#blockedcertificates-property-certificatevalidator-component) | The certificates that must be rejected as trust anchors. | | [CacheValidationResults](#cachevalidationresults-property-certificatevalidator-component) | Enables or disables validation result caching. | | [Certificate](#certificate-property-certificatevalidator-component) | The certificate to be validated. | | [ChainValidationDetails](#chainvalidationdetails-property-certificatevalidator-component) | The details of a certificate chain validation outcome. | | [ChainValidationResult](#chainvalidationresult-property-certificatevalidator-component) | The general outcome of a certificate chain validation routine. Use [ChainValidationDetails](#chainvalidationdetails-property-certificatevalidator-component) to get information about the reasons that contributed to the validation result. | | [CheckTrustedLists](#checktrustedlists-property-certificatevalidator-component) | Specifies whether the component should attempt to validate chain trust via a known Trusted List. | | [CurrentCACertificate](#currentcacertificate-property-certificatevalidator-component) | The CA of the currently processed certificate. | | [CurrentCertificate](#currentcertificate-property-certificatevalidator-component) | The certificate that is currently being processed. | | [FIPSMode](#fipsmode-property-certificatevalidator-component) | Reserved. | | [GracePeriod](#graceperiod-property-certificatevalidator-component) | Specifies a grace period to apply during certificate validation. | | [InterimValidationDetails](#interimvalidationdetails-property-certificatevalidator-component) | Contains the validation details of the moment. | | [InterimValidationResult](#interimvalidationresult-property-certificatevalidator-component) | Contains the validation status of the moment. | | [KnownCertificates](#knowncertificates-property-certificatevalidator-component) | Additional certificates for chain validation. | | [KnownCRLs](#knowncrls-property-certificatevalidator-component) | Additional CRLs for chain validation. | | [KnownOCSPs](#knownocsps-property-certificatevalidator-component) | Additional OCSP responses for chain validation. | | [MaxValidationTime](#maxvalidationtime-property-certificatevalidator-component) | Specifies the maximum time the validation process may take. | | [OfflineMode](#offlinemode-property-certificatevalidator-component) | Switches the component to offline mode. | | [Proxy](#proxy-property-certificatevalidator-component) | The proxy server settings. | | [QualifiedInfo](#qualifiedinfo-property-certificatevalidator-component) | The qualified details for the validated certificate. | | [RevocationCheck](#revocationcheck-property-certificatevalidator-component) | Specifies the kind(s) of revocation check to perform for all chain certificates. | | [SocketSettings](#socketsettings-property-certificatevalidator-component) | Manages network connection settings. | | [TLSClientChain](#tlsclientchain-property-certificatevalidator-component) | The TLS client certificate chain. | | [TLSServerChain](#tlsserverchain-property-certificatevalidator-component) | The TLS server's certificate chain. | | [TLSSettings](#tlssettings-property-certificatevalidator-component) | Manages TLS layer settings. | | [TrustedCertificates](#trustedcertificates-property-certificatevalidator-component) | A list of trusted certificates for chain validation. | | [UsedCertificates](#usedcertificates-property-certificatevalidator-component) | Contains a list of certificates used during the chain validation routine. | | [UsedCRLs](#usedcrls-property-certificatevalidator-component) | Contains a list of CRLs used during the chain validation routine. | | [UsedOCSPs](#usedocsps-property-certificatevalidator-component) | Contains a list of OCSP responses used during the chain validation routine. | | [UseSystemCertificates](#usesystemcertificates-property-certificatevalidator-component) | Enables or disables the use of the system certificates. | | [ValidationLog](#validationlog-property-certificatevalidator-component) | Contains the complete log of the certificate validation routine. | | [ValidationMoment](#validationmoment-property-certificatevalidator-component) | 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](#config-method-certificatevalidator-component) | Sets or retrieves a configuration setting. | | [DoAction](#doaction-method-certificatevalidator-component) | Performs an additional action. | | [GetQualifiedStatus](#getqualifiedstatus-method-certificatevalidator-component) | Obtains the qualified information for [Certificate](#certificate-property-certificatevalidator-component) . | | [GetTrustedListProperty](#gettrustedlistproperty-method-certificatevalidator-component) | Returns a specific TrustedList property. | | [RefreshCache](#refreshcache-method-certificatevalidator-component) | Refreshes the certificate cache. | | [Reset](#reset-method-certificatevalidator-component) | Resets the component settings. | | [ResetCache](#resetcache-method-certificatevalidator-component) | Clears all data contained in the validation cache. | | [Terminate](#terminate-method-certificatevalidator-component) | Terminates the validation process. | | [Validate](#validate-method-certificatevalidator-component) | Validates the certificate chain. | | [ValidateForSMIME](#validateforsmime-method-certificatevalidator-component) | Validates an e-mail signing certificate. | | [ValidateForSSL](#validateforssl-method-certificatevalidator-component) | 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](#aftercertificateprocessing-event-certificatevalidator-component) | Marks the end of a single certificate processing step. | | [AfterCertificateValidation](#aftercertificatevalidation-event-certificatevalidator-component) | Marks the end of a single certificate validation step. | | [BeforeCACertificateDownload](#beforecacertificatedownload-event-certificatevalidator-component) | Fires when a CA certificate is about to be downloaded. | | [BeforeCertificateProcessing](#beforecertificateprocessing-event-certificatevalidator-component) | Reports the start of certificate processing. | | [BeforeCertificateValidation](#beforecertificatevalidation-event-certificatevalidator-component) | Reports the start of certificate validation. | | [BeforeCRLDownload](#beforecrldownload-event-certificatevalidator-component) | Fires when a CRL is about to be downloaded. | | [BeforeOCSPDownload](#beforeocspdownload-event-certificatevalidator-component) | Fires when a certificate's OCSP status is about to be requested. | | [CACertificateDownloaded](#cacertificatedownloaded-event-certificatevalidator-component) | Marks the success of a certificate download. | | [CACertificateNeeded](#cacertificateneeded-event-certificatevalidator-component) | Requests a missing certificate from the user. | | [CRLDownloaded](#crldownloaded-event-certificatevalidator-component) | Marks the success of a CRL download. | | [CRLNeeded](#crlneeded-event-certificatevalidator-component) | Requests a missing CRL from the user. | | [Error](#error-event-certificatevalidator-component) | Information about errors during certificate validation. | | [Notification](#notification-event-certificatevalidator-component) | This event notifies the application about an underlying control flow event. | | [OCSPDownloaded](#ocspdownloaded-event-certificatevalidator-component) | Marks the success of an OCSP request. | | [TLSCertNeeded](#tlscertneeded-event-certificatevalidator-component) | Fires when a remote TLS party requests a client certificate. | | [TLSCertValidate](#tlscertvalidate-event-certificatevalidator-component) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. | | [TLSEstablished](#tlsestablished-event-certificatevalidator-component) | Fires when a TLS handshake with Host successfully completes. | | [TLSHandshake](#tlshandshake-event-certificatevalidator-component) | Fires when a new TLS handshake is initiated, before the handshake commences. | | [TLSShutdown](#tlsshutdown-event-certificatevalidator-component) | 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](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. | | [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. | | [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. | | [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. | | [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. | | [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. | | [CacheValidityTime](#CacheValidityTime) | Time period during which to keep validation cache. | | [CheckStrongAlgorithmForTrusted](#CheckStrongAlgorithmForTrusted) | Whether to check a 'strong' hash algorithm for trusted certificates. | | [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. | | [CrossCertificationValidationStrategy](#CrossCertificationValidationStrategy) | Defines how the cross certification validation is performed. | | [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. | | [DislikeOpenEndedOCSPs](#DislikeOpenEndedOCSPs) | Tells the component to discourage OCSP responses without an explicit NextUpdate parameter. | | [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. | | [EvaluateSystemTrustForSelfSignedCertificates](#EvaluateSystemTrustForSelfSignedCertificates) | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. | | [EvaluateSystemTrustForSSL](#EvaluateSystemTrustForSSL) | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. | | [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. | | [ForceRevocationCheckForRoot](#ForceRevocationCheckForRoot) | Whether to check revocation info for root certificates. | | [IgnoreBadOCSPChains](#IgnoreBadOCSPChains) | Whether to ignore bad OCSP chains during validation. | | [IgnoreCABasicConstraints](#IgnoreCABasicConstraints) | Whether to ignore the Basic Constraints extension for the CA certificates. | | [IgnoreCAKeyUsage](#IgnoreCAKeyUsage) | Whether to ignore Key Usage extension for CA certificates. | | [IgnoreCANameConstraints](#IgnoreCANameConstraints) | Whether to ignore the Name Constraints extension for the CA certificates. | | [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. | | [IgnoreCRLIssuerKeyID](#IgnoreCRLIssuerKeyID) | Tells the validator to ignore malformed CRL issuer key IDs. | | [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. | | [IgnoreRevocationKeyUsage](#IgnoreRevocationKeyUsage) | Whether to check the CA certs used to sign revocation info. | | [IgnoreSSLKeyUsage](#IgnoreSSLKeyUsage) | Whether to check the CA certs used in SSL/TLS. | | [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. | | [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. | | [LookupCRLByNameIfDPNotPresent](#LookupCRLByNameIfDPNotPresent) | Whether to look for implicit CRL Distribution Points. | | [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. | | [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. | | [RevocationMomentGracePeriod](#RevocationMomentGracePeriod) | Grace period for revocation information propagation. | | [SkipSubjectNameIfAltNameExists](#SkipSubjectNameIfAltNameExists) | Whether to check CommonName if SubjectAltName is present. | | [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. | | [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. | | [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. | | [ValidateInvalidCertificates](#ValidateInvalidCertificates) | Whether to do all checks on invalid certificates. | | [WeakAlgorithmHandlingMode](#WeakAlgorithmHandlingMode) | How to handle certificates signed with a 'weak' hash algorithm. | | [CustomTrustedLists](#CustomTrustedLists) | Specifies the custom TrustedLists. | | [CustomTSLs](#CustomTSLs) | Specifies the custom TrustedLists. | | [DistributionPoints](#DistributionPoints) | Contains XML content of distribution points of the TSL used. | | [HistoricalInformationPeriod](#HistoricalInformationPeriod) | Contains historical information period of the TSL used. | | [LegalNotices](#LegalNotices) | Contains XML content of legal notices of the TSL used. | | [ListIssueDateTime](#ListIssueDateTime) | Contains list issue date and time of the TSL used. | | [NextUpdate](#NextUpdate) | Contains next update date and time of the TSL used. | | [Policies](#Policies) | Contains XML content of policies of the TSL used. | | [QualifiedStatus](#QualifiedStatus) | Indicates a qualified electronic signature. | | [SchemeExtensions](#SchemeExtensions) | Contains XML content of scheme extensions of the TSL used. | | [SchemeInformationURI](#SchemeInformationURI) | Contains XML content of scheme information URI of the TSL used. | | [SchemeName](#SchemeName) | Contains XML content of scheme name of the TSL used. | | [SchemeOperatorAddress](#SchemeOperatorAddress) | Contains XML content of scheme operator address of the TSL used. | | [SchemeOperatorName](#SchemeOperatorName) | Contains XML content of scheme operator name of the TSL used. | | [SchemeTerritory](#SchemeTerritory) | Contains scheme territory of the TSL used. | | [SchemeTypeCommunityRules](#SchemeTypeCommunityRules) | Contains XML content of scheme type/community/rules of the TSL used. | | [SequenceNumber](#SequenceNumber) | Contains sequence number of the TSL used. | | [StatusDeterminationApproach](#StatusDeterminationApproach) | Contains status determination approach of the TSL used. | | [TSLContent](#TSLContent) | Specifies the TrustedList content. | | [TSLContentHex](#TSLContentHex) | Specifies the TrustedList content. | | [TSLDistributionPoints](#TSLDistributionPoints) | Contains XML content of distribution points of the TSL used. | | [TSLDistributionPoints\[Idx\]](#TSLDistributionPoints[Idx]) | Contains distribution point of the specified index of the TSL used. | | [TSLHistoricalInformationPeriod](#TSLHistoricalInformationPeriod) | Contains historical information period of the TSL used. | | [TSLLegalNotices](#TSLLegalNotices) | Contains XML content of legal notices of the TSL used. | | [TSLLegalNotices\[lang\]](#TSLLegalNotices[lang]) | Contains legal notices for the specified language of the TSL used. | | [TSLListIssueDateTime](#TSLListIssueDateTime) | Contains list issue date and time of the TSL used. | | [TSLNextUpdate](#TSLNextUpdate) | Contains next update date and time of the TSL used. | | [TSLPolicies](#TSLPolicies) | Contains XML content of policies of the TSL used. | | [TSLPolicies\[lang\]](#TSLPolicies[lang]) | Contains policies for the specified language of the TSL used. | | [TSLSchemeExtensions](#TSLSchemeExtensions) | Contains XML content of scheme extensions of the TSL used. | | [TSLSchemeExtensions\[Idx\]](#TSLSchemeExtensions[Idx]) | Contains XML content of scheme extension of the specified index of the TSL used. | | [TSLSchemeInformationURI](#TSLSchemeInformationURI) | Contains XML content of scheme information URI of the TSL used. | | [TSLSchemeInformationURI\[lang\]](#TSLSchemeInformationURI[lang]) | Contains scheme information URI for the specified language of the TSL used. | | [TSLSchemeName](#TSLSchemeName) | Contains XML content of scheme name of the TSL used. | | [TSLSchemeName\[lang\]](#TSLSchemeName[lang]) | Contains scheme name for the specified language of the TSL used. | | [TSLSchemeOperatorAddress](#TSLSchemeOperatorAddress) | Contains XML content of scheme operator address of the TSL used. | | [TSLSchemeOperatorName](#TSLSchemeOperatorName) | Contains XML content of scheme operator name of the TSL used. | | [TSLSchemeOperatorName\[lang\]](#TSLSchemeOperatorName[lang]) | Contains scheme operator name for the specified language of the TSL used. | | [TSLSchemeTerritory](#TSLSchemeTerritory) | Contains scheme territory of the TSL used. | | [TSLSchemeTypeCommunityRules](#TSLSchemeTypeCommunityRules) | Contains XML content of scheme type/community/rules of the TSL used. | | [TSLSchemeTypeCommunityRules\[lang\]](#TSLSchemeTypeCommunityRules[lang]) | Contains scheme type/community/rules for the specified language of the TSL used. | | [TSLSequenceNumber](#TSLSequenceNumber) | Contains sequence number of the TSL used. | | [TSLsRetrieveLog](#TSLsRetrieveLog) | Contains the complete log of the TSLs retrieve. | | [TSLStatusDeterminationApproach](#TSLStatusDeterminationApproach) | Contains status determination approach of the TSL used. | | [TSLsValidationLog](#TSLsValidationLog) | Contains the complete log of the TSLs validation. | | [TSLTSPAdditionalServiceInformation](#TSLTSPAdditionalServiceInformation) | Contains additional service information of the TSP service used. | | [TSLTSPAddress](#TSLTSPAddress) | Contains XML content of the address of the TSP used. | | [TSLTSPHistoryInstance](#TSLTSPHistoryInstance) | Indicates that TSP service history instance used. | | [TSLTSPHistoryInstanceAdditionalServiceInformation](#TSLTSPHistoryInstanceAdditionalServiceInformation) | Contains additional service information of the TSP service history instance used. | | [TSLTSPHistoryInstanceQualifiers](#TSLTSPHistoryInstanceQualifiers) | Contains list of qualifiers of the TSP service history instance used. | | [TSLTSPHistoryInstanceServiceInformationExtensions](#TSLTSPHistoryInstanceServiceInformationExtensions) | Contains XML content of information extensions of the TSP service history instance used. | | [TSLTSPHistoryInstanceServiceInformationExtensions\[Idx\]](#TSLTSPHistoryInstanceServiceInformationExtensions[Idx]) | Contains XML content of information extension of the specified index of the TSP service history instance used. | | [TSLTSPHistoryInstanceServiceName](#TSLTSPHistoryInstanceServiceName) | Contains XML content of name of the TSP service history instance used. | | [TSLTSPHistoryInstanceServiceName\[lang\]](#TSLTSPHistoryInstanceServiceName[lang]) | Contains name for the specified language of the TSP service history instance used. | | [TSLTSPHistoryInstanceServiceStatus](#TSLTSPHistoryInstanceServiceStatus) | Contains status of the TSP service history instance used. | | [TSLTSPHistoryInstanceServiceStatusStartingTime](#TSLTSPHistoryInstanceServiceStatusStartingTime) | Contains status starting time of the TSP service history instance used. | | [TSLTSPHistoryInstanceServiceTypeIdentifier](#TSLTSPHistoryInstanceServiceTypeIdentifier) | Contains type identifier of the TSP service history instance used. | | [TSLTSPHistoryInstanceXML](#TSLTSPHistoryInstanceXML) | Contains XML content of the TSP service history instance used. | | [TSLTSPInformationExtensions](#TSLTSPInformationExtensions) | Contains XML content of information extensions of the TSP used. | | [TSLTSPInformationExtensions\[Idx\]](#TSLTSPInformationExtensions[Idx]) | Contains XML content of information extension of the specified index of the TSP used. | | [TSLTSPInformationURI](#TSLTSPInformationURI) | Contains XML content of information URI of the TSP used. | | [TSLTSPInformationURI\[lang\]](#TSLTSPInformationURI[lang]) | Contains information URI for the specified language of the TSP used. | | [TSLTSPName](#TSLTSPName) | Contains XML content of name of the TSP used. | | [TSLTSPName\[lang\]](#TSLTSPName[lang]) | Contains name for the specified language of the TSP used. | | [TSLTSPSchemeServiceDefinitionURI](#TSLTSPSchemeServiceDefinitionURI) | Contains XML content of scheme service definition URI of the TSP service used. | | [TSLTSPSchemeServiceDefinitionURI\[lang\]](#TSLTSPSchemeServiceDefinitionURI[lang]) | Contains scheme service definition URI for the specified language of the TSP service used. | | [TSLTSPServiceDefinitionURI](#TSLTSPServiceDefinitionURI) | Contains XML content of definition URI of the TSP service used. | | [TSLTSPServiceDefinitionURI\[lang\]](#TSLTSPServiceDefinitionURI[lang]) | Contains definition URI for the specified language of the TSP service used. | | [TSLTSPServiceInformationExtensions](#TSLTSPServiceInformationExtensions) | Contains XML content of information extensions of the TSP service used. | | [TSLTSPServiceInformationExtensions\[Idx\]](#TSLTSPServiceInformationExtensions[Idx]) | Contains XML content of information extension of the specified index of the TSP service used. | | [TSLTSPServiceName](#TSLTSPServiceName) | Contains XML content of name of the TSP service used. | | [TSLTSPServiceName\[lang\]](#TSLTSPServiceName[lang]) | Contains name for the specified language of the TSP service used. | | [TSLTSPServiceQualifiers](#TSLTSPServiceQualifiers) | Contains list of qualifiers of the TSP service used. | | [TSLTSPServiceStatus](#TSLTSPServiceStatus) | Contains status of the TSP service used. | | [TSLTSPServiceStatusStartingTime](#TSLTSPServiceStatusStartingTime) | Contains status starting time of the TSP service used. | | [TSLTSPServiceSupplyPoints](#TSLTSPServiceSupplyPoints) | Contains XML content of the supply points of the TSP service used. | | [TSLTSPServiceTypeIdentifier](#TSLTSPServiceTypeIdentifier) | Contains type identifier of the TSP service used. | | [TSLTSPServiceXML](#TSLTSPServiceXML) | Contains XML content of the TSP service used. | | [TSLTSPTradeName](#TSLTSPTradeName) | Contains XML content of trade name of the TSP used. | | [TSLTSPTradeName\[lang\]](#TSLTSPTradeName[lang]) | Contains trade name for the specified language of the TSP used. | | [TSLTSPXML](#TSLTSPXML) | Contains XML content of the TSP used. | | [TSLType](#TSLType) | Contains TSL type of the TSL used. | | [TSLVersionIdentifier](#TSLVersionIdentifier) | Contains version identifier of the TSL used. | | [TSLXML](#TSLXML) | Contains XML content of the TSL used. | | [TSPAdditionalServiceInformation](#TSPAdditionalServiceInformation) | Contains additional service information of the TSP service used. | | [TSPAddress](#TSPAddress) | Contains XML content of the address of the TSP used. | | [TSPHistoryInstance](#TSPHistoryInstance) | Indicates that TSP service history instance used. | | [TSPHistoryInstanceAdditionalServiceInformation](#TSPHistoryInstanceAdditionalServiceInformation) | Contains additional service information of the TSP service history instance used. | | [TSPHistoryInstanceQualifiers](#TSPHistoryInstanceQualifiers) | Contains list of qualifiers of the TSP service history instance used. | | [TSPHistoryInstanceServiceInformationExtensions](#TSPHistoryInstanceServiceInformationExtensions) | Contains XML content of information extensions of the TSP service history instance used. | | [TSPHistoryInstanceServiceName](#TSPHistoryInstanceServiceName) | Contains XML content of name of the TSP service history instance used. | | [TSPHistoryInstanceServiceStatus](#TSPHistoryInstanceServiceStatus) | Contains status of the TSP service history instance used. | | [TSPHistoryInstanceServiceStatusStartingTime](#TSPHistoryInstanceServiceStatusStartingTime) | Contains status starting time of the TSP service history instance used. | | [TSPHistoryInstanceServiceTypeIdentifier](#TSPHistoryInstanceServiceTypeIdentifier) | Contains type identifier of the TSP service history instance used. | | [TSPHistoryInstanceXML](#TSPHistoryInstanceXML) | Contains XML content of the TSP service history instance used. | | [TSPInformationExtensions](#TSPInformationExtensions) | Contains XML content of information extensions of the TSP used. | | [TSPInformationURI](#TSPInformationURI) | Contains XML content of information URI of the TSP used. | | [TSPName](#TSPName) | Contains XML content of name of the TSP used. | | [TSPSchemeServiceDefinitionURI](#TSPSchemeServiceDefinitionURI) | Contains XML content of scheme service definition URI of the TSP service used. | | [TSPServiceDefinitionURI](#TSPServiceDefinitionURI) | Contains XML content of definition URI of the TSP service used. | | [TSPServiceInformationExtensions](#TSPServiceInformationExtensions) | Contains XML content of information extensions of the TSP service used. | | [TSPServiceName](#TSPServiceName) | Contains XML content of name of the TSP service used. | | [TSPServiceQualifiers](#TSPServiceQualifiers) | Contains list of qualifiers of the TSP service used. | | [TSPServiceStatus](#TSPServiceStatus) | Contains status of the TSP service used. | | [TSPServiceStatusStartingTime](#TSPServiceStatusStartingTime) | Contains status starting time of the TSP service used. | | [TSPServiceSupplyPoints](#TSPServiceSupplyPoints) | Contains XML content of the supply points of the TSP service used. | | [TSPServiceTypeIdentifier](#TSPServiceTypeIdentifier) | Contains type identifier of the TSP service used. | | [TSPServiceXML](#TSPServiceXML) | Contains XML content of the TSP service used. | | [TSPTradeName](#TSPTradeName) | Contains XML content of trade name of the TSP used. | | [TSPXML](#TSPXML) | Contains XML content of the TSP used. | | [Type](#Type) | Contains TSL type of the TSL used. | | [VersionIdentifier](#VersionIdentifier) | Contains version identifier of the TSL used. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the component. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server components. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client components created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client components should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # BlockedCertificates Property ([CertificateValidator](#certificatevalidator-component) Component) The certificates that must be rejected as trust anchors. ## Syntax ```text public CertificateList BlockedCertificates { get; } ``` ## Remarks Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # CacheValidationResults Property ([CertificateValidator](#certificatevalidator-component) Component) Enables or disables validation result caching. ## Syntax ```text public bool CacheValidationResults { get; set; } ``` ## Default Value False ## Remarks Set this property to True to enable caching of validation results. # Certificate Property ([CertificateValidator](#certificatevalidator-component) Component) The certificate to be validated. ## Syntax ```text public Certificate Certificate { get; set; } ``` ## Remarks Assign the certificate that needs to be validated to this property. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # ChainValidationDetails Property ([CertificateValidator](#certificatevalidator-component) Component) The details of a certificate chain validation outcome. ## Syntax ```text public int ChainValidationDetails { get; } ``` ## Default Value 0 ## Remarks Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is read-only and not available at design time. # ChainValidationResult Property ([CertificateValidator](#certificatevalidator-component) Component) The general outcome of a certificate chain validation routine. Use [ChainValidationDetails](#chainvalidationdetails-property-certificatevalidator-component) to get information about the reasons that contributed to the validation result. ## Syntax ```text public CertificateValidatorChainValidationResults ChainValidationResult { get; } enum CertificateValidatorChainValidationResults { cvtValid, cvtValidButUntrusted, cvtInvalid, cvtCantBeEstablished } ``` ## Default Value 0 ## Remarks Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. This property is read-only and not available at design time. # CheckTrustedLists Property ([CertificateValidator](#certificatevalidator-component) Component) Specifies whether the component should attempt to validate chain trust via a known Trusted List. ## Syntax ```text public bool CheckTrustedLists { get; set; } ``` ## 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). # CurrentCACertificate Property ([CertificateValidator](#certificatevalidator-component) Component) The CA of the currently processed certificate. ## Syntax ```text public Certificate CurrentCACertificate { get; } ``` ## Remarks The validator component uses this property to publish the issuer certificate of the certificate that is currently being processed, if it is available. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # CurrentCertificate Property ([CertificateValidator](#certificatevalidator-component) Component) The certificate that is currently being processed. ## Syntax ```text public Certificate CurrentCertificate { get; } ``` ## Remarks This property returns the certificate that is currently being processed by the validator. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # FIPSMode Property ([CertificateValidator](#certificatevalidator-component) Component) Reserved. ## Syntax ```text public bool FIPSMode { get; set; } ``` ## Default Value False ## Remarks This property is reserved for future use. # GracePeriod Property ([CertificateValidator](#certificatevalidator-component) Component) Specifies a grace period to apply during certificate validation. ## Syntax ```text public int GracePeriod { get; set; } ``` ## Default Value 0 ## Remarks Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated. # InterimValidationDetails Property ([CertificateValidator](#certificatevalidator-component) Component) Contains the validation details of the moment. ## Syntax ```text public int InterimValidationDetails { get; set; } ``` ## Default Value 0 ## Remarks Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn. Use this property to check the interim validity details mid-flight. The value of this property is a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | This property is not available at design time. # InterimValidationResult Property ([CertificateValidator](#certificatevalidator-component) Component) Contains the validation status of the moment. ## Syntax ```text public CertificateValidatorInterimValidationResults InterimValidationResult { get; set; } enum CertificateValidatorInterimValidationResults { cvtValid, cvtValidButUntrusted, cvtInvalid, cvtCantBeEstablished } ``` ## Default Value 0 ## Remarks Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn. Use this property to check the interim validity status mid-flight. | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | This property is not available at design time. # KnownCertificates Property ([CertificateValidator](#certificatevalidator-component) Component) Additional certificates for chain validation. ## Syntax ```text public CertificateList KnownCertificates { get; } ``` ## Remarks Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually. The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows. Do not add trust anchors or root certificates to this collection: add them to [TrustedCertificates](#trustedcertificates-property-certificatevalidator-component) instead. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # KnownCRLs Property ([CertificateValidator](#certificatevalidator-component) Component) Additional CRLs for chain validation. ## Syntax ```text public CRLList KnownCRLs { get; } ``` ## Remarks Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document. This property is not available at design time. Please refer to the [CRL](#crl-type) type for a complete list of fields. # KnownOCSPs Property ([CertificateValidator](#certificatevalidator-component) Component) Additional OCSP responses for chain validation. ## Syntax ```text public OCSPResponseList KnownOCSPs { get; } ``` ## Remarks Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document. This property is not available at design time. Please refer to the [OCSPResponse](#ocspresponse-type) type for a complete list of fields. # MaxValidationTime Property ([CertificateValidator](#certificatevalidator-component) Component) Specifies the maximum time the validation process may take. ## Syntax ```text public int MaxValidationTime { get; set; } ``` ## Default Value 0 ## Remarks Use this property to limit the amount of time available for the validator to carry out the validation. If the validation process exceeds this time, it is terminated and the validation error is returned. # OfflineMode Property ([CertificateValidator](#certificatevalidator-component) Component) Switches the component to offline mode. ## Syntax ```text public bool OfflineMode { get; set; } ``` ## Default Value False ## Remarks When working in offline mode, the component restricts itself from using any online revocation information sources, such as CRL or OCSP responders. Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via [KnownCertificates](#knowncertificates-property-certificatevalidator-component), [KnownCRLs](#knowncrls-property-certificatevalidator-component), and other related properties. # Proxy Property ([CertificateValidator](#certificatevalidator-component) Component) The proxy server settings. ## Syntax ```text public ProxySettings Proxy { get; } ``` ## Remarks Use this property to tune up the proxy server settings. This property is read-only. Please refer to the [ProxySettings](#proxysettings-type) type for a complete list of fields. # QualifiedInfo Property ([CertificateValidator](#certificatevalidator-component) Component) The qualified details for the validated certificate. ## Syntax ```text public QualifiedInfo QualifiedInfo { get; } ``` ## Remarks Use this property to check the qualified information for [Certificate](#certificate-property-certificatevalidator-component). The contents of this property is updated upon completion of the full validation routine performed by the [Validate](#validate-method-certificatevalidator-component) method (if the qualified check is enabled) or after the [GetQualifiedStatus](#getqualifiedstatus-method-certificatevalidator-component) call. This property is read-only. Please refer to the [QualifiedInfo](#qualifiedinfo-type) type for a complete list of fields. # RevocationCheck Property ([CertificateValidator](#certificatevalidator-component) Component) Specifies the kind(s) of revocation check to perform for all chain certificates. ## Syntax ```text public CertificateValidatorRevocationChecks RevocationCheck { get; set; } enum CertificateValidatorRevocationChecks { crcNone, crcAuto, crcAllCRL, crcAllOCSP, crcAllCRLAndOCSP, crcAnyCRL, crcAnyOCSP, crcAnyCRLOrOCSP, crcAnyOCSPOrCRL } ``` ## Default Value 1 ## Remarks Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types. | | | | | --- | --- | --- | | 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. # SocketSettings Property ([CertificateValidator](#certificatevalidator-component) Component) Manages network connection settings. ## Syntax ```text public SocketSettings SocketSettings { get; } ``` ## Remarks Use this property to tune up network connection parameters. This property is read-only. Please refer to the [SocketSettings](#socketsettings-type) type for a complete list of fields. # TLSClientChain Property ([CertificateValidator](#certificatevalidator-component) Component) The TLS client certificate chain. ## Syntax ```text public CertificateList TLSClientChain { get; } ``` ## Remarks Assign a certificate chain to this property to enable TLS client authentication in the component. Note that the client's end-entity certificate should have a private key associated with it. Use the [CertificateStorage](CertificateStorage.md#CertificateStorage) or [CertificateManager](CertificateManager.md#CertificateManager) components to import the certificate from a file, system store, or PKCS11 device. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # TLSServerChain Property ([CertificateValidator](#certificatevalidator-component) Component) The TLS server's certificate chain. ## Syntax ```text public CertificateList TLSServerChain { get; } ``` ## Remarks Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the [TLSCertValidate](#tlscertvalidate-event-certificatevalidator-component) event is fired by the client component. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # TLSSettings Property ([CertificateValidator](#certificatevalidator-component) Component) Manages TLS layer settings. ## Syntax ```text public TLSSettings TLSSettings { get; } ``` ## Remarks Use this property to tune up the TLS layer parameters. This property is read-only. Please refer to the [TLSSettings](#tlssettings-type) type for a complete list of fields. # TrustedCertificates Property ([CertificateValidator](#certificatevalidator-component) Component) A list of trusted certificates for chain validation. ## Syntax ```text public CertificateList TrustedCertificates { get; } ``` ## Remarks Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually. The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store. Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # UsedCertificates Property ([CertificateValidator](#certificatevalidator-component) Component) Contains a list of certificates used during the chain validation routine. ## Syntax ```text public CertificateList UsedCertificates { get; } ``` ## Remarks Use this property to access the list of certificates that were used during the chain validation. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # UsedCRLs Property ([CertificateValidator](#certificatevalidator-component) Component) Contains a list of CRLs used during the chain validation routine. ## Syntax ```text public CRLList UsedCRLs { get; } ``` ## Remarks Use this property to access the list of CRLs that were used during the chain validation. This property is read-only and not available at design time. Please refer to the [CRL](#crl-type) type for a complete list of fields. # UsedOCSPs Property ([CertificateValidator](#certificatevalidator-component) Component) Contains a list of OCSP responses used during the chain validation routine. ## Syntax ```text public OCSPResponseList UsedOCSPs { get; } ``` ## Remarks Use this property to access the list of OCSP responses that were used during the chain validation. This property is read-only and not available at design time. Please refer to the [OCSPResponse](#ocspresponse-type) type for a complete list of fields. # UseSystemCertificates Property ([CertificateValidator](#certificatevalidator-component) Component) Enables or disables the use of the system certificates. ## Syntax ```text public bool UseSystemCertificates { get; set; } ``` ## 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. # ValidationLog Property ([CertificateValidator](#certificatevalidator-component) Component) Contains the complete log of the certificate validation routine. ## Syntax ```text public string ValidationLog { get; } ``` ## Default Value "" ## Remarks Use this property to access the chain validation log produced by the component. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure. This property is read-only and not available at design time. # ValidationMoment Property ([CertificateValidator](#certificatevalidator-component) Component) The time point at which chain validity is to be established. ## Syntax ```text public string ValidationMoment { get; set; } ``` ## 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. # Config Method ([CertificateValidator](#certificatevalidator-component) Component) Sets or retrieves a configuration setting. ## Syntax ```text public string Config(string configurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-certificatevalidator-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-certificatevalidator-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoAction Method ([CertificateValidator](#certificatevalidator-component) Component) Performs an additional action. ## Syntax ```text public string DoAction(string actionID, string actionParams); ``` ## Remarks DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. 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](#certificatevalidator-component) Component) Obtains the qualified information for [Certificate](#certificate-property-certificatevalidator-component) . ## Syntax ```text public void GetQualifiedStatus(); ``` ## Remarks Use this method to obtain a fresh qualified status for the certificate. # GetTrustedListProperty Method ([CertificateValidator](#certificatevalidator-component) Component) Returns a specific TrustedList property. ## Syntax ```text public string GetTrustedListProperty(string propName, string language); ``` ## 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](#certificatevalidator-component) Component) Refreshes the certificate cache. ## Syntax ```text public void RefreshCache(); ``` ## Remarks Use this method to remove obsolete information from the validation cache (only makes sense if [CacheValidationResults](#cachevalidationresults-property-certificatevalidator-component) is on). # Reset Method ([CertificateValidator](#certificatevalidator-component) Component) Resets the component settings. ## Syntax ```text public void Reset(); ``` ## Remarks Reset is a generic method available in every component. # ResetCache Method ([CertificateValidator](#certificatevalidator-component) Component) Clears all data contained in the validation cache. ## Syntax ```text public void ResetCache(); ``` ## Remarks Use this method to clear the validation cache (only makes sense if [CacheValidationResults](#cachevalidationresults-property-certificatevalidator-component) is on). # Terminate Method ([CertificateValidator](#certificatevalidator-component) Component) Terminates the validation process. ## Syntax ```text public void Terminate(); ``` ## Remarks Call this method if you would like to stop the validation process. # Validate Method ([CertificateValidator](#certificatevalidator-component) Component) Validates the certificate chain. ## Syntax ```text public int Validate(); ``` ## Remarks Use this method to validate the certificate chain that starts with [Certificate](#certificate-property-certificatevalidator-component). 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](#chainvalidationresult-property-certificatevalidator-component) property. Another property, [ChainValidationDetails](#chainvalidationdetails-property-certificatevalidator-component), provides insight into the reasons that contributed to that decision. Use [ValidationLog](#validationlog-property-certificatevalidator-component) to get a detailed step-by-step log of the entire validation process. # ValidateForSMIME Method ([CertificateValidator](#certificatevalidator-component) Component) Validates an e-mail signing certificate. ## Syntax ```text public int ValidateForSMIME(string emailAddress); ``` ## Remarks Use this method to validate an e-mail security certificate. This is a variant of [Validate](#validate-method-certificatevalidator-component) 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](#certificatevalidator-component) Component) Validates a server-side SSL/TLS certificate. ## Syntax ```text public int ValidateForSSL(string URL, string IPAddress); ``` ## Remarks Use this method to validate a server-side SSL/TLS certificate. This is a variant of [Validate](#validate-method-certificatevalidator-component) 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](#certificatevalidator-component) Component) Marks the end of a single certificate processing step. ## Syntax ```text public event OnAfterCertificateProcessingHandler OnAfterCertificateProcessing; public delegate void OnAfterCertificateProcessingHandler(object sender, CertificateValidatorAfterCertificateProcessingEventArgs e); public class CertificateValidatorAfterCertificateProcessingEventArgs : EventArgs { public string Cert { get; } public int Validity { get; } public int ValidationDetails { get; } } ``` ## Remarks This event is fired when the component has finished processing *Cert*, and returns its *Validity* status and *ValidationDetails*. 'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via [AfterCertificateValidation](#aftercertificatevalidation-event-certificatevalidator-component) 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](#interimvalidationresult-property-certificatevalidator-component) and [InterimValidationDetails](#interimvalidationdetails-property-certificatevalidator-component) 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](#certificatevalidator-component) Component) Marks the end of a single certificate validation step. ## Syntax ```text public event OnAfterCertificateValidationHandler OnAfterCertificateValidation; public delegate void OnAfterCertificateValidationHandler(object sender, CertificateValidatorAfterCertificateValidationEventArgs e); public class CertificateValidatorAfterCertificateValidationEventArgs : EventArgs { public string Cert { get; } public string CACert { get; } public int Validity { get; } public int ValidationDetails { get; } } ``` ## Remarks This event is fired when the component has finished validation of *Cert* with *CACert*, and returns its *Validity* status and *ValidationDetails*. 'Validation', in this context, means a single validation of a certificate with its CA certificate. For certificates with multiple CAs, validations are grouped into 'processings.' Each processing, therefore, is a set of validations of the same certificate with all its CAs. You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via [InterimValidationResult](#interimvalidationresult-property-certificatevalidator-component) and [InterimValidationDetails](#interimvalidationdetails-property-certificatevalidator-component) properties. Validity status: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Validation details: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | # BeforeCACertificateDownload Event ([CertificateValidator](#certificatevalidator-component) Component) Fires when a CA certificate is about to be downloaded. ## Syntax ```text public event OnBeforeCACertificateDownloadHandler OnBeforeCACertificateDownload; public delegate void OnBeforeCACertificateDownloadHandler(object sender, CertificateValidatorBeforeCACertificateDownloadEventArgs e); public class CertificateValidatorBeforeCACertificateDownloadEventArgs : EventArgs { public string Cert { get; } public string Location { get; } } ``` ## 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](#certificatevalidator-component) Component) Reports the start of certificate processing. ## Syntax ```text public event OnBeforeCertificateProcessingHandler OnBeforeCertificateProcessing; public delegate void OnBeforeCertificateProcessingHandler(object sender, CertificateValidatorBeforeCertificateProcessingEventArgs e); public class CertificateValidatorBeforeCertificateProcessingEventArgs : EventArgs { public string Cert { get; } public int Validity { get; } public int ValidationDetails { get; } } ``` ## Remarks This event is fired when the component is about to start the processing of *Cert*. 'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via [AfterCertificateValidation](#aftercertificatevalidation-event-certificatevalidator-component) events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation. The firing of [AfterCertificateProcessing](#aftercertificateprocessing-event-certificatevalidator-component) 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](#certificatevalidator-component) Component) Reports the start of certificate validation. ## Syntax ```text public event OnBeforeCertificateValidationHandler OnBeforeCertificateValidation; public delegate void OnBeforeCertificateValidationHandler(object sender, CertificateValidatorBeforeCertificateValidationEventArgs e); public class CertificateValidatorBeforeCertificateValidationEventArgs : EventArgs { public string Cert { get; } public string CACert { get; } } ``` ## Remarks This event is fired when the component is about to start validating *Cert* with *CACert*. A 'validation' is a single step of validating a certificate with its CA certificate. A row of consecutive validations of the same certificate with different CAs are grouped into 'processings.' The firing of [AfterCertificateValidation](#aftercertificatevalidation-event-certificatevalidator-component) marks the end of the certificate validation step. # BeforeCRLDownload Event ([CertificateValidator](#certificatevalidator-component) Component) Fires when a CRL is about to be downloaded. ## Syntax ```text public event OnBeforeCRLDownloadHandler OnBeforeCRLDownload; public delegate void OnBeforeCRLDownloadHandler(object sender, CertificateValidatorBeforeCRLDownloadEventArgs e); public class CertificateValidatorBeforeCRLDownloadEventArgs : EventArgs { public string Cert { get; } public string CACert { get; } public string Location { get; } } ``` ## 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](#certificatevalidator-component) Component) Fires when a certificate's OCSP status is about to be requested. ## Syntax ```text public event OnBeforeOCSPDownloadHandler OnBeforeOCSPDownload; public delegate void OnBeforeOCSPDownloadHandler(object sender, CertificateValidatorBeforeOCSPDownloadEventArgs e); public class CertificateValidatorBeforeOCSPDownloadEventArgs : EventArgs { public string Cert { get; } public string CACert { get; } public string Location { get; } } ``` ## Remarks This event is fired when the validator is about to request a fresh revocation status from an OCSP responder. # CACertificateDownloaded Event ([CertificateValidator](#certificatevalidator-component) Component) Marks the success of a certificate download. ## Syntax ```text public event OnCACertificateDownloadedHandler OnCACertificateDownloaded; public delegate void OnCACertificateDownloadedHandler(object sender, CertificateValidatorCACertificateDownloadedEventArgs e); public class CertificateValidatorCACertificateDownloadedEventArgs : EventArgs { public string Cert { get; } public string Location { get; } } ``` ## Remarks This event is fired when a CA certificate has been successfully downloaded from *Location*. This event is preceded with [BeforeCACertificateDownload](#beforecacertificatedownload-event-certificatevalidator-component) event. # CACertificateNeeded Event ([CertificateValidator](#certificatevalidator-component) Component) Requests a missing certificate from the user. ## Syntax ```text public event OnCACertificateNeededHandler OnCACertificateNeeded; public delegate void OnCACertificateNeededHandler(object sender, CertificateValidatorCACertificateNeededEventArgs e); public class CertificateValidatorCACertificateNeededEventArgs : EventArgs { public string Cert { get; } } ``` ## 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](#knowncertificates-property-certificatevalidator-component) collection to make it available to the validator. When this event fires, the [CurrentCertificate](#currentcertificate-property-certificatevalidator-component) 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](#certificatevalidator-component) Component) Marks the success of a CRL download. ## Syntax ```text public event OnCRLDownloadedHandler OnCRLDownloaded; public delegate void OnCRLDownloadedHandler(object sender, CertificateValidatorCRLDownloadedEventArgs e); public class CertificateValidatorCRLDownloadedEventArgs : EventArgs { public string Cert { get; } public string CACert { get; } public string Location { get; } } ``` ## 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](#beforecrldownload-event-certificatevalidator-component) event. # CRLNeeded Event ([CertificateValidator](#certificatevalidator-component) Component) Requests a missing CRL from the user. ## Syntax ```text public event OnCRLNeededHandler OnCRLNeeded; public delegate void OnCRLNeededHandler(object sender, CertificateValidatorCRLNeededEventArgs e); public class CertificateValidatorCRLNeededEventArgs : EventArgs { public string Cert { get; } public string CACert { get; } } ``` ## 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](#knowncrls-property-certificatevalidator-component) collection to make it available to the validator. When this event fires, the [CurrentCertificate](#currentcertificate-property-certificatevalidator-component) and [CurrentCACertificate](#currentcacertificate-property-certificatevalidator-component) properties are assigned with the certificate being validated and its issuer certificate. # Error Event ([CertificateValidator](#certificatevalidator-component) Component) Information about errors during certificate validation. ## Syntax ```text public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, CertificateValidatorErrorEventArgs e); public class CertificateValidatorErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } } ``` ## 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](#certificatevalidator-component) Component) This event notifies the application about an underlying control flow event. ## Syntax ```text public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, CertificateValidatorNotificationEventArgs e); public class CertificateValidatorNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } } ``` ## Remarks The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted. This component can fire this event with the following *EventID* values: | | | | --- | --- | | DownloadTSL | This event is fired if a Trusted List is requested. The EventParam parameter contains the URL value from where to retrieve the TrustedList. The downloaded Trusted List content should be assigned to the TSLContent or TSLContentHex configuration settings. The component automatically downloads Trusted List if [OfflineMode](#offlinemode-property-certificatevalidator-component) 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](#certificatevalidator-component) Component) Marks the success of an OCSP request. ## Syntax ```text public event OnOCSPDownloadedHandler OnOCSPDownloaded; public delegate void OnOCSPDownloadedHandler(object sender, CertificateValidatorOCSPDownloadedEventArgs e); public class CertificateValidatorOCSPDownloadedEventArgs : EventArgs { public string Cert { get; } public string CACert { get; } public string Location { get; } } ``` ## 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](#beforeocspdownload-event-certificatevalidator-component) event. # TLSCertNeeded Event ([CertificateValidator](#certificatevalidator-component) Component) Fires when a remote TLS party requests a client certificate. ## Syntax ```text public event OnTLSCertNeededHandler OnTLSCertNeeded; public delegate void OnTLSCertNeededHandler(object sender, CertificateValidatorTLSCertNeededEventArgs e); public class CertificateValidatorTLSCertNeededEventArgs : EventArgs { public string Host { get; } public string CANames { get; } } ``` ## 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](#tlsclientchain-property-certificatevalidator-component) 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](#tlshandshake-event-certificatevalidator-component) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-certificatevalidator-component) event. # TLSCertValidate Event ([CertificateValidator](#certificatevalidator-component) Component) This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. ## Syntax ```text public event OnTLSCertValidateHandler OnTLSCertValidate; public delegate void OnTLSCertValidateHandler(object sender, CertificateValidatorTLSCertValidateEventArgs e); public class CertificateValidatorTLSCertValidateEventArgs : EventArgs { public string ServerHost { get; } public string ServerIP { get; } public bool Accept { get; set; } } ``` ## Remarks This event is fired during a TLS handshake. Use the [TLSServerChain](#tlsserverchain-property-certificatevalidator-component) property to access the certificate chain. In general, components may contact a number of TLS endpoints during their work, depending on their configuration. *Accept* is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed. # TLSEstablished Event ([CertificateValidator](#certificatevalidator-component) Component) Fires when a TLS handshake with * Host * successfully completes. ## Syntax ```text public event OnTLSEstablishedHandler OnTLSEstablished; public delegate void OnTLSEstablishedHandler(object sender, CertificateValidatorTLSEstablishedEventArgs e); public class CertificateValidatorTLSEstablishedEventArgs : EventArgs { public string Host { get; } public string Version { get; } public string Ciphersuite { get; } public byte[] ConnectionId { get; } public bool Abort { get; set; } } ``` ## Remarks The component uses this event to notify the application about a successful completion of a TLS handshake. The *Version*, *Ciphersuite*, and *ConnectionId* parameters indicate the security parameters of the new connection. Use the *Abort* parameter if you need to terminate the connection at this stage. # TLSHandshake Event ([CertificateValidator](#certificatevalidator-component) Component) Fires when a new TLS handshake is initiated, before the handshake commences. ## Syntax ```text public event OnTLSHandshakeHandler OnTLSHandshake; public delegate void OnTLSHandshakeHandler(object sender, CertificateValidatorTLSHandshakeEventArgs e); public class CertificateValidatorTLSHandshakeEventArgs : EventArgs { public string Host { get; } public bool Abort { get; set; } } ``` ## Remarks The component uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [TLSEstablished](#tlsestablished-event-certificatevalidator-component) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-certificatevalidator-component) event will also be fired. # TLSShutdown Event ([CertificateValidator](#certificatevalidator-component) Component) Reports the graceful closure of a TLS connection. ## Syntax ```text public event OnTLSShutdownHandler OnTLSShutdown; public delegate void OnTLSShutdownHandler(object sender, CertificateValidatorTLSShutdownEventArgs e); public class CertificateValidatorTLSShutdownEventArgs : EventArgs { public string Host { get; } } ``` ## Remarks This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported. # Certificate Type Encapsulates an individual X.509 certificate. ## Remarks This type keeps and provides access to X.509 certificate details. The following fields are available: - [Bytes](#Certificate_f_Bytes) - [CA](#Certificate_f_CA) - [CAKeyID](#Certificate_f_CAKeyID) - [CertType](#Certificate_f_CertType) - [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints) - [Curve](#Certificate_f_Curve) - [Fingerprint](#Certificate_f_Fingerprint) - [FriendlyName](#Certificate_f_FriendlyName) - [HashAlgorithm](#Certificate_f_HashAlgorithm) - [Issuer](#Certificate_f_Issuer) - [IssuerRDN](#Certificate_f_IssuerRDN) - [KeyAlgorithm](#Certificate_f_KeyAlgorithm) - [KeyBits](#Certificate_f_KeyBits) - [KeyFingerprint](#Certificate_f_KeyFingerprint) - [KeyUsage](#Certificate_f_KeyUsage) - [KeyValid](#Certificate_f_KeyValid) - [OCSPLocations](#Certificate_f_OCSPLocations) - [OCSPNoCheck](#Certificate_f_OCSPNoCheck) - [Origin](#Certificate_f_Origin) - [PolicyIDs](#Certificate_f_PolicyIDs) - [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) - [PrivateKeyExists](#Certificate_f_PrivateKeyExists) - [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable) - [PublicKeyBytes](#Certificate_f_PublicKeyBytes) - [Qualified](#Certificate_f_Qualified) - [QualifiedStatements](#Certificate_f_QualifiedStatements) - [Qualifiers](#Certificate_f_Qualifiers) - [SelfSigned](#Certificate_f_SelfSigned) - [SerialNumber](#Certificate_f_SerialNumber) - [SigAlgorithm](#Certificate_f_SigAlgorithm) - [Source](#Certificate_f_Source) - [Subject](#Certificate_f_Subject) - [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName) - [SubjectKeyID](#Certificate_f_SubjectKeyID) - [SubjectRDN](#Certificate_f_SubjectRDN) - [Valid](#Certificate_f_Valid) - [ValidFrom](#Certificate_f_ValidFrom) - [ValidTo](#Certificate_f_ValidTo) ## Fields **Bytes** *byte[] (read-only)* Default: "" Returns the raw certificate data in DER format. **CA** *bool* Default: False 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 field when generating a new certificate to have its Basic Constraints extension generated automatically. **CAKeyID** *byte[] (read-only)* Default: "" 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](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. **CertType** *CertTypes (read-only)* Default: 0 Returns the type of the entity contained in the [Certificate](#certificate-type) object. A [Certificate](#certificate-type) 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](CertificateManager.md#CertificateManager) component to load or create new certificate and certificate requests objects. **CRLDistributionPoints** *string* Default: "" 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 field 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. **Curve** *string* Default: "" 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 | | **Fingerprint** *string (read-only)* Default: "" 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. **FriendlyName** *string (read-only)* Default: "" 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. **HashAlgorithm** *string* Default: "" 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 [SigAlgorithm](#Certificate_f_SigAlgorithm) 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 | | **Issuer** *string (read-only)* Default: "" The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN). **IssuerRDN** *string* Default: "" A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* **KeyAlgorithm** *string* Default: "0" 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 [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains. **KeyBits** *int (read-only)* Default: 0 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 [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer. **KeyFingerprint** *string (read-only)* Default: "" 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 [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. **KeyUsage** *int* Default: 0 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 field before generating the certificate to propagate the key usage flags to the new certificate. **KeyValid** *bool (read-only)* Default: False Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. **OCSPLocations** *string* Default: "" Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this field before calling the certificate manager's [Generate](CertificateManager.md#CertificateManager_m_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. **OCSPNoCheck** *bool* Default: False Accessor to the value of the certificate's ocsp-no-check extension. **Origin** *int (read-only)* Default: 0 Returns the location that the certificate was taken or loaded from. **PolicyIDs** *string* Default: "" 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 field 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. **PrivateKeyBytes** *byte[] (read-only)* Default: "" Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. **PrivateKeyExists** *bool (read-only)* Default: False 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 field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), 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. **PrivateKeyExtractable** *bool (read-only)* Default: False Indicates whether the private key is extractable (exportable). **PublicKeyBytes** *byte[] (read-only)* Default: "" 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. **Qualified** *bool (read-only)* Default: False Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. **QualifiedStatements** *QualifiedStatementsTypes* Default: 0 Returns a simplified qualified status of the certificate. **Qualifiers** *string (read-only)* Default: "" A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. **SelfSigned** *bool (read-only)* Default: False Indicates whether the certificate is self-signed (root) or signed by an external CA. **SerialNumber** *byte[]* Default: "" 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. **SigAlgorithm** *string (read-only)* Default: "" 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*. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **Subject** *string (read-only)* Default: "" 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 [SubjectRDN](#Certificate_f_SubjectRDN). **SubjectAlternativeName** *string* Default: "" 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 [SubjectRDN](#Certificate_f_SubjectRDN) 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. **SubjectKeyID** *byte[]* Default: "" 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 [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. **SubjectRDN** *string* Default: "" 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*. **Valid** *bool (read-only)* Default: False 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. **ValidFrom** *string* Default: "" The time point at which the certificate becomes valid, in UTC. **ValidTo** *string* Default: "" The time point at which the certificate expires, in UTC. ## Constructors ```text public Certificate(byte[] bytes, int startIndex, int count, string password); ``` Loads the X.509 certificate from a memory buffer. * Bytes * is a buffer containing the raw certificate data. * StartIndex * and * Count * specify the starting position and number of bytes to be read from the buffer, respectively. * Password * is a password encrypting the certificate. ```text public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password); ``` Loads the X.509 certificate from a memory buffer. * CertBytes * is a buffer containing the raw certificate data. * CertStartIndex * and * CertCount * specify the starting position and number of bytes to be read from the buffer, respectively. * KeyBytes * is a buffer containing the private key data. * KeyStartIndex * and * KeyCount * specify the starting position and number of bytes to be read from the buffer, respectively. * Password * is a password encrypting the certificate. ```text public Certificate(byte[] bytes, int startIndex, int count); ``` Loads the X.509 certificate from a memory buffer. * Bytes * is a buffer containing the raw certificate data. * StartIndex * and * Count * specify the starting position and number of bytes to be read from the buffer, respectively. ```text public Certificate(string path, string password); ``` Loads the X.509 certificate from a file. * Path * specifies the full path to the file containing the certificate data. * Password * is a password encrypting the certificate. ```text public Certificate(string certPath, string keyPath, string password); ``` Loads the X.509 certificate from a file. * CertPath * specifies the full path to the file containing the certificate data. * KeyPath * specifies the full path to the file containing the private key. * Password * is a password encrypting the certificate. ```text public Certificate(string path); ``` Loads the X.509 certificate from a file. * Path * specifies the full path to the file containing the certificate data. ```text public Certificate(System.IO.Stream stream); ``` Loads the X.509 certificate from a stream. * Stream * is a stream containing the certificate data. ```text public Certificate(System.IO.Stream stream, string password); ``` Loads the X.509 certificate from a stream. * Stream * is a stream containing the certificate data. * Password * is a password encrypting the certificate. ```text public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password); ``` Loads the X.509 certificate from a stream. * CertStream * is a stream containing the certificate data. * KeyStream * is a stream containing the private key. * Password * is a password encrypting the certificate. ```text public Certificate(); ``` Creates a new object with default field values. # CRL Type Represents a Certificate Revocation List. ## Remarks CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons. Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations. Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid. The following fields are available: - [Bytes](#CRL_f_Bytes) - [CAKeyID](#CRL_f_CAKeyID) - [EntryCount](#CRL_f_EntryCount) - [Issuer](#CRL_f_Issuer) - [IssuerRDN](#CRL_f_IssuerRDN) - [Location](#CRL_f_Location) - [NextUpdate](#CRL_f_NextUpdate) - [SigAlgorithm](#CRL_f_SigAlgorithm) - [Source](#CRL_f_Source) - [TBS](#CRL_f_TBS) - [ThisUpdate](#CRL_f_ThisUpdate) ## Fields **Bytes** *byte[] (read-only)* Default: "" Returns the raw CRL data in DER format. **CAKeyID** *byte[]* Default: "" A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. **EntryCount** *int (read-only)* Default: 0 Returns the number of certificate status entries in the CRL. **Issuer** *string (read-only)* Default: "" The common name of the CRL issuer (CA), typically a company name. **IssuerRDN** *string (read-only)* Default: "" A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. **Location** *string (read-only)* Default: "" The URL that the CRL was downloaded from. **NextUpdate** *string* Default: "" The planned time and date of the next version of this CRL to be published. **SigAlgorithm** *string* Default: "0" The public key algorithm that was used by the CA to sign this CRL. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **TBS** *byte[] (read-only)* Default: "" The to-be-signed part of the CRL (the CRL without the signature part). **ThisUpdate** *string* Default: "" The date and time at which this version of the CRL was published. ## Constructors ```text public CRL(byte[] bytes, int startIndex, int count); ``` Creates a CRL object from a memory buffer. * Bytes * is a buffer containing raw (DER) CRL data, * StartIndex * and * Count * specify the starting position and the length of the CRL data in the buffer, respectively. ```text public CRL(string location); ``` Creates a CRL object by downloading it from a remote location. ```text public CRL(System.IO.Stream stream); ``` Creates a CRL object from data contained in a stream. ```text public CRL(); ``` Creates an empty CRL object. # OCSPResponse Type Represents a single OCSP response originating from an OCSP responder. ## Remarks OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs). An OCSP response is a snapshot of the certificate status at a given time. The following fields are available: - [Bytes](#OCSPResponse_f_Bytes) - [EntryCount](#OCSPResponse_f_EntryCount) - [Issuer](#OCSPResponse_f_Issuer) - [IssuerRDN](#OCSPResponse_f_IssuerRDN) - [Location](#OCSPResponse_f_Location) - [ProducedAt](#OCSPResponse_f_ProducedAt) - [SigAlgorithm](#OCSPResponse_f_SigAlgorithm) - [Source](#OCSPResponse_f_Source) ## Fields **Bytes** *byte[] (read-only)* Default: "" A buffer containing the raw OCSP response data. **EntryCount** *int (read-only)* Default: 0 The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. **Issuer** *string (read-only)* Default: "" Indicates the issuer of this response (a CA or its authorized representative). **IssuerRDN** *string (read-only)* Default: "" Indicates the RDN of the issuer of this response (a CA or its authorized representative). **Location** *string (read-only)* Default: "" The location of the OCSP responder. **ProducedAt** *string* Default: "" Specifies the time when the response was produced, in UTC. **SigAlgorithm** *string* Default: "0" The public key algorithm that was used by the CA to sign this OCSP response. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Constructors ```text public OCSPResponse(byte[] bytes, int startIndex, int count); ``` Initializes the response from a memory buffer. * Bytes * is a buffer containing raw OCSP response data, * StartIndex * and * Count * specify the starting position and the number of bytes to be read from this buffer. ```text public OCSPResponse(string location); ``` Downloads an OCSP response from a remote location. ```text public OCSPResponse(System.IO.Stream stream); ``` Initializes the response with the data from a stream. ```text public OCSPResponse(); ``` Creates an empty OCSP response object. # ProxySettings Type A container for proxy server settings. ## Remarks This type exposes a collection of properties for tuning up the proxy server configuration. The following fields are available: - [Address](#ProxySettings_f_Address) - [Authentication](#ProxySettings_f_Authentication) - [Password](#ProxySettings_f_Password) - [Port](#ProxySettings_f_Port) - [ProxyType](#ProxySettings_f_ProxyType) - [RequestHeaders](#ProxySettings_f_RequestHeaders) - [ResponseBody](#ProxySettings_f_ResponseBody) - [ResponseHeaders](#ProxySettings_f_ResponseHeaders) - [UseIPv6](#ProxySettings_f_UseIPv6) - [Username](#ProxySettings_f_Username) ## Fields **Address** *string* Default: "" The IP address of the proxy server. **Authentication** *ProxyAuthTypes* Default: 0 The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | **Password** *string* Default: "" The password to authenticate to the proxy server. **Port** *int* Default: 0 The port on the proxy server to connect to. **ProxyType** *ProxyTypes* Default: 0 The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | **RequestHeaders** *string* Default: "" Contains HTTP request headers for WebTunnel and HTTP proxy. **ResponseBody** *string* Default: "" Contains the HTTP or HTTPS (WebTunnel) proxy response body. **ResponseHeaders** *string* Default: "" Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. **UseIPv6** *bool* Default: False Specifies whether IPv6 should be used when connecting through the proxy. **Username** *string* Default: "" Specifies the username credential for proxy authentication. ## Constructors ```text public ProxySettings(); ``` Creates a new ProxySettings object. # QualifiedInfo Type This component is a container for X.509 qualified information. ## Remarks Use this property to access the qualified information for the validated certificate. The following fields are available: - [Address](#QualifiedInfo_f_Address) - [CustomTrustedLists](#QualifiedInfo_f_CustomTrustedLists) - [DownloadLog](#QualifiedInfo_f_DownloadLog) - [InformationURI](#QualifiedInfo_f_InformationURI) - [Languages](#QualifiedInfo_f_Languages) - [NextUpdate](#QualifiedInfo_f_NextUpdate) - [Provider](#QualifiedInfo_f_Provider) - [Qualified](#QualifiedInfo_f_Qualified) - [Qualifiers](#QualifiedInfo_f_Qualifiers) - [ServiceName](#QualifiedInfo_f_ServiceName) - [ServiceTypeId](#QualifiedInfo_f_ServiceTypeId) - [Source](#QualifiedInfo_f_Source) - [Status](#QualifiedInfo_f_Status) - [TradeName](#QualifiedInfo_f_TradeName) - [Trusted](#QualifiedInfo_f_Trusted) - [UseDefaultTrustedLists](#QualifiedInfo_f_UseDefaultTrustedLists) - [ValidationLog](#QualifiedInfo_f_ValidationLog) - [XML](#QualifiedInfo_f_XML) ## Fields **Address** *string (read-only)* Default: "" Contains the address of the TSL provider. Use this property to check the address of the TSL provider. **CustomTrustedLists** *string* Default: "" 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. **DownloadLog** *string (read-only)* Default: "" Contains the TLS download log. This log may be useful in investigating TSL retrieval failures. **InformationURI** *string (read-only)* Default: "" Contains the URI of the provider information. Use this property to get the URI of the TSL provider information. **Languages** *string* Default: "" 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. **NextUpdate** *string (read-only)* Default: "" Returns the next update date and time of the TSL. Use this property to check the next update value for the TSL. **Provider** *string (read-only)* Default: "" Contains the name of the TSL provider. Use this property to check the name of the TSL provider. **Qualified** *bool (read-only)* Default: False Indicates whether the certificate is qualified. This property is set to true if the certificate is confirmed by a TSL to be qualified. **Qualifiers** *string (read-only)* Default: "" A list of qualifiers. Contains a comma-separated list of qualifiers for the certificate, for example *QCP-n-qscd,QCWithSSCD*. **ServiceName** *string (read-only)* Default: "" Contains the name of the TSL service. Use this property to check the name of the TSL service. **ServiceTypeId** *string (read-only)* Default: "" Contains the TSL service type identifier. Use this property to check the service type identifier of the TSL. **Source** *QualifiedInfoSources (read-only)* Default: 0 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. **Status** *QualifiedServiceStatuses (read-only)* Default: 0 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). | **TradeName** *string (read-only)* Default: "" Contains the trade name of the TSL provider. Use this property to check the trade name of the TSL provider. **Trusted** *bool (read-only)* Default: False Indicates whether the certificate is trusted. This property is set to true if the certificate is confirmed by a TSL to be trusted. **UseDefaultTrustedLists** *bool* Default: True 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. **ValidationLog** *string (read-only)* Default: "" Contains the TLS validation log. This log may be useful in investigating TSL validation failures. **XML** *string (read-only)* Default: "" Contains the XML of the TSL. Use this property to obtain the original body of the TSL in XML format. ## Constructors ```text public QualifiedInfo(); ``` Creates a new QualifiedInfo object. # SocketSettings Type A container for the socket settings. ## Remarks This type is a container for socket-layer parameters. The following fields are available: - [DNSMode](#SocketSettings_f_DNSMode) - [DNSPort](#SocketSettings_f_DNSPort) - [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout) - [DNSServers](#SocketSettings_f_DNSServers) - [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout) - [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit) - [LocalAddress](#SocketSettings_f_LocalAddress) - [LocalPort](#SocketSettings_f_LocalPort) - [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit) - [Timeout](#SocketSettings_f_Timeout) - [UseIPv6](#SocketSettings_f_UseIPv6) ## Fields **DNSMode** *DNSResolveModes* Default: 0 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 | **DNSPort** *int* Default: 0 Specifies the port number to be used for sending queries to the DNS server. **DNSQueryTimeout** *int* Default: 0 The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. **DNSServers** *string* Default: "" The addresses of DNS servers to use for address resolution, separated by commas or semicolons. **DNSTotalTimeout** *int* Default: 0 The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. **IncomingSpeedLimit** *int* Default: 0 The maximum number of bytes to read from the socket, per second. **LocalAddress** *string* Default: "" The local network interface to bind the socket to. **LocalPort** *int* Default: 0 The local port number to bind the socket to. **OutgoingSpeedLimit** *int* Default: 0 The maximum number of bytes to write to the socket, per second. **Timeout** *int* Default: 60000 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). **UseIPv6** *bool* Default: False Enables or disables IP protocol version 6. ## Constructors ```text public SocketSettings(); ``` Creates a new SocketSettings object. # TLSSettings Type A container for TLS connection settings. ## Remarks The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP. The following fields are available: - [AutoValidateCertificates](#TLSSettings_f_AutoValidateCertificates) - [BaseConfiguration](#TLSSettings_f_BaseConfiguration) - [Ciphersuites](#TLSSettings_f_Ciphersuites) - [ClientAuth](#TLSSettings_f_ClientAuth) - [Extensions](#TLSSettings_f_Extensions) - [ForceResumeIfDestinationChanges](#TLSSettings_f_ForceResumeIfDestinationChanges) - [Groups](#TLSSettings_f_Groups) - [PreSharedIdentity](#TLSSettings_f_PreSharedIdentity) - [PreSharedKey](#TLSSettings_f_PreSharedKey) - [PreSharedKeyCiphersuite](#TLSSettings_f_PreSharedKeyCiphersuite) - [RenegotiationAttackPreventionMode](#TLSSettings_f_RenegotiationAttackPreventionMode) - [RevocationCheck](#TLSSettings_f_RevocationCheck) - [SSLOptions](#TLSSettings_f_SSLOptions) - [TLSMode](#TLSSettings_f_TLSMode) - [UseExtendedMasterSecret](#TLSSettings_f_UseExtendedMasterSecret) - [UseSessionResumption](#TLSSettings_f_UseSessionResumption) - [Versions](#TLSSettings_f_Versions) ## Fields **AutoValidateCertificates** *bool* Default: True Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. **BaseConfiguration** *SecureTransportPredefinedConfigurations* Default: 0 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 | | **Ciphersuites** *string* Default: "" 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 [BaseConfiguration](#TLSSettings_f_BaseConfiguration). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below: - NULL_NULL_NULL - RSA_NULL_MD5 - RSA_NULL_SHA - RSA_RC4_MD5 - RSA_RC4_SHA - RSA_RC2_MD5 - RSA_IDEA_MD5 - RSA_IDEA_SHA - RSA_DES_MD5 - RSA_DES_SHA - RSA_3DES_MD5 - RSA_3DES_SHA - RSA_AES128_SHA - RSA_AES256_SHA - DH_DSS_DES_SHA - DH_DSS_3DES_SHA - DH_DSS_AES128_SHA - DH_DSS_AES256_SHA - DH_RSA_DES_SHA - DH_RSA_3DES_SHA - DH_RSA_AES128_SHA - DH_RSA_AES256_SHA - DHE_DSS_DES_SHA - DHE_DSS_3DES_SHA - DHE_DSS_AES128_SHA - DHE_DSS_AES256_SHA - DHE_RSA_DES_SHA - DHE_RSA_3DES_SHA - DHE_RSA_AES128_SHA - DHE_RSA_AES256_SHA - DH_ANON_RC4_MD5 - DH_ANON_DES_SHA - DH_ANON_3DES_SHA - DH_ANON_AES128_SHA - DH_ANON_AES256_SHA - RSA_RC2_MD5_EXPORT - RSA_RC4_MD5_EXPORT - RSA_DES_SHA_EXPORT - DH_DSS_DES_SHA_EXPORT - DH_RSA_DES_SHA_EXPORT - DHE_DSS_DES_SHA_EXPORT - DHE_RSA_DES_SHA_EXPORT - DH_ANON_RC4_MD5_EXPORT - DH_ANON_DES_SHA_EXPORT - RSA_CAMELLIA128_SHA - DH_DSS_CAMELLIA128_SHA - DH_RSA_CAMELLIA128_SHA - DHE_DSS_CAMELLIA128_SHA - DHE_RSA_CAMELLIA128_SHA - DH_ANON_CAMELLIA128_SHA - RSA_CAMELLIA256_SHA - DH_DSS_CAMELLIA256_SHA - DH_RSA_CAMELLIA256_SHA - DHE_DSS_CAMELLIA256_SHA - DHE_RSA_CAMELLIA256_SHA - DH_ANON_CAMELLIA256_SHA - PSK_RC4_SHA - PSK_3DES_SHA - PSK_AES128_SHA - PSK_AES256_SHA - DHE_PSK_RC4_SHA - DHE_PSK_3DES_SHA - DHE_PSK_AES128_SHA - DHE_PSK_AES256_SHA - RSA_PSK_RC4_SHA - RSA_PSK_3DES_SHA - RSA_PSK_AES128_SHA - RSA_PSK_AES256_SHA - RSA_SEED_SHA - DH_DSS_SEED_SHA - DH_RSA_SEED_SHA - DHE_DSS_SEED_SHA - DHE_RSA_SEED_SHA - DH_ANON_SEED_SHA - SRP_SHA_3DES_SHA - SRP_SHA_RSA_3DES_SHA - SRP_SHA_DSS_3DES_SHA - SRP_SHA_AES128_SHA - SRP_SHA_RSA_AES128_SHA - SRP_SHA_DSS_AES128_SHA - SRP_SHA_AES256_SHA - SRP_SHA_RSA_AES256_SHA - SRP_SHA_DSS_AES256_SHA - ECDH_ECDSA_NULL_SHA - ECDH_ECDSA_RC4_SHA - ECDH_ECDSA_3DES_SHA - ECDH_ECDSA_AES128_SHA - ECDH_ECDSA_AES256_SHA - ECDHE_ECDSA_NULL_SHA - ECDHE_ECDSA_RC4_SHA - ECDHE_ECDSA_3DES_SHA - ECDHE_ECDSA_AES128_SHA - ECDHE_ECDSA_AES256_SHA - ECDH_RSA_NULL_SHA - ECDH_RSA_RC4_SHA - ECDH_RSA_3DES_SHA - ECDH_RSA_AES128_SHA - ECDH_RSA_AES256_SHA - ECDHE_RSA_NULL_SHA - ECDHE_RSA_RC4_SHA - ECDHE_RSA_3DES_SHA - ECDHE_RSA_AES128_SHA - ECDHE_RSA_AES256_SHA - ECDH_ANON_NULL_SHA - ECDH_ANON_RC4_SHA - ECDH_ANON_3DES_SHA - ECDH_ANON_AES128_SHA - ECDH_ANON_AES256_SHA - RSA_NULL_SHA256 - RSA_AES128_SHA256 - RSA_AES256_SHA256 - DH_DSS_AES128_SHA256 - DH_RSA_AES128_SHA256 - DHE_DSS_AES128_SHA256 - DHE_RSA_AES128_SHA256 - DH_DSS_AES256_SHA256 - DH_RSA_AES256_SHA256 - DHE_DSS_AES256_SHA256 - DHE_RSA_AES256_SHA256 - DH_ANON_AES128_SHA256 - DH_ANON_AES256_SHA256 - RSA_AES128_GCM_SHA256 - RSA_AES256_GCM_SHA384 - DHE_RSA_AES128_GCM_SHA256 - DHE_RSA_AES256_GCM_SHA384 - DH_RSA_AES128_GCM_SHA256 - DH_RSA_AES256_GCM_SHA384 - DHE_DSS_AES128_GCM_SHA256 - DHE_DSS_AES256_GCM_SHA384 - DH_DSS_AES128_GCM_SHA256 - DH_DSS_AES256_GCM_SHA384 - DH_ANON_AES128_GCM_SHA256 - DH_ANON_AES256_GCM_SHA384 - ECDHE_ECDSA_AES128_SHA256 - ECDHE_ECDSA_AES256_SHA384 - ECDH_ECDSA_AES128_SHA256 - ECDH_ECDSA_AES256_SHA384 - ECDHE_RSA_AES128_SHA256 - ECDHE_RSA_AES256_SHA384 - ECDH_RSA_AES128_SHA256 - ECDH_RSA_AES256_SHA384 - ECDHE_ECDSA_AES128_GCM_SHA256 - ECDHE_ECDSA_AES256_GCM_SHA384 - ECDH_ECDSA_AES128_GCM_SHA256 - ECDH_ECDSA_AES256_GCM_SHA384 - ECDHE_RSA_AES128_GCM_SHA256 - ECDHE_RSA_AES256_GCM_SHA384 - ECDH_RSA_AES128_GCM_SHA256 - ECDH_RSA_AES256_GCM_SHA384 - PSK_AES128_GCM_SHA256 - PSK_AES256_GCM_SHA384 - DHE_PSK_AES128_GCM_SHA256 - DHE_PSK_AES256_GCM_SHA384 - RSA_PSK_AES128_GCM_SHA256 - RSA_PSK_AES256_GCM_SHA384 - PSK_AES128_SHA256 - PSK_AES256_SHA384 - PSK_NULL_SHA256 - PSK_NULL_SHA384 - DHE_PSK_AES128_SHA256 - DHE_PSK_AES256_SHA384 - DHE_PSK_NULL_SHA256 - DHE_PSK_NULL_SHA384 - RSA_PSK_AES128_SHA256 - RSA_PSK_AES256_SHA384 - RSA_PSK_NULL_SHA256 - RSA_PSK_NULL_SHA384 - RSA_CAMELLIA128_SHA256 - DH_DSS_CAMELLIA128_SHA256 - DH_RSA_CAMELLIA128_SHA256 - DHE_DSS_CAMELLIA128_SHA256 - DHE_RSA_CAMELLIA128_SHA256 - DH_ANON_CAMELLIA128_SHA256 - RSA_CAMELLIA256_SHA256 - DH_DSS_CAMELLIA256_SHA256 - DH_RSA_CAMELLIA256_SHA256 - DHE_DSS_CAMELLIA256_SHA256 - DHE_RSA_CAMELLIA256_SHA256 - DH_ANON_CAMELLIA256_SHA256 - ECDHE_ECDSA_CAMELLIA128_SHA256 - ECDHE_ECDSA_CAMELLIA256_SHA384 - ECDH_ECDSA_CAMELLIA128_SHA256 - ECDH_ECDSA_CAMELLIA256_SHA384 - ECDHE_RSA_CAMELLIA128_SHA256 - ECDHE_RSA_CAMELLIA256_SHA384 - ECDH_RSA_CAMELLIA128_SHA256 - ECDH_RSA_CAMELLIA256_SHA384 - RSA_CAMELLIA128_GCM_SHA256 - RSA_CAMELLIA256_GCM_SHA384 - DHE_RSA_CAMELLIA128_GCM_SHA256 - DHE_RSA_CAMELLIA256_GCM_SHA384 - DH_RSA_CAMELLIA128_GCM_SHA256 - DH_RSA_CAMELLIA256_GCM_SHA384 - DHE_DSS_CAMELLIA128_GCM_SHA256 - DHE_DSS_CAMELLIA256_GCM_SHA384 - DH_DSS_CAMELLIA128_GCM_SHA256 - DH_DSS_CAMELLIA256_GCM_SHA384 - DH_anon_CAMELLIA128_GCM_SHA256 - DH_anon_CAMELLIA256_GCM_SHA384 - ECDHE_ECDSA_CAMELLIA128_GCM_SHA256 - ECDHE_ECDSA_CAMELLIA256_GCM_SHA384 - ECDH_ECDSA_CAMELLIA128_GCM_SHA256 - ECDH_ECDSA_CAMELLIA256_GCM_SHA384 - ECDHE_RSA_CAMELLIA128_GCM_SHA256 - ECDHE_RSA_CAMELLIA256_GCM_SHA384 - ECDH_RSA_CAMELLIA128_GCM_SHA256 - ECDH_RSA_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_GCM_SHA256 - PSK_CAMELLIA256_GCM_SHA384 - DHE_PSK_CAMELLIA128_GCM_SHA256 - DHE_PSK_CAMELLIA256_GCM_SHA384 - RSA_PSK_CAMELLIA128_GCM_SHA256 - RSA_PSK_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_SHA256 - PSK_CAMELLIA256_SHA384 - DHE_PSK_CAMELLIA128_SHA256 - DHE_PSK_CAMELLIA256_SHA384 - RSA_PSK_CAMELLIA128_SHA256 - RSA_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_CAMELLIA128_SHA256 - ECDHE_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_RC4_SHA - ECDHE_PSK_3DES_SHA - ECDHE_PSK_AES128_SHA - ECDHE_PSK_AES256_SHA - ECDHE_PSK_AES128_SHA256 - ECDHE_PSK_AES256_SHA384 - ECDHE_PSK_NULL_SHA - ECDHE_PSK_NULL_SHA256 - ECDHE_PSK_NULL_SHA384 - ECDHE_RSA_CHACHA20_POLY1305_SHA256 - ECDHE_ECDSA_CHACHA20_POLY1305_SHA256 - DHE_RSA_CHACHA20_POLY1305_SHA256 - PSK_CHACHA20_POLY1305_SHA256 - ECDHE_PSK_CHACHA20_POLY1305_SHA256 - DHE_PSK_CHACHA20_POLY1305_SHA256 - RSA_PSK_CHACHA20_POLY1305_SHA256 - AES128_GCM_SHA256 - AES256_GCM_SHA384 - CHACHA20_POLY1305_SHA256 - AES128_CCM_SHA256 - AES128_CCM8_SHA256 **ClientAuth** *ClientAuthTypes* Default: 0 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 | | **Extensions** *string* Default: "" Provides access to TLS extensions. **ForceResumeIfDestinationChanges** *bool* Default: False Whether to force TLS session resumption when the destination address changes. **Groups** *string* Default: "" 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: ```text // 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. **PreSharedIdentity** *string* Default: "" Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. **PreSharedKey** *string* Default: "" Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. **PreSharedKeyCiphersuite** *string* Default: "" Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. **RenegotiationAttackPreventionMode** *RenegotiationAttackPreventionModes* Default: 2 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. | **RevocationCheck** *RevocationCheckKinds* Default: 1 Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. **SSLOptions** *int* Default: 16 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 | **TLSMode** *SSLModes* Default: 0 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. | **UseExtendedMasterSecret** *bool* Default: True Enables the Extended Master Secret Extension, as defined in RFC 7627. **UseSessionResumption** *bool* Default: False Enables or disables the TLS session resumption capability. **Versions** *int* Default: 48 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 | ## Constructors ```text public TLSSettings(); ``` Creates a new TLSSettings object. # Config Settings ([CertificateValidator](#certificatevalidator-component) Component) The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-certificatevalidator-component) 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](#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](#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](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#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](#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](#CachedOCSPResponseMaxAge) to limit their age. See [RevocationCacheAgePolicy](#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](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#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 component how to perform the cross certification validation. Supported values: csvSmart = 0 csvOptimistic = 1 csvPessimistic = 2 csvNoCrossCertification = 3 In the optimistic strategy, positive validation results are kept, and negative ones are ignored. If there are no good certificates in the chain, the validation proceeds using self-signed certificates. Smart is the same as optimistic. In the pessimistic strategy, even one negative validation result makes the whole process to fail. **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 component 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 component is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022). **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 component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store. If [IgnoreSystemTrust](#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](#trustedcertificates-property-certificatevalidator-component) 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 component 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](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#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:;;,ocsp:;; | 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](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#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 component will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the component, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start. **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](#notification-event-certificatevalidator-component) event handler with the Trusted List content. **TSLContentHex**: Specifies the TrustedList content.Assign or read this property in your [Notification](#notification-event-certificatevalidator-component) 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 component. 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 component. 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.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. **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.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. **TSPHistoryInstanceQualifiers**: 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. **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 component. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the component.Use this property to get cookies from the internal cookie storage of the component 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 components 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 components. **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): ```text 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: ```text 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 component. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **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 component) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are 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 component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **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 components. **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: ```text 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: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text 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](#certificatevalidator-component) Component) ### CertificateValidator Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) |