# Authenticator Class The Authenticator class specializes in user authentication. ## Syntax ```text Authenticator ``` ## Remarks Authenticator provides capabilities for implementing the authenticating party (as opposed to the one being authenticated) of the authentication protocol. Authenticator can be used in a variety of authentication scenarios, ranging from simple password checks to complicated multi-factor variants. It also supports authentication via a SBB-own DC protocol, which makes it a good pair for DCAuth control. In default configuration the component uses the attached database of users to handle authentication requests. The authentication flow can be altered if needed to match specific authentication requirements. In Authenticator's terms, the authentication process is divided into a sequence of atomic steps. Each step is characterized by a user providing an authentication token - such as a password or PIN - and the authenticator validating that token. Each validation step may result in one of the following outcomes: - **Authentication succeeded**: the authentication has been completed with the positive outcome; - **Authentication failed**: the authentication process has failed, the user didn't provide enough evidence to confirm they are who they claim they are; - **Further authentication is required**: the authentication was partly successful, but the settings of the component or user details require further step(s) to be taken. Use the following logic when integrating the Authenticator into your project: - Whenever you receive an authentication request from a user, call the [StartAuth](#startauth-method-authenticator-class) method, passing the UserID as a parameter. This initiates the authentication procedure: the Authenticator control looks up the user in the [Users](#users-property-authenticator-class) database and picks the first authentication method. It then returns the *Further authentication is required* result and stores the details of the first authentication step in [AuthInfo](#authinfo-property-authenticator-class) property. Apart from the information about the authentication method that is to be performed during this step, [AuthInfo](#authinfo-property-authenticator-class) also contains a [STATE](#AuthInfo_f_STATE)> value, which accumulates parameters and progress of the user's authentication flow. You can save the state value on this stage, and restore it later when a response from the user is received. With that in mind, class is stateless; you can save the current authentication state in a database, and return to it from a different context. - Now that you have obtained *Further authentication needed* from [StartAuth](#startauth-method-authenticator-class), it's time to check the [AUTHMETHOD](#AuthInfo_f_AUTHMETHOD)> and request the corresponding token from the user. For example, if the method is 'password', you may present the user with a password dialog. - Upon receiving a password (or other kind of authentication token) from the user, pass it to the [ContinueAuth](#continueauth-method-authenticator-class) method, together with the state object that you saved on the preceding step. The component will process the token and come up with one of the three results given above, signifying the end of the first authentication step. If *Further authentication is required* result is returned, another authentication step needs to be performed (either because a multi-factor authentication is configured for this user, or because an alternative authentication method was chosen following failure of the previous attempt). If that is the case, follow the guidance for [StartAuth](#startauth-method-authenticator-class)-initiated step above. Depending on the settings, many authentication steps may need to be performed, so your code may ultimately end up calling [ContinueAuth](#continueauth-method-authenticator-class) many times. class can be customized to use external user information sources instead of a predefined user database. [AuthStart](#authstart-event-authenticator-class), [AuthVerify](#authverify-event-authenticator-class), and [AuthAttemptResult](#authattemptresult-event-authenticator-class) events provide an opportunity for your code to intervene into the authentication process by defining your own authentication procedures and validating authentication tokens manually. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthInfo](#authinfo-property-authenticator-class) | Contains details of the current authentication step. | | [BlockedCertificates](#blockedcertificates-property-authenticator-class) | The certificates that must be rejected as trust anchors. | | [Certificates](#certificates-property-authenticator-class) | A collection of certificates included in the electronic signature. | | [ChainValidationDetails](#chainvalidationdetails-property-authenticator-class) | The details of a certificate chain validation outcome. | | [ChainValidationResult](#chainvalidationresult-property-authenticator-class) | The general outcome of a certificate chain validation routine. Use ChainValidationDetails to get information about the reasons that contributed to the validation result. | | [DefaultAuthMethods](#defaultauthmethods-property-authenticator-class) | Contains the list of default authentication methods. | | [ExternalCrypto](#externalcrypto-property-authenticator-class) | Provides access to external signing and DC parameters. | | [FIPSMode](#fipsmode-property-authenticator-class) | Reserved. | | [IgnoreChainValidationErrors](#ignorechainvalidationerrors-property-authenticator-class) | Makes the class tolerant to chain validation errors. | | [KnownCertificates](#knowncertificates-property-authenticator-class) | Additional certificates for chain validation. | | [KnownCRLs](#knowncrls-property-authenticator-class) | Additional CRLs for chain validation. | | [KnownOCSPs](#knownocsps-property-authenticator-class) | Additional OCSP responses for chain validation. | | [OfflineMode](#offlinemode-property-authenticator-class) | Switches the class to offline mode. | | [Proxy](#proxy-property-authenticator-class) | The proxy server settings. | | [RevocationCheck](#revocationcheck-property-authenticator-class) | Specifies the kind(s) of revocation check to perform for all chain certificates. | | [SigningCertificate](#signingcertificate-property-authenticator-class) | The certificate to be used for signing. | | [SocketSettings](#socketsettings-property-authenticator-class) | Manages network connection settings. | | [TLSSettings](#tlssettings-property-authenticator-class) | Manages TLS layer settings. | | [TrustedCertificates](#trustedcertificates-property-authenticator-class) | A list of trusted certificates for chain validation. | | [Users](#users-property-authenticator-class) | A collection of known users along with their authentication settings. | | [ValidationLog](#validationlog-property-authenticator-class) | Contains the complete log of the certificate validation routine. | | [ValidationMoment](#validationmoment-property-authenticator-class) | The time point at which signature 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](#config-method-authenticator-class) | Sets or retrieves a configuration setting. | | [ContinueAuth](#continueauth-method-authenticator-class) | Call this method to process an authentication token and proceed to the next authentication step. | | [DoAction](#doaction-method-authenticator-class) | Performs an additional action. | | [Reset](#reset-method-authenticator-class) | Resets the class settings. | | [StartAuth](#startauth-method-authenticator-class) | Initiates an authentication process. | ## 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.* | | | | --- | --- | | [AuthAttemptResult](#authattemptresult-event-authenticator-class) | Reports the outcome of an authentication attempt. | | [AuthAttemptStart](#authattemptstart-event-authenticator-class) | Signifies the start of an authentication attempt. | | [AuthStart](#authstart-event-authenticator-class) | Signifies the start of an authentication process. | | [AuthVerify](#authverify-event-authenticator-class) | Requests the application to validate an authentication token. | | [CustomAuthStart](#customauthstart-event-authenticator-class) | Reports the beginning of a custom authentication method. | | [Error](#error-event-authenticator-class) | Reports information about errors during authentication. | | [Notification](#notification-event-authenticator-class) | This event notifies the application about an underlying control flow event. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BaseTime](#BaseTime) | TBD. | | [ChainCurrentCACert](#ChainCurrentCACert) | Returns the current CA certificate. | | [ChainCurrentCert](#ChainCurrentCert) | Returns the certificate that is currently being validated. | | [ChainCurrentCRL](#ChainCurrentCRL) | Returns the current CRL. | | [ChainCurrentCRLSize](#ChainCurrentCRLSize) | Returns the size of the current CRL. | | [ChainCurrentOCSP](#ChainCurrentOCSP) | Returns the current OCSP response. | | [ChainCurrentOCSPSigner](#ChainCurrentOCSPSigner) | Returns the signer of the current OCSP object. | | [ChainInterimDetails](#ChainInterimDetails) | Returns the current interim validation details. | | [ChainInterimResult](#ChainInterimResult) | Returns the current interim validation result. | | [CheckValidityPeriodForTrusted](#CheckValidityPeriodForTrusted) | Whether to check validity period for trusted certificates. | | [Delta](#Delta) | TBD. | | [DislikeOpenEndedOCSPs](#DislikeOpenEndedOCSPs) | Tells the class to discourage OCSP responses without an explicit NextUpdate parameter. | | [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. | | [EvaluateSystemTrustForSelfSignedCertificates](#EvaluateSystemTrustForSelfSignedCertificates) | Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates. | | [EvaluateSystemTrustForSSL](#EvaluateSystemTrustForSSL) | Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS. | | [ForceCompleteChainValidation](#ForceCompleteChainValidation) | Whether to check the CA certificates when the signing certificate is invalid. | | [ForceCompleteChainValidationForTrusted](#ForceCompleteChainValidationForTrusted) | Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. | | [GracePeriod](#GracePeriod) | Specifies a grace period to apply during revocation information checks. | | [IgnoreChainLoops](#IgnoreChainLoops) | Whether chain loops should be ignored. | | [IgnoreOCSPNoCheckExtension](#IgnoreOCSPNoCheckExtension) | Whether the OCSP NoCheck extension should be ignored. | | [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. | | [ImplicitlyTrustSelfSignedCertificates](#ImplicitlyTrustSelfSignedCertificates) | Whether to trust self-signed certificates. | | [PromoteLongOCSPResponses](#PromoteLongOCSPResponses) | Whether long OCSP responses are requested. | | [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. | | [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. | | [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. | | [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. | | [UseValidationCache](#UseValidationCache) | Enables or disable the use of the product-wide certificate chain validation cache. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # AuthInfo Property ([Authenticator](#authenticator-class) Class) Contains details of the current authentication step. ## Syntax ```text SecureBlackboxAuthInfo* GetAuthInfo(); ``` ## Remarks Check this object to get details about the current authentication step, such as authentication method, its parameters, the overall authentication state, and information about completed and pending authentication methods. This property is read-only and not available at design time. ## Data Type [SecureBlackboxAuthInfo](#authinfo-type) # BlockedCertificates Property ([Authenticator](#authenticator-class) Class) The certificates that must be rejected as trust anchors. ## Syntax ```text SecureBlackboxList* GetBlockedCertificates(); int SetBlockedCertificates(SecureBlackboxList* val); ``` ## 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 [SecureBlackboxCertificate](#certificate-type) # Certificates Property ([Authenticator](#authenticator-class) Class) A collection of certificates included in the electronic signature. ## Syntax ```text SecureBlackboxList* GetCertificates(); ``` ## Remarks This property includes a collection of certificates of the currently selected info. This property is read-only and not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # ChainValidationDetails Property ([Authenticator](#authenticator-class) Class) The details of a certificate chain validation outcome. ## Syntax ```text ANSI (Cross Platform) int GetChainValidationDetails(); Unicode (Windows) 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 ([Authenticator](#authenticator-class) 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 ```text ANSI (Cross Platform) int GetChainValidationResult(); Unicode (Windows) INT GetChainValidationResult(); ``` ## Possible Values ```text CVT_VALID(0), CVT_VALID_BUT_UNTRUSTED(1), CVT_INVALID(2), CVT_CANT_BE_ESTABLISHED(3) ``` ## 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 # DefaultAuthMethods Property ([Authenticator](#authenticator-class) Class) Contains the list of default authentication methods. ## Syntax ```text ANSI (Cross Platform) char* GetDefaultAuthMethods();int SetDefaultAuthMethods(const char* lpszDefaultAuthMethods); Unicode (Windows) LPWSTR GetDefaultAuthMethods();INT SetDefaultAuthMethods(LPCWSTR lpszDefaultAuthMethods); ``` ## Default Value "" ## Remarks Use this property to specify a list of default authentication methods to apply to users that are not included in the [Users](#users-property-authenticator-class) database. Assign this property with a comma-separated list of standard and custom authentication methods. The following standard authentication methods are supported by the component: - password - otp-h - otp-t - dcauth You can use any names not clashing with the standard methods to indicate your own custom authentication methods. Use [CustomAuthStart](#customauthstart-event-authenticator-class) and [AuthVerify](#authverify-event-authenticator-class) events to handle custom authentication methods. ## Data Type String # ExternalCrypto Property ([Authenticator](#authenticator-class) Class) Provides access to external signing and DC parameters. ## Syntax ```text SecureBlackboxExternalCrypto* GetExternalCrypto(); ``` ## Remarks Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component). This property is read-only. ## Data Type [SecureBlackboxExternalCrypto](#externalcrypto-type) # FIPSMode Property ([Authenticator](#authenticator-class) Class) Reserved. ## Syntax ```text ANSI (Cross Platform) int GetFIPSMode();int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode); ``` ## Default Value FALSE ## Remarks This property is reserved for future use. ## Data Type Boolean # IgnoreChainValidationErrors Property ([Authenticator](#authenticator-class) Class) Makes the class tolerant to chain validation errors. ## Syntax ```text ANSI (Cross Platform) int GetIgnoreChainValidationErrors();int SetIgnoreChainValidationErrors(int bIgnoreChainValidationErrors); Unicode (Windows) BOOL GetIgnoreChainValidationErrors();INT SetIgnoreChainValidationErrors(BOOL bIgnoreChainValidationErrors); ``` ## Default Value FALSE ## Remarks If this property is set to True, any errors emerging during certificate chain validation will be ignored. This setting may be handy if the purpose of validation is the creation of an LTV signature, and the validation is performed in an environment that doesn't trust the signer's certificate chain. ## Data Type Boolean # KnownCertificates Property ([Authenticator](#authenticator-class) Class) Additional certificates for chain validation. ## Syntax ```text SecureBlackboxList* GetKnownCertificates(); int SetKnownCertificates(SecureBlackboxList* val); ``` ## 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](#trustedcertificates-property-authenticator-class) instead. This property is not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # KnownCRLs Property ([Authenticator](#authenticator-class) Class) Additional CRLs for chain validation. ## Syntax ```text SecureBlackboxList* GetKnownCRLs(); int SetKnownCRLs(SecureBlackboxList* val); ``` ## 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 [SecureBlackboxCRL](#crl-type) # KnownOCSPs Property ([Authenticator](#authenticator-class) Class) Additional OCSP responses for chain validation. ## Syntax ```text SecureBlackboxList* GetKnownOCSPs(); int SetKnownOCSPs(SecureBlackboxList* val); ``` ## 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 [SecureBlackboxOCSPResponse](#ocspresponse-type) # OfflineMode Property ([Authenticator](#authenticator-class) Class) Switches the class to offline mode. ## Syntax ```text ANSI (Cross Platform) int GetOfflineMode();int SetOfflineMode(int bOfflineMode); Unicode (Windows) 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](#knowncertificates-property-authenticator-class), [KnownCRLs](#knowncrls-property-authenticator-class), and other related properties. ## Data Type Boolean # Proxy Property ([Authenticator](#authenticator-class) Class) The proxy server settings. ## Syntax ```text SecureBlackboxProxySettings* GetProxy(); ``` ## Remarks Use this property to tune up the proxy server settings. This property is read-only. ## Data Type [SecureBlackboxProxySettings](#proxysettings-type) # RevocationCheck Property ([Authenticator](#authenticator-class) Class) Specifies the kind(s) of revocation check to perform for all chain certificates. ## Syntax ```text ANSI (Cross Platform) int GetRevocationCheck();int SetRevocationCheck(int iRevocationCheck); Unicode (Windows) INT GetRevocationCheck();INT SetRevocationCheck(INT iRevocationCheck); ``` ## Possible Values ```text 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) ``` ## 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 # SigningCertificate Property ([Authenticator](#authenticator-class) Class) The certificate to be used for signing. ## Syntax ```text SecureBlackboxCertificate* GetSigningCertificate(); int SetSigningCertificate(SecureBlackboxCertificate* val); ``` ## Remarks Use this property to specify the certificate that shall be used for signing the data. Note that this certificate should have a private key associated with it. Use SigningChain to supply the rest of the certificate chain for inclusion into the signature. This property is not available at design time. ## Data Type [SecureBlackboxCertificate](#certificate-type) # SocketSettings Property ([Authenticator](#authenticator-class) Class) Manages network connection settings. ## Syntax ```text SecureBlackboxSocketSettings* GetSocketSettings(); ``` ## Remarks Use this property to tune up network connection parameters. This property is read-only. ## Data Type [SecureBlackboxSocketSettings](#socketsettings-type) # TLSSettings Property ([Authenticator](#authenticator-class) Class) Manages TLS layer settings. ## Syntax ```text SecureBlackboxTLSSettings* GetTLSSettings(); ``` ## Remarks Use this property to tune up the TLS layer parameters. This property is read-only. ## Data Type [SecureBlackboxTLSSettings](#tlssettings-type) # TrustedCertificates Property ([Authenticator](#authenticator-class) Class) A list of trusted certificates for chain validation. ## Syntax ```text SecureBlackboxList* GetTrustedCertificates(); int SetTrustedCertificates(SecureBlackboxList* val); ``` ## 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 [SecureBlackboxCertificate](#certificate-type) # Users Property ([Authenticator](#authenticator-class) Class) A collection of known users along with their authentication settings. ## Syntax ```text SecureBlackboxList* GetUsers(); int SetUsers(SecureBlackboxList* val); ``` ## Remarks Use this property to access the database of known users and their authentication details. This property is not available at design time. ## Data Type [SecureBlackboxUserAccount](#useraccount-type) # ValidationLog Property ([Authenticator](#authenticator-class) Class) Contains the complete log of the certificate validation routine. ## Syntax ```text ANSI (Cross Platform) char* GetValidationLog(); Unicode (Windows) LPWSTR 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 ([Authenticator](#authenticator-class) Class) The time point at which signature validity is to be established. ## Syntax ```text ANSI (Cross Platform) char* GetValidationMoment();int SetValidationMoment(const char* lpszValidationMoment); Unicode (Windows) LPWSTR GetValidationMoment();INT SetValidationMoment(LPCWSTR lpszValidationMoment); ``` ## Default Value "" ## Remarks Use this property to specify the moment in time at which signature validity should be established. The time is in UTC. Leave the setting empty to stick to the default moment (either the signature creation time or the current time). The validity of the same signature may differ depending on the time point chosen due to temporal changes in chain validities, revocation statuses, and timestamp times. ## Data Type String # Config Method ([Authenticator](#authenticator-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-authenticator-class) 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](#config-settings-authenticator-class), 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. # ContinueAuth Method ([Authenticator](#authenticator-class) Class) Call this method to process an authentication token and proceed to the next authentication step. ## Syntax ```text ANSI (Cross Platform) int ContinueAuth(const char* lpszState, const char* lpszAuthToken); Unicode (Windows) INT ContinueAuth(LPCWSTR lpszState, LPCWSTR lpszAuthToken); ``` ## Remarks Call this method upon receiving an authentication token from the user to validate it and proceed to the next authentication step (or complete the authentication). Pass the authentication state blob that you obtained at the beginning of the authentication step to the *State* parameter, and the authentication credential received from the user to the *AuthToken* parameter. The method will validate the token and return one of the following results: | | | | --- | --- | | arAuthFurtherAuthNeeded | 0 | | arAuthSucceeded | 1 | | arAuthFailed | 2 | The *further authentication needed* result indicates that the user is expected to go through at least one more authentication step. Check [AuthInfo](#authinfo-property-authenticator-class) property to find out which authentication method should be used on that step, and request the relevant authentication token from the user. Upon receiving that new token, call ContinueAuth again - and continue running this loop until *authentication succeeded* or *authentication failed* result is returned. ## 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. # DoAction Method ([Authenticator](#authenticator-class) Class) Performs an additional action. ## Syntax ```text ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams); ``` ## 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. # Reset Method ([Authenticator](#authenticator-class) Class) Resets the class settings. ## Syntax ```text ANSI (Cross Platform) int Reset(); Unicode (Windows) 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.) # StartAuth Method ([Authenticator](#authenticator-class) Class) Initiates an authentication process. ## Syntax ```text ANSI (Cross Platform) int StartAuth(const char* lpszUserID); Unicode (Windows) INT StartAuth(LPCWSTR lpszUserID); ``` ## Remarks Call this method to start an authentication process for *UserID*. The authentication process may consist of multiple atomic steps. Each step represents a single authentication transaction, such as provision of a password, a PIN, or a one-time token. The exact authentication step sequence for the user is chosen according to the following rules: - If the user is found in the [Users](#users-property-authenticator-class) database, all authentication methods specified for that user are activated; - otherwise, the methods assigned to [DefaultAuthMethods](#defaultauthmethods-property-authenticator-class) are activated; - [AuthStart](#authstart-event-authenticator-class) event is thrown, allowing the application to tune up the selection of authentication methods if needed. - the first method from the list is initiated. This method may return one of the three results: | | | | --- | --- | | arAuthFurtherAuthNeeded | 0 | | arAuthSucceeded | 1 | | arAuthFailed | 2 | The *authentication succeeded* result is returned if the authentication method selection procedure completed with an empty method list. A typical result of this method though is *further authentication required*, which indicates that the next authentication method has kicked off. Use rpAuthInfo; property to find out which authentication method should be used on this step, and solicit the relevant authentication token from the user. Pass the received token to the [ContinueAuth](#continueauth-method-authenticator-class) method for 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. # AuthAttemptResult Event ([Authenticator](#authenticator-class) Class) Reports the outcome of an authentication attempt. ## Syntax ```text ANSI (Cross Platform) virtual int FireAuthAttemptResult(AuthenticatorAuthAttemptResultEventParams *e); typedef struct { const char *UserID; const char *AuthMethod; int AuthRes; char *RemainingAuthMethods; int reserved; } AuthenticatorAuthAttemptResultEventParams; Unicode (Windows) virtual INT FireAuthAttemptResult(AuthenticatorAuthAttemptResultEventParams *e); typedef struct { LPCWSTR UserID; LPCWSTR AuthMethod; INT AuthRes; LPWSTR RemainingAuthMethods; INT reserved; } AuthenticatorAuthAttemptResultEventParams; ``` ## Remarks This event follows a call to [ContinueAuth](#continueauth-method-authenticator-class) method and reports the user's updated authentication status following the token verification. The updated status is reported via the *AuthRes* parameter, and can take one of the following values: | | | | --- | --- | | arAuthFurtherAuthNeeded | 0 | | arAuthSucceeded | 1 | | arAuthFailed | 2 | The *RemainingAuthMethods* parameter lists the authentication methods that the user is yet to go through. The application can change either of *AuthRes* and *RemainingAuthMethods* in the event handler to alter the authentication flow. # AuthAttemptStart Event ([Authenticator](#authenticator-class) Class) Signifies the start of an authentication attempt. ## Syntax ```text ANSI (Cross Platform) virtual int FireAuthAttemptStart(AuthenticatorAuthAttemptStartEventParams *e); typedef struct { const char *UserID; const char *AuthMethod; const char *RemainingAuthMethods; int reserved; } AuthenticatorAuthAttemptStartEventParams; Unicode (Windows) virtual INT FireAuthAttemptStart(AuthenticatorAuthAttemptStartEventParams *e); typedef struct { LPCWSTR UserID; LPCWSTR AuthMethod; LPCWSTR RemainingAuthMethods; INT reserved; } AuthenticatorAuthAttemptStartEventParams; ``` ## Remarks This event reports the start of an atomic authentication step. The *AuthMethod* parameter contains the authentication method that has started. The following authentication methods are currently supported, but the application may define its own methods in [AuthStart](#authstart-event-authenticator-class), and tune them up in [CustomAuthStart](#customauthstart-event-authenticator-class): - password - otp-h - otp-t - dcauth *RemainingAuthMethods* contains a list of authentication methods that will follow. This event is thrown from [StartAuth](#startauth-method-authenticator-class) and [ContinueAuth](#continueauth-method-authenticator-class) methods. # AuthStart Event ([Authenticator](#authenticator-class) Class) Signifies the start of an authentication process. ## Syntax ```text ANSI (Cross Platform) virtual int FireAuthStart(AuthenticatorAuthStartEventParams *e); typedef struct { const char *UserID; char *AuthMethods; int reserved; } AuthenticatorAuthStartEventParams; Unicode (Windows) virtual INT FireAuthStart(AuthenticatorAuthStartEventParams *e); typedef struct { LPCWSTR UserID; LPWSTR AuthMethods; INT reserved; } AuthenticatorAuthStartEventParams; ``` ## Remarks This event is fired in response to a [StartAuth](#startauth-method-authenticator-class) call, and signifies the start of a (potentially, multi-step) authentication process for *UserID*. The *AuthMethods* parameter list the methods to be performed for the user. The application may customize them as needed. The following default authentication methods are supported: - password - otp-h - otp-t - dcauth The application can define its own authentication methods if needed. This event is only fired once per user authentication process, at the very start of it. See [AuthAttemptStart](#authattemptstart-event-authenticator-class) for per-step notification. # AuthVerify Event ([Authenticator](#authenticator-class) Class) Requests the application to validate an authentication token. ## Syntax ```text ANSI (Cross Platform) virtual int FireAuthVerify(AuthenticatorAuthVerifyEventParams *e); typedef struct { const char *UserID; const char *AuthMethod; const char *AuthToken; const char *AuthMethodData; int Valid; int reserved; } AuthenticatorAuthVerifyEventParams; Unicode (Windows) virtual INT FireAuthVerify(AuthenticatorAuthVerifyEventParams *e); typedef struct { LPCWSTR UserID; LPCWSTR AuthMethod; LPCWSTR AuthToken; LPCWSTR AuthMethodData; BOOL Valid; INT reserved; } AuthenticatorAuthVerifyEventParams; ``` ## Remarks Class fires this event to ask the application to validate an authentication token that it can't validate automatically. This can happen if *UserID* was not found in the user database or a custom authentication method is used. *AuthMethod* and *AuthToken* specify the authentication method being used and the authentication token provided by the user. *AuthMethodData* contains an application-specific data provided by the application at the beginning of the authentication step. An event handler subscribed to this event should validate the authentication token provided by the user and set the *Valid* parameter accordingly. # CustomAuthStart Event ([Authenticator](#authenticator-class) Class) Reports the beginning of a custom authentication method. ## Syntax ```text ANSI (Cross Platform) virtual int FireCustomAuthStart(AuthenticatorCustomAuthStartEventParams *e); typedef struct { const char *UserID; const char *AuthMethod; char *AuthMethodPars; char *AuthMethodData; int reserved; } AuthenticatorCustomAuthStartEventParams; Unicode (Windows) virtual INT FireCustomAuthStart(AuthenticatorCustomAuthStartEventParams *e); typedef struct { LPCWSTR UserID; LPCWSTR AuthMethod; LPWSTR AuthMethodPars; LPWSTR AuthMethodData; INT reserved; } AuthenticatorCustomAuthStartEventParams; ``` ## Remarks This event marks the start of an authentication method not supported by class internally and requests authentication parameters from the application. Class currently supports the following authentication methods: - password - otp-h - otp-t - dcauth The application may also use any number of custom authentication method it wants. Each such method is identified by a unique string name (such as 'pin', 'fingerprint', or 'fingerprint-v2'). It may specify them in [DefaultAuthMethods](#defaultauthmethods-property-authenticator-class) property, or provide on the fly via [AuthStart](#authstart-event-authenticator-class) event. The event handler may return authentication parameters and application-specific data to be associated with the authentication attempt via *AuthMethodPars* and *AuthMethodData* parameters. # Error Event ([Authenticator](#authenticator-class) Class) Reports information about errors during authentication. ## Syntax ```text ANSI (Cross Platform) virtual int FireError(AuthenticatorErrorEventParams *e); typedef struct { int ErrorCode; const char *Description; int reserved; } AuthenticatorErrorEventParams; Unicode (Windows) virtual INT FireError(AuthenticatorErrorEventParams *e); typedef struct { INT ErrorCode; LPCWSTR Description; INT reserved; } AuthenticatorErrorEventParams; ``` ## Remarks The event is fired in case of exceptional conditions during user authentication. *ErrorCode* contains an error code and *Description* contains a textual description of the error. # Notification Event ([Authenticator](#authenticator-class) Class) This event notifies the application about an underlying control flow event. ## Syntax ```text ANSI (Cross Platform) virtual int FireNotification(AuthenticatorNotificationEventParams *e); typedef struct { const char *EventID; const char *EventParam; int reserved; } AuthenticatorNotificationEventParams; Unicode (Windows) virtual INT FireNotification(AuthenticatorNotificationEventParams *e); typedef struct { LPCWSTR EventID; LPCWSTR EventParam; INT reserved; } AuthenticatorNotificationEventParams; ``` ## 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. # AuthInfo Type A container for authentication step information. ## Syntax *SecureBlackboxAuthInfo* (declared in *secureblackbox.h*) ## Remarks AuthInfo objects are used to store current authentication information, such as userid and state. The following fields are available: - [AuthLog](#AuthInfo_f_AuthLog) - [AuthMethod](#AuthInfo_f_AuthMethod) - [AuthMethodPars](#AuthInfo_f_AuthMethodPars) - [CompletedMethods](#AuthInfo_f_CompletedMethods) - [LastAuthMessage](#AuthInfo_f_LastAuthMessage) - [LastAuthResult](#AuthInfo_f_LastAuthResult) - [RemainingMethods](#AuthInfo_f_RemainingMethods) - [State](#AuthInfo_f_State) - [UserID](#AuthInfo_f_UserID) ## Fields **AuthLog** *char* (read-only)* *Default Value: ""* Contains the authentication log. This can be used for accountability purposes. **AuthMethod** *char* (read-only)* *Default Value: ""* Contains the current authentication method. **AuthMethodPars** *char* (read-only)* *Default Value: ""* Contains the authentication method parameters. These are method-dependent. For example, the *dcauth* method will have a DC request in this property. **CompletedMethods** *char* (read-only)* *Default Value: ""* Contains a comma-separated list of completed authentication methods. **LastAuthMessage** *char* (read-only)* *Default Value: ""* Contains an uninterpreted authentication message to be displayed to the authenticating user. **LastAuthResult** *int (read-only)* *Default Value: -1* Contains the result of the last authentication token validation. **RemainingMethods** *char* (read-only)* *Default Value: ""* Contains a comma-separated list of authentication methods yet to perform. **State** *char* (read-only)* *Default Value: ""* Contains a state of the overall authentication process. Save the content of this property after calling [StartAuth](#startauth-method-authenticator-class) or [ContinueAuth](#continueauth-method-authenticator-class) to remember the setup of the authenticator control, and pass it to the next [ContinueAuth](#continueauth-method-authenticator-class) call to resume from the same stage. **UserID** *char* (read-only)* *Default Value: ""* Returns the ID of the user being authenticated, as passed to StartAuth. ## Constructors ```text AuthInfo() ``` Creates a new AuthInfo object. # 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. The following fields are available: - [Bytes](#Certificate_f_Bytes) - [CA](#Certificate_f_CA) - [CAKeyID](#Certificate_f_CAKeyID) - [CertType](#Certificate_f_CertType) - [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints) - [Curve](#Certificate_f_Curve) - [Fingerprint](#Certificate_f_Fingerprint) - [FriendlyName](#Certificate_f_FriendlyName) - [Handle](#Certificate_f_Handle) - [HashAlgorithm](#Certificate_f_HashAlgorithm) - [Issuer](#Certificate_f_Issuer) - [IssuerRDN](#Certificate_f_IssuerRDN) - [KeyAlgorithm](#Certificate_f_KeyAlgorithm) - [KeyBits](#Certificate_f_KeyBits) - [KeyFingerprint](#Certificate_f_KeyFingerprint) - [KeyUsage](#Certificate_f_KeyUsage) - [KeyValid](#Certificate_f_KeyValid) - [OCSPLocations](#Certificate_f_OCSPLocations) - [OCSPNoCheck](#Certificate_f_OCSPNoCheck) - [Origin](#Certificate_f_Origin) - [PolicyIDs](#Certificate_f_PolicyIDs) - [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) - [PrivateKeyExists](#Certificate_f_PrivateKeyExists) - [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable) - [PublicKeyBytes](#Certificate_f_PublicKeyBytes) - [Qualified](#Certificate_f_Qualified) - [QualifiedStatements](#Certificate_f_QualifiedStatements) - [Qualifiers](#Certificate_f_Qualifiers) - [SelfSigned](#Certificate_f_SelfSigned) - [SerialNumber](#Certificate_f_SerialNumber) - [SigAlgorithm](#Certificate_f_SigAlgorithm) - [Source](#Certificate_f_Source) - [Subject](#Certificate_f_Subject) - [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName) - [SubjectKeyID](#Certificate_f_SubjectKeyID) - [SubjectRDN](#Certificate_f_SubjectRDN) - [Valid](#Certificate_f_Valid) - [ValidFrom](#Certificate_f_ValidFrom) - [ValidTo](#Certificate_f_ValidTo) ## Fields **Bytes** *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](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. **CertType** *int (read-only)* *Default Value: 0* Returns the type of the entity contained in the [Certificate](#certificate-type) object. A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](CertificateManager.md#CertificateManager) 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. ```text 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](#Certificate_f_SigAlgorithm) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | **Issuer** *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](#Certificate_f_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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains. **KeyBits** *int (read-only)* *Default 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](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_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](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. **KeyUsage** *int* *Default 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](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. **OCSPNoCheck** *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](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. **PrivateKeyExtractable** *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](#Certificate_f_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](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. **SubjectKeyID** *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](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. **SubjectRDN** *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 ```text 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. The following fields are available: - [Bytes](#CRL_f_Bytes) - [CAKeyID](#CRL_f_CAKeyID) - [EntryCount](#CRL_f_EntryCount) - [Handle](#CRL_f_Handle) - [Issuer](#CRL_f_Issuer) - [IssuerRDN](#CRL_f_IssuerRDN) - [Location](#CRL_f_Location) - [NextUpdate](#CRL_f_NextUpdate) - [SigAlgorithm](#CRL_f_SigAlgorithm) - [Source](#CRL_f_Source) - [TBS](#CRL_f_TBS) - [ThisUpdate](#CRL_f_ThisUpdate) ## Fields **Bytes** *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. ```text 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 ```text CRL() ``` Creates an empty CRL object. # ExternalCrypto Type Specifies the parameters of external cryptographic calls. ## Syntax *SecureBlackboxExternalCrypto* (declared in *secureblackbox.h*) ## Remarks External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally. The following fields are available: - [AsyncDocumentID](#ExternalCrypto_f_AsyncDocumentID) - [CustomParams](#ExternalCrypto_f_CustomParams) - [Data](#ExternalCrypto_f_Data) - [ExternalHashCalculation](#ExternalCrypto_f_ExternalHashCalculation) - [HashAlgorithm](#ExternalCrypto_f_HashAlgorithm) - [KeyID](#ExternalCrypto_f_KeyID) - [KeySecret](#ExternalCrypto_f_KeySecret) - [Method](#ExternalCrypto_f_Method) - [Mode](#ExternalCrypto_f_Mode) - [PublicKeyAlgorithm](#ExternalCrypto_f_PublicKeyAlgorithm) ## Fields **AsyncDocumentID** *char** *Default Value: ""* Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. **CustomParams** *char** *Default Value: ""* Custom parameters to be passed to the signing service (uninterpreted). **Data** *char** *Default Value: ""* Additional data to be included in the async state and mirrored back by the requestor. **ExternalHashCalculation** *int* *Default Value: FALSE* Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. **HashAlgorithm** *char** *Default Value: "SHA256"* Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | 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 | | **KeyID** *char** *Default Value: ""* The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [KeySecret](#ExternalCrypto_f_KeySecret) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` **KeySecret** *char** *Default Value: ""* The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [KeyID](#ExternalCrypto_f_KeyID) topic. **Method** *int* *Default Value: 0* Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | **Mode** *int* *Default Value: 0* Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | **PublicKeyAlgorithm** *char** *Default Value: ""* Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Constructors ```text ExternalCrypto() ``` Creates a new ExternalCrypto object with default field values. # 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. The following fields are available: - [Bytes](#OCSPResponse_f_Bytes) - [EntryCount](#OCSPResponse_f_EntryCount) - [Handle](#OCSPResponse_f_Handle) - [Issuer](#OCSPResponse_f_Issuer) - [IssuerRDN](#OCSPResponse_f_IssuerRDN) - [Location](#OCSPResponse_f_Location) - [ProducedAt](#OCSPResponse_f_ProducedAt) - [SigAlgorithm](#OCSPResponse_f_SigAlgorithm) - [Source](#OCSPResponse_f_Source) ## Fields **Bytes** *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. ```text 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 ```text 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. The following fields are available: - [Address](#ProxySettings_f_Address) - [Authentication](#ProxySettings_f_Authentication) - [Password](#ProxySettings_f_Password) - [Port](#ProxySettings_f_Port) - [ProxyType](#ProxySettings_f_ProxyType) - [RequestHeaders](#ProxySettings_f_RequestHeaders) - [ResponseBody](#ProxySettings_f_ResponseBody) - [ResponseHeaders](#ProxySettings_f_ResponseHeaders) - [UseIPv6](#ProxySettings_f_UseIPv6) - [Username](#ProxySettings_f_Username) ## Fields **Address** *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 ```text ProxySettings() ``` Creates a new ProxySettings 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. The following fields are available: - [DNSMode](#SocketSettings_f_DNSMode) - [DNSPort](#SocketSettings_f_DNSPort) - [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout) - [DNSServers](#SocketSettings_f_DNSServers) - [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout) - [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit) - [LocalAddress](#SocketSettings_f_LocalAddress) - [LocalPort](#SocketSettings_f_LocalPort) - [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit) - [Timeout](#SocketSettings_f_Timeout) - [UseIPv6](#SocketSettings_f_UseIPv6) ## Fields **DNSMode** *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 ```text 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. The following fields are available: - [AutoValidateCertificates](#TLSSettings_f_AutoValidateCertificates) - [BaseConfiguration](#TLSSettings_f_BaseConfiguration) - [Ciphersuites](#TLSSettings_f_Ciphersuites) - [ClientAuth](#TLSSettings_f_ClientAuth) - [Extensions](#TLSSettings_f_Extensions) - [ForceResumeIfDestinationChanges](#TLSSettings_f_ForceResumeIfDestinationChanges) - [Groups](#TLSSettings_f_Groups) - [PreSharedIdentity](#TLSSettings_f_PreSharedIdentity) - [PreSharedKey](#TLSSettings_f_PreSharedKey) - [PreSharedKeyCiphersuite](#TLSSettings_f_PreSharedKeyCiphersuite) - [RenegotiationAttackPreventionMode](#TLSSettings_f_RenegotiationAttackPreventionMode) - [RevocationCheck](#TLSSettings_f_RevocationCheck) - [SSLOptions](#TLSSettings_f_SSLOptions) - [TLSMode](#TLSSettings_f_TLSMode) - [UseExtendedMasterSecret](#TLSSettings_f_UseExtendedMasterSecret) - [UseSessionResumption](#TLSSettings_f_UseSessionResumption) - [Versions](#TLSSettings_f_Versions) ## Fields **AutoValidateCertificates** *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](#TLSSettings_f_BaseConfiguration). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below: - NULL_NULL_NULL - RSA_NULL_MD5 - RSA_NULL_SHA - RSA_RC4_MD5 - RSA_RC4_SHA - RSA_RC2_MD5 - RSA_IDEA_MD5 - RSA_IDEA_SHA - RSA_DES_MD5 - RSA_DES_SHA - RSA_3DES_MD5 - RSA_3DES_SHA - RSA_AES128_SHA - RSA_AES256_SHA - DH_DSS_DES_SHA - DH_DSS_3DES_SHA - DH_DSS_AES128_SHA - DH_DSS_AES256_SHA - DH_RSA_DES_SHA - DH_RSA_3DES_SHA - DH_RSA_AES128_SHA - DH_RSA_AES256_SHA - DHE_DSS_DES_SHA - DHE_DSS_3DES_SHA - DHE_DSS_AES128_SHA - DHE_DSS_AES256_SHA - DHE_RSA_DES_SHA - DHE_RSA_3DES_SHA - DHE_RSA_AES128_SHA - DHE_RSA_AES256_SHA - DH_ANON_RC4_MD5 - DH_ANON_DES_SHA - DH_ANON_3DES_SHA - DH_ANON_AES128_SHA - DH_ANON_AES256_SHA - RSA_RC2_MD5_EXPORT - RSA_RC4_MD5_EXPORT - RSA_DES_SHA_EXPORT - DH_DSS_DES_SHA_EXPORT - DH_RSA_DES_SHA_EXPORT - DHE_DSS_DES_SHA_EXPORT - DHE_RSA_DES_SHA_EXPORT - DH_ANON_RC4_MD5_EXPORT - DH_ANON_DES_SHA_EXPORT - RSA_CAMELLIA128_SHA - DH_DSS_CAMELLIA128_SHA - DH_RSA_CAMELLIA128_SHA - DHE_DSS_CAMELLIA128_SHA - DHE_RSA_CAMELLIA128_SHA - DH_ANON_CAMELLIA128_SHA - RSA_CAMELLIA256_SHA - DH_DSS_CAMELLIA256_SHA - DH_RSA_CAMELLIA256_SHA - DHE_DSS_CAMELLIA256_SHA - DHE_RSA_CAMELLIA256_SHA - DH_ANON_CAMELLIA256_SHA - PSK_RC4_SHA - PSK_3DES_SHA - PSK_AES128_SHA - PSK_AES256_SHA - DHE_PSK_RC4_SHA - DHE_PSK_3DES_SHA - DHE_PSK_AES128_SHA - DHE_PSK_AES256_SHA - RSA_PSK_RC4_SHA - RSA_PSK_3DES_SHA - RSA_PSK_AES128_SHA - RSA_PSK_AES256_SHA - RSA_SEED_SHA - DH_DSS_SEED_SHA - DH_RSA_SEED_SHA - DHE_DSS_SEED_SHA - DHE_RSA_SEED_SHA - DH_ANON_SEED_SHA - SRP_SHA_3DES_SHA - SRP_SHA_RSA_3DES_SHA - SRP_SHA_DSS_3DES_SHA - SRP_SHA_AES128_SHA - SRP_SHA_RSA_AES128_SHA - SRP_SHA_DSS_AES128_SHA - SRP_SHA_AES256_SHA - SRP_SHA_RSA_AES256_SHA - SRP_SHA_DSS_AES256_SHA - ECDH_ECDSA_NULL_SHA - ECDH_ECDSA_RC4_SHA - ECDH_ECDSA_3DES_SHA - ECDH_ECDSA_AES128_SHA - ECDH_ECDSA_AES256_SHA - ECDHE_ECDSA_NULL_SHA - ECDHE_ECDSA_RC4_SHA - ECDHE_ECDSA_3DES_SHA - ECDHE_ECDSA_AES128_SHA - ECDHE_ECDSA_AES256_SHA - ECDH_RSA_NULL_SHA - ECDH_RSA_RC4_SHA - ECDH_RSA_3DES_SHA - ECDH_RSA_AES128_SHA - ECDH_RSA_AES256_SHA - ECDHE_RSA_NULL_SHA - ECDHE_RSA_RC4_SHA - ECDHE_RSA_3DES_SHA - ECDHE_RSA_AES128_SHA - ECDHE_RSA_AES256_SHA - ECDH_ANON_NULL_SHA - ECDH_ANON_RC4_SHA - ECDH_ANON_3DES_SHA - ECDH_ANON_AES128_SHA - ECDH_ANON_AES256_SHA - RSA_NULL_SHA256 - RSA_AES128_SHA256 - RSA_AES256_SHA256 - DH_DSS_AES128_SHA256 - DH_RSA_AES128_SHA256 - DHE_DSS_AES128_SHA256 - DHE_RSA_AES128_SHA256 - DH_DSS_AES256_SHA256 - DH_RSA_AES256_SHA256 - DHE_DSS_AES256_SHA256 - DHE_RSA_AES256_SHA256 - DH_ANON_AES128_SHA256 - DH_ANON_AES256_SHA256 - RSA_AES128_GCM_SHA256 - RSA_AES256_GCM_SHA384 - DHE_RSA_AES128_GCM_SHA256 - DHE_RSA_AES256_GCM_SHA384 - DH_RSA_AES128_GCM_SHA256 - DH_RSA_AES256_GCM_SHA384 - DHE_DSS_AES128_GCM_SHA256 - DHE_DSS_AES256_GCM_SHA384 - DH_DSS_AES128_GCM_SHA256 - DH_DSS_AES256_GCM_SHA384 - DH_ANON_AES128_GCM_SHA256 - DH_ANON_AES256_GCM_SHA384 - ECDHE_ECDSA_AES128_SHA256 - ECDHE_ECDSA_AES256_SHA384 - ECDH_ECDSA_AES128_SHA256 - ECDH_ECDSA_AES256_SHA384 - ECDHE_RSA_AES128_SHA256 - ECDHE_RSA_AES256_SHA384 - ECDH_RSA_AES128_SHA256 - ECDH_RSA_AES256_SHA384 - ECDHE_ECDSA_AES128_GCM_SHA256 - ECDHE_ECDSA_AES256_GCM_SHA384 - ECDH_ECDSA_AES128_GCM_SHA256 - ECDH_ECDSA_AES256_GCM_SHA384 - ECDHE_RSA_AES128_GCM_SHA256 - ECDHE_RSA_AES256_GCM_SHA384 - ECDH_RSA_AES128_GCM_SHA256 - ECDH_RSA_AES256_GCM_SHA384 - PSK_AES128_GCM_SHA256 - PSK_AES256_GCM_SHA384 - DHE_PSK_AES128_GCM_SHA256 - DHE_PSK_AES256_GCM_SHA384 - RSA_PSK_AES128_GCM_SHA256 - RSA_PSK_AES256_GCM_SHA384 - PSK_AES128_SHA256 - PSK_AES256_SHA384 - PSK_NULL_SHA256 - PSK_NULL_SHA384 - DHE_PSK_AES128_SHA256 - DHE_PSK_AES256_SHA384 - DHE_PSK_NULL_SHA256 - DHE_PSK_NULL_SHA384 - RSA_PSK_AES128_SHA256 - RSA_PSK_AES256_SHA384 - RSA_PSK_NULL_SHA256 - RSA_PSK_NULL_SHA384 - RSA_CAMELLIA128_SHA256 - DH_DSS_CAMELLIA128_SHA256 - DH_RSA_CAMELLIA128_SHA256 - DHE_DSS_CAMELLIA128_SHA256 - DHE_RSA_CAMELLIA128_SHA256 - DH_ANON_CAMELLIA128_SHA256 - RSA_CAMELLIA256_SHA256 - DH_DSS_CAMELLIA256_SHA256 - DH_RSA_CAMELLIA256_SHA256 - DHE_DSS_CAMELLIA256_SHA256 - DHE_RSA_CAMELLIA256_SHA256 - DH_ANON_CAMELLIA256_SHA256 - ECDHE_ECDSA_CAMELLIA128_SHA256 - ECDHE_ECDSA_CAMELLIA256_SHA384 - ECDH_ECDSA_CAMELLIA128_SHA256 - ECDH_ECDSA_CAMELLIA256_SHA384 - ECDHE_RSA_CAMELLIA128_SHA256 - ECDHE_RSA_CAMELLIA256_SHA384 - ECDH_RSA_CAMELLIA128_SHA256 - ECDH_RSA_CAMELLIA256_SHA384 - RSA_CAMELLIA128_GCM_SHA256 - RSA_CAMELLIA256_GCM_SHA384 - DHE_RSA_CAMELLIA128_GCM_SHA256 - DHE_RSA_CAMELLIA256_GCM_SHA384 - DH_RSA_CAMELLIA128_GCM_SHA256 - DH_RSA_CAMELLIA256_GCM_SHA384 - DHE_DSS_CAMELLIA128_GCM_SHA256 - DHE_DSS_CAMELLIA256_GCM_SHA384 - DH_DSS_CAMELLIA128_GCM_SHA256 - DH_DSS_CAMELLIA256_GCM_SHA384 - DH_anon_CAMELLIA128_GCM_SHA256 - DH_anon_CAMELLIA256_GCM_SHA384 - ECDHE_ECDSA_CAMELLIA128_GCM_SHA256 - ECDHE_ECDSA_CAMELLIA256_GCM_SHA384 - ECDH_ECDSA_CAMELLIA128_GCM_SHA256 - ECDH_ECDSA_CAMELLIA256_GCM_SHA384 - ECDHE_RSA_CAMELLIA128_GCM_SHA256 - ECDHE_RSA_CAMELLIA256_GCM_SHA384 - ECDH_RSA_CAMELLIA128_GCM_SHA256 - ECDH_RSA_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_GCM_SHA256 - PSK_CAMELLIA256_GCM_SHA384 - DHE_PSK_CAMELLIA128_GCM_SHA256 - DHE_PSK_CAMELLIA256_GCM_SHA384 - RSA_PSK_CAMELLIA128_GCM_SHA256 - RSA_PSK_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_SHA256 - PSK_CAMELLIA256_SHA384 - DHE_PSK_CAMELLIA128_SHA256 - DHE_PSK_CAMELLIA256_SHA384 - RSA_PSK_CAMELLIA128_SHA256 - RSA_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_CAMELLIA128_SHA256 - ECDHE_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_RC4_SHA - ECDHE_PSK_3DES_SHA - ECDHE_PSK_AES128_SHA - ECDHE_PSK_AES256_SHA - ECDHE_PSK_AES128_SHA256 - ECDHE_PSK_AES256_SHA384 - ECDHE_PSK_NULL_SHA - ECDHE_PSK_NULL_SHA256 - ECDHE_PSK_NULL_SHA384 - ECDHE_RSA_CHACHA20_POLY1305_SHA256 - ECDHE_ECDSA_CHACHA20_POLY1305_SHA256 - DHE_RSA_CHACHA20_POLY1305_SHA256 - PSK_CHACHA20_POLY1305_SHA256 - ECDHE_PSK_CHACHA20_POLY1305_SHA256 - DHE_PSK_CHACHA20_POLY1305_SHA256 - RSA_PSK_CHACHA20_POLY1305_SHA256 - AES128_GCM_SHA256 - AES256_GCM_SHA384 - CHACHA20_POLY1305_SHA256 - AES128_CCM_SHA256 - AES128_CCM8_SHA256 **ClientAuth** *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 | | **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. **Groups** *char** *Default Value: ""* Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. **PreSharedIdentity** *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: TRUE* 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: 48* The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | ## Constructors ```text TLSSettings() ``` Creates a new TLSSettings object. # UserAccount Type A container for user account information. ## Syntax *SecureBlackboxUserAccount* (declared in *secureblackbox.h*) ## Remarks UserAccount objects are used to store user account information, such as logins and passwords. The following fields are available: - [AssociatedData](#UserAccount_f_AssociatedData) - [BasePath](#UserAccount_f_BasePath) - [Certificate](#UserAccount_f_Certificate) - [Data](#UserAccount_f_Data) - [Email](#UserAccount_f_Email) - [Handle](#UserAccount_f_Handle) - [HashAlgorithm](#UserAccount_f_HashAlgorithm) - [IncomingSpeedLimit](#UserAccount_f_IncomingSpeedLimit) - [OtpAlgorithm](#UserAccount_f_OtpAlgorithm) - [OTPLen](#UserAccount_f_OTPLen) - [OtpValue](#UserAccount_f_OtpValue) - [OutgoingSpeedLimit](#UserAccount_f_OutgoingSpeedLimit) - [Password](#UserAccount_f_Password) - [SharedSecret](#UserAccount_f_SharedSecret) - [SSHKey](#UserAccount_f_SSHKey) - [Username](#UserAccount_f_Username) ## Fields **AssociatedData** *char** *Default Value: * Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. **BasePath** *char** *Default Value: ""* Base path for this user in the server's file system. **Certificate** *char** *Default Value: * Contains the user's certificate. **Data** *char** *Default Value: ""* Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. **Email** *char** *Default Value: ""* The user's email address. **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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` **HashAlgorithm** *char** *Default Value: ""* Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests: | | | | | --- | --- | --- | | SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | | | SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | | | SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 | | **IncomingSpeedLimit** *int* *Default Value: 0* Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation". **OtpAlgorithm** *int* *Default Value: 0* The algorithm used to generate one-time passwords (OTP) for this user, either HOTP (Hash-based OTP) or TOTP (Time-based OTP). In the former case, a value of a dedicated counter is used to generate a unique password, while in the latter the password is generated on the basis of the current time value. | | | | | --- | --- | --- | | oaHmac | 0 | | | oaTime | 1 | | **OTPLen** *int* *Default Value: 0* Specifies the length of the user's OTP password. **OtpValue** *int* *Default Value: 0* The user's time interval (TOTP) or Counter (HOTP). **OutgoingSpeedLimit** *int* *Default Value: 0* Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation". **Password** *char** *Default Value: ""* The user's authentication password. **SharedSecret** *char** *Default Value: * Contains the user's secret key, which is essentially a shared secret between the client and server. Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other. **SSHKey** *char** *Default Value: * Contains the user's SSH key. **Username** *char** *Default Value: ""* The registered name (login) of the user. ## Constructors ```text UserAccount() ``` Creates a new UserAccount object # SecureBlackboxList Type ## Syntax *SecureBlackboxList* (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 Authenticator class. ```text int GetCount() {} ``` ```text int SetCount(int count) {} ``` ```text T* Get(int index) {} ``` ```text T* Set(int index, T* value) {} ``` | | | | --- | --- | | Methods | | | GetCount | This method returns the current size of the collection. | | 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. | | 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. | | 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. | # Config Settings ([Authenticator](#authenticator-class) 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](#config-method-authenticator-class) method. ### DCAuthenticator Config Settings **BaseTime**: TBD.TBD **ChainCurrentCACert**: Returns the current CA certificate.This property returns the CA certificate that is used on the current step. **ChainCurrentCert**: Returns the certificate that is currently being validated.Use this property to obtain the body of the certificate that is currently being validated. **ChainCurrentCRL**: Returns the current CRL.Returns the CRL object that is currently being processed. **ChainCurrentCRLSize**: Returns the size of the current CRL.This property returns the size of the CRL object that is currently being processed. **ChainCurrentOCSP**: Returns the current OCSP response.Returns the OCSP object that is currently being processed. **ChainCurrentOCSPSigner**: Returns the signer of the current OCSP object.Returns the signer/CA that has issued the OCSP response that is currently being processed. **ChainInterimDetails**: Returns the current interim validation details.This property returns the interim chain validation details. **ChainInterimResult**: Returns the current interim validation result.Use this setting to obtain the current (mid-chain) validation result. This property applies to the current validation step and may change as the chain walk proceeds. The final result will be published in the ChainValidationResult property once the validation process completes. **CheckValidityPeriodForTrusted**: Whether to check validity period for trusted certificates.Whether to check validity period for trusted certificates. **Delta**: TBD.TBD **DislikeOpenEndedOCSPs**: Tells the class to discourage OCSP responses without an explicit NextUpdate parameter.When this property is set to True, the validation engine treats OCSP response without a NextUpdate field as 'substandard' and tries to obtain some further revocation material for the certificate in question (a different OCSP or a CRL, even if the class is configured to prefer the OCSP route). This is to work around Adobe Reader's intolerance to such OCSPs when classifying signed documents as LTV (as of August 2022). **EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is disabled by default, because enabling it may prevent the AdES components from collecting full revocation information required for long-term validation (LTV) signatures. **EvaluateSystemTrustForSelfSignedCertificates**: Enables or disables usage of the platform's built-in trust validation facilities for self-signed certificates.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) for self-signed certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **EvaluateSystemTrustForSSL**: Enables or disables usage of the platform's built-in trust validation facilities for SSL/TLS.When enabled, the component delegates the certificate chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms) specifically for SSL/TLS certificates. This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **ForceCompleteChainValidation**: Whether to check the CA certificates when the signing certificate is invalid.Set this property to True to check issuer (CA) certificates if the signing or an intermediate chain certificate is invalid. **ForceCompleteChainValidationForTrusted**: Whether to continue with the full validation up to the root CA certificate for mid-level trust anchors. Set this property to True to enable full chain validation for explicitly trusted intermediary or end-entity certificates. This may be useful when creating signatures to enforce completeness of the collected revocation information. It often makes sense to set this property to false when validating signatures to reduce validation time and avoid issues with badly configured environments. **GracePeriod**: Specifies a grace period to apply during revocation information checks.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. **IgnoreChainLoops**: Whether chain loops should be ignored.Set this property to True to make the validation engine ignore chain loops. This may be an option when you need to process chains from buggy CAs that happen to include subchains that sign themselves. **IgnoreOCSPNoCheckExtension**: Whether the OCSP NoCheck extension should be ignored.Set this property to True to make the validation engine ignore the OCSP no-check extension. You would normally need to set this property when validating severely non-compliant chains that misuse the extension, causing chain loops or other validation issues. **IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the class should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the class should trust the certificates residing in the Trusted Root Certification Authorities store. If [IgnoreSystemTrust](#IgnoreSystemTrust) is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the [TrustedCertificates](#trustedcertificates-property-authenticator-class) property) are considered trusted. **ImplicitlyTrustSelfSignedCertificates**: Whether to trust self-signed certificates. Set this property to True to implicitly trust all self-signed certificates. Use it with care as trusting just about every self-signed certificate is unwise. One exceptional reason where this property may be handy is where a chain is validated in an environment that is not supposed to trust it (for example, a signing, rather than verifying environment, or a QA server). Trusting all self-signing certificates (which are normally trusted) allows emulating the verifying environment without actually changing its security settings. **PromoteLongOCSPResponses**: Whether long OCSP responses are requested. Set this property to True to force the class to publish the 'long' form of OCSP responses. Otherwise, only BasicOCSPResponse blobs are promoted. **TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are: - CA, revocation source, TLS key usage requirements are not mandated - Violation of OCSP issuer requirements are ignored - The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates) - Basic constraints and name constraints of CA certificates are ignored - Some weaker algorithms are tolerated **UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages. **UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. **UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in 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. **UseValidationCache**: Enables or disable the use of the product-wide certificate chain validation cache.Use this property to enable or disable the use of the global chain validation cache. If enabled, the class will consult the product-wide validation cache when validating the signing chains. Also, the outcomes of any new chain validations performed by the class, both interim and final, will be saved in the cache and available for re-use by any future validations. Disable this property to ignore the cache and always perform the validation from a fresh start. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([Authenticator](#authenticator-class) 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.