# DCAuth Class

The DCAuth class represents the private key side of the SecureBlackbox distributed cryptography protocol.

## Class Name

**SecureBlackbox_DCAuth**

## Procedural Interface

```text
 secureblackbox_dcauth_open();
 secureblackbox_dcauth_close($res);
 secureblackbox_dcauth_register_callback($res, $id, $function);
 secureblackbox_dcauth_get_last_error($res);
 secureblackbox_dcauth_get_last_error_code($res);
 secureblackbox_dcauth_set($res, $id, $index, $value);
 secureblackbox_dcauth_get($res, $id, $index);
 secureblackbox_dcauth_do_config($res, $configurationstring);
 secureblackbox_dcauth_do_doaction($res, $actionid, $actionparams);
 secureblackbox_dcauth_do_processrequest($res);
 secureblackbox_dcauth_do_reset($res);
```

## Remarks

The purpose of DCAuth is to sign *async requests* produced by *SignAsyncBegin* calls. For each incoming *async request* containing a document hash, DCAuth produces the corresponding *async response* containing a signature over that hash.

### Protocol Overview

The distributed cryptography protocol involves two principal parties. The *signing party*, represented by classes such as [PDFSigner](PDFSigner.md#PDFSigner), [XAdESSigner](XAdESSigner.md#XAdESSigner), or [OfficeSigner](OfficeSigner.md#OfficeSigner), pre-signs documents (such as PDF files), and encapsulates their hashes into what is called an *async request*. It then communicates the async request to the *private key side*, where the DCAuth class extracts the hash and signs it with a local private key. DCAuth then encapsulates the signature into an *async response*, which is sent back to the signing party. The signing party completes the signing operation by extracting the signature from the async response and embedding it into the pre-signed document.

The protocol supports a variety of uses. The scheme above describes the most typical of them, where the signing party is represented by a web application, and the private key side is represented by a workstation. In that particular scenario DC provides a mechanism for the web app to sign documents residing on the web server with private keys residing on the users workstations, perhaps in non-exportable form (e.g. a USB dongle). Other uses include creation of a signing server for a team of driver developers, or an automated signing gateway for outgoing official documents.

In the webapp-to-browser setting the DCAuth control would normally be used within a web server running on the users workstation. That web server would accept async requests from the web page running in the browser, use DCAuth to generate the matching async response, and feed that response back to the web page. The web page will then submit it back to the web server.

### Configuring and Using DCAuth

To process an async request, you need to set up a DCAuth object first, and then call its [ProcessRequest](#processrequest-method-secureblackbox_dcauth-class) method:

- Set the *KeyId* and *KeySecret* properties so they match the credentials used by the signing party - e.g. those of PDFSigner object:

```text
      DCAuth.KeyId = "mykeyid";
      DCAuth.KeySecret = "mykeysecret123";

```

These two properties are used to verify the integrity of the incoming async requests. Keep them safe.
- Provide the signing certificate:

```text
      DCAuth.SigningCertificate = "C:\Certs\SigningCert.pfx";
      DCAuth.CertPassword = "password789";

```

Alternatively, use [StorageId](#storageid-property-secureblackbox_dcauth-class) to provide a certificate residing elsewhere, such as a PKCS#11 device.
- Assign the async request to the [Input](#input-property-secureblackbox_dcauth-class) property:

```text
      DCAuth.Input = Request;

```

Make sure to provide the request in its original XML format. Some technologies and SecureBlackbox code samples may apply additional encoding when conveying async requests from their origin to the DCAuth endpoint. Please double check that you assign the request without any encodings applied. An async request is a properly formed XML document with the root element of *SecureBlackboxAsyncState*.
- Call the [ProcessRequest](#processrequest-method-secureblackbox_dcauth-class) method:

```text
      DCAuth.ProcessRequest;

```

This method performs the actual signing of the hash. Make sure your code is prepared for potential signing errors.
- If the [ProcessRequest](#processrequest-method-secureblackbox_dcauth-class) call has succeeded, grab the async response from the [Output](#output-property-secureblackbox_dcauth-class) property:

```text
      Result = DCAuth.Output;

```

 Please see the demo folder for more in-depth code examples of this class.

## Property List

*The following is the full list of the properties of the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [ClaimedSigningTime](#claimedsigningtime-property-secureblackbox_dcauth-class) | The signing time from the signer's computer. |
| [ExternalCryptoAsyncDocumentID](#externalcryptoasyncdocumentid-property-secureblackbox_dcauth-class) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| [ExternalCryptoCustomParams](#externalcryptocustomparams-property-secureblackbox_dcauth-class) | Custom parameters to be passed to the signing service (uninterpreted). |
| [ExternalCryptoData](#externalcryptodata-property-secureblackbox_dcauth-class) | Additional data to be included in the async state and mirrored back by the requestor. |
| [ExternalCryptoExternalHashCalculation](#externalcryptoexternalhashcalculation-property-secureblackbox_dcauth-class) | Specifies whether the message hash is to be calculated at the external endpoint. |
| [ExternalCryptoHashAlgorithm](#externalcryptohashalgorithm-property-secureblackbox_dcauth-class) | Specifies the request's signature hash algorithm. |
| [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_dcauth-class) | The ID of the pre-shared key used for DC request authentication. |
| [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_dcauth-class) | The pre-shared key used for DC request authentication. |
| [ExternalCryptoMethod](#externalcryptomethod-property-secureblackbox_dcauth-class) | Specifies the asynchronous signing method. |
| [ExternalCryptoMode](#externalcryptomode-property-secureblackbox_dcauth-class) | Specifies the external cryptography mode. |
| [ExternalCryptoPublicKeyAlgorithm](#externalcryptopublickeyalgorithm-property-secureblackbox_dcauth-class) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. |
| [FIPSMode](#fipsmode-property-secureblackbox_dcauth-class) | Reserved. |
| [Input](#input-property-secureblackbox_dcauth-class) | Contains the signing request to process. |
| [InputEncoding](#inputencoding-property-secureblackbox_dcauth-class) | Specifies request encoding. |
| [KeyId](#keyid-property-secureblackbox_dcauth-class) | Specifies the KeyID of the pre-shared authentication key. |
| [KeySecret](#keysecret-property-secureblackbox_dcauth-class) | The pre-shared authentication key. |
| [Output](#output-property-secureblackbox_dcauth-class) | Contains the output of the request processing. |
| [OutputEncoding](#outputencoding-property-secureblackbox_dcauth-class) | Specifies response encoding. |
| [Policies](#policies-property-secureblackbox_dcauth-class) | Specifies the policies to use when processing requests. |
| [Profile](#profile-property-secureblackbox_dcauth-class) | Specifies a pre-defined profile to apply when creating the signature. |
| [ProxyAddress](#proxyaddress-property-secureblackbox_dcauth-class) | The IP address of the proxy server. |
| [ProxyAuthentication](#proxyauthentication-property-secureblackbox_dcauth-class) | The authentication type used by the proxy server. |
| [ProxyPassword](#proxypassword-property-secureblackbox_dcauth-class) | The password to authenticate to the proxy server. |
| [ProxyPort](#proxyport-property-secureblackbox_dcauth-class) | The port on the proxy server to connect to. |
| [ProxyType](#proxytype-property-secureblackbox_dcauth-class) | The type of the proxy server. |
| [ProxyRequestHeaders](#proxyrequestheaders-property-secureblackbox_dcauth-class) | Contains HTTP request headers for WebTunnel and HTTP proxy. |
| [ProxyResponseBody](#proxyresponsebody-property-secureblackbox_dcauth-class) | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
| [ProxyResponseHeaders](#proxyresponseheaders-property-secureblackbox_dcauth-class) | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
| [ProxyUseIPv6](#proxyuseipv6-property-secureblackbox_dcauth-class) | Specifies whether IPv6 should be used when connecting through the proxy. |
| [ProxyUsername](#proxyusername-property-secureblackbox_dcauth-class) | Specifies the username credential for proxy authentication. |
| [SigningCertBytes](#signingcertbytes-property-secureblackbox_dcauth-class) | Returns the raw certificate data in DER format. |
| [SigningCertHandle](#signingcerthandle-property-secureblackbox_dcauth-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [SigningChainCount](#signingchaincount-property-secureblackbox_dcauth-class) | The number of records in the SigningChain arrays. |
| [SigningChainBytes](#signingchainbytes-property-secureblackbox_dcauth-class) | Returns the raw certificate data in DER format. |
| [SigningChainHandle](#signingchainhandle-property-secureblackbox_dcauth-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [SocketDNSMode](#socketdnsmode-property-secureblackbox_dcauth-class) | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
| [SocketDNSPort](#socketdnsport-property-secureblackbox_dcauth-class) | Specifies the port number to be used for sending queries to the DNS server. |
| [SocketDNSQueryTimeout](#socketdnsquerytimeout-property-secureblackbox_dcauth-class) | The timeout (in milliseconds) for each DNS query. |
| [SocketDNSServers](#socketdnsservers-property-secureblackbox_dcauth-class) | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
| [SocketDNSTotalTimeout](#socketdnstotaltimeout-property-secureblackbox_dcauth-class) | The timeout (in milliseconds) for the whole resolution process. |
| [SocketIncomingSpeedLimit](#socketincomingspeedlimit-property-secureblackbox_dcauth-class) | The maximum number of bytes to read from the socket, per second. |
| [SocketLocalAddress](#socketlocaladdress-property-secureblackbox_dcauth-class) | The local network interface to bind the socket to. |
| [SocketLocalPort](#socketlocalport-property-secureblackbox_dcauth-class) | The local port number to bind the socket to. |
| [SocketOutgoingSpeedLimit](#socketoutgoingspeedlimit-property-secureblackbox_dcauth-class) | The maximum number of bytes to write to the socket, per second. |
| [SocketTimeout](#sockettimeout-property-secureblackbox_dcauth-class) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
| [SocketUseIPv6](#socketuseipv6-property-secureblackbox_dcauth-class) | Enables or disables IP protocol version 6. |
| [StorageId](#storageid-property-secureblackbox_dcauth-class) | Specifies the signing certificate residing in an alternative location. |
| [TimestampServer](#timestampserver-property-secureblackbox_dcauth-class) | The address of the timestamping server. |
| [TLSClientCertCount](#tlsclientcertcount-property-secureblackbox_dcauth-class) | The number of records in the TLSClientCert arrays. |
| [TLSClientCertBytes](#tlsclientcertbytes-property-secureblackbox_dcauth-class) | Returns the raw certificate data in DER format. |
| [TLSClientCertHandle](#tlsclientcerthandle-property-secureblackbox_dcauth-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) | The number of records in the TLSServerCert arrays. |
| [TLSServerCertBytes](#tlsservercertbytes-property-secureblackbox_dcauth-class) | Returns the raw certificate data in DER format. |
| [TLSServerCertFingerprint](#tlsservercertfingerprint-property-secureblackbox_dcauth-class) | Contains the fingerprint (a hash imprint) of this certificate. |
| [TLSServerCertHandle](#tlsservercerthandle-property-secureblackbox_dcauth-class) | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
| [TLSServerCertIssuer](#tlsservercertissuer-property-secureblackbox_dcauth-class) | The common name of the certificate issuer (CA), typically a company name. |
| [TLSServerCertIssuerRDN](#tlsservercertissuerrdn-property-secureblackbox_dcauth-class) | A list of Property=Value pairs that uniquely identify the certificate issuer. |
| [TLSServerCertKeyAlgorithm](#tlsservercertkeyalgorithm-property-secureblackbox_dcauth-class) | Specifies the public key algorithm of this certificate. |
| [TLSServerCertKeyBits](#tlsservercertkeybits-property-secureblackbox_dcauth-class) | Returns the length of the public key in bits. |
| [TLSServerCertKeyUsage](#tlsservercertkeyusage-property-secureblackbox_dcauth-class) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
| [TLSServerCertSelfSigned](#tlsservercertselfsigned-property-secureblackbox_dcauth-class) | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
| [TLSServerCertSerialNumber](#tlsservercertserialnumber-property-secureblackbox_dcauth-class) | Returns the certificate's serial number. |
| [TLSServerCertSigAlgorithm](#tlsservercertsigalgorithm-property-secureblackbox_dcauth-class) | Indicates the algorithm that was used by the CA to sign this certificate. |
| [TLSServerCertSubject](#tlsservercertsubject-property-secureblackbox_dcauth-class) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
| [TLSServerCertSubjectRDN](#tlsservercertsubjectrdn-property-secureblackbox_dcauth-class) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). |
| [TLSServerCertValidFrom](#tlsservercertvalidfrom-property-secureblackbox_dcauth-class) | The time point at which the certificate becomes valid, in UTC. |
| [TLSServerCertValidTo](#tlsservercertvalidto-property-secureblackbox_dcauth-class) | The time point at which the certificate expires, in UTC. |
| [TLSAutoValidateCertificates](#tlsautovalidatecertificates-property-secureblackbox_dcauth-class) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
| [TLSBaseConfiguration](#tlsbaseconfiguration-property-secureblackbox_dcauth-class) | Selects the base configuration for the TLS settings. |
| [TLSCiphersuites](#tlsciphersuites-property-secureblackbox_dcauth-class) | A list of ciphersuites separated with commas or semicolons. |
| [TLSClientAuth](#tlsclientauth-property-secureblackbox_dcauth-class) | Enables or disables certificate-based client authentication. |
| [TLSExtensions](#tlsextensions-property-secureblackbox_dcauth-class) | Provides access to TLS extensions. |
| [TLSForceResumeIfDestinationChanges](#tlsforceresumeifdestinationchanges-property-secureblackbox_dcauth-class) | Whether to force TLS session resumption when the destination address changes. |
| [TLSGroups](#tlsgroups-property-secureblackbox_dcauth-class) | Specifies a list of key exchange groups to attempt during the TLS key exchange. |
| [TLSPreSharedIdentity](#tlspresharedidentity-property-secureblackbox_dcauth-class) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
| [TLSPreSharedKey](#tlspresharedkey-property-secureblackbox_dcauth-class) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
| [TLSPreSharedKeyCiphersuite](#tlspresharedkeyciphersuite-property-secureblackbox_dcauth-class) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
| [TLSRenegotiationAttackPreventionMode](#tlsrenegotiationattackpreventionmode-property-secureblackbox_dcauth-class) | Selects the renegotiation attack prevention mechanism. |
| [TLSRevocationCheck](#tlsrevocationcheck-property-secureblackbox_dcauth-class) | Specifies the kind(s) of revocation check to perform. |
| [TLSSSLOptions](#tlsssloptions-property-secureblackbox_dcauth-class) | Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size. |
| [TLSMode](#tlsmode-property-secureblackbox_dcauth-class) | Specifies the TLS mode to use. |
| [TLSUseExtendedMasterSecret](#tlsuseextendedmastersecret-property-secureblackbox_dcauth-class) | Enables the Extended Master Secret Extension, as defined in RFC 7627. |
| [TLSUseSessionResumption](#tlsusesessionresumption-property-secureblackbox_dcauth-class) | Enables or disables the TLS session resumption capability. |
| [TLSVersions](#tlsversions-property-secureblackbox_dcauth-class) | The SSL/TLS versions to enable by default. |

## 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-secureblackbox_dcauth-class) | Sets or retrieves a configuration setting. |
| [DoAction](#doaction-method-secureblackbox_dcauth-class) | Performs an additional action. |
| [ProcessRequest](#processrequest-method-secureblackbox_dcauth-class) | Processes the request. |
| [Reset](#reset-method-secureblackbox_dcauth-class) | Resets the class settings. |

## 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.*

|  |  |
| --- | --- |
| [CustomParametersReceived](#customparametersreceived-event-secureblackbox_dcauth-class) | Passes custom request parameters to the application. |
| [Error](#error-event-secureblackbox_dcauth-class) | Reports information about errors during request processing or signing. |
| [ExternalSign](#externalsign-event-secureblackbox_dcauth-class) | Handles remote or external signing initiated by the SignExternal method or other source. |
| [KeySecretNeeded](#keysecretneeded-event-secureblackbox_dcauth-class) | Requests the key secret from the application. |
| [Notification](#notification-event-secureblackbox_dcauth-class) | This event notifies the application about an underlying control flow event. |
| [ParameterReceived](#parameterreceived-event-secureblackbox_dcauth-class) | Passes a standard request parameter to the user code. |
| [SignRequest](#signrequest-event-secureblackbox_dcauth-class) | This event signifies the processing of an atomic signing request. |
| [SignRequestCompleted](#signrequestcompleted-event-secureblackbox_dcauth-class) | This event signifies completion of the processing of an atomic signing request. |
| [TimestampRequest](#timestamprequest-event-secureblackbox_dcauth-class) | Fires when the class is ready to request a timestamp from an external TSA. |
| [TLSCertNeeded](#tlscertneeded-event-secureblackbox_dcauth-class) | Fires when a remote TLS party requests a client certificate. |
| [TLSCertValidate](#tlscertvalidate-event-secureblackbox_dcauth-class) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. |
| [TLSEstablished](#tlsestablished-event-secureblackbox_dcauth-class) | Fires when a TLS handshake with Host successfully completes. |
| [TLSHandshake](#tlshandshake-event-secureblackbox_dcauth-class) | Fires when a new TLS handshake is initiated, before the handshake commences. |
| [TLSShutdown](#tlsshutdown-event-secureblackbox_dcauth-class) | Reports the graceful closure of a TLS connection. |

## Config Settings

*The following is a list of config settings for the class with short descriptions. Click on the links for further details.*

|  |  |
| --- | --- |
| [DataURL](#DataURL) | (obsolete) The DataURL parameter to pass to the signer. |
| [FingerprintAlgorithm](#FingerprintAlgorithm) | The fingerprint algorithm to use. |
| [GoURL](#GoURL) | (obsolete) The GoURL parameter to pass to the signer. |
| [PolicyHash](#PolicyHash) | The EPES policy hash. |
| [PolicyHashAlgorithm](#PolicyHashAlgorithm) | The EPES policy hash algorithm. |
| [PolicyID](#PolicyID) | The EPES policy identifier. |
| [PolicyURI](#PolicyURI) | The EPES policy URL. |
| [RequireDefinedSignCert](#RequireDefinedSignCert) | (obsolete) The RequireDefinedSignCert parameter to pass to the signer. |
| [SchemeParams](#SchemeParams) | The algorithm scheme parameters to employ. |
| [SessionID](#SessionID) | (obsolete) The SessionID parameter to pass to the signer. |
| [TLSChainValidationDetails](#TLSChainValidationDetails) | Contains the advanced details of the TLS server certificate validation. |
| [TLSChainValidationResult](#TLSChainValidationResult) | Contains the result of the TLS server certificate validation. |
| [TLSClientAuthRequested](#TLSClientAuthRequested) | Indicates whether the TLS server requests client authentication. |
| [TLSValidationLog](#TLSValidationLog) | Contains the log of the TLS server certificate validation. |
| [TokenName](#TokenName) | The TokenName parameter to pass to the signer. |
| [TokensLibraries](#TokensLibraries) | (obsolete) The TokensLibraries parameter to pass to the signer. |
| [TspAttemptCount](#TspAttemptCount) | Specifies the number of timestamping request attempts. |
| [TspHashAlgorithm](#TspHashAlgorithm) | Sets a specific hash algorithm for use with the timestamping service. |
| [TspReqPolicy](#TspReqPolicy) | Sets a request policy ID to include in the timestamping request. |
| [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. |

# ClaimedSigningTime Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The signing time from the signer's computer.

## Object Oriented Interface

```text
public function getClaimedSigningTime();
public function setClaimedSigningTime($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 1 );
secureblackbox_dcauth_set($res, 1, $value );
```

## Default Value

''

## Remarks

Use this property to provide the signature production time. The claimed time is not supported by a trusted source; it may be inaccurate, forfeited, or wrong, and as such is usually taken for informational purposes only by verifiers. Use timestamp servers to embed verifiable trusted timestamps. The time is in UTC.

## Data Type

String

# ExternalCryptoAsyncDocumentID Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

## Object Oriented Interface

```text
public function getExternalCryptoAsyncDocumentID();
public function setExternalCryptoAsyncDocumentID($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 2 );
secureblackbox_dcauth_set($res, 2, $value );
```

## Default Value

''

## Remarks

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.

## Data Type

String

# ExternalCryptoCustomParams Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Custom parameters to be passed to the signing service (uninterpreted).

## Object Oriented Interface

```text
public function getExternalCryptoCustomParams();
public function setExternalCryptoCustomParams($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 3 );
secureblackbox_dcauth_set($res, 3, $value );
```

## Default Value

''

## Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

## Data Type

String

# ExternalCryptoData Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Additional data to be included in the async state and mirrored back by the requestor.

## Object Oriented Interface

```text
public function getExternalCryptoData();
public function setExternalCryptoData($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 4 );
secureblackbox_dcauth_set($res, 4, $value );
```

## Default Value

''

## Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

## Data Type

String

# ExternalCryptoExternalHashCalculation Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies whether the message hash is to be calculated at the external endpoint.

## Object Oriented Interface

```text
public function getExternalCryptoExternalHashCalculation();
public function setExternalCryptoExternalHashCalculation($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 5 );
secureblackbox_dcauth_set($res, 5, $value );
```

## Default Value

false

## Remarks

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.

## Data Type

Boolean

# ExternalCryptoHashAlgorithm Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the request's signature hash algorithm.

## Object Oriented Interface

```text
public function getExternalCryptoHashAlgorithm();
public function setExternalCryptoHashAlgorithm($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 6 );
secureblackbox_dcauth_set($res, 6, $value );
```

## Default Value

'SHA256'

## Remarks

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

## Data Type

String

# ExternalCryptoKeyID Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The ID of the pre-shared key used for DC request authentication.

## Object Oriented Interface

```text
public function getExternalCryptoKeyID();
public function setExternalCryptoKeyID($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 7 );
secureblackbox_dcauth_set($res, 7, $value );
```

## Default Value

''

## Remarks

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 [ExternalCryptoKeySecret](#externalcryptokeysecret-property-secureblackbox_dcauth-class) 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";
```

## Data Type

String

# ExternalCryptoKeySecret Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The pre-shared key used for DC request authentication.

## Object Oriented Interface

```text
public function getExternalCryptoKeySecret();
public function setExternalCryptoKeySecret($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 8 );
secureblackbox_dcauth_set($res, 8, $value );
```

## Default Value

''

## Remarks

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 [ExternalCryptoKeyID](#externalcryptokeyid-property-secureblackbox_dcauth-class) topic.

## Data Type

String

# ExternalCryptoMethod Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the asynchronous signing method.

## Object Oriented Interface

```text
public function getExternalCryptoMethod();
public function setExternalCryptoMethod($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 9 );
secureblackbox_dcauth_set($res, 9, $value );
```

## Possible Values

```text
DCAUTH_EXTERNALCRYPTOMETHOD_PKCS1(0), DCAUTH_EXTERNALCRYPTOMETHOD_PKCS7(1)
```

## Default Value

0

## Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

|  |  |
| --- | --- |
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |

## Data Type

Integer

# ExternalCryptoMode Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the external cryptography mode.

## Object Oriented Interface

```text
public function getExternalCryptoMode();
public function setExternalCryptoMode($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 10 );
secureblackbox_dcauth_set($res, 10, $value );
```

## Possible Values

```text
DCAUTH_EXTERNALCRYPTOMODE_DEFAULT(0), DCAUTH_EXTERNALCRYPTOMODE_DISABLED(1), DCAUTH_EXTERNALCRYPTOMODE_GENERIC(2), DCAUTH_EXTERNALCRYPTOMODE_DCAUTH(3), DCAUTH_EXTERNALCRYPTOMODE_DCAUTH_JSON(4)
```

## Default Value

0

## Remarks

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) |

This property is not available at design time.

## Data Type

Integer

# ExternalCryptoPublicKeyAlgorithm Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

## Object Oriented Interface

```text
public function getExternalCryptoPublicKeyAlgorithm();
public function setExternalCryptoPublicKeyAlgorithm($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 11 );
secureblackbox_dcauth_set($res, 11, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# FIPSMode Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Reserved.

## Object Oriented Interface

```text
public function getFIPSMode();
public function setFIPSMode($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 12 );
secureblackbox_dcauth_set($res, 12, $value );
```

## Default Value

false

## Remarks

This property is reserved for future use.

## Data Type

Boolean

# Input Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Contains the signing request to process.

## Object Oriented Interface

```text
public function getInput();
public function setInput($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 13 );
secureblackbox_dcauth_set($res, 13, $value );
```

## Default Value

''

## Remarks

Assign the request you received from the counterparty to this property before calling the [ProcessRequest](#processrequest-method-secureblackbox_dcauth-class) method. Use [Output](#output-property-secureblackbox_dcauth-class) to read the resulting signature response after [ProcessRequest](#processrequest-method-secureblackbox_dcauth-class) completes.

## Data Type

String

# InputEncoding Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies request encoding.

## Object Oriented Interface

```text
public function getInputEncoding();
public function setInputEncoding($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 14 );
secureblackbox_dcauth_set($res, 14, $value );
```

## Possible Values

```text
DCAUTH_INPUTENCODING_NONE(0), DCAUTH_INPUTENCODING_AUTO(1), DCAUTH_INPUTENCODING_BASE_64(2)
```

## Default Value

0

## Remarks

Use this property to specify the encoding to expect the requests to be in.

## Data Type

Integer

# KeyId Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the KeyID of the pre-shared authentication key.

## Object Oriented Interface

```text
public function getKeyId();
public function setKeyId($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 15 );
secureblackbox_dcauth_set($res, 15, $value );
```

## Default Value

''

## Remarks

If processing requests from a single known party, assign the Id of the key you pre-shared with them to this property, and the key itself to the [KeySecret](#keysecret-property-secureblackbox_dcauth-class) property. If you expect to receive requests from many parties with different authentication keys, use [KeySecretNeeded](#keysecretneeded-event-secureblackbox_dcauth-class) event instead.

## Data Type

String

# KeySecret Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The pre-shared authentication key.

## Object Oriented Interface

```text
public function getKeySecret();
public function setKeySecret($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 16 );
secureblackbox_dcauth_set($res, 16, $value );
```

## Default Value

''

## Remarks

If processing requests from a single known party, assign the key you pre-shared with them to this property. Use [KeyId](#keyid-property-secureblackbox_dcauth-class) property to assign the ID of that key. If you expect to receive requests from many parties with different authentication keys, use [KeySecretNeeded](#keysecretneeded-event-secureblackbox_dcauth-class) event instead.

## Data Type

String

# Output Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Contains the output of the request processing.

## Object Oriented Interface

```text
public function getOutput();
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 17 );
```

## Default Value

''

## Remarks

When [ProcessRequest](#processrequest-method-secureblackbox_dcauth-class) method completes it saves the processing output to this property. The output typically contains the response to be sent back to the requestor.

This property is read-only.

## Data Type

String

# OutputEncoding Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies response encoding.

## Object Oriented Interface

```text
public function getOutputEncoding();
public function setOutputEncoding($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 18 );
secureblackbox_dcauth_set($res, 18, $value );
```

## Possible Values

```text
DCAUTH_OUTPUTENCODING_NONE(0), DCAUTH_OUTPUTENCODING_AUTO(1), DCAUTH_OUTPUTENCODING_BASE_64(2)
```

## Default Value

0

## Remarks

Use this property to specify the encoding you want the response to be produced in.

## Data Type

Integer

# Policies Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the policies to use when processing requests.

## Object Oriented Interface

```text
public function getPolicies();
public function setPolicies($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 19 );
secureblackbox_dcauth_set($res, 19, $value );
```

## Default Value

0

## Remarks

This property lets you specify policies to apply blanketly to the requests. If this property does not give you enough flexibility - for example, if you need to cherry-pick requests basing on their content - please consider using the [SignRequest](#signrequest-event-secureblackbox_dcauth-class) (allows you to track individual requests) and/or [ExternalSign](#externalsign-event-secureblackbox_dcauth-class) (lets you perform the signing manually) events. This setting is a bit mask of the following flags:

|  |  |  |
| --- | --- | --- |
| aspAcceptUnsignedRequests | 1 | Allows the component to accept unauthenticated messages (those not signed with KeyID/KeySecret). Use with extreme care. |
| aspIgnorePKCS1Requests | 2 | Ignore requests of PKCS1 type. |
| aspIgnorePKCS7Requests | 4 | Ignore requests of PKCS7 type. |
| aspIgnoreRequestTSA | 8 | Ignore the TSA URL provided in the request, and either stick with the service provided via TimestampServer property, or not timestamp the message altogether. |
| aspIgnoreRequestSigningTime | 16 | Ignore the signing time included in the request. |
| aspIgnoreRequestPKCS7Settings | 32 | Ignore auxiliary PKCS7 settings (content type, attributes) included in the request. |
| aspAlwaysTimestampSigs | 64 | Timestamp created signatures (PKCS7 only), even if the client did not request it. |

This property is not available at design time.

## Data Type

Integer

# Profile Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies a pre-defined profile to apply when creating the signature.

## Object Oriented Interface

```text
public function getProfile();
public function setProfile($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 20 );
secureblackbox_dcauth_set($res, 20, $value );
```

## Default Value

''

## Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

## Data Type

String

# ProxyAddress Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The IP address of the proxy server.

## Object Oriented Interface

```text
public function getProxyAddress();
public function setProxyAddress($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 21 );
secureblackbox_dcauth_set($res, 21, $value );
```

## Default Value

''

## Remarks

The IP address of the proxy server.

## Data Type

String

# ProxyAuthentication Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The authentication type used by the proxy server.

## Object Oriented Interface

```text
public function getProxyAuthentication();
public function setProxyAuthentication($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 22 );
secureblackbox_dcauth_set($res, 22, $value );
```

## Possible Values

```text
DCAUTH_PROXYAUTHENTICATION_NO_AUTHENTICATION(0), DCAUTH_PROXYAUTHENTICATION_BASIC(1), DCAUTH_PROXYAUTHENTICATION_DIGEST(2), DCAUTH_PROXYAUTHENTICATION_NTLM(3)
```

## Default Value

0

## Remarks

The authentication type used by the proxy server.

|  |  |
| --- | --- |
| patNoAuthentication | 0 |
| patBasic | 1 |
| patDigest | 2 |
| patNTLM | 3 |

## Data Type

Integer

# ProxyPassword Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The password to authenticate to the proxy server.

## Object Oriented Interface

```text
public function getProxyPassword();
public function setProxyPassword($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 23 );
secureblackbox_dcauth_set($res, 23, $value );
```

## Default Value

''

## Remarks

The password to authenticate to the proxy server.

## Data Type

String

# ProxyPort Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The port on the proxy server to connect to.

## Object Oriented Interface

```text
public function getProxyPort();
public function setProxyPort($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 24 );
secureblackbox_dcauth_set($res, 24, $value );
```

## Default Value

0

## Remarks

The port on the proxy server to connect to.

## Data Type

Integer

# ProxyType Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The type of the proxy server.

## Object Oriented Interface

```text
public function getProxyType();
public function setProxyType($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 25 );
secureblackbox_dcauth_set($res, 25, $value );
```

## Possible Values

```text
DCAUTH_PROXYTYPE_NONE(0), DCAUTH_PROXYTYPE_SOCKS_4(1), DCAUTH_PROXYTYPE_SOCKS_5(2), DCAUTH_PROXYTYPE_WEB_TUNNEL(3), DCAUTH_PROXYTYPE_HTTP(4)
```

## Default Value

0

## Remarks

The type of the proxy server.

|  |  |
| --- | --- |
| cptNone | 0 |
| cptSocks4 | 1 |
| cptSocks5 | 2 |
| cptWebTunnel | 3 |
| cptHTTP | 4 |

## Data Type

Integer

# ProxyRequestHeaders Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

## Object Oriented Interface

```text
public function getProxyRequestHeaders();
public function setProxyRequestHeaders($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 26 );
secureblackbox_dcauth_set($res, 26, $value );
```

## Default Value

''

## Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

## Data Type

String

# ProxyResponseBody Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

## Object Oriented Interface

```text
public function getProxyResponseBody();
public function setProxyResponseBody($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 27 );
secureblackbox_dcauth_set($res, 27, $value );
```

## Default Value

''

## Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

## Data Type

String

# ProxyResponseHeaders Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

## Object Oriented Interface

```text
public function getProxyResponseHeaders();
public function setProxyResponseHeaders($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 28 );
secureblackbox_dcauth_set($res, 28, $value );
```

## Default Value

''

## Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

## Data Type

String

# ProxyUseIPv6 Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getProxyUseIPv6();
public function setProxyUseIPv6($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 29 );
secureblackbox_dcauth_set($res, 29, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# ProxyUsername Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the username credential for proxy authentication.

## Object Oriented Interface

```text
public function getProxyUsername();
public function setProxyUsername($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 30 );
secureblackbox_dcauth_set($res, 30, $value );
```

## Default Value

''

## Remarks

Specifies the username credential for proxy authentication.

## Data Type

String

# SigningCertBytes Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getSigningCertBytes();
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 31 );
```

## Remarks

Returns the raw certificate data in DER format.

This property is read-only and not available at design time.

## Data Type

Byte Array

# SigningCertHandle Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getSigningCertHandle();
public function setSigningCertHandle($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 39 );
secureblackbox_dcauth_set($res, 39, $value );
```

## Default Value

0

## Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

This property is not available at design time.

## Data Type

Long64

# SigningChainCount Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The number of records in the SigningChain arrays.

## Object Oriented Interface

```text
public function getSigningChainCount();
public function setSigningChainCount($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 70 );
secureblackbox_dcauth_set($res, 70, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [SigningChainBytes](#signingchainbytes-property-secureblackbox_dcauth-class)
- [SigningChainHandle](#signingchainhandle-property-secureblackbox_dcauth-class)

The array indices start at *0* and end at *SigningChainCount - 1*.

This property is not available at design time.

## Data Type

Integer

# SigningChainBytes Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getSigningChainBytes($signingchainindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 71 , $signingchainindex);
```

## Remarks

Returns the raw certificate data in DER format.

The *$signingchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningChainCount](#signingchaincount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

Byte Array

# SigningChainHandle Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getSigningChainHandle($signingchainindex);
public function setSigningChainHandle($signingchainindex, $value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 79 , $signingchainindex);
secureblackbox_dcauth_set($res, 79, $value , $signingchainindex);
```

## Default Value

0

## Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

The *$signingchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SigningChainCount](#signingchaincount-property-secureblackbox_dcauth-class) property.

This property is not available at design time.

## Data Type

Long64

# SocketDNSMode Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getSocketDNSMode();
public function setSocketDNSMode($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 110 );
secureblackbox_dcauth_set($res, 110, $value );
```

## Possible Values

```text
DCAUTH_SOCKETDNSMODE_AUTO(0), DCAUTH_SOCKETDNSMODE_PLATFORM(1), DCAUTH_SOCKETDNSMODE_OWN(2), DCAUTH_SOCKETDNSMODE_OWN_SECURE(3)
```

## Default Value

0

## Remarks

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

|  |  |
| --- | --- |
| dmAuto | 0 |
| dmPlatform | 1 |
| dmOwn | 2 |
| dmOwnSecure | 3 |

## Data Type

Integer

# SocketDNSPort Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getSocketDNSPort();
public function setSocketDNSPort($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 111 );
secureblackbox_dcauth_set($res, 111, $value );
```

## Default Value

0

## Remarks

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

## Data Type

Integer

# SocketDNSQueryTimeout Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The timeout (in milliseconds) for each DNS query.

## Object Oriented Interface

```text
public function getSocketDNSQueryTimeout();
public function setSocketDNSQueryTimeout($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 112 );
secureblackbox_dcauth_set($res, 112, $value );
```

## Default Value

0

## Remarks

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

## Data Type

Integer

# SocketDNSServers Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getSocketDNSServers();
public function setSocketDNSServers($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 113 );
secureblackbox_dcauth_set($res, 113, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# SocketDNSTotalTimeout Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The timeout (in milliseconds) for the whole resolution process.

## Object Oriented Interface

```text
public function getSocketDNSTotalTimeout();
public function setSocketDNSTotalTimeout($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 114 );
secureblackbox_dcauth_set($res, 114, $value );
```

## Default Value

0

## Remarks

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

## Data Type

Integer

# SocketIncomingSpeedLimit Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getSocketIncomingSpeedLimit();
public function setSocketIncomingSpeedLimit($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 115 );
secureblackbox_dcauth_set($res, 115, $value );
```

## Default Value

0

## Remarks

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

## Data Type

Integer

# SocketLocalAddress Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The local network interface to bind the socket to.

## Object Oriented Interface

```text
public function getSocketLocalAddress();
public function setSocketLocalAddress($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 116 );
secureblackbox_dcauth_set($res, 116, $value );
```

## Default Value

''

## Remarks

The local network interface to bind the socket to.

## Data Type

String

# SocketLocalPort Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The local port number to bind the socket to.

## Object Oriented Interface

```text
public function getSocketLocalPort();
public function setSocketLocalPort($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 117 );
secureblackbox_dcauth_set($res, 117, $value );
```

## Default Value

0

## Remarks

The local port number to bind the socket to.

## Data Type

Integer

# SocketOutgoingSpeedLimit Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getSocketOutgoingSpeedLimit();
public function setSocketOutgoingSpeedLimit($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 118 );
secureblackbox_dcauth_set($res, 118, $value );
```

## Default Value

0

## Remarks

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

## Data Type

Integer

# SocketTimeout Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getSocketTimeout();
public function setSocketTimeout($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 119 );
secureblackbox_dcauth_set($res, 119, $value );
```

## Default Value

60000

## Remarks

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

If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

## Data Type

Integer

# SocketUseIPv6 Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Enables or disables IP protocol version 6.

## Object Oriented Interface

```text
public function getSocketUseIPv6();
public function setSocketUseIPv6($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 120 );
secureblackbox_dcauth_set($res, 120, $value );
```

## Default Value

false

## Remarks

Enables or disables IP protocol version 6.

## Data Type

Boolean

# StorageId Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the signing certificate residing in an alternative location.

## Object Oriented Interface

```text
public function getStorageId();
public function setStorageId($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 121 );
secureblackbox_dcauth_set($res, 121, $value );
```

## Default Value

''

## Remarks

Use this property to specify the signing certificate contained on alternative media, such as a hardware device or in a system certificate store.

Example 1: The certificate resides on a PKCS#11 device

pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1

Example 2: The certificate resides in a system store

system://localmachine@/?store=MY

You can use the following URI modifiers to provide more accurate specifiers for the needed certificate:

- **cn**: the common name of the certificate subject.
- **keyid**: the unique identifier included in subject key identifier extension of the certificate.
- **keyusage**: a comma-separated list of enabled (+) or disabled (-) key usages. The following usages are supported: signature, nonrepudiation, keyencipherment, dataencipherment, keyagreement, keycertsign, crlsign, encipheronly, decipheronly, serverauth, clientauth, codesigning, emailprotection, timestamping, ocspsigning, smartcardlogon, keypurposeclientauth, keypurposekdc.
- **fingerprint**: the fingerprint of the certificate.

Example 3: selecting the certificate with a given fingerprint:

pkcs11://user:pin@/c:/windows/system32/pkcsdriver.dll?slot=0&readonly=1&fingerprint=001122334455667788aabbccddeeff0011223344

## Data Type

String

# TimestampServer Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The address of the timestamping server.

## Object Oriented Interface

```text
public function getTimestampServer();
public function setTimestampServer($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 122 );
secureblackbox_dcauth_set($res, 122, $value );
```

## Default Value

''

## Remarks

Use this property to provide the address of the Time Stamping Authority (TSA) server to be used for timestamping the signature.

SecureBlackbox supports RFC3161-compliant timestamping servers, available via HTTP or HTTPS.

If your timestamping service enforces credential-based user authentication (basic or digest), you can provide the credentials in the same URL:

http://user:password@timestamp.server.com/TsaService

For TSAs using certificate-based TLS authentication, provide the client certificate via the TLSClientChain property.

If this property is left empty, no timestamp will be added to the signature.

Starting from summer 2021 update (Vol. 2), the *virtual* timestamping service is supported, which allows you to intervene in the timestamping routine and provide your own handling for the TSA exchange. This may be handy if the service that you are requesting timestamps from uses a non-standard TSP protocol or requires special authentication option.

To employ the virtual service, assign an URI of the following format to this property:

virtual://localhost?hashonly=true&includecerts=true&reqpolicy=1.2.3.4.5&halg=SHA256&ignorenonce=true

Subscribe to [Notification](#notification-event-secureblackbox_dcauth-class) event to get notified about the virtualized timestamping event. The EventID of the timestamping event is TimestampRequest. Inside the event handler, read the base16-encoded request from the EventParam parameter and forward it to the timestamping authority. Upon receiving the response, pass it back to the component, encoded in base16, via the TimestampResponse config property:

component.Config("TimestampResponse=308208ab...");

Note that all the exchange with your custom TSA should take place within the same invocation of the Notification event.

The *hashonly* parameter of the virtual URI tells the component to only return the timestamp message imprint via the EventParam parameter. If set to false, EventParam will contain the complete RFC3161 timestamping request.

The *includecerts* parameter specifies that the requestCertificates parameter of the timestamping request should be set to true.

The *reqpolicy* parameter lets you specify the request policy, and the *halg* parameter specifies the hash algorithm to use for timestamping.

The *ignorenonce* parameter allows you to switch off client nonce verification to enable compatibility with TSA services that do not support nonce mirroring.

All the parameters are optional.

## Data Type

String

# TLSClientCertCount Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The number of records in the TLSClientCert arrays.

## Object Oriented Interface

```text
public function getTLSClientCertCount();
public function setTLSClientCertCount($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 123 );
secureblackbox_dcauth_set($res, 123, $value );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [TLSClientCertBytes](#tlsclientcertbytes-property-secureblackbox_dcauth-class)
- [TLSClientCertHandle](#tlsclientcerthandle-property-secureblackbox_dcauth-class)

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

This property is not available at design time.

## Data Type

Integer

# TLSClientCertBytes Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getTLSClientCertBytes($tlsclientcertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 124 , $tlsclientcertindex);
```

## Remarks

Returns the raw certificate data in DER format.

The *$tlsclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSClientCertCount](#tlsclientcertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

Byte Array

# TLSClientCertHandle Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSClientCertHandle($tlsclientcertindex);
public function setTLSClientCertHandle($tlsclientcertindex, $value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 132 , $tlsclientcertindex);
secureblackbox_dcauth_set($res, 132, $value , $tlsclientcertindex);
```

## Default Value

0

## Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

The *$tlsclientcertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSClientCertCount](#tlsclientcertcount-property-secureblackbox_dcauth-class) property.

This property is not available at design time.

## Data Type

Long64

# TLSServerCertCount Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The number of records in the TLSServerCert arrays.

## Object Oriented Interface

```text
public function getTLSServerCertCount();
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 163 );
```

## Default Value

0

## Remarks

This property controls the size of the following arrays:

- [TLSServerCertBytes](#tlsservercertbytes-property-secureblackbox_dcauth-class)
- [TLSServerCertFingerprint](#tlsservercertfingerprint-property-secureblackbox_dcauth-class)
- [TLSServerCertHandle](#tlsservercerthandle-property-secureblackbox_dcauth-class)
- [TLSServerCertIssuer](#tlsservercertissuer-property-secureblackbox_dcauth-class)
- [TLSServerCertIssuerRDN](#tlsservercertissuerrdn-property-secureblackbox_dcauth-class)
- [TLSServerCertKeyAlgorithm](#tlsservercertkeyalgorithm-property-secureblackbox_dcauth-class)
- [TLSServerCertKeyBits](#tlsservercertkeybits-property-secureblackbox_dcauth-class)
- [TLSServerCertKeyUsage](#tlsservercertkeyusage-property-secureblackbox_dcauth-class)
- [TLSServerCertSelfSigned](#tlsservercertselfsigned-property-secureblackbox_dcauth-class)
- [TLSServerCertSerialNumber](#tlsservercertserialnumber-property-secureblackbox_dcauth-class)
- [TLSServerCertSigAlgorithm](#tlsservercertsigalgorithm-property-secureblackbox_dcauth-class)
- [TLSServerCertSubject](#tlsservercertsubject-property-secureblackbox_dcauth-class)
- [TLSServerCertSubjectRDN](#tlsservercertsubjectrdn-property-secureblackbox_dcauth-class)
- [TLSServerCertValidFrom](#tlsservercertvalidfrom-property-secureblackbox_dcauth-class)
- [TLSServerCertValidTo](#tlsservercertvalidto-property-secureblackbox_dcauth-class)

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

This property is read-only and not available at design time.

## Data Type

Integer

# TLSServerCertBytes Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Returns the raw certificate data in DER format.

## Object Oriented Interface

```text
public function getTLSServerCertBytes($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 164 , $tlsservercertindex);
```

## Remarks

Returns the raw certificate data in DER format.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

Byte Array

# TLSServerCertFingerprint Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertFingerprint($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 170 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSServerCertHandle Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertHandle($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 172 , $tlsservercertindex);
```

## Default Value

0

## Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation.

```text
  pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
```

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

Long64

# TLSServerCertIssuer Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertIssuer($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 174 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSServerCertIssuerRDN Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertIssuerRDN($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 175 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSServerCertKeyAlgorithm Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the public key algorithm of this certificate.

## Object Oriented Interface

```text
public function getTLSServerCertKeyAlgorithm($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 176 , $tlsservercertindex);
```

## Default Value

'0'

## Remarks

Specifies the public key algorithm of this certificate.

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

Use the [TLSKeyBits](#DCAuth_p_TLSKeyBits), [TLSCurve](#DCAuth_p_TLSCurve), and [TLSPublicKeyBytes](#DCAuth_p_TLSPublicKeyBytes) properties to get more details about the key the certificate contains.

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSServerCertKeyBits Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Returns the length of the public key in bits.

## Object Oriented Interface

```text
public function getTLSServerCertKeyBits($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 177 , $tlsservercertindex);
```

## Default Value

0

## Remarks

Returns the length of the public key in bits.

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# TLSServerCertKeyUsage Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertKeyUsage($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 179 , $tlsservercertindex);
```

## Default Value

0

## Remarks

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

This value is a bit mask of the following values:

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

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

Integer

# TLSServerCertSelfSigned Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertSelfSigned($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 192 , $tlsservercertindex);
```

## Default Value

false

## Remarks

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

Boolean

# TLSServerCertSerialNumber Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Returns the certificate's serial number.

## Object Oriented Interface

```text
public function getTLSServerCertSerialNumber($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 193 , $tlsservercertindex);
```

## Remarks

Returns the certificate's serial number.

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

Byte Array

# TLSServerCertSigAlgorithm Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertSigAlgorithm($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 194 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSServerCertSubject Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

## Object Oriented Interface

```text
public function getTLSServerCertSubject($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 196 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSServerCertSubjectRDN Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertSubjectRDN($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 199 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

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

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSServerCertValidFrom Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertValidFrom($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 201 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSServerCertValidTo Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSServerCertValidTo($tlsservercertindex);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 202 , $tlsservercertindex);
```

## Default Value

''

## Remarks

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

The *$tlsservercertindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [TLSServerCertCount](#tlsservercertcount-property-secureblackbox_dcauth-class) property.

This property is read-only and not available at design time.

## Data Type

String

# TLSAutoValidateCertificates Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSAutoValidateCertificates();
public function setTLSAutoValidateCertificates($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 203 );
secureblackbox_dcauth_set($res, 203, $value );
```

## Default Value

true

## Remarks

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

## Data Type

Boolean

# TLSBaseConfiguration Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Selects the base configuration for the TLS settings.

## Object Oriented Interface

```text
public function getTLSBaseConfiguration();
public function setTLSBaseConfiguration($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 204 );
secureblackbox_dcauth_set($res, 204, $value );
```

## Possible Values

```text
DCAUTH_TLSBASECONFIGURATION_DEFAULT(0), DCAUTH_TLSBASECONFIGURATION_COMPATIBLE(1), DCAUTH_TLSBASECONFIGURATION_COMPREHENSIVE_INSECURE(2), DCAUTH_TLSBASECONFIGURATION_HIGHLY_SECURE(3)
```

## Default Value

0

## Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

|  |  |  |
| --- | --- | --- |
| stpcDefault | 0 |  |
| stpcCompatible | 1 |  |
| stpcComprehensiveInsecure | 2 |  |
| stpcHighlySecure | 3 |  |

## Data Type

Integer

# TLSCiphersuites Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

A list of ciphersuites separated with commas or semicolons.

## Object Oriented Interface

```text
public function getTLSCiphersuites();
public function setTLSCiphersuites($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 205 );
secureblackbox_dcauth_set($res, 205, $value );
```

## Default Value

''

## Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [TLSBaseConfiguration](#tlsbaseconfiguration-property-secureblackbox_dcauth-class). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

- NULL_NULL_NULL
- RSA_NULL_MD5
- RSA_NULL_SHA
- RSA_RC4_MD5
- RSA_RC4_SHA
- RSA_RC2_MD5
- RSA_IDEA_MD5
- RSA_IDEA_SHA
- RSA_DES_MD5
- RSA_DES_SHA
- RSA_3DES_MD5
- RSA_3DES_SHA
- RSA_AES128_SHA
- RSA_AES256_SHA
- DH_DSS_DES_SHA
- DH_DSS_3DES_SHA
- DH_DSS_AES128_SHA
- DH_DSS_AES256_SHA
- DH_RSA_DES_SHA
- DH_RSA_3DES_SHA
- DH_RSA_AES128_SHA
- DH_RSA_AES256_SHA
- DHE_DSS_DES_SHA
- DHE_DSS_3DES_SHA
- DHE_DSS_AES128_SHA
- DHE_DSS_AES256_SHA
- DHE_RSA_DES_SHA
- DHE_RSA_3DES_SHA
- DHE_RSA_AES128_SHA
- DHE_RSA_AES256_SHA
- DH_ANON_RC4_MD5
- DH_ANON_DES_SHA
- DH_ANON_3DES_SHA
- DH_ANON_AES128_SHA
- DH_ANON_AES256_SHA
- RSA_RC2_MD5_EXPORT
- RSA_RC4_MD5_EXPORT
- RSA_DES_SHA_EXPORT
- DH_DSS_DES_SHA_EXPORT
- DH_RSA_DES_SHA_EXPORT
- DHE_DSS_DES_SHA_EXPORT
- DHE_RSA_DES_SHA_EXPORT
- DH_ANON_RC4_MD5_EXPORT
- DH_ANON_DES_SHA_EXPORT
- RSA_CAMELLIA128_SHA
- DH_DSS_CAMELLIA128_SHA
- DH_RSA_CAMELLIA128_SHA
- DHE_DSS_CAMELLIA128_SHA
- DHE_RSA_CAMELLIA128_SHA
- DH_ANON_CAMELLIA128_SHA
- RSA_CAMELLIA256_SHA
- DH_DSS_CAMELLIA256_SHA
- DH_RSA_CAMELLIA256_SHA
- DHE_DSS_CAMELLIA256_SHA
- DHE_RSA_CAMELLIA256_SHA
- DH_ANON_CAMELLIA256_SHA
- PSK_RC4_SHA
- PSK_3DES_SHA
- PSK_AES128_SHA
- PSK_AES256_SHA
- DHE_PSK_RC4_SHA
- DHE_PSK_3DES_SHA
- DHE_PSK_AES128_SHA
- DHE_PSK_AES256_SHA
- RSA_PSK_RC4_SHA
- RSA_PSK_3DES_SHA
- RSA_PSK_AES128_SHA
- RSA_PSK_AES256_SHA
- RSA_SEED_SHA
- DH_DSS_SEED_SHA
- DH_RSA_SEED_SHA
- DHE_DSS_SEED_SHA
- DHE_RSA_SEED_SHA
- DH_ANON_SEED_SHA
- SRP_SHA_3DES_SHA
- SRP_SHA_RSA_3DES_SHA
- SRP_SHA_DSS_3DES_SHA
- SRP_SHA_AES128_SHA
- SRP_SHA_RSA_AES128_SHA
- SRP_SHA_DSS_AES128_SHA
- SRP_SHA_AES256_SHA
- SRP_SHA_RSA_AES256_SHA
- SRP_SHA_DSS_AES256_SHA
- ECDH_ECDSA_NULL_SHA
- ECDH_ECDSA_RC4_SHA
- ECDH_ECDSA_3DES_SHA
- ECDH_ECDSA_AES128_SHA
- ECDH_ECDSA_AES256_SHA
- ECDHE_ECDSA_NULL_SHA
- ECDHE_ECDSA_RC4_SHA
- ECDHE_ECDSA_3DES_SHA
- ECDHE_ECDSA_AES128_SHA
- ECDHE_ECDSA_AES256_SHA
- ECDH_RSA_NULL_SHA
- ECDH_RSA_RC4_SHA
- ECDH_RSA_3DES_SHA
- ECDH_RSA_AES128_SHA
- ECDH_RSA_AES256_SHA
- ECDHE_RSA_NULL_SHA
- ECDHE_RSA_RC4_SHA
- ECDHE_RSA_3DES_SHA
- ECDHE_RSA_AES128_SHA
- ECDHE_RSA_AES256_SHA
- ECDH_ANON_NULL_SHA
- ECDH_ANON_RC4_SHA
- ECDH_ANON_3DES_SHA
- ECDH_ANON_AES128_SHA
- ECDH_ANON_AES256_SHA
- RSA_NULL_SHA256
- RSA_AES128_SHA256
- RSA_AES256_SHA256
- DH_DSS_AES128_SHA256
- DH_RSA_AES128_SHA256
- DHE_DSS_AES128_SHA256
- DHE_RSA_AES128_SHA256
- DH_DSS_AES256_SHA256
- DH_RSA_AES256_SHA256
- DHE_DSS_AES256_SHA256
- DHE_RSA_AES256_SHA256
- DH_ANON_AES128_SHA256
- DH_ANON_AES256_SHA256
- RSA_AES128_GCM_SHA256
- RSA_AES256_GCM_SHA384
- DHE_RSA_AES128_GCM_SHA256
- DHE_RSA_AES256_GCM_SHA384
- DH_RSA_AES128_GCM_SHA256
- DH_RSA_AES256_GCM_SHA384
- DHE_DSS_AES128_GCM_SHA256
- DHE_DSS_AES256_GCM_SHA384
- DH_DSS_AES128_GCM_SHA256
- DH_DSS_AES256_GCM_SHA384
- DH_ANON_AES128_GCM_SHA256
- DH_ANON_AES256_GCM_SHA384
- ECDHE_ECDSA_AES128_SHA256
- ECDHE_ECDSA_AES256_SHA384
- ECDH_ECDSA_AES128_SHA256
- ECDH_ECDSA_AES256_SHA384
- ECDHE_RSA_AES128_SHA256
- ECDHE_RSA_AES256_SHA384
- ECDH_RSA_AES128_SHA256
- ECDH_RSA_AES256_SHA384
- ECDHE_ECDSA_AES128_GCM_SHA256
- ECDHE_ECDSA_AES256_GCM_SHA384
- ECDH_ECDSA_AES128_GCM_SHA256
- ECDH_ECDSA_AES256_GCM_SHA384
- ECDHE_RSA_AES128_GCM_SHA256
- ECDHE_RSA_AES256_GCM_SHA384
- ECDH_RSA_AES128_GCM_SHA256
- ECDH_RSA_AES256_GCM_SHA384
- PSK_AES128_GCM_SHA256
- PSK_AES256_GCM_SHA384
- DHE_PSK_AES128_GCM_SHA256
- DHE_PSK_AES256_GCM_SHA384
- RSA_PSK_AES128_GCM_SHA256
- RSA_PSK_AES256_GCM_SHA384
- PSK_AES128_SHA256
- PSK_AES256_SHA384
- PSK_NULL_SHA256
- PSK_NULL_SHA384
- DHE_PSK_AES128_SHA256
- DHE_PSK_AES256_SHA384
- DHE_PSK_NULL_SHA256
- DHE_PSK_NULL_SHA384
- RSA_PSK_AES128_SHA256
- RSA_PSK_AES256_SHA384
- RSA_PSK_NULL_SHA256
- RSA_PSK_NULL_SHA384
- RSA_CAMELLIA128_SHA256
- DH_DSS_CAMELLIA128_SHA256
- DH_RSA_CAMELLIA128_SHA256
- DHE_DSS_CAMELLIA128_SHA256
- DHE_RSA_CAMELLIA128_SHA256
- DH_ANON_CAMELLIA128_SHA256
- RSA_CAMELLIA256_SHA256
- DH_DSS_CAMELLIA256_SHA256
- DH_RSA_CAMELLIA256_SHA256
- DHE_DSS_CAMELLIA256_SHA256
- DHE_RSA_CAMELLIA256_SHA256
- DH_ANON_CAMELLIA256_SHA256
- ECDHE_ECDSA_CAMELLIA128_SHA256
- ECDHE_ECDSA_CAMELLIA256_SHA384
- ECDH_ECDSA_CAMELLIA128_SHA256
- ECDH_ECDSA_CAMELLIA256_SHA384
- ECDHE_RSA_CAMELLIA128_SHA256
- ECDHE_RSA_CAMELLIA256_SHA384
- ECDH_RSA_CAMELLIA128_SHA256
- ECDH_RSA_CAMELLIA256_SHA384
- RSA_CAMELLIA128_GCM_SHA256
- RSA_CAMELLIA256_GCM_SHA384
- DHE_RSA_CAMELLIA128_GCM_SHA256
- DHE_RSA_CAMELLIA256_GCM_SHA384
- DH_RSA_CAMELLIA128_GCM_SHA256
- DH_RSA_CAMELLIA256_GCM_SHA384
- DHE_DSS_CAMELLIA128_GCM_SHA256
- DHE_DSS_CAMELLIA256_GCM_SHA384
- DH_DSS_CAMELLIA128_GCM_SHA256
- DH_DSS_CAMELLIA256_GCM_SHA384
- DH_anon_CAMELLIA128_GCM_SHA256
- DH_anon_CAMELLIA256_GCM_SHA384
- ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
- ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
- ECDH_ECDSA_CAMELLIA128_GCM_SHA256
- ECDH_ECDSA_CAMELLIA256_GCM_SHA384
- ECDHE_RSA_CAMELLIA128_GCM_SHA256
- ECDHE_RSA_CAMELLIA256_GCM_SHA384
- ECDH_RSA_CAMELLIA128_GCM_SHA256
- ECDH_RSA_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_GCM_SHA256
- PSK_CAMELLIA256_GCM_SHA384
- DHE_PSK_CAMELLIA128_GCM_SHA256
- DHE_PSK_CAMELLIA256_GCM_SHA384
- RSA_PSK_CAMELLIA128_GCM_SHA256
- RSA_PSK_CAMELLIA256_GCM_SHA384
- PSK_CAMELLIA128_SHA256
- PSK_CAMELLIA256_SHA384
- DHE_PSK_CAMELLIA128_SHA256
- DHE_PSK_CAMELLIA256_SHA384
- RSA_PSK_CAMELLIA128_SHA256
- RSA_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_CAMELLIA128_SHA256
- ECDHE_PSK_CAMELLIA256_SHA384
- ECDHE_PSK_RC4_SHA
- ECDHE_PSK_3DES_SHA
- ECDHE_PSK_AES128_SHA
- ECDHE_PSK_AES256_SHA
- ECDHE_PSK_AES128_SHA256
- ECDHE_PSK_AES256_SHA384
- ECDHE_PSK_NULL_SHA
- ECDHE_PSK_NULL_SHA256
- ECDHE_PSK_NULL_SHA384
- ECDHE_RSA_CHACHA20_POLY1305_SHA256
- ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
- DHE_RSA_CHACHA20_POLY1305_SHA256
- PSK_CHACHA20_POLY1305_SHA256
- ECDHE_PSK_CHACHA20_POLY1305_SHA256
- DHE_PSK_CHACHA20_POLY1305_SHA256
- RSA_PSK_CHACHA20_POLY1305_SHA256
- AES128_GCM_SHA256
- AES256_GCM_SHA384
- CHACHA20_POLY1305_SHA256
- AES128_CCM_SHA256
- AES128_CCM8_SHA256

## Data Type

String

# TLSClientAuth Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Enables or disables certificate-based client authentication.

## Object Oriented Interface

```text
public function getTLSClientAuth();
public function setTLSClientAuth($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 206 );
secureblackbox_dcauth_set($res, 206, $value );
```

## Possible Values

```text
DCAUTH_TLSCLIENTAUTH_NO_AUTH(0), DCAUTH_TLSCLIENTAUTH_REQUEST_CERT(1), DCAUTH_TLSCLIENTAUTH_REQUIRE_CERT(2)
```

## Default Value

0

## Remarks

Enables or disables certificate-based client authentication.

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

|  |  |  |
| --- | --- | --- |
| ccatNoAuth | 0 |  |
| ccatRequestCert | 1 |  |
| ccatRequireCert | 2 |  |

## Data Type

Integer

# TLSExtensions Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Provides access to TLS extensions.

## Object Oriented Interface

```text
public function getTLSExtensions();
public function setTLSExtensions($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 207 );
secureblackbox_dcauth_set($res, 207, $value );
```

## Default Value

''

## Remarks

Provides access to TLS extensions.

## Data Type

String

# TLSForceResumeIfDestinationChanges Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSForceResumeIfDestinationChanges();
public function setTLSForceResumeIfDestinationChanges($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 208 );
secureblackbox_dcauth_set($res, 208, $value );
```

## Default Value

false

## Remarks

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

## Data Type

Boolean

# TLSGroups Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSGroups();
public function setTLSGroups($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 209 );
secureblackbox_dcauth_set($res, 209, $value );
```

## Default Value

''

## Remarks

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

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

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

## Data Type

String

# TLSPreSharedIdentity Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSPreSharedIdentity();
public function setTLSPreSharedIdentity($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 210 );
secureblackbox_dcauth_set($res, 210, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# TLSPreSharedKey Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSPreSharedKey();
public function setTLSPreSharedKey($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 211 );
secureblackbox_dcauth_set($res, 211, $value );
```

## Default Value

''

## Remarks

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

This property is not available at design time.

## Data Type

String

# TLSPreSharedKeyCiphersuite Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSPreSharedKeyCiphersuite();
public function setTLSPreSharedKeyCiphersuite($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 212 );
secureblackbox_dcauth_set($res, 212, $value );
```

## Default Value

''

## Remarks

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

## Data Type

String

# TLSRenegotiationAttackPreventionMode Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Selects the renegotiation attack prevention mechanism.

## Object Oriented Interface

```text
public function getTLSRenegotiationAttackPreventionMode();
public function setTLSRenegotiationAttackPreventionMode($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 213 );
secureblackbox_dcauth_set($res, 213, $value );
```

## Possible Values

```text
DCAUTH_TLSRENEGOTIATIONATTACKPREVENTIONMODE_COMPATIBLE(0), DCAUTH_TLSRENEGOTIATIONATTACKPREVENTIONMODE_STRICT(1), DCAUTH_TLSRENEGOTIATIONATTACKPREVENTIONMODE_AUTO(2)
```

## Default Value

2

## Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

|  |  |  |
| --- | --- | --- |
| crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). |
| crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. |
| crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. |

## Data Type

Integer

# TLSRevocationCheck Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSRevocationCheck();
public function setTLSRevocationCheck($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 214 );
secureblackbox_dcauth_set($res, 214, $value );
```

## Possible Values

```text
DCAUTH_TLSREVOCATIONCHECK_NONE(0), DCAUTH_TLSREVOCATIONCHECK_AUTO(1), DCAUTH_TLSREVOCATIONCHECK_ALL_CRL(2), DCAUTH_TLSREVOCATIONCHECK_ALL_OCSP(3), DCAUTH_TLSREVOCATIONCHECK_ALL_CRLAND_OCSP(4), DCAUTH_TLSREVOCATIONCHECK_ANY_CRL(5), DCAUTH_TLSREVOCATIONCHECK_ANY_OCSP(6), DCAUTH_TLSREVOCATIONCHECK_ANY_CRLOR_OCSP(7), DCAUTH_TLSREVOCATIONCHECK_ANY_OCSPOR_CRL(8)
```

## Default Value

1

## Remarks

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

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

|  |  |  |
| --- | --- | --- |
| crcNone | 0 | No revocation checking. |
| crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. |
| crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. |
| crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. |
| crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. |
| crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. |
| crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. |
| crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. |
| crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. |

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

## Data Type

Integer

# TLSSSLOptions Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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.

## Object Oriented Interface

```text
public function getTLSSSLOptions();
public function setTLSSSLOptions($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 215 );
secureblackbox_dcauth_set($res, 215, $value );
```

## Default Value

16

## Remarks

Various SSL (TLS) protocol options, set of

|  |  |  |
| --- | --- | --- |
| cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection |
| cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions |
| cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. |
| cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. |
| cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known |
| cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only |
| cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. |
| cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled |
| cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms |
| cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks |
| cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually |

## Data Type

Integer

# TLSMode Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Specifies the TLS mode to use.

## Object Oriented Interface

```text
public function getTLSMode();
public function setTLSMode($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 216 );
secureblackbox_dcauth_set($res, 216, $value );
```

## Possible Values

```text
DCAUTH_TLSMODE_DEFAULT(0), DCAUTH_TLSMODE_NO_TLS(1), DCAUTH_TLSMODE_EXPLICIT_TLS(2), DCAUTH_TLSMODE_IMPLICIT_TLS(3), DCAUTH_TLSMODE_MIXED_TLS(4)
```

## Default Value

0

## Remarks

Specifies the TLS mode to use.

|  |  |  |
| --- | --- | --- |
| smDefault | 0 |  |
| smNoTLS | 1 | Do not use TLS |
| smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. |
| smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. |
| smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. |

## Data Type

Integer

# TLSUseExtendedMasterSecret Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

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

## Object Oriented Interface

```text
public function getTLSUseExtendedMasterSecret();
public function setTLSUseExtendedMasterSecret($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 217 );
secureblackbox_dcauth_set($res, 217, $value );
```

## Default Value

true

## Remarks

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

## Data Type

Boolean

# TLSUseSessionResumption Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Enables or disables the TLS session resumption capability.

## Object Oriented Interface

```text
public function getTLSUseSessionResumption();
public function setTLSUseSessionResumption($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 218 );
secureblackbox_dcauth_set($res, 218, $value );
```

## Default Value

false

## Remarks

Enables or disables the TLS session resumption capability.

## Data Type

Boolean

# TLSVersions Property ([SecureBlackbox_DCAuth](#dcauth-class) Class)

The SSL/TLS versions to enable by default.

## Object Oriented Interface

```text
public function getTLSVersions();
public function setTLSVersions($value);
```

## Procedural Interface

```text
secureblackbox_dcauth_get($res, 219 );
secureblackbox_dcauth_set($res, 219, $value );
```

## Default Value

48

## Remarks

The SSL/TLS versions to enable by default.

|  |  |  |
| --- | --- | --- |
| csbSSL2 | 0x01 | SSL 2 |
| csbSSL3 | 0x02 | SSL 3 |
| csbTLS1 | 0x04 | TLS 1.0 |
| csbTLS11 | 0x08 | TLS 1.1 |
| csbTLS12 | 0x10 | TLS 1.2 |
| csbTLS13 | 0x20 | TLS 1.3 |

## Data Type

Integer

# Config Method ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Sets or retrieves a configuration setting.

## Object Oriented Interface

```text
public function doConfig($configurationstring);
```

## Procedural Interface

```text
secureblackbox_dcauth_do_config($res, $configurationstring);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-dcauth-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-dcauth-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# DoAction Method ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Performs an additional action.

## Object Oriented Interface

```text
public function doDoAction($actionid, $actionparams);
```

## Procedural Interface

```text
secureblackbox_dcauth_do_doaction($res, $actionid, $actionparams);
```

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

# ProcessRequest Method ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Processes the request.

## Object Oriented Interface

```text
public function doProcessRequest();
```

## Procedural Interface

```text
secureblackbox_dcauth_do_processrequest($res);
```

## Remarks

Use this method to process the request, sign the hashes, and produce the response. This is the main method of the class. Note that a single request received from the counterparty may contain more than one signature request. This method processes them all, reporting each atomic signature request with [SignRequest](#signrequest-event-secureblackbox_dcauth-class) and [SignRequestCompleted](#signrequestcompleted-event-secureblackbox_dcauth-class) events. Before calling this method, make sure you assign the request content to [Input](#input-property-secureblackbox_dcauth-class). Upon completion, read the response (containing all the signatures) from [Output](#output-property-secureblackbox_dcauth-class) property.

# Reset Method ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Resets the class settings.

## Object Oriented Interface

```text
public function doReset();
```

## Procedural Interface

```text
secureblackbox_dcauth_do_reset($res);
```

## Remarks

Reset is a generic method available in every class.

# CustomParametersReceived Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Passes custom request parameters to the application.

## Object Oriented Interface

```text
public function fireCustomParametersReceived($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 1, array($this, 'fireCustomParametersReceived'));
```

## Parameter List

```text
 'value'
```

## Remarks

This event is only provided for backward compatibility and is not currently used.

# Error Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Reports information about errors during request processing or signing.

## Object Oriented Interface

```text
public function fireError($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 2, array($this, 'fireError'));
```

## Parameter List

```text
 'errorcode' 'description'
```

## Remarks

The event is fired if an error occurs during the request processing. Use the *ErrorCode* and *Description* parameters to get the details.

# ExternalSign Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Handles remote or external signing initiated by the SignExternal method or other source.

## Object Oriented Interface

```text
public function fireExternalSign($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 3, array($this, 'fireExternalSign'));
```

## Parameter List

```text
 'operationid' 'hashalgorithm' 'pars' 'methodpars' 'data' 'signeddata'
```

## Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter.

*OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following:

```text
signer.OnExternalSign += (s, e) =>
{
       var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable);
       var key = (RSACryptoServiceProvider)cert.PrivateKey;

       var dataToSign = e.Data.FromBase16String();
       var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1");
       e.SignedData = signedData.ToBase16String();
};
```

The *MethodPars* parameter contains the method-specific parameters. For example, for PKCS7 requests it contains the requested parameters of the PKCS7 blob.

# KeySecretNeeded Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Requests the key secret from the application.

## Object Oriented Interface

```text
public function fireKeySecretNeeded($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 4, array($this, 'fireKeySecretNeeded'));
```

## Parameter List

```text
 'keyid' 'keysecret'
```

## Remarks

Subscribe to this event to pass the key secret (a pre-shared request authentication code) to the signing component when it is needed. The authentication combination consists of the *KeyId*, a non-secret unique key identifier, and the *KeySecret*, shared by the parties, which should be kept private. This event is an alternative for [KeySecret](#keysecret-property-secureblackbox_dcauth-class) property. Use it when you expect to process requests from requestors with different KeyIds and secrets. If you only expect to receive requests from a single requestor with a known KeyId, providing the key secret via [KeyId](#keyid-property-secureblackbox_dcauth-class) and [KeySecret](#keysecret-property-secureblackbox_dcauth-class) properties would be an easier route.

# Notification Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

This event notifies the application about an underlying control flow event.

## Object Oriented Interface

```text
public function fireNotification($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 5, array($this, 'fireNotification'));
```

## Parameter List

```text
 'eventid' 'eventparam'
```

## Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted.

This class can fire this event with the following *EventID* values:

|  |  |
| --- | --- |
| BeforeTimestamp | This event is fired before a timestamp is requested from the timestamping authority. Use the event handler to modify TSA and HTTP settings. |
| TimestampError | This event is only fired if the class failed to obtain a timestamp from the timestamping authority. The EventParam parameter contains extended error info. |

# ParameterReceived Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Passes a standard request parameter to the user code.

## Object Oriented Interface

```text
public function fireParameterReceived($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 6, array($this, 'fireParameterReceived'));
```

## Parameter List

```text
 'name' 'value'
```

## Remarks

This event is only provided for backward compatibility and is not currently used.

# SignRequest Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

This event signifies the processing of an atomic signing request.

## Object Oriented Interface

```text
public function fireSignRequest($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 7, array($this, 'fireSignRequest'));
```

## Parameter List

```text
 'method' 'hashalgorithm' 'hash' 'keyid' 'pars' 'methodpars' 'allow'
```

## Remarks

Subscribe to this event to be notified of every signature request processed by the DC server. Note that any one request coming from the requestor may contain multiple individual signature requests (so-called 'batching'). This event is a good mechanism to track signature requests for accountability purposes, and provide basic access control over the signing operations. The *Method* parameter specifies the async signing method requested by the client:

|  |  |
| --- | --- |
| asmdPKCS1 | 0 |
| asmdPKCS7 | 1 |

The *Hash* parameter contains the hash, made using *HashAlgorithm*, that needs to be signed. *KeyID* contains the key identifier of the requestor.

The *Pars* string contains a semicolon-separated string of the principal signature parameters. This has the same format and content that is passed to [ExternalSign](#externalsign-event-secureblackbox_dcauth-class), if it is used. The *MethodPars* contains a similar parameter string, but for the specific async signing method used. For the PKCS1 method there are no defined method parameters, while the PKCS7 method supports a selection of settings that tune up the CMS blob.

Set *Allow* to false to stop the request from being served. Use the [SignRequestCompleted](#signrequestcompleted-event-secureblackbox_dcauth-class) event to track completion of the initiated operation.

# SignRequestCompleted Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

This event signifies completion of the processing of an atomic signing request.

## Object Oriented Interface

```text
public function fireSignRequestCompleted($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 8, array($this, 'fireSignRequestCompleted'));
```

## Parameter List

```text
 'method' 'hashalgorithm' 'hash' 'keyid' 'pars' 'methodpars' 'signature'
```

## Remarks

Use this event to track completion of signing request processing. The *Hash* parameter contains the hash that is signed, as supplied by the requestor, and the *Signature* parameter contains the resulting cryptographic signature. The *KeyID* parameter matches the parameter in [SignRequest](#signrequest-event-secureblackbox_dcauth-class) event.

# TimestampRequest Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Fires when the class is ready to request a timestamp from an external TSA.

## Object Oriented Interface

```text
public function fireTimestampRequest($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 9, array($this, 'fireTimestampRequest'));
```

## Parameter List

```text
 'tsa' 'timestamprequest' 'timestampresponse' 'suppressdefault'
```

## Remarks

Subscribe to this event to intercept timestamp requests. You can use it to override timestamping requests and perform them in your code.

The *TSA* parameter indicates the timestamping service being used. It matches the value passed to the [TimestampServer](#timestampserver-property-secureblackbox_dcauth-class) property. Set the *SuppressDefault* parameter to true if you would like to stop the built-in TSA request from going ahead. The built-in TSA request is also not performed if the returned *TimestampResponse* parameter is not empty.

# TLSCertNeeded Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Fires when a remote TLS party requests a client certificate.

## Object Oriented Interface

```text
public function fireTLSCertNeeded($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 10, array($this, 'fireTLSCertNeeded'));
```

## Parameter List

```text
 'host' 'canames'
```

## Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The *Host* parameter identifies the host that makes a request, and the *CANames* parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the [TLSHandshake](#tlshandshake-event-secureblackbox_dcauth-class) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-secureblackbox_dcauth-class) event.

# TLSCertValidate Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

## Object Oriented Interface

```text
public function fireTLSCertValidate($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 11, array($this, 'fireTLSCertValidate'));
```

## Parameter List

```text
 'serverhost' 'serverip' 'accept'
```

## Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, classes may contact a number of TLS endpoints during their work, depending on their configuration.

*Accept* is assigned in accordance with the outcome of the internal validation check performed by the class, and can be adjusted if needed.

# TLSEstablished Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Fires when a TLS handshake with Host successfully completes.

## Object Oriented Interface

```text
public function fireTLSEstablished($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 12, array($this, 'fireTLSEstablished'));
```

## Parameter List

```text
 'host' 'version' 'ciphersuite' 'connectionid' 'abort'
```

## Remarks

The class uses this event to notify the application about a successful completion of a TLS handshake.

The *Version*, *Ciphersuite*, and *ConnectionId* parameters indicate the security parameters of the new connection. Use the *Abort* parameter if you need to terminate the connection at this stage.

# TLSHandshake Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Fires when a new TLS handshake is initiated, before the handshake commences.

## Object Oriented Interface

```text
public function fireTLSHandshake($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 13, array($this, 'fireTLSHandshake'));
```

## Parameter List

```text
 'host' 'abort'
```

## Remarks

The class uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [TLSEstablished](#tlsestablished-event-secureblackbox_dcauth-class) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-secureblackbox_dcauth-class) event will also be fired.

# TLSShutdown Event ([SecureBlackbox_DCAuth](#dcauth-class) Class)

Reports the graceful closure of a TLS connection.

## Object Oriented Interface

```text
public function fireTLSShutdown($param);
```

## Procedural Interface

```text
secureblackbox_dcauth_register_callback($res, 14, array($this, 'fireTLSShutdown'));
```

## Parameter List

```text
 'host'
```

## Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

# Config Settings ([DCAuth](#dcauth-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-secureblackbox_dcauth-class) method.

### DCAuth Config Settings

**DataURL**: (obsolete) The DataURL parameter to pass to the signer.(obsolete) The DataURL parameter to pass to the signer.

**FingerprintAlgorithm**: The fingerprint algorithm to use.The fingerprint algorithm is used for auxiliary tasks, such as for generating a certificate imprint in SigningCertificateV2 attribute.

**GoURL**: (obsolete) The GoURL parameter to pass to the signer.(obsolete) The GoURL parameter to pass to the signer.

**PolicyHash**: The EPES policy hash.The EPES policy hash to use, in hex.

**PolicyHashAlgorithm**: The EPES policy hash algorithm.The EPES policy hash algorithm.

**PolicyID**: The EPES policy identifier.The EPES policy identifier, as OID string (1.2.3.4.5)

**PolicyURI**: The EPES policy URL.The EPES policy URL.

**RequireDefinedSignCert**: (obsolete) The RequireDefinedSignCert parameter to pass to the signer.(obsolete) The RequireDefinedSignCert parameter to pass to the signer.

**SchemeParams**: The algorithm scheme parameters to employ.Use this property to specify the parameters of the algorithm scheme if needed.

This setting is used to provide parameters for some cryptographic schemes. Use the Name1=Value1;Name2=Value2;... syntax to encode the parameters. For example: *Scheme=PSS;SaltSize=32;TrailerField=1*.

**SessionID**: (obsolete) The SessionID parameter to pass to the signer.(obsolete) The SessionID parameter to pass to the signer.

**TLSChainValidationDetails**: Contains the advanced details of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to access the TLS certificate validation details.

**TLSChainValidationResult**: Contains the result of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to obtain the TLS certificate validation result.

**TLSClientAuthRequested**: Indicates whether the TLS server requests client authentication.Check this property in the TLSCertValidate event handler to find out whether the TLS server requests the client to provide the authentication certificate. If this property is set to true, provide your certificate via the TLSClientChain property. Note that the class may fire this event more than once during each operation, as more than one TLS-enabled server may need to be contacted.

**TLSValidationLog**: Contains the log of the TLS server certificate validation.Check this property in the TLSCertValidate event handler to retrieve the validation log of the TLS server.

**TokenName**: The TokenName parameter to pass to the signer.(obsolete) The TokenName parameter to pass to the signer.

**TokensLibraries**: (obsolete) The TokensLibraries parameter to pass to the signer.(obsolete) The TokensLibraries parameter to pass to the signer.

**TspAttemptCount**: Specifies the number of timestamping request attempts.Use this property to specify a number of timestamping request attempts.

In case of a timestamping failure, provide new TSA and HTTP settings inside the [Notification](#notification-event-secureblackbox_dcauth-class) event handler ('BeforeTimestamp' and 'TimestampError' event IDs).

**TspHashAlgorithm**: Sets a specific hash algorithm for use with the timestamping service.In default configuration class uses the 'SHA256' hash algorithm. Use this property to specify a different hash algorithm for the timestamp.

Note: Unlike other classes, [PDFSigner](PDFSigner.md#PDFSigner) class uses the same hash algorithm for the main signature and any associated timestamps during signing. Use this property to specify a different hash algorithm for the timestamp.

**TspReqPolicy**: Sets a request policy ID to include in the timestamping request.Use this property to provide a specific request policy OID to include in the timestamping request. Use the standard human-readable OID notation (1.2.3.4.5).

### 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 ([DCAuth](#dcauth-class) Class)