CertificateValidator Class
Properties Methods Events Config Settings Errors
The CertificateValidator class provides fine-grained validation of X.509 certificates.
Syntax
CertificateValidator
Remarks
This is a powerful and configurable class which can be used to validate all kinds of certificates and their chains.
The purpose of CertificateValidator is to validate certificate chains according to the X.509 specification. It supports a variety of technologies, including CRL and OCSP services, and can provide a comprehensive output on the certificate cryptographic validity, chain integrity, and trust levels. CertificateValidator is used internally in many other SecureBlackbox components, such as PDFSigner, HTTPClient, and OfficeVerifier.
To validate a certificate, please tune up the component as following:
- Assign the certificate to be validated to the Certificate property.
- Set RevocationCheck in accordance with your revocation check preferences.
- Enable UseSystemCertificates property to trust certificates that are trusted by the operating system. Copy any certificates that are not available in the standard system locations to KnownCertificates and TrustedCertificates collections (see Note 1 below).
- Optionally, adjust TLSSettings and SocketSettings.
- Adjust ValidationMoment if you would like to check the certificate validity at a different moment in time. Leave it unchanged to validate the certificate at the current time moment.
- Call Validate or ValidateForSSL method to initiate chain validation.
Depending on the complexity of the chain and the configuration of the component, the validation routine may take certain amount of time. The validator reports chain validation progress using a selection of events, such as BeforeCertificateProcessing, AfterCertificateProcessing, and CRLDownloaded events. It may also ask you for missing objects using CRLNeeded or CACertificateNeeded events. In each such event handler you can access the currently validated certificate via the CurrentCertificate property, and the interim validity figures via the InterimValidationResult and InterimValidationDetails property.
The return of the Validate (or similar) method indicates the completion of the validation procedure. The outcome of the chain validation is represented with the two parameters:
- ChainValidationResult reports the general validation outcome: valid, valid-but-untrusted, invalid, and unknown. As a rule, only the valid result can be taken as a good reason to consider the chain valid.
- ChainValidationDetails provides insights into the factors that caused the validation to fail.
Note 1: On Windows, CertificateValidator can use CA and ROOT system stores to look for any missing CA certificates and trust anchors. No similar functionality is currently available for other platforms, so in most cases you must provide your own list of trusted and CA certificates via TrustedCertificates and KnownCertificates collections to have your chains validate fully in Linux and macOS projects.
Note 2: The OfflineMode property is a handy way to check the completeness of your revocation/validation information. When the offline mode is on, CertificateValidator won't go online for any missing certificates, CRLs, and OCSP responses. Paired with a switched-off UseSystemCertificates property, it allows to make sure that any content provided via KnownCertificates, KnownCRLs, and KnownOCSPs represents the complete set of validation information required to validate the chain.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
BlockedCertificates | The certificates that must be rejected as trust anchors. |
CacheValidationResults | Enables or disables validation result caching. |
Certificate | The certificate to be validated. |
ChainValidationDetails | The details of a certificate chain validation outcome. |
ChainValidationResult | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. |
CheckTrustedLists | Specifies whether the class should attempt to validate chain trust via a known Trusted List. |
CurrentCACertificate | The CA of the currently processed certificate. |
CurrentCertificate | The certificate that is currently being processed. |
FIPSMode | Reserved. |
GracePeriod | Specifies a grace period to apply during certificate validation. |
InterimValidationDetails | Contains the validation details of the moment. |
InterimValidationResult | Contains the validation status of the moment. |
KnownCertificates | Additional certificates for chain validation. |
KnownCRLs | Additional CRLs for chain validation. |
KnownOCSPs | Additional OCSP responses for chain validation. |
MaxValidationTime | Specifies the maximum time the validation process may take. |
OfflineMode | Switches the class to offline mode. |
Proxy | The proxy server settings. |
QualifiedInfo | The qualified details for the validated certificate. |
RevocationCheck | Specifies the kind(s) of revocation check to perform for all chain certificates. |
SocketSettings | Manages network connection settings. |
TLSClientChain | The TLS client certificate chain. |
TLSServerChain | The TLS server's certificate chain. |
TLSSettings | Manages TLS layer settings. |
TrustedCertificates | A list of trusted certificates for chain validation. |
UsedCertificates | Contains a list of certificates used during the chain validation routine. |
UsedCRLs | Contains a list of CRLs used during the chain validation routine. |
UsedOCSPs | Contains a list of OCSP responses used during the chain validation routine. |
UseSystemCertificates | Enables or disables the use of the system certificates. |
ValidationLog | Contains the complete log of the certificate validation routine. |
ValidationMoment | The time point at which chain validity is to be established. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoAction | Performs an additional action. |
GetQualifiedStatus | Obtains the qualified information for Certificate . |
GetTrustedListProperty | Returns a specific TrustedList property. |
RefreshCache | Refreshes the certificate cache. |
Reset | Resets the class settings. |
ResetCache | Clears all data contained in the validation cache. |
Terminate | Terminates the validation process. |
Validate | Validates the certificate chain. |
ValidateForSMIME | Validates an e-mail signing certificate. |
ValidateForSSL | Validates a server-side SSL/TLS certificate. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
AfterCertificateProcessing | Marks the end of a single certificate processing step. |
AfterCertificateValidation | Marks the end of a single certificate validation step. |
BeforeCACertificateDownload | Fires when a CA certificate is about to be downloaded. |
BeforeCertificateProcessing | Reports the start of certificate processing. |
BeforeCertificateValidation | Reports the start of certificate validation. |
BeforeCRLDownload | Fires when a CRL is about to be downloaded. |
BeforeOCSPDownload | Fires when a certificate's OCSP status is about to be requested. |
CACertificateDownloaded | Marks the success of a certificate download. |
CACertificateNeeded | Requests a missing certificate from the user. |
CRLDownloaded | Marks the success of a CRL download. |
CRLNeeded | Requests a missing CRL from the user. |
Error | Information about errors during certificate validation. |
Notification | This event notifies the application about an underlying control flow event. |
OCSPDownloaded | Marks the success of an OCSP request. |
TLSCertNeeded | Fires when a remote TLS party requests a client certificate. |
TLSCertValidate | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
TLSEstablished | Fires when a TLS handshake with Host successfully completes. |
TLSHandshake | Fires when a new TLS handshake is initiated, before the handshake commences. |
TLSShutdown | Reports the graceful closure of a TLS connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
CacheValidityTime | Time period during which to keep validation cache. |
CheckStrongAlgorithmForTrusted | Whether to check a 'strong' hash algorithm for trusted certificates. |
CheckValidityPeriodForTrusted | Whether to check validity period for trusted certificates. |
CrossCertificationValidationStrategy | Defines how the cross certification validation is performed. |
DislikeOpenEndedOCSPs | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. |
ForceCompleteChainValidationForTrusted | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. |
ForceRevocationCheckForRoot | Whether to check revocation info for root certificates. |
IgnoreBadOCSPChains | Whether to ignore bad OCSP chains during validation. |
IgnoreCABasicConstraints | Whether to ignore the Basic Constraints extension for the CA certificates. |
IgnoreCAKeyUsage | Whether to ignore Key Usage extension for CA certificates. |
IgnoreCANameConstraints | Whether to ignore the Name Constraints extension for the CA certificates. |
IgnoreChainLoops | Whether chain loops should be ignored. |
IgnoreCRLIssuerKeyID | Tells the validator to ignore malformed CRL issuer key IDs. |
IgnoreOCSPNoCheckExtension | Whether the OCSP NoCheck extension should be ignored. |
IgnoreRevocationKeyUsage | Whether to check the CA certs used to sign revocation info. |
IgnoreSSLKeyUsage | Whether to check the CA certs used in SSL/TLS. |
IgnoreSystemTrust | Whether trusted Windows Certificate Stores should be treated as trusted. |
ImplicitlyTrustSelfSignedCertificates | Whether to trust self-signed certificates. |
LookupCRLByNameIfDPNotPresent | Whether to look for implicit CRL Distribution Points. |
PromoteLongOCSPResponses | Whether long OCSP responses are requested. |
RevocationMomentGracePeriod | Grace period for revocation information propagation. |
SkipSubjectNameIfAltNameExists | Whether to check CommonName if SubjectAltName is present. |
UseMicrosoftCTL | Enables or disables the automatic use of the Microsoft online certificate trust list. |
UseValidationCache | Enables or disable the use of the product-wide certificate chain validation cache. |
ValidateInvalidCertificates | Whether to do all checks on invalid certificates. |
WeakAlgorithmHandlingMode | How to handle certificates signed with a 'weak' hash algorithm. |
CustomTrustedLists | Specifies the custom TrustedLists. |
CustomTSLs | Specifies the custom TrustedLists. |
DistributionPoints | Contains XML content of distribution points of the TSL used. |
HistoricalInformationPeriod | Contains historical information period of the TSL used. |
LegalNotices | Contains XML content of legal notices of the TSL used. |
ListIssueDateTime | Contains list issue date and time of the TSL used. |
NextUpdate | Contains next update date and time of the TSL used. |
Policies | Contains XML content of policies of the TSL used. |
QualifiedStatus | Indicates a qualified electronic signature. |
SchemeExtensions | Contains XML content of scheme extensions of the TSL used. |
SchemeInformationURI | Contains XML content of scheme information URI of the TSL used. |
SchemeName | Contains XML content of scheme name of the TSL used. |
SchemeOperatorAddress | Contains XML content of scheme operator address of the TSL used. |
SchemeOperatorName | Contains XML content of scheme operator name of the TSL used. |
SchemeTerritory | Contains scheme territory of the TSL used. |
SchemeTypeCommunityRules | Contains XML content of scheme type/community/rules of the TSL used. |
SequenceNumber | Contains sequence number of the TSL used. |
StatusDeterminationApproach | Contains status determination approach of the TSL used. |
TSLContent | Specifies the TrustedList content. |
TSLContentHex | Specifies the TrustedList content. |
TSLDistributionPoints | Contains XML content of distribution points of the TSL used. |
TSLDistributionPoints[Idx] | Contains distribution point of the specified index of the TSL used. |
TSLHistoricalInformationPeriod | Contains historical information period of the TSL used. |
TSLLegalNotices | Contains XML content of legal notices of the TSL used. |
TSLLegalNotices[lang] | Contains legal notices for the specified language of the TSL used. |
TSLListIssueDateTime | Contains list issue date and time of the TSL used. |
TSLNextUpdate | Contains next update date and time of the TSL used. |
TSLPolicies | Contains XML content of policies of the TSL used. |
TSLPolicies[lang] | Contains policies for the specified language of the TSL used. |
TSLSchemeExtensions | Contains XML content of scheme extensions of the TSL used. |
TSLSchemeExtensions[Idx] | Contains XML content of scheme extension of the specified index of the TSL used. |
TSLSchemeInformationURI | Contains XML content of scheme information URI of the TSL used. |
TSLSchemeInformationURI[lang] | Contains scheme information URI for the specified language of the TSL used. |
TSLSchemeName | Contains XML content of scheme name of the TSL used. |
TSLSchemeName[lang] | Contains scheme name for the specified language of the TSL used. |
TSLSchemeOperatorAddress | Contains XML content of scheme operator address of the TSL used. |
TSLSchemeOperatorName | Contains XML content of scheme operator name of the TSL used. |
TSLSchemeOperatorName[lang] | Contains scheme operator name for the specified language of the TSL used. |
TSLSchemeTerritory | Contains scheme territory of the TSL used. |
TSLSchemeTypeCommunityRules | Contains XML content of scheme type/community/rules of the TSL used. |
TSLSchemeTypeCommunityRules[lang] | Contains scheme type/community/rules for the specified language of the TSL used. |
TSLSequenceNumber | Contains sequence number of the TSL used. |
TSLsRetrieveLog | Contains the complete log of the TSLs retrieve. |
TSLStatusDeterminationApproach | Contains status determination approach of the TSL used. |
TSLsValidationLog | Contains the complete log of the TSLs validation. |
TSLTSPAdditionalServiceInformation | Contains addtional service information of the TSP service used. |
TSLTSPAddress | Contains XML content of the address of the TSP used. |
TSLTSPHistoryInstance | Indicates that TSP service history instance used. |
TSLTSPHistoryInstanceAdditionalServiceInformation | Contains addtional service information of the TSP service history instance used. |
TSLTSPHistoryInstanceQualifiers | Contains list of qualifiers of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceInformationExtensions | Contains XML content of information extensions of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceName | Contains XML content of name of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceName[lang] | Contains name for the specified language of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceStatus | Contains status of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceStatusStartingTime | Contains status starting time of the TSP service history instance used. |
TSLTSPHistoryInstanceServiceTypeIdentifier | Contains type identifier of the TSP service history instance used. |
TSLTSPHistoryInstanceXML | Contains XML content of the TSP service history instance used. |
TSLTSPInformationExtensions | Contains XML content of information extensions of the TSP used. |
TSLTSPInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP used. |
TSLTSPInformationURI | Contains XML content of information URI of the TSP used. |
TSLTSPInformationURI[lang] | Contains information URI for the specified language of the TSP used. |
TSLTSPName | Contains XML content of name of the TSP used. |
TSLTSPName[lang] | Contains name for the specified language of the TSP used. |
TSLTSPSchemeServiceDefinitionURI | Contains XML content of scheme service definition URI of the TSP service used. |
TSLTSPSchemeServiceDefinitionURI[lang] | Contains scheme service definition URI for the specified language of the TSP service used. |
TSLTSPServiceDefinitionURI | Contains XML content of definition URI of the TSP service used. |
TSLTSPServiceDefinitionURI[lang] | Contains definition URI for the specified language of the TSP service used. |
TSLTSPServiceInformationExtensions | Contains XML content of information extensions of the TSP service used. |
TSLTSPServiceInformationExtensions[Idx] | Contains XML content of information extension of the specified index of the TSP service used. |
TSLTSPServiceName | Contains XML content of name of the TSP service used. |
TSLTSPServiceName[lang] | Contains name for the specified language of the TSP service used. |
TSLTSPServiceQualifiers | Contains list of qualifiers of the TSP service used. |
TSLTSPServiceStatus | Contains status of the TSP service used. |
TSLTSPServiceStatusStartingTime | Contains status starting time of the TSP service used. |
TSLTSPServiceSupplyPoints | Contains XML content of the supply points of the TSP service used. |
TSLTSPServiceTypeIdentifier | Contains type identifier of the TSP service used. |
TSLTSPServiceXML | Contains XML content of the TSP service used. |
TSLTSPTradeName | Contains XML content of trade name of the TSP used. |
TSLTSPTradeName[lang] | Contains trade name for the specified language of the TSP used. |
TSLTSPXML | Contains XML content of the TSP used. |
TSLType | Contains TSL type of the TSL used. |
TSLVersionIdentifier | Contains version identifier of the TSL used. |
TSLXML | Contains XML content of the TSL used. |
TSPAdditionalServiceInformation | Contains addtional service information of the TSP service used. |
TSPAddress | Contains XML content of the address of the TSP used. |
TSPHistoryInstance | Indicates that TSP service history instance used. |
TSPHistoryInstanceAdditionalServiceInformation | Contains addtional service information of the TSP service history instance used. |
TSPHistoryInstanceQualifiers | Contains list of qualifiers of the TSP service history instance used. |
TSPHistoryInstanceServiceInformationExtensions | Contains XML content of information extensions of the TSP service history instance used. |
TSPHistoryInstanceServiceName | Contains XML content of name of the TSP service history instance used. |
TSPHistoryInstanceServiceStatus | Contains status of the TSP service history instance used. |
TSPHistoryInstanceServiceStatusStartingTime | Contains status starting time of the TSP service history instance used. |
TSPHistoryInstanceServiceTypeIdentifier | Contains type identifier of the TSP service history instance used. |
TSPHistoryInstanceXML | Contains XML content of the TSP service history instance used. |
TSPInformationExtensions | Contains XML content of information extensions of the TSP used. |
TSPInformationURI | Contains XML content of information URI of the TSP used. |
TSPName | Contains XML content of name of the TSP used. |
TSPSchemeServiceDefinitionURI | Contains XML content of scheme service definition URI of the TSP service used. |
TSPServiceDefinitionURI | Contains XML content of definition URI of the TSP service used. |
TSPServiceInformationExtensions | Contains XML content of information extensions of the TSP service used. |
TSPServiceName | Contains XML content of name of the TSP service used. |
TSPServiceQualifiers | Contains list of qualifiers of the TSP service used. |
TSPServiceStatus | Contains status of the TSP service used. |
TSPServiceStatusStartingTime | Contains status starting time of the TSP service used. |
TSPServiceSupplyPoints | Contains XML content of the supply points of the TSP service used. |
TSPServiceTypeIdentifier | Contains type identifier of the TSP service used. |
TSPServiceXML | Contains XML content of the TSP service used. |
TSPTradeName | Contains XML content of trade name of the TSP used. |
TSPXML | Contains XML content of the TSP used. |
Type | Contains TSL type of the TSL used. |
VersionIdentifier | Contains version identifier of the TSL used. |
ASN1UseGlobalTagCache | Controls whether ASN.1 module should use a global object cache. |
AssignSystemSmartCardPins | Specifies whether CSP-level PINs should be assigned to CNG keys. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class. |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
DNSLocalSuffix | The suffix to assign for TLD names. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HardwareCryptoUsePolicy | The hardware crypto usage policy. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
HttpVersion | The HTTP version to use in any inner HTTP client classes created. |
IgnoreExpiredMSCTLSigningCert | Whether to tolerate the expired Windows Update signing certificate. |
ListDelimiter | The delimiter character for multi-element lists. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
OldClientSideRSAFallback | Specifies whether the SSH client should use a SHA1 fallback. |
PKICache | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. |
PKICachePath | Specifies the file system path where cached PKI data is stored. |
ProductVersion | Returns the version of the SecureBlackbox library. |
ServerSSLDHKeyLength | Sets the size of the TLS DHE key exchange group. |
StaticDNS | Specifies whether static DNS rules should be used. |
StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
StaticIPAddresses | Gets or sets all the static DNS rules. |
Tag | Allows to store any custom data. |
TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
UseCRLObjectCaching | Specifies whether reuse of loaded CRL objects is enabled. |
UseInternalRandom | Switches between SecureBlackbox-own and platform PRNGs. |
UseLegacyAdESValidation | Enables legacy AdES validation mode. |
UseOCSPResponseObjectCaching | Specifies whether reuse of loaded OCSP response objects is enabled. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemNativeSizeCalculation | An internal CryptoAPI access tweak. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |
XMLRDNDescriptorName[OID] | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. |
XMLRDNDescriptorPriority[OID] | Specifies the priority of descriptor names associated with a specific OID. |
XMLRDNDescriptorReverseOrder | Specifies whether to reverse the order of descriptors in RDN. |
XMLRDNDescriptorSeparator | Specifies the separator used between descriptors in RDN. |
BlockedCertificates Property (CertificateValidator Class)
The certificates that must be rejected as trust anchors.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetBlockedCertificates(); int SetBlockedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_certificatevalidator_getblockedcertcount(void* lpObj);
int secureblackbox_certificatevalidator_setblockedcertcount(void* lpObj, int iBlockedCertCount);
int secureblackbox_certificatevalidator_getblockedcertbytes(void* lpObj, int blockedcertindex, char** lpBlockedCertBytes, int* lenBlockedCertBytes);
int64 secureblackbox_certificatevalidator_getblockedcerthandle(void* lpObj, int blockedcertindex);
int secureblackbox_certificatevalidator_setblockedcerthandle(void* lpObj, int blockedcertindex, int64 lBlockedCertHandle);
int GetBlockedCertCount();
int SetBlockedCertCount(int iBlockedCertCount); QByteArray GetBlockedCertBytes(int iBlockedCertIndex); qint64 GetBlockedCertHandle(int iBlockedCertIndex);
int SetBlockedCertHandle(int iBlockedCertIndex, qint64 lBlockedCertHandle);
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.
Data Type
CacheValidationResults Property (CertificateValidator Class)
Enables or disables validation result caching.
Syntax
ANSI (Cross Platform) int GetCacheValidationResults();
int SetCacheValidationResults(int bCacheValidationResults); Unicode (Windows) BOOL GetCacheValidationResults();
INT SetCacheValidationResults(BOOL bCacheValidationResults);
int secureblackbox_certificatevalidator_getcachevalidationresults(void* lpObj);
int secureblackbox_certificatevalidator_setcachevalidationresults(void* lpObj, int bCacheValidationResults);
bool GetCacheValidationResults();
int SetCacheValidationResults(bool bCacheValidationResults);
Default Value
FALSE
Remarks
Set this property to True to enable caching of validation results.
Data Type
Boolean
Certificate Property (CertificateValidator Class)
The certificate to be validated.
Syntax
SecureBlackboxCertificate* GetCertificate(); int SetCertificate(SecureBlackboxCertificate* val);
int secureblackbox_certificatevalidator_getcertbytes(void* lpObj, char** lpCertBytes, int* lenCertBytes);
int64 secureblackbox_certificatevalidator_getcerthandle(void* lpObj);
int secureblackbox_certificatevalidator_setcerthandle(void* lpObj, int64 lCertHandle);
QByteArray GetCertBytes(); qint64 GetCertHandle();
int SetCertHandle(qint64 lCertHandle);
Remarks
Assign the certificate that needs to be validated to this property.
This property is not available at design time.
Data Type
ChainValidationDetails Property (CertificateValidator Class)
The details of a certificate chain validation outcome.
Syntax
ANSI (Cross Platform) int GetChainValidationDetails(); Unicode (Windows) INT GetChainValidationDetails();
int secureblackbox_certificatevalidator_getchainvalidationdetails(void* lpObj);
int GetChainValidationDetails();
Default Value
0
Remarks
Use the value(s) returned by this property to identify the reasons that contributed to the overall validation result.
Returns a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is read-only and not available at design time.
Data Type
Integer
ChainValidationResult Property (CertificateValidator Class)
The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result.
Syntax
ANSI (Cross Platform) int GetChainValidationResult(); Unicode (Windows) INT GetChainValidationResult();
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_certificatevalidator_getchainvalidationresult(void* lpObj);
int GetChainValidationResult();
Default Value
0
Remarks
Available options:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Use the ValidationLog property to access the detailed validation log.
This property is read-only and not available at design time.
Data Type
Integer
CheckTrustedLists Property (CertificateValidator Class)
Specifies whether the class should attempt to validate chain trust via a known Trusted List.
Syntax
ANSI (Cross Platform) int GetCheckTrustedLists();
int SetCheckTrustedLists(int bCheckTrustedLists); Unicode (Windows) BOOL GetCheckTrustedLists();
INT SetCheckTrustedLists(BOOL bCheckTrustedLists);
int secureblackbox_certificatevalidator_getchecktrustedlists(void* lpObj);
int secureblackbox_certificatevalidator_setchecktrustedlists(void* lpObj, int bCheckTrustedLists);
bool GetCheckTrustedLists();
int SetCheckTrustedLists(bool bCheckTrustedLists);
Default Value
FALSE
Remarks
Set this property to true to enable the component to validate chain trust against an internal list of known Trusted Lists (such as EUTL).
Data Type
Boolean
CurrentCACertificate Property (CertificateValidator Class)
The CA of the currently processed certificate.
Syntax
SecureBlackboxCertificate* GetCurrentCACertificate();
int secureblackbox_certificatevalidator_getcurrentcacertbytes(void* lpObj, char** lpCurrentCACertBytes, int* lenCurrentCACertBytes);
int secureblackbox_certificatevalidator_getcurrentcacertca(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertcakeyid(void* lpObj, char** lpCurrentCACertCAKeyID, int* lenCurrentCACertCAKeyID);
int secureblackbox_certificatevalidator_getcurrentcacertcerttype(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertcrldistributionpoints(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertcurve(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertfingerprint(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertfriendlyname(void* lpObj);
int64 secureblackbox_certificatevalidator_getcurrentcacerthandle(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacerthashalgorithm(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertissuer(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertissuerrdn(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertkeyalgorithm(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertkeybits(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertkeyfingerprint(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertkeyusage(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertkeyvalid(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertocsplocations(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertocspnocheck(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertorigin(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertpolicyids(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertprivatekeybytes(void* lpObj, char** lpCurrentCACertPrivateKeyBytes, int* lenCurrentCACertPrivateKeyBytes);
int secureblackbox_certificatevalidator_getcurrentcacertprivatekeyexists(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertprivatekeyextractable(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertpublickeybytes(void* lpObj, char** lpCurrentCACertPublicKeyBytes, int* lenCurrentCACertPublicKeyBytes);
int secureblackbox_certificatevalidator_getcurrentcacertqualified(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertqualifiedstatements(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertqualifiers(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertselfsigned(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertserialnumber(void* lpObj, char** lpCurrentCACertSerialNumber, int* lenCurrentCACertSerialNumber);
char* secureblackbox_certificatevalidator_getcurrentcacertsigalgorithm(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertsource(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertsubject(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertsubjectalternativename(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertsubjectkeyid(void* lpObj, char** lpCurrentCACertSubjectKeyID, int* lenCurrentCACertSubjectKeyID);
char* secureblackbox_certificatevalidator_getcurrentcacertsubjectrdn(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcacertvalid(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertvalidfrom(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcacertvalidto(void* lpObj);
QByteArray GetCurrentCACertBytes(); bool GetCurrentCACertCA(); QByteArray GetCurrentCACertCAKeyID(); int GetCurrentCACertCertType(); QString GetCurrentCACertCRLDistributionPoints(); QString GetCurrentCACertCurve(); QString GetCurrentCACertFingerprint(); QString GetCurrentCACertFriendlyName(); qint64 GetCurrentCACertHandle(); QString GetCurrentCACertHashAlgorithm(); QString GetCurrentCACertIssuer(); QString GetCurrentCACertIssuerRDN(); QString GetCurrentCACertKeyAlgorithm(); int GetCurrentCACertKeyBits(); QString GetCurrentCACertKeyFingerprint(); int GetCurrentCACertKeyUsage(); bool GetCurrentCACertKeyValid(); QString GetCurrentCACertOCSPLocations(); bool GetCurrentCACertOCSPNoCheck(); int GetCurrentCACertOrigin(); QString GetCurrentCACertPolicyIDs(); QByteArray GetCurrentCACertPrivateKeyBytes(); bool GetCurrentCACertPrivateKeyExists(); bool GetCurrentCACertPrivateKeyExtractable(); QByteArray GetCurrentCACertPublicKeyBytes(); bool GetCurrentCACertQualified(); int GetCurrentCACertQualifiedStatements(); QString GetCurrentCACertQualifiers(); bool GetCurrentCACertSelfSigned(); QByteArray GetCurrentCACertSerialNumber(); QString GetCurrentCACertSigAlgorithm(); int GetCurrentCACertSource(); QString GetCurrentCACertSubject(); QString GetCurrentCACertSubjectAlternativeName(); QByteArray GetCurrentCACertSubjectKeyID(); QString GetCurrentCACertSubjectRDN(); bool GetCurrentCACertValid(); QString GetCurrentCACertValidFrom(); QString GetCurrentCACertValidTo();
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.
Data Type
CurrentCertificate Property (CertificateValidator Class)
The certificate that is currently being processed.
Syntax
SecureBlackboxCertificate* GetCurrentCertificate();
int secureblackbox_certificatevalidator_getcurrentcertbytes(void* lpObj, char** lpCurrentCertBytes, int* lenCurrentCertBytes);
int secureblackbox_certificatevalidator_getcurrentcertca(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertcakeyid(void* lpObj, char** lpCurrentCertCAKeyID, int* lenCurrentCertCAKeyID);
int secureblackbox_certificatevalidator_getcurrentcertcerttype(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertcrldistributionpoints(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertcurve(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertfingerprint(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertfriendlyname(void* lpObj);
int64 secureblackbox_certificatevalidator_getcurrentcerthandle(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcerthashalgorithm(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertissuer(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertissuerrdn(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertkeyalgorithm(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertkeybits(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertkeyfingerprint(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertkeyusage(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertkeyvalid(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertocsplocations(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertocspnocheck(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertorigin(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertpolicyids(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertprivatekeybytes(void* lpObj, char** lpCurrentCertPrivateKeyBytes, int* lenCurrentCertPrivateKeyBytes);
int secureblackbox_certificatevalidator_getcurrentcertprivatekeyexists(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertprivatekeyextractable(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertpublickeybytes(void* lpObj, char** lpCurrentCertPublicKeyBytes, int* lenCurrentCertPublicKeyBytes);
int secureblackbox_certificatevalidator_getcurrentcertqualified(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertqualifiedstatements(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertqualifiers(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertselfsigned(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertserialnumber(void* lpObj, char** lpCurrentCertSerialNumber, int* lenCurrentCertSerialNumber);
char* secureblackbox_certificatevalidator_getcurrentcertsigalgorithm(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertsource(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertsubject(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertsubjectalternativename(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertsubjectkeyid(void* lpObj, char** lpCurrentCertSubjectKeyID, int* lenCurrentCertSubjectKeyID);
char* secureblackbox_certificatevalidator_getcurrentcertsubjectrdn(void* lpObj);
int secureblackbox_certificatevalidator_getcurrentcertvalid(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertvalidfrom(void* lpObj);
char* secureblackbox_certificatevalidator_getcurrentcertvalidto(void* lpObj);
QByteArray GetCurrentCertBytes(); bool GetCurrentCertCA(); QByteArray GetCurrentCertCAKeyID(); int GetCurrentCertCertType(); QString GetCurrentCertCRLDistributionPoints(); QString GetCurrentCertCurve(); QString GetCurrentCertFingerprint(); QString GetCurrentCertFriendlyName(); qint64 GetCurrentCertHandle(); QString GetCurrentCertHashAlgorithm(); QString GetCurrentCertIssuer(); QString GetCurrentCertIssuerRDN(); QString GetCurrentCertKeyAlgorithm(); int GetCurrentCertKeyBits(); QString GetCurrentCertKeyFingerprint(); int GetCurrentCertKeyUsage(); bool GetCurrentCertKeyValid(); QString GetCurrentCertOCSPLocations(); bool GetCurrentCertOCSPNoCheck(); int GetCurrentCertOrigin(); QString GetCurrentCertPolicyIDs(); QByteArray GetCurrentCertPrivateKeyBytes(); bool GetCurrentCertPrivateKeyExists(); bool GetCurrentCertPrivateKeyExtractable(); QByteArray GetCurrentCertPublicKeyBytes(); bool GetCurrentCertQualified(); int GetCurrentCertQualifiedStatements(); QString GetCurrentCertQualifiers(); bool GetCurrentCertSelfSigned(); QByteArray GetCurrentCertSerialNumber(); QString GetCurrentCertSigAlgorithm(); int GetCurrentCertSource(); QString GetCurrentCertSubject(); QString GetCurrentCertSubjectAlternativeName(); QByteArray GetCurrentCertSubjectKeyID(); QString GetCurrentCertSubjectRDN(); bool GetCurrentCertValid(); QString GetCurrentCertValidFrom(); QString GetCurrentCertValidTo();
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.
Data Type
FIPSMode Property (CertificateValidator Class)
Reserved.
Syntax
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_certificatevalidator_getfipsmode(void* lpObj);
int secureblackbox_certificatevalidator_setfipsmode(void* lpObj, int bFIPSMode);
bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);
Default Value
FALSE
Remarks
This property is reserved for future use.
Data Type
Boolean
GracePeriod Property (CertificateValidator Class)
Specifies a grace period to apply during certificate validation.
Syntax
ANSI (Cross Platform) int GetGracePeriod();
int SetGracePeriod(int iGracePeriod); Unicode (Windows) INT GetGracePeriod();
INT SetGracePeriod(INT iGracePeriod);
int secureblackbox_certificatevalidator_getgraceperiod(void* lpObj);
int secureblackbox_certificatevalidator_setgraceperiod(void* lpObj, int iGracePeriod);
int GetGracePeriod();
int SetGracePeriod(int iGracePeriod);
Default Value
0
Remarks
Use this property to specify a grace period (in seconds). Grace period applies to certain subprotocols, such as OCSP, and caters to the inaccuracy and/or missynchronization of clocks on different participating systems. Any time deviations within the grace period will be tolerated.
Data Type
Integer
InterimValidationDetails Property (CertificateValidator Class)
Contains the validation details of the moment.
Syntax
ANSI (Cross Platform) int GetInterimValidationDetails();
int SetInterimValidationDetails(int iInterimValidationDetails); Unicode (Windows) INT GetInterimValidationDetails();
INT SetInterimValidationDetails(INT iInterimValidationDetails);
int secureblackbox_certificatevalidator_getinterimvalidationdetails(void* lpObj);
int secureblackbox_certificatevalidator_setinterimvalidationdetails(void* lpObj, int iInterimValidationDetails);
int GetInterimValidationDetails();
int SetInterimValidationDetails(int iInterimValidationDetails);
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity details mid-flight.
The value of this property is a bit mask of the following options:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
This property is not available at design time.
Data Type
Integer
InterimValidationResult Property (CertificateValidator Class)
Contains the validation status of the moment.
Syntax
ANSI (Cross Platform) int GetInterimValidationResult();
int SetInterimValidationResult(int iInterimValidationResult); Unicode (Windows) INT GetInterimValidationResult();
INT SetInterimValidationResult(INT iInterimValidationResult);
Possible Values
CVT_VALID(0),
CVT_VALID_BUT_UNTRUSTED(1),
CVT_INVALID(2),
CVT_CANT_BE_ESTABLISHED(3)
int secureblackbox_certificatevalidator_getinterimvalidationresult(void* lpObj);
int secureblackbox_certificatevalidator_setinterimvalidationresult(void* lpObj, int iInterimValidationResult);
int GetInterimValidationResult();
int SetInterimValidationResult(int iInterimValidationResult);
Default Value
0
Remarks
Over the course of the validation process, the validator maintains an interim validity status for the chain that is being processed. This status is influenced by every single step of the validation routine, and may change along the way, before the end of the chain is reached and the final validation conclusion is drawn.
Use this property to check the interim validity status mid-flight.
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
This property is not available at design time.
Data Type
Integer
KnownCertificates Property (CertificateValidator Class)
Additional certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_certificatevalidator_getknowncertcount(void* lpObj);
int secureblackbox_certificatevalidator_setknowncertcount(void* lpObj, int iKnownCertCount);
int secureblackbox_certificatevalidator_getknowncertbytes(void* lpObj, int knowncertindex, char** lpKnownCertBytes, int* lenKnownCertBytes);
int64 secureblackbox_certificatevalidator_getknowncerthandle(void* lpObj, int knowncertindex);
int secureblackbox_certificatevalidator_setknowncerthandle(void* lpObj, int knowncertindex, int64 lKnownCertHandle);
int GetKnownCertCount();
int SetKnownCertCount(int iKnownCertCount); QByteArray GetKnownCertBytes(int iKnownCertIndex); qint64 GetKnownCertHandle(int iKnownCertIndex);
int SetKnownCertHandle(int iKnownCertIndex, qint64 lKnownCertHandle);
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 class 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 instead.
This property is not available at design time.
Data Type
KnownCRLs Property (CertificateValidator Class)
Additional CRLs for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetKnownCRLs(); int SetKnownCRLs(SecureBlackboxList<SecureBlackboxCRL>* val);
int secureblackbox_certificatevalidator_getknowncrlcount(void* lpObj);
int secureblackbox_certificatevalidator_setknowncrlcount(void* lpObj, int iKnownCRLCount);
int secureblackbox_certificatevalidator_getknowncrlbytes(void* lpObj, int knowncrlindex, char** lpKnownCRLBytes, int* lenKnownCRLBytes);
int64 secureblackbox_certificatevalidator_getknowncrlhandle(void* lpObj, int knowncrlindex);
int secureblackbox_certificatevalidator_setknowncrlhandle(void* lpObj, int knowncrlindex, int64 lKnownCRLHandle);
int GetKnownCRLCount();
int SetKnownCRLCount(int iKnownCRLCount); QByteArray GetKnownCRLBytes(int iKnownCRLIndex); qint64 GetKnownCRLHandle(int iKnownCRLIndex);
int SetKnownCRLHandle(int iKnownCRLIndex, qint64 lKnownCRLHandle);
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.
Data Type
KnownOCSPs Property (CertificateValidator Class)
Additional OCSP responses for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetKnownOCSPs(); int SetKnownOCSPs(SecureBlackboxList<SecureBlackboxOCSPResponse>* val);
int secureblackbox_certificatevalidator_getknownocspcount(void* lpObj);
int secureblackbox_certificatevalidator_setknownocspcount(void* lpObj, int iKnownOCSPCount);
int secureblackbox_certificatevalidator_getknownocspbytes(void* lpObj, int knownocspindex, char** lpKnownOCSPBytes, int* lenKnownOCSPBytes);
int64 secureblackbox_certificatevalidator_getknownocsphandle(void* lpObj, int knownocspindex);
int secureblackbox_certificatevalidator_setknownocsphandle(void* lpObj, int knownocspindex, int64 lKnownOCSPHandle);
int GetKnownOCSPCount();
int SetKnownOCSPCount(int iKnownOCSPCount); QByteArray GetKnownOCSPBytes(int iKnownOCSPIndex); qint64 GetKnownOCSPHandle(int iKnownOCSPIndex);
int SetKnownOCSPHandle(int iKnownOCSPIndex, qint64 lKnownOCSPHandle);
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.
Data Type
MaxValidationTime Property (CertificateValidator Class)
Specifies the maximum time the validation process may take.
Syntax
ANSI (Cross Platform) int GetMaxValidationTime();
int SetMaxValidationTime(int iMaxValidationTime); Unicode (Windows) INT GetMaxValidationTime();
INT SetMaxValidationTime(INT iMaxValidationTime);
int secureblackbox_certificatevalidator_getmaxvalidationtime(void* lpObj);
int secureblackbox_certificatevalidator_setmaxvalidationtime(void* lpObj, int iMaxValidationTime);
int GetMaxValidationTime();
int SetMaxValidationTime(int iMaxValidationTime);
Default Value
0
Remarks
Use this property to limit the amount of time available for the validator to carry out the validation. If the validation process exceeds this time, it is terminated and the validation error is returned.
Data Type
Integer
OfflineMode Property (CertificateValidator Class)
Switches the class to offline mode.
Syntax
ANSI (Cross Platform) int GetOfflineMode();
int SetOfflineMode(int bOfflineMode); Unicode (Windows) BOOL GetOfflineMode();
INT SetOfflineMode(BOOL bOfflineMode);
int secureblackbox_certificatevalidator_getofflinemode(void* lpObj);
int secureblackbox_certificatevalidator_setofflinemode(void* lpObj, int bOfflineMode);
bool GetOfflineMode();
int SetOfflineMode(bool bOfflineMode);
Default Value
FALSE
Remarks
When working in offline mode, the class restricts itself from using any online revocation information sources, such as CRL or OCSP responders.
Offline mode may be useful if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCertificates, KnownCRLs, and other related properties.
Data Type
Boolean
Proxy Property (CertificateValidator Class)
The proxy server settings.
Syntax
SecureBlackboxProxySettings* GetProxy();
char* secureblackbox_certificatevalidator_getproxyaddress(void* lpObj);
int secureblackbox_certificatevalidator_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
int secureblackbox_certificatevalidator_getproxyauthentication(void* lpObj);
int secureblackbox_certificatevalidator_setproxyauthentication(void* lpObj, int iProxyAuthentication);
char* secureblackbox_certificatevalidator_getproxypassword(void* lpObj);
int secureblackbox_certificatevalidator_setproxypassword(void* lpObj, const char* lpszProxyPassword);
int secureblackbox_certificatevalidator_getproxyport(void* lpObj);
int secureblackbox_certificatevalidator_setproxyport(void* lpObj, int iProxyPort);
int secureblackbox_certificatevalidator_getproxyproxytype(void* lpObj);
int secureblackbox_certificatevalidator_setproxyproxytype(void* lpObj, int iProxyProxyType);
char* secureblackbox_certificatevalidator_getproxyrequestheaders(void* lpObj);
int secureblackbox_certificatevalidator_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
char* secureblackbox_certificatevalidator_getproxyresponsebody(void* lpObj);
int secureblackbox_certificatevalidator_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
char* secureblackbox_certificatevalidator_getproxyresponseheaders(void* lpObj);
int secureblackbox_certificatevalidator_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
int secureblackbox_certificatevalidator_getproxyuseipv6(void* lpObj);
int secureblackbox_certificatevalidator_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
char* secureblackbox_certificatevalidator_getproxyusername(void* lpObj);
int secureblackbox_certificatevalidator_setproxyusername(void* lpObj, const char* lpszProxyUsername);
QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress); int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword); int GetProxyPort();
int SetProxyPort(int iProxyPort); int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders); QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody); QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders); bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6); QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);
Remarks
Use this property to tune up the proxy server settings.
This property is read-only.
Data Type
QualifiedInfo Property (CertificateValidator Class)
The qualified details for the validated certificate.
Syntax
SecureBlackboxQualifiedInfo* GetQualifiedInfo();
char* secureblackbox_certificatevalidator_getqualifiedinfoaddress(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfocustomtrustedlists(void* lpObj);
int secureblackbox_certificatevalidator_setqualifiedinfocustomtrustedlists(void* lpObj, const char* lpszQualifiedInfoCustomTrustedLists);
char* secureblackbox_certificatevalidator_getqualifiedinfodownloadlog(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfoinformationuri(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfolanguages(void* lpObj);
int secureblackbox_certificatevalidator_setqualifiedinfolanguages(void* lpObj, const char* lpszQualifiedInfoLanguages);
char* secureblackbox_certificatevalidator_getqualifiedinfonextupdate(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfoprovider(void* lpObj);
int secureblackbox_certificatevalidator_getqualifiedinfoqualified(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfoqualifiers(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfoservicename(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfoservicetypeid(void* lpObj);
int secureblackbox_certificatevalidator_getqualifiedinfosource(void* lpObj);
int secureblackbox_certificatevalidator_getqualifiedinfostatus(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfotradename(void* lpObj);
int secureblackbox_certificatevalidator_getqualifiedinfotrusted(void* lpObj);
int secureblackbox_certificatevalidator_getqualifiedinfousedefaulttrustedlists(void* lpObj);
int secureblackbox_certificatevalidator_setqualifiedinfousedefaulttrustedlists(void* lpObj, int bQualifiedInfoUseDefaultTrustedLists);
char* secureblackbox_certificatevalidator_getqualifiedinfovalidationlog(void* lpObj);
char* secureblackbox_certificatevalidator_getqualifiedinfoxml(void* lpObj);
QString GetQualifiedInfoAddress(); QString GetQualifiedInfoCustomTrustedLists();
int SetQualifiedInfoCustomTrustedLists(QString qsQualifiedInfoCustomTrustedLists); QString GetQualifiedInfoDownloadLog(); QString GetQualifiedInfoInformationURI(); QString GetQualifiedInfoLanguages();
int SetQualifiedInfoLanguages(QString qsQualifiedInfoLanguages); QString GetQualifiedInfoNextUpdate(); QString GetQualifiedInfoProvider(); bool GetQualifiedInfoQualified(); QString GetQualifiedInfoQualifiers(); QString GetQualifiedInfoServiceName(); QString GetQualifiedInfoServiceTypeId(); int GetQualifiedInfoSource(); int GetQualifiedInfoStatus(); QString GetQualifiedInfoTradeName(); bool GetQualifiedInfoTrusted(); bool GetQualifiedInfoUseDefaultTrustedLists();
int SetQualifiedInfoUseDefaultTrustedLists(bool bQualifiedInfoUseDefaultTrustedLists); QString GetQualifiedInfoValidationLog(); QString GetQualifiedInfoXML();
Remarks
Use this property to check the qualified information for Certificate. The contents of this property is updated upon completion of the full validation routine performed by the Validate method (if the qualified check is enabled) or after the GetQualifiedStatus call.
This property is read-only.
Data Type
RevocationCheck Property (CertificateValidator Class)
Specifies the kind(s) of revocation check to perform for all chain certificates.
Syntax
ANSI (Cross Platform) int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck); Unicode (Windows) INT GetRevocationCheck();
INT SetRevocationCheck(INT iRevocationCheck);
Possible Values
CRC_NONE(0),
CRC_AUTO(1),
CRC_ALL_CRL(2),
CRC_ALL_OCSP(3),
CRC_ALL_CRLAND_OCSP(4),
CRC_ANY_CRL(5),
CRC_ANY_OCSP(6),
CRC_ANY_CRLOR_OCSP(7),
CRC_ANY_OCSPOR_CRL(8)
int secureblackbox_certificatevalidator_getrevocationcheck(void* lpObj);
int secureblackbox_certificatevalidator_setrevocationcheck(void* lpObj, int iRevocationCheck);
int GetRevocationCheck();
int SetRevocationCheck(int iRevocationCheck);
Default Value
1
Remarks
Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.
Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate had not been revoked by the Certificate Authority (CA) at the time of use. Depending on your circumstances and security policy requirements, you may want to use either one or both of the revocation information source types.
crcNone | 0 | No revocation checking. |
crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |
This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.
There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).
This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.
Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.
Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.
Data Type
Integer
SocketSettings Property (CertificateValidator Class)
Manages network connection settings.
Syntax
SecureBlackboxSocketSettings* GetSocketSettings();
int secureblackbox_certificatevalidator_getsocketdnsmode(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int secureblackbox_certificatevalidator_getsocketdnsport(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int secureblackbox_certificatevalidator_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
char* secureblackbox_certificatevalidator_getsocketdnsservers(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
int secureblackbox_certificatevalidator_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_certificatevalidator_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int secureblackbox_certificatevalidator_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_certificatevalidator_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
char* secureblackbox_certificatevalidator_getsocketlocaladdress(void* lpObj);
int secureblackbox_certificatevalidator_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
int secureblackbox_certificatevalidator_getsocketlocalport(void* lpObj);
int secureblackbox_certificatevalidator_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int secureblackbox_certificatevalidator_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_certificatevalidator_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int secureblackbox_certificatevalidator_getsockettimeout(void* lpObj);
int secureblackbox_certificatevalidator_setsockettimeout(void* lpObj, int iSocketTimeout);
int secureblackbox_certificatevalidator_getsocketuseipv6(void* lpObj);
int secureblackbox_certificatevalidator_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers); int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress); int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);
Remarks
Use this property to tune up network connection parameters.
This property is read-only.
Data Type
TLSClientChain Property (CertificateValidator Class)
The TLS client certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSClientChain(); int SetTLSClientChain(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_certificatevalidator_gettlsclientcertcount(void* lpObj);
int secureblackbox_certificatevalidator_settlsclientcertcount(void* lpObj, int iTLSClientCertCount);
int secureblackbox_certificatevalidator_gettlsclientcertbytes(void* lpObj, int tlsclientcertindex, char** lpTLSClientCertBytes, int* lenTLSClientCertBytes);
int64 secureblackbox_certificatevalidator_gettlsclientcerthandle(void* lpObj, int tlsclientcertindex);
int secureblackbox_certificatevalidator_settlsclientcerthandle(void* lpObj, int tlsclientcertindex, int64 lTLSClientCertHandle);
int GetTLSClientCertCount();
int SetTLSClientCertCount(int iTLSClientCertCount); QByteArray GetTLSClientCertBytes(int iTLSClientCertIndex); qint64 GetTLSClientCertHandle(int iTLSClientCertIndex);
int SetTLSClientCertHandle(int iTLSClientCertIndex, qint64 lTLSClientCertHandle);
Remarks
Assign a certificate chain to this property to enable TLS client authentication in the class. Note that the client's end-entity certificate should have a private key associated with it.
Use the CertificateStorage or CertificateManager components to import the certificate from a file, system store, or PKCS11 device.
This property is not available at design time.
Data Type
TLSServerChain Property (CertificateValidator Class)
The TLS server's certificate chain.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTLSServerChain();
int secureblackbox_certificatevalidator_gettlsservercertcount(void* lpObj);
int secureblackbox_certificatevalidator_gettlsservercertbytes(void* lpObj, int tlsservercertindex, char** lpTLSServerCertBytes, int* lenTLSServerCertBytes);
char* secureblackbox_certificatevalidator_gettlsservercertfingerprint(void* lpObj, int tlsservercertindex);
int64 secureblackbox_certificatevalidator_gettlsservercerthandle(void* lpObj, int tlsservercertindex);
char* secureblackbox_certificatevalidator_gettlsservercertissuer(void* lpObj, int tlsservercertindex);
char* secureblackbox_certificatevalidator_gettlsservercertissuerrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_certificatevalidator_gettlsservercertkeyalgorithm(void* lpObj, int tlsservercertindex);
int secureblackbox_certificatevalidator_gettlsservercertkeybits(void* lpObj, int tlsservercertindex);
int secureblackbox_certificatevalidator_gettlsservercertkeyusage(void* lpObj, int tlsservercertindex);
int secureblackbox_certificatevalidator_gettlsservercertselfsigned(void* lpObj, int tlsservercertindex);
int secureblackbox_certificatevalidator_gettlsservercertserialnumber(void* lpObj, int tlsservercertindex, char** lpTLSServerCertSerialNumber, int* lenTLSServerCertSerialNumber);
char* secureblackbox_certificatevalidator_gettlsservercertsigalgorithm(void* lpObj, int tlsservercertindex);
char* secureblackbox_certificatevalidator_gettlsservercertsubject(void* lpObj, int tlsservercertindex);
char* secureblackbox_certificatevalidator_gettlsservercertsubjectrdn(void* lpObj, int tlsservercertindex);
char* secureblackbox_certificatevalidator_gettlsservercertvalidfrom(void* lpObj, int tlsservercertindex);
char* secureblackbox_certificatevalidator_gettlsservercertvalidto(void* lpObj, int tlsservercertindex);
int GetTLSServerCertCount(); QByteArray GetTLSServerCertBytes(int iTLSServerCertIndex); QString GetTLSServerCertFingerprint(int iTLSServerCertIndex); qint64 GetTLSServerCertHandle(int iTLSServerCertIndex); QString GetTLSServerCertIssuer(int iTLSServerCertIndex); QString GetTLSServerCertIssuerRDN(int iTLSServerCertIndex); QString GetTLSServerCertKeyAlgorithm(int iTLSServerCertIndex); int GetTLSServerCertKeyBits(int iTLSServerCertIndex); int GetTLSServerCertKeyUsage(int iTLSServerCertIndex); bool GetTLSServerCertSelfSigned(int iTLSServerCertIndex); QByteArray GetTLSServerCertSerialNumber(int iTLSServerCertIndex); QString GetTLSServerCertSigAlgorithm(int iTLSServerCertIndex); QString GetTLSServerCertSubject(int iTLSServerCertIndex); QString GetTLSServerCertSubjectRDN(int iTLSServerCertIndex); QString GetTLSServerCertValidFrom(int iTLSServerCertIndex); QString GetTLSServerCertValidTo(int iTLSServerCertIndex);
Remarks
Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the TLSCertValidate event is fired by the client component.
This property is read-only and not available at design time.
Data Type
TLSSettings Property (CertificateValidator Class)
Manages TLS layer settings.
Syntax
SecureBlackboxTLSSettings* GetTLSSettings();
int secureblackbox_certificatevalidator_gettlsautovalidatecertificates(void* lpObj);
int secureblackbox_certificatevalidator_settlsautovalidatecertificates(void* lpObj, int bTLSAutoValidateCertificates);
int secureblackbox_certificatevalidator_gettlsbaseconfiguration(void* lpObj);
int secureblackbox_certificatevalidator_settlsbaseconfiguration(void* lpObj, int iTLSBaseConfiguration);
char* secureblackbox_certificatevalidator_gettlsciphersuites(void* lpObj);
int secureblackbox_certificatevalidator_settlsciphersuites(void* lpObj, const char* lpszTLSCiphersuites);
int secureblackbox_certificatevalidator_gettlsclientauth(void* lpObj);
int secureblackbox_certificatevalidator_settlsclientauth(void* lpObj, int iTLSClientAuth);
char* secureblackbox_certificatevalidator_gettlseccurves(void* lpObj);
int secureblackbox_certificatevalidator_settlseccurves(void* lpObj, const char* lpszTLSECCurves);
char* secureblackbox_certificatevalidator_gettlsextensions(void* lpObj);
int secureblackbox_certificatevalidator_settlsextensions(void* lpObj, const char* lpszTLSExtensions);
int secureblackbox_certificatevalidator_gettlsforceresumeifdestinationchanges(void* lpObj);
int secureblackbox_certificatevalidator_settlsforceresumeifdestinationchanges(void* lpObj, int bTLSForceResumeIfDestinationChanges);
char* secureblackbox_certificatevalidator_gettlspresharedidentity(void* lpObj);
int secureblackbox_certificatevalidator_settlspresharedidentity(void* lpObj, const char* lpszTLSPreSharedIdentity);
char* secureblackbox_certificatevalidator_gettlspresharedkey(void* lpObj);
int secureblackbox_certificatevalidator_settlspresharedkey(void* lpObj, const char* lpszTLSPreSharedKey);
char* secureblackbox_certificatevalidator_gettlspresharedkeyciphersuite(void* lpObj);
int secureblackbox_certificatevalidator_settlspresharedkeyciphersuite(void* lpObj, const char* lpszTLSPreSharedKeyCiphersuite);
int secureblackbox_certificatevalidator_gettlsrenegotiationattackpreventionmode(void* lpObj);
int secureblackbox_certificatevalidator_settlsrenegotiationattackpreventionmode(void* lpObj, int iTLSRenegotiationAttackPreventionMode);
int secureblackbox_certificatevalidator_gettlsrevocationcheck(void* lpObj);
int secureblackbox_certificatevalidator_settlsrevocationcheck(void* lpObj, int iTLSRevocationCheck);
int secureblackbox_certificatevalidator_gettlsssloptions(void* lpObj);
int secureblackbox_certificatevalidator_settlsssloptions(void* lpObj, int iTLSSSLOptions);
int secureblackbox_certificatevalidator_gettlstlsmode(void* lpObj);
int secureblackbox_certificatevalidator_settlstlsmode(void* lpObj, int iTLSTLSMode);
int secureblackbox_certificatevalidator_gettlsuseextendedmastersecret(void* lpObj);
int secureblackbox_certificatevalidator_settlsuseextendedmastersecret(void* lpObj, int bTLSUseExtendedMasterSecret);
int secureblackbox_certificatevalidator_gettlsusesessionresumption(void* lpObj);
int secureblackbox_certificatevalidator_settlsusesessionresumption(void* lpObj, int bTLSUseSessionResumption);
int secureblackbox_certificatevalidator_gettlsversions(void* lpObj);
int secureblackbox_certificatevalidator_settlsversions(void* lpObj, int iTLSVersions);
bool GetTLSAutoValidateCertificates();
int SetTLSAutoValidateCertificates(bool bTLSAutoValidateCertificates); int GetTLSBaseConfiguration();
int SetTLSBaseConfiguration(int iTLSBaseConfiguration); QString GetTLSCiphersuites();
int SetTLSCiphersuites(QString qsTLSCiphersuites); int GetTLSClientAuth();
int SetTLSClientAuth(int iTLSClientAuth); QString GetTLSECCurves();
int SetTLSECCurves(QString qsTLSECCurves); QString GetTLSExtensions();
int SetTLSExtensions(QString qsTLSExtensions); bool GetTLSForceResumeIfDestinationChanges();
int SetTLSForceResumeIfDestinationChanges(bool bTLSForceResumeIfDestinationChanges); QString GetTLSPreSharedIdentity();
int SetTLSPreSharedIdentity(QString qsTLSPreSharedIdentity); QString GetTLSPreSharedKey();
int SetTLSPreSharedKey(QString qsTLSPreSharedKey); QString GetTLSPreSharedKeyCiphersuite();
int SetTLSPreSharedKeyCiphersuite(QString qsTLSPreSharedKeyCiphersuite); int GetTLSRenegotiationAttackPreventionMode();
int SetTLSRenegotiationAttackPreventionMode(int iTLSRenegotiationAttackPreventionMode); int GetTLSRevocationCheck();
int SetTLSRevocationCheck(int iTLSRevocationCheck); int GetTLSSSLOptions();
int SetTLSSSLOptions(int iTLSSSLOptions); int GetTLSTLSMode();
int SetTLSTLSMode(int iTLSTLSMode); bool GetTLSUseExtendedMasterSecret();
int SetTLSUseExtendedMasterSecret(bool bTLSUseExtendedMasterSecret); bool GetTLSUseSessionResumption();
int SetTLSUseSessionResumption(bool bTLSUseSessionResumption); int GetTLSVersions();
int SetTLSVersions(int iTLSVersions);
Remarks
Use this property to tune up the TLS layer parameters.
This property is read-only.
Data Type
TrustedCertificates Property (CertificateValidator Class)
A list of trusted certificates for chain validation.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetTrustedCertificates(); int SetTrustedCertificates(SecureBlackboxList<SecureBlackboxCertificate>* val);
int secureblackbox_certificatevalidator_gettrustedcertcount(void* lpObj);
int secureblackbox_certificatevalidator_settrustedcertcount(void* lpObj, int iTrustedCertCount);
int secureblackbox_certificatevalidator_gettrustedcertbytes(void* lpObj, int trustedcertindex, char** lpTrustedCertBytes, int* lenTrustedCertBytes);
int64 secureblackbox_certificatevalidator_gettrustedcerthandle(void* lpObj, int trustedcertindex);
int secureblackbox_certificatevalidator_settrustedcerthandle(void* lpObj, int trustedcertindex, int64 lTrustedCertHandle);
int GetTrustedCertCount();
int SetTrustedCertCount(int iTrustedCertCount); QByteArray GetTrustedCertBytes(int iTrustedCertIndex); qint64 GetTrustedCertHandle(int iTrustedCertIndex);
int SetTrustedCertHandle(int iTrustedCertIndex, qint64 lTrustedCertHandle);
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.
Data Type
UsedCertificates Property (CertificateValidator Class)
Contains a list of certificates used during the chain validation routine.
Syntax
SecureBlackboxList<SecureBlackboxCertificate>* GetUsedCertificates();
int secureblackbox_certificatevalidator_getusedcertcount(void* lpObj);
int secureblackbox_certificatevalidator_getusedcertbytes(void* lpObj, int usedcertindex, char** lpUsedCertBytes, int* lenUsedCertBytes);
int secureblackbox_certificatevalidator_getusedcertca(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertcakeyid(void* lpObj, int usedcertindex, char** lpUsedCertCAKeyID, int* lenUsedCertCAKeyID);
int secureblackbox_certificatevalidator_getusedcertcerttype(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertcrldistributionpoints(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertcurve(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertfingerprint(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertfriendlyname(void* lpObj, int usedcertindex);
int64 secureblackbox_certificatevalidator_getusedcerthandle(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcerthashalgorithm(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertissuer(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertissuerrdn(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertkeyalgorithm(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertkeybits(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertkeyfingerprint(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertkeyusage(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertkeyvalid(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertocsplocations(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertocspnocheck(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertorigin(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertpolicyids(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertprivatekeybytes(void* lpObj, int usedcertindex, char** lpUsedCertPrivateKeyBytes, int* lenUsedCertPrivateKeyBytes);
int secureblackbox_certificatevalidator_getusedcertprivatekeyexists(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertprivatekeyextractable(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertpublickeybytes(void* lpObj, int usedcertindex, char** lpUsedCertPublicKeyBytes, int* lenUsedCertPublicKeyBytes);
int secureblackbox_certificatevalidator_getusedcertqualified(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertqualifiedstatements(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertqualifiers(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertselfsigned(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertserialnumber(void* lpObj, int usedcertindex, char** lpUsedCertSerialNumber, int* lenUsedCertSerialNumber);
char* secureblackbox_certificatevalidator_getusedcertsigalgorithm(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertsource(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertsubject(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertsubjectalternativename(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertsubjectkeyid(void* lpObj, int usedcertindex, char** lpUsedCertSubjectKeyID, int* lenUsedCertSubjectKeyID);
char* secureblackbox_certificatevalidator_getusedcertsubjectrdn(void* lpObj, int usedcertindex);
int secureblackbox_certificatevalidator_getusedcertvalid(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertvalidfrom(void* lpObj, int usedcertindex);
char* secureblackbox_certificatevalidator_getusedcertvalidto(void* lpObj, int usedcertindex);
int GetUsedCertCount(); QByteArray GetUsedCertBytes(int iUsedCertIndex); bool GetUsedCertCA(int iUsedCertIndex); QByteArray GetUsedCertCAKeyID(int iUsedCertIndex); int GetUsedCertCertType(int iUsedCertIndex); QString GetUsedCertCRLDistributionPoints(int iUsedCertIndex); QString GetUsedCertCurve(int iUsedCertIndex); QString GetUsedCertFingerprint(int iUsedCertIndex); QString GetUsedCertFriendlyName(int iUsedCertIndex); qint64 GetUsedCertHandle(int iUsedCertIndex); QString GetUsedCertHashAlgorithm(int iUsedCertIndex); QString GetUsedCertIssuer(int iUsedCertIndex); QString GetUsedCertIssuerRDN(int iUsedCertIndex); QString GetUsedCertKeyAlgorithm(int iUsedCertIndex); int GetUsedCertKeyBits(int iUsedCertIndex); QString GetUsedCertKeyFingerprint(int iUsedCertIndex); int GetUsedCertKeyUsage(int iUsedCertIndex); bool GetUsedCertKeyValid(int iUsedCertIndex); QString GetUsedCertOCSPLocations(int iUsedCertIndex); bool GetUsedCertOCSPNoCheck(int iUsedCertIndex); int GetUsedCertOrigin(int iUsedCertIndex); QString GetUsedCertPolicyIDs(int iUsedCertIndex); QByteArray GetUsedCertPrivateKeyBytes(int iUsedCertIndex); bool GetUsedCertPrivateKeyExists(int iUsedCertIndex); bool GetUsedCertPrivateKeyExtractable(int iUsedCertIndex); QByteArray GetUsedCertPublicKeyBytes(int iUsedCertIndex); bool GetUsedCertQualified(int iUsedCertIndex); int GetUsedCertQualifiedStatements(int iUsedCertIndex); QString GetUsedCertQualifiers(int iUsedCertIndex); bool GetUsedCertSelfSigned(int iUsedCertIndex); QByteArray GetUsedCertSerialNumber(int iUsedCertIndex); QString GetUsedCertSigAlgorithm(int iUsedCertIndex); int GetUsedCertSource(int iUsedCertIndex); QString GetUsedCertSubject(int iUsedCertIndex); QString GetUsedCertSubjectAlternativeName(int iUsedCertIndex); QByteArray GetUsedCertSubjectKeyID(int iUsedCertIndex); QString GetUsedCertSubjectRDN(int iUsedCertIndex); bool GetUsedCertValid(int iUsedCertIndex); QString GetUsedCertValidFrom(int iUsedCertIndex); QString GetUsedCertValidTo(int iUsedCertIndex);
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.
Data Type
UsedCRLs Property (CertificateValidator Class)
Contains a list of CRLs used during the chain validation routine.
Syntax
SecureBlackboxList<SecureBlackboxCRL>* GetUsedCRLs();
int secureblackbox_certificatevalidator_getusedcrlcount(void* lpObj);
int secureblackbox_certificatevalidator_getusedcrlbytes(void* lpObj, int usedcrlindex, char** lpUsedCRLBytes, int* lenUsedCRLBytes);
int64 secureblackbox_certificatevalidator_getusedcrlhandle(void* lpObj, int usedcrlindex);
char* secureblackbox_certificatevalidator_getusedcrlissuer(void* lpObj, int usedcrlindex);
char* secureblackbox_certificatevalidator_getusedcrlissuerrdn(void* lpObj, int usedcrlindex);
char* secureblackbox_certificatevalidator_getusedcrllocation(void* lpObj, int usedcrlindex);
char* secureblackbox_certificatevalidator_getusedcrlnextupdate(void* lpObj, int usedcrlindex);
int secureblackbox_certificatevalidator_getusedcrlsource(void* lpObj, int usedcrlindex);
char* secureblackbox_certificatevalidator_getusedcrlthisupdate(void* lpObj, int usedcrlindex);
int GetUsedCRLCount(); QByteArray GetUsedCRLBytes(int iUsedCRLIndex); qint64 GetUsedCRLHandle(int iUsedCRLIndex); QString GetUsedCRLIssuer(int iUsedCRLIndex); QString GetUsedCRLIssuerRDN(int iUsedCRLIndex); QString GetUsedCRLLocation(int iUsedCRLIndex); QString GetUsedCRLNextUpdate(int iUsedCRLIndex); int GetUsedCRLSource(int iUsedCRLIndex); QString GetUsedCRLThisUpdate(int iUsedCRLIndex);
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.
Data Type
UsedOCSPs Property (CertificateValidator Class)
Contains a list of OCSP responses used during the chain validation routine.
Syntax
SecureBlackboxList<SecureBlackboxOCSPResponse>* GetUsedOCSPs();
int secureblackbox_certificatevalidator_getusedocspcount(void* lpObj);
int secureblackbox_certificatevalidator_getusedocspbytes(void* lpObj, int usedocspindex, char** lpUsedOCSPBytes, int* lenUsedOCSPBytes);
int64 secureblackbox_certificatevalidator_getusedocsphandle(void* lpObj, int usedocspindex);
char* secureblackbox_certificatevalidator_getusedocspissuer(void* lpObj, int usedocspindex);
char* secureblackbox_certificatevalidator_getusedocspissuerrdn(void* lpObj, int usedocspindex);
char* secureblackbox_certificatevalidator_getusedocsplocation(void* lpObj, int usedocspindex);
char* secureblackbox_certificatevalidator_getusedocspproducedat(void* lpObj, int usedocspindex);
int secureblackbox_certificatevalidator_getusedocspsource(void* lpObj, int usedocspindex);
int GetUsedOCSPCount(); QByteArray GetUsedOCSPBytes(int iUsedOCSPIndex); qint64 GetUsedOCSPHandle(int iUsedOCSPIndex); QString GetUsedOCSPIssuer(int iUsedOCSPIndex); QString GetUsedOCSPIssuerRDN(int iUsedOCSPIndex); QString GetUsedOCSPLocation(int iUsedOCSPIndex); QString GetUsedOCSPProducedAt(int iUsedOCSPIndex); int GetUsedOCSPSource(int iUsedOCSPIndex);
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.
Data Type
UseSystemCertificates Property (CertificateValidator Class)
Enables or disables the use of the system certificates.
Syntax
ANSI (Cross Platform) int GetUseSystemCertificates();
int SetUseSystemCertificates(int bUseSystemCertificates); Unicode (Windows) BOOL GetUseSystemCertificates();
INT SetUseSystemCertificates(BOOL bUseSystemCertificates);
int secureblackbox_certificatevalidator_getusesystemcertificates(void* lpObj);
int secureblackbox_certificatevalidator_setusesystemcertificates(void* lpObj, int bUseSystemCertificates);
bool GetUseSystemCertificates();
int SetUseSystemCertificates(bool bUseSystemCertificates);
Default Value
FALSE
Remarks
Use this property to tell the validator to use (or not to use) the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework.
Data Type
Boolean
ValidationLog Property (CertificateValidator Class)
Contains the complete log of the certificate validation routine.
Syntax
ANSI (Cross Platform) char* GetValidationLog(); Unicode (Windows) LPWSTR GetValidationLog();
char* secureblackbox_certificatevalidator_getvalidationlog(void* lpObj);
QString GetValidationLog();
Default Value
""
Remarks
Use this property to access the chain validation log produced by the class. The log can be very useful when investigating issues with chain validation, as it contains a step-by-step trace of the entire validation procedure.
This property is read-only and not available at design time.
Data Type
String
ValidationMoment Property (CertificateValidator Class)
The time point at which chain validity is to be established.
Syntax
ANSI (Cross Platform) char* GetValidationMoment();
int SetValidationMoment(const char* lpszValidationMoment); Unicode (Windows) LPWSTR GetValidationMoment();
INT SetValidationMoment(LPCWSTR lpszValidationMoment);
char* secureblackbox_certificatevalidator_getvalidationmoment(void* lpObj);
int secureblackbox_certificatevalidator_setvalidationmoment(void* lpObj, const char* lpszValidationMoment);
QString GetValidationMoment();
int SetValidationMoment(QString qsValidationMoment);
Default Value
""
Remarks
Use this property to specify the moment in time at which chain validity should be established. The time is in UTC. Leave the setting empty to stick to the current moment.
The validity of the same chain may differ depending on the time point chosen due to temporal changes in subchain validities and revocation statuses.
Data Type
String
Config Method (CertificateValidator Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_certificatevalidator_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
DoAction Method (CertificateValidator Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_certificatevalidator_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
QString DoAction(const QString& qsActionID, const QString& qsActionParams);
Remarks
DoAction is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.
The unique identifier (case 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. |
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
GetQualifiedStatus Method (CertificateValidator Class)
Obtains the qualified information for Certificate .
Syntax
ANSI (Cross Platform) int GetQualifiedStatus(); Unicode (Windows) INT GetQualifiedStatus();
int secureblackbox_certificatevalidator_getqualifiedstatus(void* lpObj);
int GetQualifiedStatus();
Remarks
Use this method to obtain a fresh qualified status for the certificate.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
GetTrustedListProperty Method (CertificateValidator Class)
Returns a specific TrustedList property.
Syntax
ANSI (Cross Platform) char* GetTrustedListProperty(const char* lpszPropName, const char* lpszLanguage); Unicode (Windows) LPWSTR GetTrustedListProperty(LPCWSTR lpszPropName, LPCWSTR lpszLanguage);
char* secureblackbox_certificatevalidator_gettrustedlistproperty(void* lpObj, const char* lpszPropName, const char* lpszLanguage);
QString GetTrustedListProperty(const QString& qsPropName, const QString& qsLanguage);
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
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
RefreshCache Method (CertificateValidator Class)
Refreshes the certificate cache.
Syntax
ANSI (Cross Platform) int RefreshCache(); Unicode (Windows) INT RefreshCache();
int secureblackbox_certificatevalidator_refreshcache(void* lpObj);
int RefreshCache();
Remarks
Use this method to remove obsolete information from the validation cache (only makes sense if CacheValidationResults is on).
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (CertificateValidator Class)
Resets the class settings.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int secureblackbox_certificatevalidator_reset(void* lpObj);
int Reset();
Remarks
Reset is a generic method available in every class.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ResetCache Method (CertificateValidator Class)
Clears all data contained in the validation cache.
Syntax
ANSI (Cross Platform) int ResetCache(); Unicode (Windows) INT ResetCache();
int secureblackbox_certificatevalidator_resetcache(void* lpObj);
int ResetCache();
Remarks
Use this method to clear the validation cache (only makes sense if CacheValidationResults is on).
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Terminate Method (CertificateValidator Class)
Terminates the validation process.
Syntax
ANSI (Cross Platform) int Terminate(); Unicode (Windows) INT Terminate();
int secureblackbox_certificatevalidator_terminate(void* lpObj);
int Terminate();
Remarks
Call this method if you would like to stop the validation process.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Validate Method (CertificateValidator Class)
Validates the certificate chain.
Syntax
ANSI (Cross Platform) int Validate(); Unicode (Windows) INT Validate();
int secureblackbox_certificatevalidator_validate(void* lpObj);
int Validate();
Remarks
Use this method to validate the certificate chain that starts with Certificate.
The chain validation is a multi-step process which includes validation of each certificate in the chain up to the trusted anchor. The ultimate goal of this process is to establish the integrity of the chain and its trustworthiness.
Depending on the component tuneup, the validation process may differ drastically, even for the same certificate: it may be more or less rigorous, may include or exclude revocation checks, and may be more or less tolerant to minor chain issues.
When this process is completed, the final decision on the validity of the checked certificate is returned from this method, and also saved in ChainValidationResult property. Another property, ChainValidationDetails, provides insight into the reasons that contributed to that decision. Use ValidationLog to get a detailed step-by-step log of the entire validation process.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ValidateForSMIME Method (CertificateValidator Class)
Validates an e-mail signing certificate.
Syntax
ANSI (Cross Platform) int ValidateForSMIME(const char* lpszEmailAddress); Unicode (Windows) INT ValidateForSMIME(LPCWSTR lpszEmailAddress);
int secureblackbox_certificatevalidator_validateforsmime(void* lpObj, const char* lpszEmailAddress);
int ValidateForSMIME(const QString& qsEmailAddress);
Remarks
Use this method to validate an e-mail security certificate.
This is a variant of Validate method that performs some additional e-mail specific checks, imposed by e-mail certificate rules. This method returns the overall chain validation result.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
ValidateForSSL Method (CertificateValidator Class)
Validates a server-side SSL/TLS certificate.
Syntax
ANSI (Cross Platform) int ValidateForSSL(const char* lpszURL, const char* lpszIPAddress); Unicode (Windows) INT ValidateForSSL(LPCWSTR lpszURL, LPCWSTR lpszIPAddress);
int secureblackbox_certificatevalidator_validateforssl(void* lpObj, const char* lpszURL, const char* lpszIPAddress);
int ValidateForSSL(const QString& qsURL, const QString& qsIPAddress);
Remarks
Use this method to validate a server-side SSL/TLS certificate.
This is a variant of Validate method that performs some additional TLS-specific checks. It is important that you provide a correct URL or IPAddress for the check to return a reasonable and justified result.
This method returns the overall result of the chain validation.
Error Handling (C++)
This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
AfterCertificateProcessing Event (CertificateValidator Class)
Marks the end of a single certificate processing step.
Syntax
ANSI (Cross Platform) virtual int FireAfterCertificateProcessing(CertificateValidatorAfterCertificateProcessingEventParams *e);
typedef struct {
const char *Cert;
int Validity;
int ValidationDetails; int reserved; } CertificateValidatorAfterCertificateProcessingEventParams;
Unicode (Windows) virtual INT FireAfterCertificateProcessing(CertificateValidatorAfterCertificateProcessingEventParams *e);
typedef struct {
LPCWSTR Cert;
INT Validity;
INT ValidationDetails; INT reserved; } CertificateValidatorAfterCertificateProcessingEventParams;
#define EID_CERTIFICATEVALIDATOR_AFTERCERTIFICATEPROCESSING 1 virtual INT SECUREBLACKBOX_CALL FireAfterCertificateProcessing(LPSTR &lpszCert, INT &iValidity, INT &iValidationDetails);
class CertificateValidatorAfterCertificateProcessingEventParams { public: const QString &Cert(); int Validity(); int ValidationDetails(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCertificateProcessing(CertificateValidatorAfterCertificateProcessingEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireAfterCertificateProcessing(CertificateValidatorAfterCertificateProcessingEventParams *e) {...}
Remarks
This event is fired when the class has finished processing Cert, and returns its Validity status and ValidationDetails.
'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via AfterCertificateValidation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.
You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via InterimValidationResult and InterimValidationDetails properties.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
AfterCertificateValidation Event (CertificateValidator Class)
Marks the end of a single certificate validation step.
Syntax
ANSI (Cross Platform) virtual int FireAfterCertificateValidation(CertificateValidatorAfterCertificateValidationEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
int Validity;
int ValidationDetails; int reserved; } CertificateValidatorAfterCertificateValidationEventParams;
Unicode (Windows) virtual INT FireAfterCertificateValidation(CertificateValidatorAfterCertificateValidationEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
INT Validity;
INT ValidationDetails; INT reserved; } CertificateValidatorAfterCertificateValidationEventParams;
#define EID_CERTIFICATEVALIDATOR_AFTERCERTIFICATEVALIDATION 2 virtual INT SECUREBLACKBOX_CALL FireAfterCertificateValidation(LPSTR &lpszCert, LPSTR &lpszCACert, INT &iValidity, INT &iValidationDetails);
class CertificateValidatorAfterCertificateValidationEventParams { public: const QString &Cert(); const QString &CACert(); int Validity(); int ValidationDetails(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void AfterCertificateValidation(CertificateValidatorAfterCertificateValidationEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireAfterCertificateValidation(CertificateValidatorAfterCertificateValidationEventParams *e) {...}
Remarks
This event is fired when the class has finished validation of Cert with CACert, and returns its Validity status and ValidationDetails.
'Validation', in this context, means a single validation of a certificate with its CA certificate. For certificates with multiple CAs, validations are grouped into 'processings.' Each processing, therefore, is a set of validations of the same certificate with all its CAs.
You can influence the validation process by altering the provided validation outcome, such as changing the invalid status to valid. This can be done via InterimValidationResult and InterimValidationDetails properties.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
BeforeCACertificateDownload Event (CertificateValidator Class)
Fires when a CA certificate is about to be downloaded.
Syntax
ANSI (Cross Platform) virtual int FireBeforeCACertificateDownload(CertificateValidatorBeforeCACertificateDownloadEventParams *e);
typedef struct {
const char *Cert;
const char *Location; int reserved; } CertificateValidatorBeforeCACertificateDownloadEventParams;
Unicode (Windows) virtual INT FireBeforeCACertificateDownload(CertificateValidatorBeforeCACertificateDownloadEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR Location; INT reserved; } CertificateValidatorBeforeCACertificateDownloadEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFORECACERTIFICATEDOWNLOAD 3 virtual INT SECUREBLACKBOX_CALL FireBeforeCACertificateDownload(LPSTR &lpszCert, LPSTR &lpszLocation);
class CertificateValidatorBeforeCACertificateDownloadEventParams { public: const QString &Cert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCACertificateDownload(CertificateValidatorBeforeCACertificateDownloadEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeCACertificateDownload(CertificateValidatorBeforeCACertificateDownloadEventParams *e) {...}
Remarks
This event is fired when a CA certificate that is needed to validate Cert is about to be downloaded from Location.
BeforeCertificateProcessing Event (CertificateValidator Class)
Reports the start of certificate processing.
Syntax
ANSI (Cross Platform) virtual int FireBeforeCertificateProcessing(CertificateValidatorBeforeCertificateProcessingEventParams *e);
typedef struct {
const char *Cert;
int Validity;
int ValidationDetails; int reserved; } CertificateValidatorBeforeCertificateProcessingEventParams;
Unicode (Windows) virtual INT FireBeforeCertificateProcessing(CertificateValidatorBeforeCertificateProcessingEventParams *e);
typedef struct {
LPCWSTR Cert;
INT Validity;
INT ValidationDetails; INT reserved; } CertificateValidatorBeforeCertificateProcessingEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFORECERTIFICATEPROCESSING 4 virtual INT SECUREBLACKBOX_CALL FireBeforeCertificateProcessing(LPSTR &lpszCert, INT &iValidity, INT &iValidationDetails);
class CertificateValidatorBeforeCertificateProcessingEventParams { public: const QString &Cert(); int Validity(); int ValidationDetails(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCertificateProcessing(CertificateValidatorBeforeCertificateProcessingEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeCertificateProcessing(CertificateValidatorBeforeCertificateProcessingEventParams *e) {...}
Remarks
This event is fired when the class is about to start the processing of Cert.
'Processing' consists of one or more 'validations' (with one CA certificate each), completion of each of which is reported via AfterCertificateValidation events. If a certificate is signed by a single CA (which is a typical case), processing is synonymous to validation.
The firing of AfterCertificateProcessing marks the end of the certificate processing.
Validity and ValidationDetails specify the current validation status.
Validity status:
cvtValid | 0 | The chain is valid |
cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted |
cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) |
cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) |
Validation details:
cvrBadData | 0x0001 | One or more certificates in the validation path are malformed |
cvrRevoked | 0x0002 | One or more certificates are revoked |
cvrNotYetValid | 0x0004 | One or more certificates are not yet valid |
cvrExpired | 0x0008 | One or more certificates are expired |
cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature |
cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) |
cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA |
cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified |
cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified |
cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate |
cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates |
cvrBlocked | 0x0800 | One or more certificates are blocked |
cvrFailure | 0x1000 | General validation failure |
cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself |
cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements |
cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code |
BeforeCertificateValidation Event (CertificateValidator Class)
Reports the start of certificate validation.
Syntax
ANSI (Cross Platform) virtual int FireBeforeCertificateValidation(CertificateValidatorBeforeCertificateValidationEventParams *e);
typedef struct {
const char *Cert;
const char *CACert; int reserved; } CertificateValidatorBeforeCertificateValidationEventParams;
Unicode (Windows) virtual INT FireBeforeCertificateValidation(CertificateValidatorBeforeCertificateValidationEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert; INT reserved; } CertificateValidatorBeforeCertificateValidationEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFORECERTIFICATEVALIDATION 5 virtual INT SECUREBLACKBOX_CALL FireBeforeCertificateValidation(LPSTR &lpszCert, LPSTR &lpszCACert);
class CertificateValidatorBeforeCertificateValidationEventParams { public: const QString &Cert(); const QString &CACert(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCertificateValidation(CertificateValidatorBeforeCertificateValidationEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeCertificateValidation(CertificateValidatorBeforeCertificateValidationEventParams *e) {...}
Remarks
This event is fired when the class is about to start validating Cert with CACert.
A 'validation' is a single step of validating a certificate with its CA certificate. A row of consecutive validations of the same certificate with different CAs are grouped into 'processings.'
The firing of AfterCertificateValidation marks the end of the certificate validation step.
BeforeCRLDownload Event (CertificateValidator Class)
Fires when a CRL is about to be downloaded.
Syntax
ANSI (Cross Platform) virtual int FireBeforeCRLDownload(CertificateValidatorBeforeCRLDownloadEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
const char *Location; int reserved; } CertificateValidatorBeforeCRLDownloadEventParams;
Unicode (Windows) virtual INT FireBeforeCRLDownload(CertificateValidatorBeforeCRLDownloadEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
LPCWSTR Location; INT reserved; } CertificateValidatorBeforeCRLDownloadEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFORECRLDOWNLOAD 6 virtual INT SECUREBLACKBOX_CALL FireBeforeCRLDownload(LPSTR &lpszCert, LPSTR &lpszCACert, LPSTR &lpszLocation);
class CertificateValidatorBeforeCRLDownloadEventParams { public: const QString &Cert(); const QString &CACert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeCRLDownload(CertificateValidatorBeforeCRLDownloadEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeCRLDownload(CertificateValidatorBeforeCRLDownloadEventParams *e) {...}
Remarks
This event is fired when a CRL (Certificate Revocation List) needed to validate Cert is going to be downloaded from Location.
BeforeOCSPDownload Event (CertificateValidator Class)
Fires when a certificate's OCSP status is about to be requested.
Syntax
ANSI (Cross Platform) virtual int FireBeforeOCSPDownload(CertificateValidatorBeforeOCSPDownloadEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
const char *Location; int reserved; } CertificateValidatorBeforeOCSPDownloadEventParams;
Unicode (Windows) virtual INT FireBeforeOCSPDownload(CertificateValidatorBeforeOCSPDownloadEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
LPCWSTR Location; INT reserved; } CertificateValidatorBeforeOCSPDownloadEventParams;
#define EID_CERTIFICATEVALIDATOR_BEFOREOCSPDOWNLOAD 7 virtual INT SECUREBLACKBOX_CALL FireBeforeOCSPDownload(LPSTR &lpszCert, LPSTR &lpszCACert, LPSTR &lpszLocation);
class CertificateValidatorBeforeOCSPDownloadEventParams { public: const QString &Cert(); const QString &CACert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void BeforeOCSPDownload(CertificateValidatorBeforeOCSPDownloadEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireBeforeOCSPDownload(CertificateValidatorBeforeOCSPDownloadEventParams *e) {...}
Remarks
This event is fired when the validator is about to request a fresh revocation status from an OCSP responder.
CACertificateDownloaded Event (CertificateValidator Class)
Marks the success of a certificate download.
Syntax
ANSI (Cross Platform) virtual int FireCACertificateDownloaded(CertificateValidatorCACertificateDownloadedEventParams *e);
typedef struct {
const char *Cert;
const char *Location; int reserved; } CertificateValidatorCACertificateDownloadedEventParams;
Unicode (Windows) virtual INT FireCACertificateDownloaded(CertificateValidatorCACertificateDownloadedEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR Location; INT reserved; } CertificateValidatorCACertificateDownloadedEventParams;
#define EID_CERTIFICATEVALIDATOR_CACERTIFICATEDOWNLOADED 8 virtual INT SECUREBLACKBOX_CALL FireCACertificateDownloaded(LPSTR &lpszCert, LPSTR &lpszLocation);
class CertificateValidatorCACertificateDownloadedEventParams { public: const QString &Cert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CACertificateDownloaded(CertificateValidatorCACertificateDownloadedEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireCACertificateDownloaded(CertificateValidatorCACertificateDownloadedEventParams *e) {...}
Remarks
This event is fired when a CA certificate has been successfully downloaded from Location. This event is preceded with BeforeCACertificateDownload event.
CACertificateNeeded Event (CertificateValidator Class)
Requests a missing certificate from the user.
Syntax
ANSI (Cross Platform) virtual int FireCACertificateNeeded(CertificateValidatorCACertificateNeededEventParams *e);
typedef struct {
const char *Cert; int reserved; } CertificateValidatorCACertificateNeededEventParams;
Unicode (Windows) virtual INT FireCACertificateNeeded(CertificateValidatorCACertificateNeededEventParams *e);
typedef struct {
LPCWSTR Cert; INT reserved; } CertificateValidatorCACertificateNeededEventParams;
#define EID_CERTIFICATEVALIDATOR_CACERTIFICATENEEDED 9 virtual INT SECUREBLACKBOX_CALL FireCACertificateNeeded(LPSTR &lpszCert);
class CertificateValidatorCACertificateNeededEventParams { public: const QString &Cert(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CACertificateNeeded(CertificateValidatorCACertificateNeededEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireCACertificateNeeded(CertificateValidatorCACertificateNeededEventParams *e) {...}
Remarks
This event is fired when a CA certificate that is needed to validate Cert is not found at any of the available locations. If you have access to the missing certificate, please add it to the KnownCertificates collection to make it available to the validator.
When this event fires, the CurrentCertificate property is assigned with the certificate being validated. It is the CA that issued that certificate that the validator is looking for.
CRLDownloaded Event (CertificateValidator Class)
Marks the success of a CRL download.
Syntax
ANSI (Cross Platform) virtual int FireCRLDownloaded(CertificateValidatorCRLDownloadedEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
const char *Location; int reserved; } CertificateValidatorCRLDownloadedEventParams;
Unicode (Windows) virtual INT FireCRLDownloaded(CertificateValidatorCRLDownloadedEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
LPCWSTR Location; INT reserved; } CertificateValidatorCRLDownloadedEventParams;
#define EID_CERTIFICATEVALIDATOR_CRLDOWNLOADED 10 virtual INT SECUREBLACKBOX_CALL FireCRLDownloaded(LPSTR &lpszCert, LPSTR &lpszCACert, LPSTR &lpszLocation);
class CertificateValidatorCRLDownloadedEventParams { public: const QString &Cert(); const QString &CACert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CRLDownloaded(CertificateValidatorCRLDownloadedEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireCRLDownloaded(CertificateValidatorCRLDownloadedEventParams *e) {...}
Remarks
This event is fired when a CRL containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with BeforeCRLDownload event.
CRLNeeded Event (CertificateValidator Class)
Requests a missing CRL from the user.
Syntax
ANSI (Cross Platform) virtual int FireCRLNeeded(CertificateValidatorCRLNeededEventParams *e);
typedef struct {
const char *Cert;
const char *CACert; int reserved; } CertificateValidatorCRLNeededEventParams;
Unicode (Windows) virtual INT FireCRLNeeded(CertificateValidatorCRLNeededEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert; INT reserved; } CertificateValidatorCRLNeededEventParams;
#define EID_CERTIFICATEVALIDATOR_CRLNEEDED 11 virtual INT SECUREBLACKBOX_CALL FireCRLNeeded(LPSTR &lpszCert, LPSTR &lpszCACert);
class CertificateValidatorCRLNeededEventParams { public: const QString &Cert(); const QString &CACert(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void CRLNeeded(CertificateValidatorCRLNeededEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireCRLNeeded(CertificateValidatorCRLNeededEventParams *e) {...}
Remarks
This event is fired when a CRL that is needed to validate Cert is not found at any of the available locations. If you have access to the missing CRL, please add it to the KnownCRLs collection to make it available to the validator.
When this event fires, the CurrentCertificate and CurrentCACertificate properties are assigned with the certificate being validated and its issuer certificate.
Error Event (CertificateValidator Class)
Information about errors during certificate validation.
Syntax
ANSI (Cross Platform) virtual int FireError(CertificateValidatorErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } CertificateValidatorErrorEventParams;
Unicode (Windows) virtual INT FireError(CertificateValidatorErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } CertificateValidatorErrorEventParams;
#define EID_CERTIFICATEVALIDATOR_ERROR 12 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class CertificateValidatorErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(CertificateValidatorErrorEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireError(CertificateValidatorErrorEventParams *e) {...}
Remarks
The event is fired in case of exceptional conditions during certificate processing or online information retrieval.
ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the corresponding section.
Notification Event (CertificateValidator Class)
This event notifies the application about an underlying control flow event.
Syntax
ANSI (Cross Platform) virtual int FireNotification(CertificateValidatorNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } CertificateValidatorNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(CertificateValidatorNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } CertificateValidatorNotificationEventParams;
#define EID_CERTIFICATEVALIDATOR_NOTIFICATION 13 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
class CertificateValidatorNotificationEventParams { public: const QString &EventID(); const QString &EventParam(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Notification(CertificateValidatorNotificationEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireNotification(CertificateValidatorNotificationEventParams *e) {...}
Remarks
The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.
The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.
This class can fire this event with the following EventID values:
DownloadTSL | This event is fired if a Trusted List is requested. The EventParam parameter contains the URL value from where to retrieve the TrustedList. The downloaded Trusted List content should be assigned to the TSLContent or TSLContentHex configuration settings. The class automatically downloads Trusted List if OfflineMode is disabled and no Trusted List content is provided. It is important to note that if you are caching the Trusted List content, you should check the NextUpdate field of the Trusted List and update it in a timely manner, otherwise the outdated Trusted List will be discarded. |
StoreTSL | This event is fired if the Trusted List should be stored for offline usage. The EventParam parameter contains the URL value from where the Trusted List was retrieved. The TrustedList content could be read using TSLContent or TSLContentHex configuration settings. |
OCSPDownloaded Event (CertificateValidator Class)
Marks the success of an OCSP request.
Syntax
ANSI (Cross Platform) virtual int FireOCSPDownloaded(CertificateValidatorOCSPDownloadedEventParams *e);
typedef struct {
const char *Cert;
const char *CACert;
const char *Location; int reserved; } CertificateValidatorOCSPDownloadedEventParams;
Unicode (Windows) virtual INT FireOCSPDownloaded(CertificateValidatorOCSPDownloadedEventParams *e);
typedef struct {
LPCWSTR Cert;
LPCWSTR CACert;
LPCWSTR Location; INT reserved; } CertificateValidatorOCSPDownloadedEventParams;
#define EID_CERTIFICATEVALIDATOR_OCSPDOWNLOADED 14 virtual INT SECUREBLACKBOX_CALL FireOCSPDownloaded(LPSTR &lpszCert, LPSTR &lpszCACert, LPSTR &lpszLocation);
class CertificateValidatorOCSPDownloadedEventParams { public: const QString &Cert(); const QString &CACert(); const QString &Location(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void OCSPDownloaded(CertificateValidatorOCSPDownloadedEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireOCSPDownloaded(CertificateValidatorOCSPDownloadedEventParams *e) {...}
Remarks
This event is fired when an OCSP response containing the validation information for Cert has been successfully downloaded from Location. This event is always preceded with BeforeOCSPDownload event.
TLSCertNeeded Event (CertificateValidator Class)
Fires when a remote TLS party requests a client certificate.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertNeeded(CertificateValidatorTLSCertNeededEventParams *e);
typedef struct {
const char *Host;
const char *CANames; int reserved; } CertificateValidatorTLSCertNeededEventParams;
Unicode (Windows) virtual INT FireTLSCertNeeded(CertificateValidatorTLSCertNeededEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR CANames; INT reserved; } CertificateValidatorTLSCertNeededEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSCERTNEEDED 15 virtual INT SECUREBLACKBOX_CALL FireTLSCertNeeded(LPSTR &lpszHost, LPSTR &lpszCANames);
class CertificateValidatorTLSCertNeededEventParams { public: const QString &Host(); const QString &CANames(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertNeeded(CertificateValidatorTLSCertNeededEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSCertNeeded(CertificateValidatorTLSCertNeededEventParams *e) {...}
Remarks
This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.
Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.
This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.
TLSCertValidate Event (CertificateValidator Class)
This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.
Syntax
ANSI (Cross Platform) virtual int FireTLSCertValidate(CertificateValidatorTLSCertValidateEventParams *e);
typedef struct {
const char *ServerHost;
const char *ServerIP;
int Accept; int reserved; } CertificateValidatorTLSCertValidateEventParams;
Unicode (Windows) virtual INT FireTLSCertValidate(CertificateValidatorTLSCertValidateEventParams *e);
typedef struct {
LPCWSTR ServerHost;
LPCWSTR ServerIP;
BOOL Accept; INT reserved; } CertificateValidatorTLSCertValidateEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSCERTVALIDATE 16 virtual INT SECUREBLACKBOX_CALL FireTLSCertValidate(LPSTR &lpszServerHost, LPSTR &lpszServerIP, BOOL &bAccept);
class CertificateValidatorTLSCertValidateEventParams { public: const QString &ServerHost(); const QString &ServerIP(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSCertValidate(CertificateValidatorTLSCertValidateEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSCertValidate(CertificateValidatorTLSCertValidateEventParams *e) {...}
Remarks
This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.
Accept is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.
TLSEstablished Event (CertificateValidator Class)
Fires when a TLS handshake with Host successfully completes.
Syntax
ANSI (Cross Platform) virtual int FireTLSEstablished(CertificateValidatorTLSEstablishedEventParams *e);
typedef struct {
const char *Host;
const char *Version;
const char *Ciphersuite;
const char *ConnectionId; int lenConnectionId;
int Abort; int reserved; } CertificateValidatorTLSEstablishedEventParams;
Unicode (Windows) virtual INT FireTLSEstablished(CertificateValidatorTLSEstablishedEventParams *e);
typedef struct {
LPCWSTR Host;
LPCWSTR Version;
LPCWSTR Ciphersuite;
LPCSTR ConnectionId; INT lenConnectionId;
BOOL Abort; INT reserved; } CertificateValidatorTLSEstablishedEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSESTABLISHED 17 virtual INT SECUREBLACKBOX_CALL FireTLSEstablished(LPSTR &lpszHost, LPSTR &lpszVersion, LPSTR &lpszCiphersuite, LPSTR &lpConnectionId, INT &lenConnectionId, BOOL &bAbort);
class CertificateValidatorTLSEstablishedEventParams { public: const QString &Host(); const QString &Version(); const QString &Ciphersuite(); const QByteArray &ConnectionId(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSEstablished(CertificateValidatorTLSEstablishedEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSEstablished(CertificateValidatorTLSEstablishedEventParams *e) {...}
Remarks
The class uses this event to notify the application about 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 Class)
Fires when a new TLS handshake is initiated, before the handshake commences.
Syntax
ANSI (Cross Platform) virtual int FireTLSHandshake(CertificateValidatorTLSHandshakeEventParams *e);
typedef struct {
const char *Host;
int Abort; int reserved; } CertificateValidatorTLSHandshakeEventParams;
Unicode (Windows) virtual INT FireTLSHandshake(CertificateValidatorTLSHandshakeEventParams *e);
typedef struct {
LPCWSTR Host;
BOOL Abort; INT reserved; } CertificateValidatorTLSHandshakeEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSHANDSHAKE 18 virtual INT SECUREBLACKBOX_CALL FireTLSHandshake(LPSTR &lpszHost, BOOL &bAbort);
class CertificateValidatorTLSHandshakeEventParams { public: const QString &Host(); bool Abort(); void SetAbort(bool bAbort); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSHandshake(CertificateValidatorTLSHandshakeEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSHandshake(CertificateValidatorTLSHandshakeEventParams *e) {...}
Remarks
The class uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.
TLSShutdown Event (CertificateValidator Class)
Reports the graceful closure of a TLS connection.
Syntax
ANSI (Cross Platform) virtual int FireTLSShutdown(CertificateValidatorTLSShutdownEventParams *e);
typedef struct {
const char *Host; int reserved; } CertificateValidatorTLSShutdownEventParams;
Unicode (Windows) virtual INT FireTLSShutdown(CertificateValidatorTLSShutdownEventParams *e);
typedef struct {
LPCWSTR Host; INT reserved; } CertificateValidatorTLSShutdownEventParams;
#define EID_CERTIFICATEVALIDATOR_TLSSHUTDOWN 19 virtual INT SECUREBLACKBOX_CALL FireTLSShutdown(LPSTR &lpszHost);
class CertificateValidatorTLSShutdownEventParams { public: const QString &Host(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void TLSShutdown(CertificateValidatorTLSShutdownEventParams *e);
// Or, subclass CertificateValidator and override this emitter function. virtual int FireTLSShutdown(CertificateValidatorTLSShutdownEventParams *e) {...}
Remarks
This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.
Certificate Type
Encapsulates an individual X.509 certificate.
Syntax
SecureBlackboxCertificate (declared in secureblackbox.h)
Remarks
This type keeps and provides access to X.509 certificate details.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw certificate data in DER format.
CA
int
Default Value: 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
char* (read-only)
Default Value:
A unique identifier (fingerprint) of the CA certificate's cryptographic key.
Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.
This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the SubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.
CertType
int (read-only)
Default Value: 0
Returns the type of the entity contained in the Certificate object.
A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.
Use the CertificateManager class to load or create new certificate and certificate requests objects.
CRLDistributionPoints
char*
Default Value: ""
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
char*
Default Value: ""
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
char* (read-only)
Default Value: ""
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
char* (read-only)
Default Value: ""
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.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
HashAlgorithm
char*
Default Value: ""
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 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
char* (read-only)
Default Value: ""
The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via IssuerRDN.
IssuerRDN
char*
Default Value: ""
A list of Property=Value pairs that uniquely identify the certificate issuer.
Example: /C=US/O=Nationwide CA/CN=Web Certification Authority
KeyAlgorithm
char*
Default Value: "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 |
Use the KeyBits, Curve, and PublicKeyBytes fields to get more details about the key the certificate contains.
KeyBits
int (read-only)
Default Value: 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 or PrivateKeyBytes field would typically contain auxiliary values, and therefore be longer.
KeyFingerprint
char* (read-only)
Default Value: ""
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 field. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.
KeyUsage
int
Default Value: 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
int (read-only)
Default Value: FALSE
Returns True if the certificate's key is cryptographically valid, and False otherwise.
OCSPLocations
char*
Default Value: ""
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 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
int
Default Value: FALSE
Accessor to the value of the certificate's ocsp-no-check extension.
Origin
int (read-only)
Default Value: 0
Returns the location that the certificate was taken or loaded from.
PolicyIDs
char*
Default Value: ""
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
char* (read-only)
Default Value:
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
int (read-only)
Default Value: 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, 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
int (read-only)
Default Value: FALSE
Indicates whether the private key is extractable (exportable).
PublicKeyBytes
char* (read-only)
Default Value:
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
int (read-only)
Default Value: 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
int
Default Value: 0
Returns a simplified qualified status of the certificate.
Qualifiers
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.
SelfSigned
int (read-only)
Default Value: FALSE
Indicates whether the certificate is self-signed (root) or signed by an external CA.
SerialNumber
char*
Default Value:
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
char* (read-only)
Default Value: ""
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
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Subject
char* (read-only)
Default Value: ""
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.
SubjectAlternativeName
char*
Default Value: ""
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 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
char*
Default Value:
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 and 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
char*
Default Value: ""
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
int (read-only)
Default Value: 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
char*
Default Value: ""
The time point at which the certificate becomes valid, in UTC.
ValidTo
char*
Default Value: ""
The time point at which the certificate expires, in UTC.
Constructors
Certificate()
Creates a new object with default field values.
CRL Type
Represents a Certificate Revocation List.
Syntax
SecureBlackboxCRL (declared in secureblackbox.h)
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.
Fields
Bytes
char* (read-only)
Default Value:
Returns the raw CRL data in DER format.
CAKeyID
char*
Default Value:
A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL.
EntryCount
int (read-only)
Default Value: 0
Returns the number of certificate status entries in the CRL.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
The common name of the CRL issuer (CA), typically a company name.
IssuerRDN
char* (read-only)
Default Value: ""
A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer.
Location
char* (read-only)
Default Value: ""
The URL that the CRL was downloaded from.
NextUpdate
char*
Default Value: ""
The planned time and date of the next version of this CRL to be published.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this CRL.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
TBS
char* (read-only)
Default Value:
The to-be-signed part of the CRL (the CRL without the signature part).
ThisUpdate
char*
Default Value: ""
The date and time at which this version of the CRL was published.
Constructors
CRL()
Creates an empty CRL object.
OCSPResponse Type
Represents a single OCSP response originating from an OCSP responder.
Syntax
SecureBlackboxOCSPResponse (declared in secureblackbox.h)
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.
Fields
Bytes
char* (read-only)
Default Value:
A buffer containing the raw OCSP response data.
EntryCount
int (read-only)
Default Value: 0
The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status.
Handle
int64
Default Value: 0
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
Issuer
char* (read-only)
Default Value: ""
Indicates the issuer of this response (a CA or its authorized representative).
IssuerRDN
char* (read-only)
Default Value: ""
Indicates the RDN of the issuer of this response (a CA or its authorized representative).
Location
char* (read-only)
Default Value: ""
The location of the OCSP responder.
ProducedAt
char*
Default Value: ""
Specifies the time when the response was produced, in UTC.
SigAlgorithm
char*
Default Value: "0"
The public key algorithm that was used by the CA to sign this OCSP response.
Source
int (read-only)
Default Value: 0
Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.
Constructors
OCSPResponse()
Creates an empty OCSP response object.
ProxySettings Type
A container for proxy server settings.
Syntax
SecureBlackboxProxySettings (declared in secureblackbox.h)
Remarks
This type exposes a collection of properties for tuning up the proxy server configuration.
Fields
Address
char*
Default Value: ""
The IP address of the proxy server.
Authentication
int
Default Value: 0
The authentication type used by the proxy server.
patNoAuthentication | 0 |
patBasic | 1 |
patDigest | 2 |
patNTLM | 3 |
Password
char*
Default Value: ""
The password to authenticate to the proxy server.
Port
int
Default Value: 0
The port on the proxy server to connect to.
ProxyType
int
Default Value: 0
The type of the proxy server.
cptNone | 0 |
cptSocks4 | 1 |
cptSocks5 | 2 |
cptWebTunnel | 3 |
cptHTTP | 4 |
RequestHeaders
char*
Default Value: ""
Contains HTTP request headers for WebTunnel and HTTP proxy.
ResponseBody
char*
Default Value: ""
Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ResponseHeaders
char*
Default Value: ""
Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
UseIPv6
int
Default Value: FALSE
Specifies whether IPv6 should be used when connecting through the proxy.
Username
char*
Default Value: ""
Specifies the username credential for proxy authentication.
Constructors
ProxySettings()
Creates a new ProxySettings object.
QualifiedInfo Type
This component is a container for X.509 qualified information.
Syntax
SecureBlackboxQualifiedInfo (declared in secureblackbox.h)
Remarks
Use this property to access the qualified information for the validated certificate.
Fields
Address
char* (read-only)
Default Value: ""
Contains the address of the TSL provider.
Use this property to check the address of the TSL provider.
CustomTrustedLists
char*
Default Value: ""
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
char* (read-only)
Default Value: ""
Contains the TLS download log.
This log may be useful in investigating TSL retrieval failures.
InformationURI
char* (read-only)
Default Value: ""
Contains the URI of the provider information.
Use this property to get the URI of the TSL provider information.
Languages
char*
Default Value: ""
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
char* (read-only)
Default Value: ""
Returns the next update date and time of the TSL.
Use this property to check the next update value for the TSL.
Provider
char* (read-only)
Default Value: ""
Contains the name of the TSL provider.
Use this property to check the name of the TSL provider.
Qualified
int (read-only)
Default Value: 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
char* (read-only)
Default Value: ""
A list of qualifiers.
Contains a comma-separated list of qualifiers for the certificate, for example QCP-n-qscd,QCWithSSCD.
ServiceName
char* (read-only)
Default Value: ""
Contains the name of the TSL service.
Use this property to check the name of the TSL service.
ServiceTypeId
char* (read-only)
Default Value: ""
Contains the TSL service type identifier.
Use this property to check the service type identifier of the TSL.
Source
int (read-only)
Default Value: 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
int (read-only)
Default Value: 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
char* (read-only)
Default Value: ""
Contains the trade name of the TSL provider.
Use this property to check the trade name of the TSL provider.
Trusted
int (read-only)
Default Value: 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
int
Default Value: 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
char* (read-only)
Default Value: ""
Contains the TLS validation log.
This log may be useful in investigating TSL validation failures.
XML
char* (read-only)
Default Value: ""
Contains the XML of the TSL.
Use this property to obtain the original body of the TSL in XML format.
Constructors
QualifiedInfo()
Creates a new QualifiedInfo object.
SocketSettings Type
A container for the socket settings.
Syntax
SecureBlackboxSocketSettings (declared in secureblackbox.h)
Remarks
This type is a container for socket-layer parameters.
Fields
DNSMode
int
Default Value: 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 Value: 0
Specifies the port number to be used for sending queries to the DNS server.
DNSQueryTimeout
int
Default Value: 0
The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.
DNSServers
char*
Default Value: ""
The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
DNSTotalTimeout
int
Default Value: 0
The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.
IncomingSpeedLimit
int
Default Value: 0
The maximum number of bytes to read from the socket, per second.
LocalAddress
char*
Default Value: ""
The local network interface to bind the socket to.
LocalPort
int
Default Value: 0
The local port number to bind the socket to.
OutgoingSpeedLimit
int
Default Value: 0
The maximum number of bytes to write to the socket, per second.
Timeout
int
Default Value: 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
int
Default Value: FALSE
Enables or disables IP protocol version 6.
Constructors
SocketSettings()
Creates a new SocketSettings object.
TLSSettings Type
A container for TLS connection settings.
Syntax
SecureBlackboxTLSSettings (declared in secureblackbox.h)
Remarks
The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP.
Fields
AutoValidateCertificates
int
Default Value: TRUE
Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.
BaseConfiguration
int
Default Value: 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
char*
Default Value: ""
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. 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
int
Default Value: 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 |
ECCurves
char*
Default Value: ""
Defines the elliptic curves to enable.
Extensions
char*
Default Value: ""
Provides access to TLS extensions.
ForceResumeIfDestinationChanges
int
Default Value: FALSE
Whether to force TLS session resumption when the destination address changes.
PreSharedIdentity
char*
Default Value: ""
Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.
PreSharedKey
char*
Default Value: ""
Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.
PreSharedKeyCiphersuite
char*
Default Value: ""
Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.
RenegotiationAttackPreventionMode
int
Default Value: 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
int
Default Value: 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 Value: 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
int
Default Value: 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
int
Default Value: FALSE
Enables the Extended Master Secret Extension, as defined in RFC 7627.
UseSessionResumption
int
Default Value: FALSE
Enables or disables the TLS session resumption capability.
Versions
int
Default Value: 16
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
TLSSettings()
Creates a new TLSSettings object.
SecureBlackboxList Type
Syntax
SecureBlackboxList<T> (declared in secureblackbox.h)
Remarks
SecureBlackboxList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the CertificateValidator class.
Methods | |
GetCount |
This method returns the current size of the collection.
int GetCount() {}
|
SetCount |
This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection.
int SetCount(int count) {}
|
Get |
This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified.
T* Get(int index) {}
|
Set |
This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class.
T* Set(int index, T* value) {}
|
Config Settings (CertificateValidator Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.CertificateValidator Config Settings
In the optimistic strategy, positive validation results are kept, and negative ones are ignored. If there are no good certificates in the chain, the validation proceeds using self-signed certificates. Smart is the same as optimistic.
In the pessimistic strategy, even one negative validation result makes the whole process to fail.
If IgnoreSystemTrust is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the TrustedCertificates property) are considered trusted.
When ValidateInvalidCertificates is False and a certificate is found to be not valid, further checks of this certificate are not performed.
Supported values: wahmIgnore = 0 wahmWarning = 1 wahmError = 2
TrustedLists Config Settings
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
off | No caching (default) | |
local | Local caching | |
global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
file | File | |
console | Console | |
systemlog | System Log (supported for Android only) | |
debugger | Debugger (supported for VCL for Windows and .Net) |
Supported values are:
time | Current time | |
level | Level | |
package | Package name | |
module | Module name | |
class | Class name | |
method | Method name | |
threadid | Thread Id | |
contenttype | Content type | |
content | Content | |
all | All details |
Supported filter names are:
exclude-package | Exclude a package specified in the value | |
exclude-module | Exclude a module specified in the value | |
exclude-class | Exclude a class specified in the value | |
exclude-method | Exclude a method specified in the value | |
include-package | Include a package specified in the value | |
include-module | Include a module specified in the value | |
include-class | Include a class specified in the value | |
include-method | Include a method specified in the value |
none | No flush (caching only) | |
immediate | Immediate flush (real-time logging) | |
maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
Supported values are:
none | None (by default) | |
fatal | Severe errors that cause premature termination. | |
error | Other runtime errors or unexpected conditions. | |
warning | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | |
info | Interesting runtime events (startup/shutdown). | |
debug | Detailed information on flow of through the system. | |
trace | More detailed information. |
The default value of this setting is 100.
none | No rotation | |
deleteolder | Delete older entries from the cache upon reaching LogMaxEventCount | |
keepolder | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) |
Supported Values:
certificate | Enables caching of certificates. |
crl | Enables caching of Certificate Revocation Lists (CRLs). |
ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. |
Example (default value):
PKICache=certificate,crl,ocsp
In this example, the component caches certificates, CRLs, and OCSP responses.
The default value is an empty string - no cached PKI data is stored on disk.
Example:
PKICachePath=C:\Temp\cache
In this example, the cached PKI data is stored in the C:\Temp\cache directory.
Supported values are:
none | No static DNS rules (default) | |
local | Local static DNS rules | |
global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing.
Syntax:
Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2");
Where:
OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map.
PrimaryName: The main descriptor name used in the XML signature when the OID is encountered.
Alias1, Alias2, ...: Optional alternative names recognized during parsing.
Usage Examples:
Map OID 2.5.4.5 to SERIALNUMBER:
Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER");
Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS:
Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS");
Trappable Errors (CertificateValidator Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
CertificateValidator Errors
1048577 | Invalid parameter (SB_ERROR_INVALID_PARAMETER) |
1048578 | Invalid configuration (SB_ERROR_INVALID_SETUP) |
1048579 | Invalid state (SB_ERROR_INVALID_STATE) |
1048580 | Invalid value (SB_ERROR_INVALID_VALUE) |
1048581 | Private key not found (SB_ERROR_NO_PRIVATE_KEY) |
1048582 | Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) |
1048583 | The file was not found (SB_ERROR_NO_SUCH_FILE) |
1048584 | Unsupported feature or operation (SB_ERROR_UNSUPPORTED_FEATURE) |
1048585 | General error (SB_ERROR_GENERAL_ERROR) |