# RESTClient Component The RESTClient component implements client-side functionality for the REST protocol. ## Syntax ```text nsoftware.SecureBlackbox.RESTClient ``` ## Remarks RESTClient allows you to send requests to a REST server and receive server responses. It supports both plain (HTTP) and secure (HTTPS) modes. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthTypes](#authtypes-property-restclient-component) | Defines allowed HTTP authentication types. | | [BlockedCertificates](#blockedcertificates-property-restclient-component) | The certificates that must be rejected as trust anchors. | | [ConnectionInfo](#connectioninfo-property-restclient-component) | Returns the details of the underlying network connection. | | [CustomRequest](#customrequest-property-restclient-component) | Specifies a custom request verb. | | [DynamicData](#dynamicdata-property-restclient-component) | Takes a piece of data to be sent to the server within a dynamic POST or PUT request. | | [ExternalCrypto](#externalcrypto-property-restclient-component) | Provides access to external signing and DC parameters. | | [FIPSMode](#fipsmode-property-restclient-component) | Reserved. | | [KeepAlivePolicy](#keepalivepolicy-property-restclient-component) | Defines the keep-alive handling policy. | | [KnownCertificates](#knowncertificates-property-restclient-component) | Additional certificates for chain validation. | | [KnownCRLs](#knowncrls-property-restclient-component) | Additional CRLs for chain validation. | | [KnownOCSPs](#knownocsps-property-restclient-component) | Additional OCSP responses for chain validation. | | [OutputBytes](#outputbytes-property-restclient-component) | Contains the response content. | | [OutputFile](#outputfile-property-restclient-component) | A path to the output file. | | [OutputStream](#outputstream-property-restclient-component) | A stream where the response content should be written. | | [OutputString](#outputstring-property-restclient-component) | Contains the response content. | | [Proxy](#proxy-property-restclient-component) | The proxy server settings. | | [ReasonPhrase](#reasonphrase-property-restclient-component) | Contains the Reason Phrase element of the server's response. | | [RequestHeaders](#requestheaders-property-restclient-component) | Contains HTTP request headers. | | [RequestParameters](#requestparameters-property-restclient-component) | Provides access to common HTTP request properties. | | [ResponseHeaders](#responseheaders-property-restclient-component) | Contains the HTTP server's response headers. | | [ResponseParameters](#responseparameters-property-restclient-component) | Contains the HTTP server's response parameters. | | [SocketSettings](#socketsettings-property-restclient-component) | Manages network connection settings. | | [StatusCode](#statuscode-property-restclient-component) | Contains the Status Code element of the server's response. | | [TLSClientChain](#tlsclientchain-property-restclient-component) | The TLS client certificate chain. | | [TLSServerChain](#tlsserverchain-property-restclient-component) | The TLS server's certificate chain. | | [TLSSettings](#tlssettings-property-restclient-component) | Manages TLS layer settings. | | [TrustedCertificates](#trustedcertificates-property-restclient-component) | A list of trusted certificates for chain validation. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-restclient-component) | Sets or retrieves a configuration setting. | | [Delete](#delete-method-restclient-component) | Sends a DELETE request to the server. | | [DoAction](#doaction-method-restclient-component) | Performs an additional action. | | [Get](#get-method-restclient-component) | Sends a GET request to the server. | | [Head](#head-method-restclient-component) | Sends a HEAD request to the server. | | [Options](#options-method-restclient-component) | Sends an OPTIONS request to the server. | | [Post](#post-method-restclient-component) | Sends a POST request to the server. | | [PostBytes](#postbytes-method-restclient-component) | Sends a POST request to the server. | | [PostFile](#postfile-method-restclient-component) | Sends a file to the server using a POST request. | | [PostJSON](#postjson-method-restclient-component) | Sends a JSON POST request to the server. | | [PostStream](#poststream-method-restclient-component) | Sends a POST request to the server. | | [PostWebForm](#postwebform-method-restclient-component) | Posts a web form data to the server. | | [PostXML](#postxml-method-restclient-component) | Posts an XML request to the server. | | [Put](#put-method-restclient-component) | Sends a PUT request to the server. | | [PutBytes](#putbytes-method-restclient-component) | Sends a PUT request to the server. | | [PutFile](#putfile-method-restclient-component) | Sends a file to the server using a PUT request. | | [PutJSON](#putjson-method-restclient-component) | PUTs a JSON to the server. | | [PutStream](#putstream-method-restclient-component) | Sends a PUT request to the server. | | [PutXML](#putxml-method-restclient-component) | PUTs an XML to the server. | | [Reset](#reset-method-restclient-component) | Resets the component settings. | | [Trace](#trace-method-restclient-component) | Sends a TRACE request to the server. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Cookie](#cookie-event-restclient-component) | Fired to report a received cookie. | | [DocumentBegin](#documentbegin-event-restclient-component) | Marks the start of the incoming HTML document or file. | | [DocumentEnd](#documentend-event-restclient-component) | Marks the successful receipt of the incoming HTML document or file. | | [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) | Requests a portion of data to be uploaded from the application. | | [Error](#error-event-restclient-component) | Information about errors during data delivery. | | [ExternalSign](#externalsign-event-restclient-component) | Handles remote or external signing initiated by the SignExternal method or other source. | | [HeadersPrepared](#headersprepared-event-restclient-component) | Fires when the request headers have been formed and are about to be sent to the server. | | [HeadersReceived](#headersreceived-event-restclient-component) | Fires when the HTTP response headers have just been received from the server. | | [Notification](#notification-event-restclient-component) | This event notifies the application about an underlying control flow event. | | [Progress](#progress-event-restclient-component) | Fires periodically during the data transfer. | | [Redirection](#redirection-event-restclient-component) | Fires when the server suggests a redirect. | | [ServerEvent](#serverevent-event-restclient-component) | Fires when a server-sent event is received. | | [TLSCertNeeded](#tlscertneeded-event-restclient-component) | Fires when a remote TLS party requests a client certificate. | | [TLSCertValidate](#tlscertvalidate-event-restclient-component) | This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. | | [TLSEstablished](#tlsestablished-event-restclient-component) | Fires when a TLS handshake with Host successfully completes. | | [TLSHandshake](#tlshandshake-event-restclient-component) | Fires when a new TLS handshake is initiated, before the handshake commences. | | [TLSPSK](#tlspsk-event-restclient-component) | Notifies the application about the PSK key exchange. | | [TLSShutdown](#tlsshutdown-event-restclient-component) | Reports the graceful closure of a TLS connection. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthStickToLastURL](#AuthStickToLastURL) | TBD. | | [CachedCRLMaxAge](#CachedCRLMaxAge) | Specifies the maximum age of a cached CRL. | | [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio) | Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime. | | [CachedCRLOverlapTime](#CachedCRLOverlapTime) | Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed. | | [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) | Specifies the maximum age of a cached OCSP response. | | [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) | Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime. | | [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime) | Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed. | | [CacheStreamOutput](#CacheStreamOutput) | Tells the component whether to cache stream- and file-bound responses in the component. | | [Cookies](#Cookies) | TBD. | | [DefClientCookieFmt](#DefClientCookieFmt) | TBD. | | [DeltaCRLPreference](#DeltaCRLPreference) | Specifies whether complete or delta CRLs are preferred. | | [EvaluateSystemTrust](#EvaluateSystemTrust) | Enables or disables usage of the platform's built-in trust validation facilities. | | [ForceNTLMAuth](#ForceNTLMAuth) | Activates and enforces NTLM authentication. | | [IgnoreCookieSecureFlag](#IgnoreCookieSecureFlag) | TBD. | | [IgnoreSystemTrust](#IgnoreSystemTrust) | Whether trusted Windows Certificate Stores should be treated as trusted. | | [IgnoreUnknownTransferEncodings](#IgnoreUnknownTransferEncodings) | All incoming responses with unknown transfer encodings are ignored if this property is true. | | [KeepConnectionOpen](#KeepConnectionOpen) | TBD. | | [MaxRedirections](#MaxRedirections) | The maximum number of HTTP redirects. | | [OutputFile](#OutputFile) | Specifies the file where the received content should be saved to. | | [PersistentAuthHeader](#PersistentAuthHeader) | Whether to resend NTLM negotiation on every request. | | [RequestCompressionGZip](#RequestCompressionGZip) | Ask server to enforce GZip compression. | | [RequestCompressionLevel](#RequestCompressionLevel) | Ask server to use the specified compression level. | | [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) | Specifies a preset policy for cached CRL and OCSP response freshness settings. | | [SendBufferSize](#SendBufferSize) | Size of send buffer in bytes. | | [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. | | [SuppressRedirectionContent](#SuppressRedirectionContent) | Whether to suppress the redirection content. | | [TempPath](#TempPath) | Path for storing temporary files. | | [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the component for the current session. | | [TLSExtensions](#TLSExtensions) | TBD. | | [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the component. | | [TLSPeerExtensions](#TLSPeerExtensions) | TBD. | | [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. | | [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the component. | | [TolerateMinorChainIssues](#TolerateMinorChainIssues) | Whether to tolerate minor chain issues. | | [Use100Continue](#Use100Continue) | Whether to use 100-continue for POST and PUT commands. | | [UseCompression](#UseCompression) | Enables compression capability. | | [UseEnvStorages](#UseEnvStorages) | Enables or disables use of the environment storages. | | [UseKerberosAuth](#UseKerberosAuth) | TBD. | | [UseMicrosoftCTL](#UseMicrosoftCTL) | Enables or disables the automatic use of the Microsoft online certificate trust list. | | [UseSystemCertificates](#UseSystemCertificates) | Enables or disables the use of the system certificates. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the component. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server components. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client components created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client components should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # AuthTypes Property ([RESTClient](#restclient-component) Component) Defines allowed HTTP authentication types. ## Syntax ```text public int AuthTypes { get; set; } ``` ## Default Value 0 ## Remarks Use this property to define which authentication types the component should support or attempt to use by enabling the relevant bitmask flags: | | | | | --- | --- | --- | | haBasic | 0x01 | Basic authentication | | haDigest | 0x02 | Digest authentication (RFC 2617) | | haNTLM | 0x04 | Windows NTLM authentication | | haKerberos | 0x08 | Kerberos (Negotiate) authentication | | haOAuth2 | 0x10 | OAuth2 authentication | # BlockedCertificates Property ([RESTClient](#restclient-component) Component) The certificates that must be rejected as trust anchors. ## Syntax ```text public CertificateList BlockedCertificates { get; } ``` ## Remarks Use this property to provide a list of compromised or blocked certificates. Any chain containing a blocked certificate will fail validation. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # ConnectionInfo Property ([RESTClient](#restclient-component) Component) Returns the details of the underlying network connection. ## Syntax ```text public TLSConnectionInfo ConnectionInfo { get; } ``` ## Remarks Use this property to learn about the connection setup, such as the protocol security details and amounts of data transferred each way. This property is read-only and not available at design time. Please refer to the [TLSConnectionInfo](#tlsconnectioninfo-type) type for a complete list of fields. # CustomRequest Property ([RESTClient](#restclient-component) Component) Specifies a custom request verb. ## Syntax ```text public string CustomRequest { get; set; } ``` ## Default Value "" ## Remarks Use this property to specify a custom HTTP method verb to use instead of the original method. PATCH is one of the commonly used custom verbs. This property is not available at design time. # DynamicData Property ([RESTClient](#restclient-component) Component) Takes a piece of data to be sent to the server within a dynamic POST or PUT request. ## Syntax ```text public byte[] DynamicData { get; set; } ``` ## Remarks Assign the next chunk of data to this property from your [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event handler to pass it to the server. Leave it empty to tell the component that no more data is available. This property is not available at design time. # ExternalCrypto Property ([RESTClient](#restclient-component) Component) Provides access to external signing and DC parameters. ## Syntax ```text public ExternalCrypto ExternalCrypto { get; } ``` ## Remarks Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the [ExternalSign](#externalsign-event-restclient-component) event) and asynchronous (based on the DC protocol and the DCAuth signing component). This property is read-only. Please refer to the [ExternalCrypto](#externalcrypto-type) type for a complete list of fields. # FIPSMode Property ([RESTClient](#restclient-component) Component) Reserved. ## Syntax ```text public bool FIPSMode { get; set; } ``` ## Default Value False ## Remarks This property is reserved for future use. # KeepAlivePolicy Property ([RESTClient](#restclient-component) Component) Defines the keep-alive handling policy. ## Syntax ```text public RESTClientKeepAlivePolicies KeepAlivePolicy { get; set; } enum RESTClientKeepAlivePolicies { ckapStandardDefined, ckapPreferKeepAlive, ckapRelyOnServer, ckapKeepAlivesDisabled } ``` ## Default Value 0 ## Remarks Use this property to tune-up the keep-alive mechanism as per the needs of your application. | | | | | --- | --- | --- | | ckapStandardDefined | 0 | Follow the standard | | ckapPreferKeepAlive | 1 | Always request a keep-alive connection | | ckapRelyOnServer | 2 | Not include the "Connection" header, allowing the server to choose the keep-alive mode | | ckapKeepAlivesDisabled | 3 | Disable keep-alives by including the "Connection: Close" header | # KnownCertificates Property ([RESTClient](#restclient-component) Component) Additional certificates for chain validation. ## Syntax ```text public CertificateList KnownCertificates { get; } ``` ## Remarks Use this property to supply a list of additional certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when intermediary CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually. The purpose of the certificates to be added to this collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows. Do not add trust anchors or root certificates to this collection: add them to [TrustedCertificates](#trustedcertificates-property-restclient-component) instead. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # KnownCRLs Property ([RESTClient](#restclient-component) Component) Additional CRLs for chain validation. ## Syntax ```text public CRLList KnownCRLs { get; } ``` ## Remarks Use this property to supply additional CRLs that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated CRLs are stored separately from the signed message or document. This property is not available at design time. Please refer to the [CRL](#crl-type) type for a complete list of fields. # KnownOCSPs Property ([RESTClient](#restclient-component) Component) Additional OCSP responses for chain validation. ## Syntax ```text public OCSPResponseList KnownOCSPs { get; } ``` ## Remarks Use this property to supply additional OCSP responses that might be needed for chain validation. This property may be helpful when a chain is validated in offline mode, and the associated OCSP responses are stored separately from the signed message or document. This property is not available at design time. Please refer to the [OCSPResponse](#ocspresponse-type) type for a complete list of fields. # OutputBytes Property ([RESTClient](#restclient-component) Component) Contains the response content. ## Syntax ```text public byte[] OutputBytes { get; } ``` ## Remarks Use this property to access the content received from the server in response to a prior request. This property is read-only and not available at design time. # OutputFile Property ([RESTClient](#restclient-component) Component) A path to the output file. ## Syntax ```text public string OutputFile { get; set; } ``` ## Default Value "" ## Remarks Use this property to specify the file to store the content received from the server in response to a prior request. # OutputStream Property ([RESTClient](#restclient-component) Component) A stream where the response content should be written. ## Syntax ```text public System.IO.Stream OutputStream { get; set; } ``` ## Default Value null ## Remarks Use this property to specify the stream to store the content received from the server in response to a prior request. This property is not available at design time. # OutputString Property ([RESTClient](#restclient-component) Component) Contains the response content. ## Syntax ```text public string OutputString { get; } ``` ## Default Value "" ## Remarks Use this property to access the content received from the server in response to a prior request, as a string. This property is read-only and not available at design time. # Proxy Property ([RESTClient](#restclient-component) Component) The proxy server settings. ## Syntax ```text public ProxySettings Proxy { get; } ``` ## Remarks Use this property to tune up the proxy server settings. This property is read-only. Please refer to the [ProxySettings](#proxysettings-type) type for a complete list of fields. # ReasonPhrase Property ([RESTClient](#restclient-component) Component) Contains the Reason Phrase element of the server's response. ## Syntax ```text public string ReasonPhrase { get; } ``` ## Default Value "" ## Remarks Use this property to access the reason phrase supplied by the server in its response (such as OK in HTTP 200 OK). This property is read-only and not available at design time. # RequestHeaders Property ([RESTClient](#restclient-component) Component) Contains HTTP request headers. ## Syntax ```text public StringNameValuePairList RequestHeaders { get; } ``` ## Remarks Use this property to check and/or adjust the HTTP request headers from your [HeadersPrepared](#headersprepared-event-restclient-component) event handler. This property is read-only and not available at design time. Please refer to the [StringNameValuePair](#stringnamevaluepair-type) type for a complete list of fields. # RequestParameters Property ([RESTClient](#restclient-component) Component) Provides access to common HTTP request properties. ## Syntax ```text public HTTPRequestParameters RequestParameters { get; set; } ``` ## Remarks Use this property to configure the HTTP request properties. This property is not available at design time. Please refer to the [HTTPRequestParameters](#httprequestparameters-type) type for a complete list of fields. # ResponseHeaders Property ([RESTClient](#restclient-component) Component) Contains the HTTP server's response headers. ## Syntax ```text public StringNameValuePairList ResponseHeaders { get; } ``` ## Remarks Use this property to check the headers of the HTTP response received from the server. The headers become available as soon as [HeadersReceived](#headersreceived-event-restclient-component) event is fired. This property is read-only and not available at design time. Please refer to the [StringNameValuePair](#stringnamevaluepair-type) type for a complete list of fields. # ResponseParameters Property ([RESTClient](#restclient-component) Component) Contains the HTTP server's response parameters. ## Syntax ```text public HTTPResponseParameters ResponseParameters { get; } ``` ## Remarks Use this property to access the properties of the received HTTP response. This property is read-only and not available at design time. Please refer to the [HTTPResponseParameters](#httpresponseparameters-type) type for a complete list of fields. # SocketSettings Property ([RESTClient](#restclient-component) Component) Manages network connection settings. ## Syntax ```text public SocketSettings SocketSettings { get; } ``` ## Remarks Use this property to tune up network connection parameters. This property is read-only. Please refer to the [SocketSettings](#socketsettings-type) type for a complete list of fields. # StatusCode Property ([RESTClient](#restclient-component) Component) Contains the Status Code element of the server's response. ## Syntax ```text public int StatusCode { get; } ``` ## Default Value 0 ## Remarks Use this property to access the status code supplied by the server in its response (such as 200 in HTTP 200 OK). This property is read-only and not available at design time. # TLSClientChain Property ([RESTClient](#restclient-component) Component) The TLS client certificate chain. ## Syntax ```text public CertificateList TLSClientChain { get; } ``` ## Remarks Assign a certificate chain to this property to enable TLS client authentication in the component. Note that the client's end-entity certificate should have a private key associated with it. Use the [CertificateStorage](CertificateStorage.md#CertificateStorage) or [CertificateManager](CertificateManager.md#CertificateManager) components to import the certificate from a file, system store, or PKCS11 device. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # TLSServerChain Property ([RESTClient](#restclient-component) Component) The TLS server's certificate chain. ## Syntax ```text public CertificateList TLSServerChain { get; } ``` ## Remarks Use this property to access the certificate chain sent by the TLS server. This property is ready to read when the [TLSCertValidate](#tlscertvalidate-event-restclient-component) event is fired by the client component. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # TLSSettings Property ([RESTClient](#restclient-component) Component) Manages TLS layer settings. ## Syntax ```text public TLSSettings TLSSettings { get; } ``` ## Remarks Use this property to tune up the TLS layer parameters. This property is read-only. Please refer to the [TLSSettings](#tlssettings-type) type for a complete list of fields. # TrustedCertificates Property ([RESTClient](#restclient-component) Component) A list of trusted certificates for chain validation. ## Syntax ```text public CertificateList TrustedCertificates { get; } ``` ## Remarks Use this property to supply a list of trusted certificates that might be needed for chain validation. An example of a scenario where you might want to do that is when root CA certificates are absent from the standard system locations (or when there are no standard system locations), and therefore should be supplied to the component manually. The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store. Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the trusted list may result in bad chains being accepted, and forfeited signatures being recognized as genuine. Only add certificates that originate from the parties that you know and trust. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # Config Method ([RESTClient](#restclient-component) Component) Sets or retrieves a configuration setting. ## Syntax ```text public string Config(string configurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-restclient-component) for the component. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-restclient-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Delete Method ([RESTClient](#restclient-component) Component) Sends a DELETE request to the server. ## Syntax ```text public void Delete(string url); ``` ## Remarks Use this method to send a DELETE request to server. In response to this request, the server may (without any guarantees) delete the resource specified in *Url*. Most of the servers disable DELETE requests. If this request fails, an exception will be thrown, and the error details published in [StatusCode](#statuscode-property-restclient-component) and [ReasonPhrase](#reasonphrase-property-restclient-component) properties. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # DoAction Method ([RESTClient](#restclient-component) Component) Performs an additional action. ## Syntax ```text public string DoAction(string actionID, string actionParams); ``` ## Remarks DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # Get Method ([RESTClient](#restclient-component) Component) Sends a GET request to the server. ## Syntax ```text public void Get(string url); ``` ## Remarks GET is one of the most widely used HTTP requests. The server responds with the content of the resource specified in *Url*. If the request is successful, the received content will be available in [OutputBytes](#outputbytes-property-restclient-component) and [OutputString](#outputstring-property-restclient-component) properties. Otherwise an exception will be thrown, and the error details published in [StatusCode](#statuscode-property-restclient-component) and [ReasonPhrase](#reasonphrase-property-restclient-component) properties. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # Head Method ([RESTClient](#restclient-component) Component) Sends a HEAD request to the server. ## Syntax ```text public void Head(string url); ``` ## Remarks HEAD is very similar to GET, with the only difference being that only the headers (but not the content) is returned. HEAD is often use to retrieve the parameters of the resource, such as its size and modification date. If the request is successful, those details will be available via [ResponseParameters](#responseparameters-property-restclient-component) and [ResponseHeaders](#responseheaders-property-restclient-component) properties. Otherwise, an exception will be thrown, and the error details published in [StatusCode](#statuscode-property-restclient-component) and [ReasonPhrase](#reasonphrase-property-restclient-component) properties. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # Options Method ([RESTClient](#restclient-component) Component) Sends an OPTIONS request to the server. ## Syntax ```text public void Options(string url); ``` ## Remarks This request gets various information about the server such as supported HTTP methods. No content is included in the response. # Post Method ([RESTClient](#restclient-component) Component) Sends a POST request to the server. ## Syntax ```text public void Post(string url, string content); ``` ## Remarks POST is used to send data to the remote HTTP endpoint/script. Provide the data you need to send via the *Content* parameter. If Content is omitted, and only *Url* is set, the data will be streamed dynamically using the [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event. To post a web form's data (including file attachments to the form) use [PostWebForm](#postwebform-method-restclient-component) method. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PostBytes Method ([RESTClient](#restclient-component) Component) Sends a POST request to the server. ## Syntax ```text public void PostBytes(string url, byte[] contentBytes); ``` ## Remarks POST is used to send data to the remote HTTP endpoint/script. Provide the data you need to send via the *ContentBytes* parameter. If content is omitted, and only *Url* is set, the data will be streamed dynamically using the [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event. To post a web form's data (including file attachments to the form) use [PostWebForm](#postwebform-method-restclient-component) method. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PostFile Method ([RESTClient](#restclient-component) Component) Sends a file to the server using a POST request. ## Syntax ```text public void PostFile(string url, string fileName); ``` ## Remarks POST is used to send data to the remote HTTP endpoint/script. The content to send will be taken from *FileName*. To post a web form's data (including file attachments to the form) use [PostWebForm](#postwebform-method-restclient-component) method. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PostJSON Method ([RESTClient](#restclient-component) Component) Sends a JSON POST request to the server. ## Syntax ```text public void PostJSON(string url, string content); ``` ## Remarks POST is used to send data to the remote HTTP endpoint/script. Provide the JSON data you need to send via the *Content* parameter. If Content is omitted, and only *Url* is set, the data will be streamed dynamically using the [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event. To post a regular (non-JSON) data, use [Post](#post-method-restclient-component) method. To post a web form's data (including file attachments to the form) use [PostWebForm](#postwebform-method-restclient-component) method. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PostStream Method ([RESTClient](#restclient-component) Component) Sends a POST request to the server. ## Syntax ```text public void PostStream(string url, System.IO.Stream inputStream); ``` ## Remarks POST is used to send data to the remote HTTP endpoint/script. Provide the data you need to send via the *InputStream* parameter. To post a web form data (including file attachments to the form) use [PostWebForm](#postwebform-method-restclient-component) method. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PostWebForm Method ([RESTClient](#restclient-component) Component) Posts a web form data to the server. ## Syntax ```text public void PostWebForm(string url, string fields, string fileField, string fileName, string contentType); ``` ## Remarks This variant of the POST method provides means to submit a form (as in a web browser) with an optional file attachment. *Fields* are expected to contain a list of field names and values in "Name=Value" format separated with EOLs. This list can be empty. If including a file with your request, use the *FileField* and *FileName* properties to specify the file field name and the local filename for the uploaded file. Use *ContentType* to override the default content type chosen by the client, e.g., "application/x-www-form-urlencoded". Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PostXML Method ([RESTClient](#restclient-component) Component) Posts an XML request to the server. ## Syntax ```text public void PostXML(string url, string content); ``` ## Remarks POST is used to send data to the remote HTTP endpoint/script. Provide the XML data you need to send via the *Content* parameter. If Content is omitted, and only *Url* is set, the data will be streamed dynamically using the [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event. To post a regular (non-XML) data, use [Post](#post-method-restclient-component) method. To post a web form's data (including file attachments to the form) use [PostWebForm](#postwebform-method-restclient-component) method. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # Put Method ([RESTClient](#restclient-component) Component) Sends a PUT request to the server. ## Syntax ```text public void Put(string url, string content); ``` ## Remarks PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers. If *Content* is not present, and only *Url* is set, the data will be streamed dynamically using the [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event. Note that some servers do not support streaming. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PutBytes Method ([RESTClient](#restclient-component) Component) Sends a PUT request to the server. ## Syntax ```text public void PutBytes(string url, byte[] contentBytes); ``` ## Remarks PUT method is used to write data to the server. This method is optional to support and is disabled on most of HTTP servers. If *ContentBytes* is not present, and only *Url* is set, the data will be streamed dynamically using the [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event. Note that some servers do not support streaming. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PutFile Method ([RESTClient](#restclient-component) Component) Sends a file to the server using a PUT request. ## Syntax ```text public void PutFile(string url, string fileName); ``` ## Remarks PUT is an alternative to POST and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off. The content to send will be taken from *FileName*. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PutJSON Method ([RESTClient](#restclient-component) Component) PUTs a JSON to the server. ## Syntax ```text public void PutJSON(string url, string content); ``` ## Remarks PUT method is used to write data to the server. If *Content* is not present, and only *Url* is set, the data will be streamed dynamically using the [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event. Note that some servers do not support streaming. To PUT a regular (non-JSON) data, use [Put](#put-method-restclient-component) method. To post JSON data, use [PostJSON](#postjson-method-restclient-component) method. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PutStream Method ([RESTClient](#restclient-component) Component) Sends a PUT request to the server. ## Syntax ```text public void PutStream(string url, System.IO.Stream inputStream); ``` ## Remarks PUT is an alternative to POST, and is used to send data to the remote HTTP endpoint/script. Many servers have this method switched off. Provide the data you need to send via the *InputStream* parameter. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # PutXML Method ([RESTClient](#restclient-component) Component) PUTs an XML to the server. ## Syntax ```text public void PutXML(string url, string content); ``` ## Remarks PUT method is used to write data to the server. If *Content* is not present, and only *Url* is set, the data will be streamed dynamically using the [DynamicDataNeeded](#dynamicdataneeded-event-restclient-component) event. Note that some servers do not support streaming. To PUT a regular (non-XML) data, use [Put](#put-method-restclient-component) method. To post XML data, use [PostXML](#postxml-method-restclient-component) method. Note that any parameters you intend to pass to this method should be properly encoded before this method is called. # Reset Method ([RESTClient](#restclient-component) Component) Resets the component settings. ## Syntax ```text public void Reset(); ``` ## Remarks Reset is a generic method available in every component. # Trace Method ([RESTClient](#restclient-component) Component) Sends a TRACE request to the server. ## Syntax ```text public void Trace(string url); ``` ## Remarks TRACE is a debug command and is typically switched off and/or not supported by web servers. # Cookie Event ([RESTClient](#restclient-component) Component) Fired to report a received cookie. ## Syntax ```text public event OnCookieHandler OnCookie; public delegate void OnCookieHandler(object sender, RESTClientCookieEventArgs e); public class RESTClientCookieEventArgs : EventArgs { public string CookieText { get; } } ``` ## Remarks The *CookieText* parameter contains the text of the cookie. # DocumentBegin Event ([RESTClient](#restclient-component) Component) Marks the start of the incoming HTML document or file. ## Syntax ```text public event OnDocumentBeginHandler OnDocumentBegin; public delegate void OnDocumentBeginHandler(object sender, RESTClientDocumentBeginEventArgs e); public class RESTClientDocumentBeginEventArgs : EventArgs { } ``` ## Remarks This event is followed by one or more [Progress](#progress-event-restclient-component) calls. When the document has been received in full, the [DocumentEnd](#documentend-event-restclient-component) event is fired. # DocumentEnd Event ([RESTClient](#restclient-component) Component) Marks the successful receipt of the incoming HTML document or file. ## Syntax ```text public event OnDocumentEndHandler OnDocumentEnd; public delegate void OnDocumentEndHandler(object sender, RESTClientDocumentEndEventArgs e); public class RESTClientDocumentEndEventArgs : EventArgs { } ``` ## Remarks This event fires when the document has been received in full. # DynamicDataNeeded Event ([RESTClient](#restclient-component) Component) Requests a portion of data to be uploaded from the application. ## Syntax ```text public event OnDynamicDataNeededHandler OnDynamicDataNeeded; public delegate void OnDynamicDataNeededHandler(object sender, RESTClientDynamicDataNeededEventArgs e); public class RESTClientDynamicDataNeededEventArgs : EventArgs { public int BytesNeeded { get; } } ``` ## Remarks If dynamic ('streaming') variants of PUT or POST methods are used, this event is fired periodically to request portions of data to be sent to the server. When handling this event, assign the next portion of data of *BytesNeeded* length (or less) to [DynamicData](#dynamicdata-property-restclient-component). If no more data is available to upload (the whole document has been sent), leave [DynamicData](#dynamicdata-property-restclient-component) empty. # Error Event ([RESTClient](#restclient-component) Component) Information about errors during data delivery. ## Syntax ```text public event OnErrorHandler OnError; public delegate void OnErrorHandler(object sender, RESTClientErrorEventArgs e); public class RESTClientErrorEventArgs : EventArgs { public int ErrorCode { get; } public string Description { get; } } ``` ## Remarks The event is fired in case of exceptional conditions during message processing. *ErrorCode* contains an error code and *Description* contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [HTTPS](#trappable-errors-restclient-component) section. # ExternalSign Event ([RESTClient](#restclient-component) Component) Handles remote or external signing initiated by the SignExternal method or other source. ## Syntax ```text public event OnExternalSignHandler OnExternalSign; public delegate void OnExternalSignHandler(object sender, RESTClientExternalSignEventArgs e); public class RESTClientExternalSignEventArgs : EventArgs { public string OperationId { get; } public string HashAlgorithm { get; } public string Pars { get; } public string Data { get; } public string SignedData { get; set; } } ``` ## 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 component via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The component 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(); }; ``` # HeadersPrepared Event ([RESTClient](#restclient-component) Component) Fires when the request headers have been formed and are about to be sent to the server. ## Syntax ```text public event OnHeadersPreparedHandler OnHeadersPrepared; public delegate void OnHeadersPreparedHandler(object sender, RESTClientHeadersPreparedEventArgs e); public class RESTClientHeadersPreparedEventArgs : EventArgs { } ``` ## Remarks The prepared headers are available in [RequestHeaders](#requestheaders-property-restclient-component) property. This event provides you the last chance to review/alter them. # HeadersReceived Event ([RESTClient](#restclient-component) Component) Fires when the HTTP response headers have just been received from the server. ## Syntax ```text public event OnHeadersReceivedHandler OnHeadersReceived; public delegate void OnHeadersReceivedHandler(object sender, RESTClientHeadersReceivedEventArgs e); public class RESTClientHeadersReceivedEventArgs : EventArgs { } ``` ## Remarks The received headers are available via the [ResponseHeaders](#responseheaders-property-restclient-component) property. # Notification Event ([RESTClient](#restclient-component) Component) This event notifies the application about an underlying control flow event. ## Syntax ```text public event OnNotificationHandler OnNotification; public delegate void OnNotificationHandler(object sender, RESTClientNotificationEventArgs e); public class RESTClientNotificationEventArgs : EventArgs { public string EventID { get; } public string EventParam { get; } } ``` ## Remarks The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted. # Progress Event ([RESTClient](#restclient-component) Component) Fires periodically during the data transfer. ## Syntax ```text public event OnProgressHandler OnProgress; public delegate void OnProgressHandler(object sender, RESTClientProgressEventArgs e); public class RESTClientProgressEventArgs : EventArgs { public long Total { get; } public long Current { get; } public bool Cancel { get; set; } } ``` ## Remarks Use this event to check the progress of an upload or download operation. *Total* indicates the total number of bytes to be transferred; *Current* specifies how much data has been transferred so far, and *Cancel* gives you a chance to cancel the operation. # Redirection Event ([RESTClient](#restclient-component) Component) Fires when the server suggests a redirect. ## Syntax ```text public event OnRedirectionHandler OnRedirection; public delegate void OnRedirectionHandler(object sender, RESTClientRedirectionEventArgs e); public class RESTClientRedirectionEventArgs : EventArgs { public string OldURL { get; } public string NewURL { get; set; } public bool AllowRedirection { get; set; } } ``` ## Remarks This event is fired when the server suggests a redirection request (typically via a 301 or 302 response). *OldURL* indicates the 'from' page, and *NewURL* indicates the 'to' one. The destination page can be altered by the application if needed. Use *AllowRedirection* to block undesirable redirects. Generally, this is a notification event: the component handles redirections automatically. Use the *MaxRedirections* config property to limit the number of redirection hops. # ServerEvent Event ([RESTClient](#restclient-component) Component) Fires when a server-sent event is received. ## Syntax ```text public event OnServerEventHandler OnServerEvent; public delegate void OnServerEventHandler(object sender, RESTClientServerEventEventArgs e); public class RESTClientServerEventEventArgs : EventArgs { public string Evt { get; } public string Data { get; } public string Id { get; } } ``` ## Remarks Use this event to capture server-sent events (SSE). This event is only fired when the component is used in the SSE subscriber mode. Use the Subscribe method to subscribe to an endpoint that sends SSEs. # TLSCertNeeded Event ([RESTClient](#restclient-component) Component) Fires when a remote TLS party requests a client certificate. ## Syntax ```text public event OnTLSCertNeededHandler OnTLSCertNeeded; public delegate void OnTLSCertNeededHandler(object sender, RESTClientTLSCertNeededEventArgs e); public class RESTClientTLSCertNeededEventArgs : EventArgs { public string Host { get; } public string CANames { get; } } ``` ## Remarks This event fires to notify the implementation that a remote TLS server has requested a client certificate. The *Host* parameter identifies the host that makes a request, and the *CANames* parameter (optional, according to the TLS spec) advises on the accepted issuing CAs. Use the [TLSClientChain](#tlsclientchain-property-restclient-component) property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire. This event is preceded by the [TLSHandshake](#tlshandshake-event-restclient-component) event for the given host and, if the certificate was accepted, succeeded by the [TLSEstablished](#tlsestablished-event-restclient-component) event. # TLSCertValidate Event ([RESTClient](#restclient-component) Component) This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance. ## Syntax ```text public event OnTLSCertValidateHandler OnTLSCertValidate; public delegate void OnTLSCertValidateHandler(object sender, RESTClientTLSCertValidateEventArgs e); public class RESTClientTLSCertValidateEventArgs : EventArgs { public string ServerHost { get; } public string ServerIP { get; } public bool Accept { get; set; } } ``` ## Remarks This event is fired during a TLS handshake. Use the [TLSServerChain](#tlsserverchain-property-restclient-component) property to access the certificate chain. In general, components may contact a number of TLS endpoints during their work, depending on their configuration. *Accept* is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed. # TLSEstablished Event ([RESTClient](#restclient-component) Component) Fires when a TLS handshake with * Host * successfully completes. ## Syntax ```text public event OnTLSEstablishedHandler OnTLSEstablished; public delegate void OnTLSEstablishedHandler(object sender, RESTClientTLSEstablishedEventArgs e); public class RESTClientTLSEstablishedEventArgs : EventArgs { public string Host { get; } public string Version { get; } public string Ciphersuite { get; } public byte[] ConnectionId { get; } public bool Abort { get; set; } } ``` ## Remarks The component uses this event to notify the application about a successful completion of a TLS handshake. The *Version*, *Ciphersuite*, and *ConnectionId* parameters indicate the security parameters of the new connection. Use the *Abort* parameter if you need to terminate the connection at this stage. # TLSHandshake Event ([RESTClient](#restclient-component) Component) Fires when a new TLS handshake is initiated, before the handshake commences. ## Syntax ```text public event OnTLSHandshakeHandler OnTLSHandshake; public delegate void OnTLSHandshakeHandler(object sender, RESTClientTLSHandshakeEventArgs e); public class RESTClientTLSHandshakeEventArgs : EventArgs { public string Host { get; } public bool Abort { get; set; } } ``` ## Remarks The component uses this event to notify the application about the start of a new TLS handshake to *Host*. If the handshake is successful, this event will be followed by the [TLSEstablished](#tlsestablished-event-restclient-component) event. If the server chooses to request a client certificate, the [TLSCertNeeded](#tlscertneeded-event-restclient-component) event will also be fired. # TLSPSK Event ([RESTClient](#restclient-component) Component) Notifies the application about the PSK key exchange. ## Syntax ```text public event OnTLSPSKHandler OnTLSPSK; public delegate void OnTLSPSKHandler(object sender, RESTClientTLSPSKEventArgs e); public class RESTClientTLSPSKEventArgs : EventArgs { public string Host { get; } public string Hint { get; } } ``` ## Remarks The component fires this event to notify the application about the beginning of TLS-PSK key exchange with *Host*. The *Hint* parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of [TLSSettings](#tlssettings-property-restclient-component) to provide the pre-shared key to the component. # TLSShutdown Event ([RESTClient](#restclient-component) Component) Reports the graceful closure of a TLS connection. ## Syntax ```text public event OnTLSShutdownHandler OnTLSShutdown; public delegate void OnTLSShutdownHandler(object sender, RESTClientTLSShutdownEventArgs e); public class RESTClientTLSShutdownEventArgs : EventArgs { public string Host { get; } } ``` ## Remarks This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported. # Certificate Type Encapsulates an individual X.509 certificate. ## Remarks This type keeps and provides access to X.509 certificate details. The following fields are available: - [Bytes](#Certificate_f_Bytes) - [CA](#Certificate_f_CA) - [CAKeyID](#Certificate_f_CAKeyID) - [CertType](#Certificate_f_CertType) - [CRLDistributionPoints](#Certificate_f_CRLDistributionPoints) - [Curve](#Certificate_f_Curve) - [Fingerprint](#Certificate_f_Fingerprint) - [FriendlyName](#Certificate_f_FriendlyName) - [HashAlgorithm](#Certificate_f_HashAlgorithm) - [Issuer](#Certificate_f_Issuer) - [IssuerRDN](#Certificate_f_IssuerRDN) - [KeyAlgorithm](#Certificate_f_KeyAlgorithm) - [KeyBits](#Certificate_f_KeyBits) - [KeyFingerprint](#Certificate_f_KeyFingerprint) - [KeyUsage](#Certificate_f_KeyUsage) - [KeyValid](#Certificate_f_KeyValid) - [OCSPLocations](#Certificate_f_OCSPLocations) - [OCSPNoCheck](#Certificate_f_OCSPNoCheck) - [Origin](#Certificate_f_Origin) - [PolicyIDs](#Certificate_f_PolicyIDs) - [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) - [PrivateKeyExists](#Certificate_f_PrivateKeyExists) - [PrivateKeyExtractable](#Certificate_f_PrivateKeyExtractable) - [PublicKeyBytes](#Certificate_f_PublicKeyBytes) - [Qualified](#Certificate_f_Qualified) - [QualifiedStatements](#Certificate_f_QualifiedStatements) - [Qualifiers](#Certificate_f_Qualifiers) - [SelfSigned](#Certificate_f_SelfSigned) - [SerialNumber](#Certificate_f_SerialNumber) - [SigAlgorithm](#Certificate_f_SigAlgorithm) - [Source](#Certificate_f_Source) - [Subject](#Certificate_f_Subject) - [SubjectAlternativeName](#Certificate_f_SubjectAlternativeName) - [SubjectKeyID](#Certificate_f_SubjectKeyID) - [SubjectRDN](#Certificate_f_SubjectRDN) - [Valid](#Certificate_f_Valid) - [ValidFrom](#Certificate_f_ValidFrom) - [ValidTo](#Certificate_f_ValidTo) ## Fields **Bytes** *byte[] (read-only)* Default: "" Returns the raw certificate data in DER format. **CA** *bool* Default: False Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled. Set this field when generating a new certificate to have its Basic Constraints extension generated automatically. **CAKeyID** *byte[] (read-only)* Default: "" A unique identifier (fingerprint) of the CA certificate's cryptographic key. Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building. This setting cannot be set when generating a certificate as it always derives from another certificate property. [CertificateManager](CertificateManager.md#CertificateManager) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [SubjectKeyID](#Certificate_f_SubjectKeyID) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. **CertType** *CertTypes (read-only)* Default: 0 Returns the type of the entity contained in the [Certificate](#certificate-type) object. A [Certificate](#certificate-type) object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate. Use the [CertificateManager](CertificateManager.md#CertificateManager) component to load or create new certificate and certificate requests objects. **CRLDistributionPoints** *string* Default: "" Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension. Use this field when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate. The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. **Curve** *string* Default: "" Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys. | | | | | --- | --- | --- | | SB_EC_SECP112R1 | SECP112R1 | | | SB_EC_SECP112R2 | SECP112R2 | | | SB_EC_SECP128R1 | SECP128R1 | | | SB_EC_SECP128R2 | SECP128R2 | | | SB_EC_SECP160K1 | SECP160K1 | | | SB_EC_SECP160R1 | SECP160R1 | | | SB_EC_SECP160R2 | SECP160R2 | | | SB_EC_SECP192K1 | SECP192K1 | | | SB_EC_SECP192R1 | SECP192R1 | | | SB_EC_SECP224K1 | SECP224K1 | | | SB_EC_SECP224R1 | SECP224R1 | | | SB_EC_SECP256K1 | SECP256K1 | | | SB_EC_SECP256R1 | SECP256R1 | | | SB_EC_SECP384R1 | SECP384R1 | | | SB_EC_SECP521R1 | SECP521R1 | | | SB_EC_SECT113R1 | SECT113R1 | | | SB_EC_SECT113R2 | SECT113R2 | | | SB_EC_SECT131R1 | SECT131R1 | | | SB_EC_SECT131R2 | SECT131R2 | | | SB_EC_SECT163K1 | SECT163K1 | | | SB_EC_SECT163R1 | SECT163R1 | | | SB_EC_SECT163R2 | SECT163R2 | | | SB_EC_SECT193R1 | SECT193R1 | | | SB_EC_SECT193R2 | SECT193R2 | | | SB_EC_SECT233K1 | SECT233K1 | | | SB_EC_SECT233R1 | SECT233R1 | | | SB_EC_SECT239K1 | SECT239K1 | | | SB_EC_SECT283K1 | SECT283K1 | | | SB_EC_SECT283R1 | SECT283R1 | | | SB_EC_SECT409K1 | SECT409K1 | | | SB_EC_SECT409R1 | SECT409R1 | | | SB_EC_SECT571K1 | SECT571K1 | | | SB_EC_SECT571R1 | SECT571R1 | | | SB_EC_PRIME192V1 | PRIME192V1 | | | SB_EC_PRIME192V2 | PRIME192V2 | | | SB_EC_PRIME192V3 | PRIME192V3 | | | SB_EC_PRIME239V1 | PRIME239V1 | | | SB_EC_PRIME239V2 | PRIME239V2 | | | SB_EC_PRIME239V3 | PRIME239V3 | | | SB_EC_PRIME256V1 | PRIME256V1 | | | SB_EC_C2PNB163V1 | C2PNB163V1 | | | SB_EC_C2PNB163V2 | C2PNB163V2 | | | SB_EC_C2PNB163V3 | C2PNB163V3 | | | SB_EC_C2PNB176W1 | C2PNB176W1 | | | SB_EC_C2TNB191V1 | C2TNB191V1 | | | SB_EC_C2TNB191V2 | C2TNB191V2 | | | SB_EC_C2TNB191V3 | C2TNB191V3 | | | SB_EC_C2ONB191V4 | C2ONB191V4 | | | SB_EC_C2ONB191V5 | C2ONB191V5 | | | SB_EC_C2PNB208W1 | C2PNB208W1 | | | SB_EC_C2TNB239V1 | C2TNB239V1 | | | SB_EC_C2TNB239V2 | C2TNB239V2 | | | SB_EC_C2TNB239V3 | C2TNB239V3 | | | SB_EC_C2ONB239V4 | C2ONB239V4 | | | SB_EC_C2ONB239V5 | C2ONB239V5 | | | SB_EC_C2PNB272W1 | C2PNB272W1 | | | SB_EC_C2PNB304W1 | C2PNB304W1 | | | SB_EC_C2TNB359V1 | C2TNB359V1 | | | SB_EC_C2PNB368W1 | C2PNB368W1 | | | SB_EC_C2TNB431R1 | C2TNB431R1 | | | SB_EC_NISTP192 | NISTP192 | | | SB_EC_NISTP224 | NISTP224 | | | SB_EC_NISTP256 | NISTP256 | | | SB_EC_NISTP384 | NISTP384 | | | SB_EC_NISTP521 | NISTP521 | | | SB_EC_NISTB163 | NISTB163 | | | SB_EC_NISTB233 | NISTB233 | | | SB_EC_NISTB283 | NISTB283 | | | SB_EC_NISTB409 | NISTB409 | | | SB_EC_NISTB571 | NISTB571 | | | SB_EC_NISTK163 | NISTK163 | | | SB_EC_NISTK233 | NISTK233 | | | SB_EC_NISTK283 | NISTK283 | | | SB_EC_NISTK409 | NISTK409 | | | SB_EC_NISTK571 | NISTK571 | | | SB_EC_GOSTCPTEST | GOSTCPTEST | | | SB_EC_GOSTCPA | GOSTCPA | | | SB_EC_GOSTCPB | GOSTCPB | | | SB_EC_GOSTCPC | GOSTCPC | | | SB_EC_GOSTCPXCHA | GOSTCPXCHA | | | SB_EC_GOSTCPXCHB | GOSTCPXCHB | | | SB_EC_BRAINPOOLP160R1 | BRAINPOOLP160R1 | | | SB_EC_BRAINPOOLP160T1 | BRAINPOOLP160T1 | | | SB_EC_BRAINPOOLP192R1 | BRAINPOOLP192R1 | | | SB_EC_BRAINPOOLP192T1 | BRAINPOOLP192T1 | | | SB_EC_BRAINPOOLP224R1 | BRAINPOOLP224R1 | | | SB_EC_BRAINPOOLP224T1 | BRAINPOOLP224T1 | | | SB_EC_BRAINPOOLP256R1 | BRAINPOOLP256R1 | | | SB_EC_BRAINPOOLP256T1 | BRAINPOOLP256T1 | | | SB_EC_BRAINPOOLP320R1 | BRAINPOOLP320R1 | | | SB_EC_BRAINPOOLP320T1 | BRAINPOOLP320T1 | | | SB_EC_BRAINPOOLP384R1 | BRAINPOOLP384R1 | | | SB_EC_BRAINPOOLP384T1 | BRAINPOOLP384T1 | | | SB_EC_BRAINPOOLP512R1 | BRAINPOOLP512R1 | | | SB_EC_BRAINPOOLP512T1 | BRAINPOOLP512T1 | | | SB_EC_CURVE25519 | CURVE25519 | | | SB_EC_CURVE448 | CURVE448 | | **Fingerprint** *string (read-only)* Default: "" Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. **FriendlyName** *string (read-only)* Default: "" Contains an associated alias (friendly name) of the certificate. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names. **HashAlgorithm** *string* Default: "" Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use [SigAlgorithm](#Certificate_f_SigAlgorithm) to find out the hash algorithm that is part of the certificate signature. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | **Issuer** *string (read-only)* Default: "" The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [IssuerRDN](#Certificate_f_IssuerRDN). **IssuerRDN** *string* Default: "" A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* **KeyAlgorithm** *string* Default: "0" Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [KeyBits](#Certificate_f_KeyBits), [Curve](#Certificate_f_Curve), and [PublicKeyBytes](#Certificate_f_PublicKeyBytes) fields to get more details about the key the certificate contains. **KeyBits** *int (read-only)* Default: 0 Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [PublicKeyBytes](#Certificate_f_PublicKeyBytes) or [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes) field would typically contain auxiliary values, and therefore be longer. **KeyFingerprint** *string (read-only)* Default: "" Returns a SHA1 fingerprint of the public key contained in the certificate. Note that the key fingerprint is different from the certificate fingerprint accessible via the [Fingerprint](#Certificate_f_Fingerprint) field. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. **KeyUsage** *int* Default: 0 Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this field before generating the certificate to propagate the key usage flags to the new certificate. **KeyValid** *bool (read-only)* Default: False Returns *True* if the certificate's key is cryptographically valid, and *False* otherwise. **OCSPLocations** *string* Default: "" Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA. Set this field before calling the certificate manager's [Generate](CertificateManager.md#CertificateManager_m_Generate) method to propagate it to the new certificate. The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator. **OCSPNoCheck** *bool* Default: False Accessor to the value of the certificate's ocsp-no-check extension. **Origin** *int (read-only)* Default: 0 Returns the location that the certificate was taken or loaded from. **PolicyIDs** *string* Default: "" Contains identifiers (OIDs) of the applicable certificate policies. The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage. Set this field when generating a certificate to propagate the policies information to the new certificate. The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator. **PrivateKeyBytes** *byte[] (read-only)* Default: "" Returns the certificate's private key in DER-encoded format. It is normal for this field to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices. **PrivateKeyExists** *bool (read-only)* Default: False Indicates whether the certificate has a usable private key associated with it. If it is set to *True*, the certificate can be used for private key operations, such as signing or decryption. This field is independent from [PrivateKeyBytes](#Certificate_f_PrivateKeyBytes), and can be set to *True* even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations. **PrivateKeyExtractable** *bool (read-only)* Default: False Indicates whether the private key is extractable (exportable). **PublicKeyBytes** *byte[] (read-only)* Default: "" Contains the certificate's public key in DER format. This typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate. **Qualified** *bool (read-only)* Default: False Indicates whether the certificate is qualified. This property is set to *True* if the certificate is confirmed by a Trusted List to be qualified. **QualifiedStatements** *QualifiedStatementsTypes* Default: 0 Returns a simplified qualified status of the certificate. **Qualifiers** *string (read-only)* Default: "" A list of qualifiers. Contains a comma-separated list of qualifier aliases for the certificate, for example *QCP-n-qscd,QCWithSSCD*. **SelfSigned** *bool (read-only)* Default: False Indicates whether the certificate is self-signed (root) or signed by an external CA. **SerialNumber** *byte[]* Default: "" Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. **SigAlgorithm** *string (read-only)* Default: "" Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **Subject** *string (read-only)* Default: "" The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [SubjectRDN](#Certificate_f_SubjectRDN). **SubjectAlternativeName** *string* Default: "" Returns or sets the value of the Subject Alternative Name extension of the certificate. Subject alternative names are used to provide additional names that are impractical to store in the main [SubjectRDN](#Certificate_f_SubjectRDN) field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect. The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator. **SubjectKeyID** *byte[]* Default: "" Contains a unique identifier of the certificate's cryptographic key. Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building. The [SubjectKeyID](#Certificate_f_SubjectKeyID) and [CAKeyID](#Certificate_f_CAKeyID) fields of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. **SubjectRDN** *string* Default: "" A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. **Valid** *bool (read-only)* Default: False Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request. **ValidFrom** *string* Default: "" The time point at which the certificate becomes valid, in UTC. **ValidTo** *string* Default: "" The time point at which the certificate expires, in UTC. ## Constructors ```text public Certificate(byte[] bytes, int startIndex, int count, string password); ``` Loads the X.509 certificate from a memory buffer. * Bytes * is a buffer containing the raw certificate data. * StartIndex * and * Count * specify the starting position and number of bytes to be read from the buffer, respectively. * Password * is a password encrypting the certificate. ```text public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password); ``` Loads the X.509 certificate from a memory buffer. * CertBytes * is a buffer containing the raw certificate data. * CertStartIndex * and * CertCount * specify the starting position and number of bytes to be read from the buffer, respectively. * KeyBytes * is a buffer containing the private key data. * KeyStartIndex * and * KeyCount * specify the starting position and number of bytes to be read from the buffer, respectively. * Password * is a password encrypting the certificate. ```text public Certificate(byte[] bytes, int startIndex, int count); ``` Loads the X.509 certificate from a memory buffer. * Bytes * is a buffer containing the raw certificate data. * StartIndex * and * Count * specify the starting position and number of bytes to be read from the buffer, respectively. ```text public Certificate(string path, string password); ``` Loads the X.509 certificate from a file. * Path * specifies the full path to the file containing the certificate data. * Password * is a password encrypting the certificate. ```text public Certificate(string certPath, string keyPath, string password); ``` Loads the X.509 certificate from a file. * CertPath * specifies the full path to the file containing the certificate data. * KeyPath * specifies the full path to the file containing the private key. * Password * is a password encrypting the certificate. ```text public Certificate(string path); ``` Loads the X.509 certificate from a file. * Path * specifies the full path to the file containing the certificate data. ```text public Certificate(System.IO.Stream stream); ``` Loads the X.509 certificate from a stream. * Stream * is a stream containing the certificate data. ```text public Certificate(System.IO.Stream stream, string password); ``` Loads the X.509 certificate from a stream. * Stream * is a stream containing the certificate data. * Password * is a password encrypting the certificate. ```text public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password); ``` Loads the X.509 certificate from a stream. * CertStream * is a stream containing the certificate data. * KeyStream * is a stream containing the private key. * Password * is a password encrypting the certificate. ```text public Certificate(); ``` Creates a new object with default field values. # CRL Type Represents a Certificate Revocation List. ## Remarks CRLs store information about revoked certificates, i.e., certificates that have been identified as invalid by their issuing certificate authority (CA) for any number of reasons. Each CRL object lists certificates from a single CA and identifies them by their serial numbers. A CA may or may not publish a CRL, may publish several CRLs, or may publish the same CRL in multiple locations. Unlike OCSP responses, CRLs only list certificates that have been revoked. They do not list certificates that are still valid. The following fields are available: - [Bytes](#CRL_f_Bytes) - [CAKeyID](#CRL_f_CAKeyID) - [EntryCount](#CRL_f_EntryCount) - [Issuer](#CRL_f_Issuer) - [IssuerRDN](#CRL_f_IssuerRDN) - [Location](#CRL_f_Location) - [NextUpdate](#CRL_f_NextUpdate) - [SigAlgorithm](#CRL_f_SigAlgorithm) - [Source](#CRL_f_Source) - [TBS](#CRL_f_TBS) - [ThisUpdate](#CRL_f_ThisUpdate) ## Fields **Bytes** *byte[] (read-only)* Default: "" Returns the raw CRL data in DER format. **CAKeyID** *byte[]* Default: "" A unique identifier (fingerprint) of the CA certificate's private key, if present in the CRL. **EntryCount** *int (read-only)* Default: 0 Returns the number of certificate status entries in the CRL. **Issuer** *string (read-only)* Default: "" The common name of the CRL issuer (CA), typically a company name. **IssuerRDN** *string (read-only)* Default: "" A collection of information, in the form of [OID, Value] pairs, uniquely identifying the CRL issuer. **Location** *string (read-only)* Default: "" The URL that the CRL was downloaded from. **NextUpdate** *string* Default: "" The planned time and date of the next version of this CRL to be published. **SigAlgorithm** *string* Default: "0" The public key algorithm that was used by the CA to sign this CRL. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. **TBS** *byte[] (read-only)* Default: "" The to-be-signed part of the CRL (the CRL without the signature part). **ThisUpdate** *string* Default: "" The date and time at which this version of the CRL was published. ## Constructors ```text public CRL(byte[] bytes, int startIndex, int count); ``` Creates a CRL object from a memory buffer. * Bytes * is a buffer containing raw (DER) CRL data, * StartIndex * and * Count * specify the starting position and the length of the CRL data in the buffer, respectively. ```text public CRL(string location); ``` Creates a CRL object by downloading it from a remote location. ```text public CRL(System.IO.Stream stream); ``` Creates a CRL object from data contained in a stream. ```text public CRL(); ``` Creates an empty CRL object. # ExternalCrypto Type Specifies the parameters of external cryptographic calls. ## Remarks External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally. The following fields are available: - [AsyncDocumentID](#ExternalCrypto_f_AsyncDocumentID) - [CustomParams](#ExternalCrypto_f_CustomParams) - [Data](#ExternalCrypto_f_Data) - [ExternalHashCalculation](#ExternalCrypto_f_ExternalHashCalculation) - [HashAlgorithm](#ExternalCrypto_f_HashAlgorithm) - [KeyID](#ExternalCrypto_f_KeyID) - [KeySecret](#ExternalCrypto_f_KeySecret) - [Method](#ExternalCrypto_f_Method) - [Mode](#ExternalCrypto_f_Mode) - [PublicKeyAlgorithm](#ExternalCrypto_f_PublicKeyAlgorithm) ## Fields **AsyncDocumentID** *string* Default: "" Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. **CustomParams** *string* Default: "" Custom parameters to be passed to the signing service (uninterpreted). **Data** *string* Default: "" Additional data to be included in the async state and mirrored back by the requestor. **ExternalHashCalculation** *bool* Default: False Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component. If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. **HashAlgorithm** *string* Default: "SHA256" Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | **KeyID** *string* Default: "" The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [KeySecret](#ExternalCrypto_f_KeySecret) to pass the key itself. The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted. Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users. Example: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` **KeySecret** *string* Default: "" The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [KeyID](#ExternalCrypto_f_KeyID) topic. **Method** *AsyncSignMethods* Default: 0 Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | **Mode** *ExternalCryptoModes* Default: 0 Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | **PublicKeyAlgorithm** *string* Default: "" Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Constructors ```text public ExternalCrypto(); ``` Creates a new ExternalCrypto object with default field values. # HTTPRequestParameters Type Represents the headers of the HTTP request to make. ## Remarks If a header is not assigned but required for a successful request (such as Connection or Host), it will be generated automatically by the component. The following fields are available: - [Accept](#HTTPRequestParameters_f_Accept) - [AcceptCharset](#HTTPRequestParameters_f_AcceptCharset) - [AcceptLanguage](#HTTPRequestParameters_f_AcceptLanguage) - [AcceptRangeEnd](#HTTPRequestParameters_f_AcceptRangeEnd) - [AcceptRangeStart](#HTTPRequestParameters_f_AcceptRangeStart) - [Authorization](#HTTPRequestParameters_f_Authorization) - [Connection](#HTTPRequestParameters_f_Connection) - [ContentLength](#HTTPRequestParameters_f_ContentLength) - [ContentRangeEnd](#HTTPRequestParameters_f_ContentRangeEnd) - [ContentRangeFullSize](#HTTPRequestParameters_f_ContentRangeFullSize) - [ContentRangeStart](#HTTPRequestParameters_f_ContentRangeStart) - [ContentType](#HTTPRequestParameters_f_ContentType) - [Cookie](#HTTPRequestParameters_f_Cookie) - [CustomHeaders](#HTTPRequestParameters_f_CustomHeaders) - [Date](#HTTPRequestParameters_f_Date) - [From](#HTTPRequestParameters_f_From) - [Host](#HTTPRequestParameters_f_Host) - [HTTPVersion](#HTTPRequestParameters_f_HTTPVersion) - [IfMatch](#HTTPRequestParameters_f_IfMatch) - [IfModifiedSince](#HTTPRequestParameters_f_IfModifiedSince) - [IfNoneMatch](#HTTPRequestParameters_f_IfNoneMatch) - [IfUnmodifiedSince](#HTTPRequestParameters_f_IfUnmodifiedSince) - [Password](#HTTPRequestParameters_f_Password) - [Referer](#HTTPRequestParameters_f_Referer) - [UserAgent](#HTTPRequestParameters_f_UserAgent) - [Username](#HTTPRequestParameters_f_Username) ## Fields **Accept** *string* Default: "" Specifies the Accept header field of the HTTP request. The Accept field defines which media types are accepted in the response. **AcceptCharset** *string* Default: "" Specifies the Accept-Charset header field of the HTTP request. The Accept-Charset field specifies the character set which the client can understand. **AcceptLanguage** *string* Default: "" Specifies the Accept-Language header field of the HTTP request. The Accept-Language field specifies the language (and locale) which the client can understand. **AcceptRangeEnd** *long* Default: 0 This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request. **AcceptRangeStart** *long* Default: 0 This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request. **Authorization** *string* Default: "" Specifies the Authorization header of the HTTP request. This header contains the credentials to authenticate a user with a server. **Connection** *string* Default: "" Specifies the value to pass to the Connection header field of HTTP request. **ContentLength** *long* Default: 0 Specifies the size of the entity-body of the HTTP request. Leave this field set to 0 to make the component calculate it automatically. **ContentRangeEnd** *long* Default: 0 Specifies the upper bound used in the Content-Range header of the HTTP request. **ContentRangeFullSize** *long* Default: 0 Specifies the total length of the full entity-body of the HTTP request. **ContentRangeStart** *long* Default: 0 Specifies the lower bound used in the Content-Range header of the HTTP request. **ContentType** *string* Default: "" The Content-Type header field of the HTTP request. **Cookie** *string* Default: "" This header is expected to be assigned with cookies previously received from the server and stored by the client. **CustomHeaders** *string* Default: "" Assign any custom HTTP headers to be passed to the server to this property. **Date** *string* Default: "" The date and time of the request. **From** *string* Default: "" Contains the From header field of the HTTP request. It specifies the e-mail address for the human user who controls the requesting user agent. **Host** *string* Default: "" This field contains the Host header field of the HTTP request. It specifies the host and port number of the resource being requested. **HTTPVersion** *HTTPVersions* Default: 1 Specifies the version of HTTP protocol to use: 1.0 or 1.1. | | | | --- | --- | | chvHTTP10 | HTTP/1.0 (0) | | chvHTTP11 | HTTP/1.1 (1) | **IfMatch** *string* Default: "" Contains the If-Match request header field. This field makes the requested method conditional: when If-Match field is set, only the entities matching the included entity tags will be returned by the server. **IfModifiedSince** *string* Default: "" Contains the If-Modified-Since request header field. This field makes the requested method conditional: when If-Modified-Since field is set, only the modified entities will be returned by the server. **IfNoneMatch** *string* Default: "" Contains the If-None-Match request header field. This field makes the requested method conditional: when If-None-Match field is set, only the entities which doesn't match the included entity tags will be returned by the server. **IfUnmodifiedSince** *string* Default: "" Contains the If-Unmodified-Since request header field. This field makes the requested method conditional: when If-Unmodified-Since field is set, only the unmodified entities will be returned by the server. **Password** *string* Default: "" Assign this property with the user's password. **Referer** *string* Default: "" The Referer field of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer). **UserAgent** *string* Default: "" The User-Agent field of the HTTP request provides information about the software that initiates the request. **Username** *string* Default: "" Assign this property with the user's login name. ## Constructors ```text public HTTPRequestParameters(); ``` Creates a new HTTPRequestParameters object. # HTTPResponseParameters Type This object is a container for HTTP server response details. ## Remarks An HTTP response is sent by the server when it has processed the client's request. The response consists of the status code (perhaps, the most annoying and widely known one is 404), the reason phrase, the response headers, and the body (the actual data) of the response. The following fields are available: - [ContentLength](#HTTPResponseParameters_f_ContentLength) - [ContentType](#HTTPResponseParameters_f_ContentType) - [Date](#HTTPResponseParameters_f_Date) - [ReasonPhrase](#HTTPResponseParameters_f_ReasonPhrase) - [StatusCode](#HTTPResponseParameters_f_StatusCode) ## Fields **ContentLength** *long* Default: 0 Indicates the length of the response content in bytes. **ContentType** *string* Default: "" Returns the content type of the server response, as included in the response headers. **Date** *string* Default: "" The date and time at which the response was generated, in server time, in UTC. **ReasonPhrase** *string* Default: "" Contains the reason phrase (a human-readable comment) of the request processing status, which corresponds to, and complements, the status code. **StatusCode** *int* Default: 0 The server-generated status code of the request processing status. The code is a 3-digit integer where the first digit defines the class of the response: | | | | --- | --- | | 1 | Informational | | 2 | Success | | 3 | Redirection | | 4 | Client Error | | 5 | Server Error | Common examples are 200 (page served successfully), 404 (page not found), 302 (redirect), and 500 (internal server error). ## Constructors ```text public HTTPResponseParameters(); ``` Creates a new HTTPResponseParameters object. # OCSPResponse Type Represents a single OCSP response originating from an OCSP responder. ## Remarks OCSP is a protocol that allows verification of certificate status in real-time, and is an alternative to Certificate Revocation Lists (CRLs). An OCSP response is a snapshot of the certificate status at a given time. The following fields are available: - [Bytes](#OCSPResponse_f_Bytes) - [EntryCount](#OCSPResponse_f_EntryCount) - [Issuer](#OCSPResponse_f_Issuer) - [IssuerRDN](#OCSPResponse_f_IssuerRDN) - [Location](#OCSPResponse_f_Location) - [ProducedAt](#OCSPResponse_f_ProducedAt) - [SigAlgorithm](#OCSPResponse_f_SigAlgorithm) - [Source](#OCSPResponse_f_Source) ## Fields **Bytes** *byte[] (read-only)* Default: "" A buffer containing the raw OCSP response data. **EntryCount** *int (read-only)* Default: 0 The number of SingleResponse elements contained in this OCSP response. Each SingleResponse element corresponds to a certificate status. **Issuer** *string (read-only)* Default: "" Indicates the issuer of this response (a CA or its authorized representative). **IssuerRDN** *string (read-only)* Default: "" Indicates the RDN of the issuer of this response (a CA or its authorized representative). **Location** *string (read-only)* Default: "" The location of the OCSP responder. **ProducedAt** *string* Default: "" Specifies the time when the response was produced, in UTC. **SigAlgorithm** *string* Default: "0" The public key algorithm that was used by the CA to sign this OCSP response. **Source** *PKISources (read-only)* Default: 0 Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response. ## Constructors ```text public OCSPResponse(byte[] bytes, int startIndex, int count); ``` Initializes the response from a memory buffer. * Bytes * is a buffer containing raw OCSP response data, * StartIndex * and * Count * specify the starting position and the number of bytes to be read from this buffer. ```text public OCSPResponse(string location); ``` Downloads an OCSP response from a remote location. ```text public OCSPResponse(System.IO.Stream stream); ``` Initializes the response with the data from a stream. ```text public OCSPResponse(); ``` Creates an empty OCSP response object. # ProxySettings Type A container for proxy server settings. ## Remarks This type exposes a collection of properties for tuning up the proxy server configuration. The following fields are available: - [Address](#ProxySettings_f_Address) - [Authentication](#ProxySettings_f_Authentication) - [Password](#ProxySettings_f_Password) - [Port](#ProxySettings_f_Port) - [ProxyType](#ProxySettings_f_ProxyType) - [RequestHeaders](#ProxySettings_f_RequestHeaders) - [ResponseBody](#ProxySettings_f_ResponseBody) - [ResponseHeaders](#ProxySettings_f_ResponseHeaders) - [UseIPv6](#ProxySettings_f_UseIPv6) - [Username](#ProxySettings_f_Username) ## Fields **Address** *string* Default: "" The IP address of the proxy server. **Authentication** *ProxyAuthTypes* Default: 0 The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | **Password** *string* Default: "" The password to authenticate to the proxy server. **Port** *int* Default: 0 The port on the proxy server to connect to. **ProxyType** *ProxyTypes* Default: 0 The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | **RequestHeaders** *string* Default: "" Contains HTTP request headers for WebTunnel and HTTP proxy. **ResponseBody** *string* Default: "" Contains the HTTP or HTTPS (WebTunnel) proxy response body. **ResponseHeaders** *string* Default: "" Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. **UseIPv6** *bool* Default: False Specifies whether IPv6 should be used when connecting through the proxy. **Username** *string* Default: "" Specifies the username credential for proxy authentication. ## Constructors ```text public ProxySettings(); ``` Creates a new ProxySettings object. # SocketSettings Type A container for the socket settings. ## Remarks This type is a container for socket-layer parameters. The following fields are available: - [DNSMode](#SocketSettings_f_DNSMode) - [DNSPort](#SocketSettings_f_DNSPort) - [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout) - [DNSServers](#SocketSettings_f_DNSServers) - [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout) - [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit) - [LocalAddress](#SocketSettings_f_LocalAddress) - [LocalPort](#SocketSettings_f_LocalPort) - [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit) - [Timeout](#SocketSettings_f_Timeout) - [UseIPv6](#SocketSettings_f_UseIPv6) ## Fields **DNSMode** *DNSResolveModes* Default: 0 Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system. | | | | --- | --- | | dmAuto | 0 | | dmPlatform | 1 | | dmOwn | 2 | | dmOwnSecure | 3 | **DNSPort** *int* Default: 0 Specifies the port number to be used for sending queries to the DNS server. **DNSQueryTimeout** *int* Default: 0 The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. **DNSServers** *string* Default: "" The addresses of DNS servers to use for address resolution, separated by commas or semicolons. **DNSTotalTimeout** *int* Default: 0 The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. **IncomingSpeedLimit** *int* Default: 0 The maximum number of bytes to read from the socket, per second. **LocalAddress** *string* Default: "" The local network interface to bind the socket to. **LocalPort** *int* Default: 0 The local port number to bind the socket to. **OutgoingSpeedLimit** *int* Default: 0 The maximum number of bytes to write to the socket, per second. **Timeout** *int* Default: 60000 The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). **UseIPv6** *bool* Default: False Enables or disables IP protocol version 6. ## Constructors ```text public SocketSettings(); ``` Creates a new SocketSettings object. # StringNameValuePair Type A simple name-value pair object. ## Remarks The component represents a name-value string pair used in a variety of network components. The following fields are available: - [Category](#StringNameValuePair_f_Category) - [Format](#StringNameValuePair_f_Format) - [Name](#StringNameValuePair_f_Name) - [Value](#StringNameValuePair_f_Value) ## Fields **Category** *string* Default: "" Specifies the string category of the contained value. This property allows to check or set the category (or type) associated with the contained value. Depending on the format used to load or save the string, the category parameter may or may not be used. For example, for ASN.1 property lists the category contains the ASN.1 tag of the contained data (OCTETSTRING, UTF8STRING, INTEGER, ...). For basic (name, value) pairs, such as HTTP headers, the category parameter is not used. **Format** *int* Default: 0 Specifies the format (encoding) of the value contained in the [Value](#StringNameValuePair_f_Value) property. Use this property to check or set the format of the contained value. Remember to provide the actual value in the appropriate format that matches this setting: ```text utils.NameValuePairs[0].Name = "key"; utils.NameValuePairs[0].Format = svfBinary; utils.NameValuePairs[0].Name = "0a1b2c3d4e5f6071"; ``` The following formats are currently supported: | | | | | --- | --- | --- | | svfText | 0 | The property contains text | | svfBinary | 1 | The property contains binary data. The Value property contains a hex encoding of it. | **Name** *string* Default: "" The name element in a (name, value) pair. **Value** *string* Default: "" The value element in a (name, value) pair. ## Constructors ```text public StringNameValuePair(string name, string value); ``` Creates a name-value pair from a name and a value. ```text public StringNameValuePair(); ``` Creates an empty name-value object. # TLSConnectionInfo Type Contains information about a network connection. ## Remarks Use this property to check various details of the network connection. These include the total amounts of data transferred, the availability of TLS, and its parameters. The following fields are available: - [AEADCipher](#TLSConnectionInfo_f_AEADCipher) - [ChainValidationDetails](#TLSConnectionInfo_f_ChainValidationDetails) - [ChainValidationResult](#TLSConnectionInfo_f_ChainValidationResult) - [Ciphersuite](#TLSConnectionInfo_f_Ciphersuite) - [ClientAuthenticated](#TLSConnectionInfo_f_ClientAuthenticated) - [ClientAuthRequested](#TLSConnectionInfo_f_ClientAuthRequested) - [ConnectionEstablished](#TLSConnectionInfo_f_ConnectionEstablished) - [ConnectionID](#TLSConnectionInfo_f_ConnectionID) - [DigestAlgorithm](#TLSConnectionInfo_f_DigestAlgorithm) - [EncryptionAlgorithm](#TLSConnectionInfo_f_EncryptionAlgorithm) - [Exportable](#TLSConnectionInfo_f_Exportable) - [Group](#TLSConnectionInfo_f_Group) - [ID](#TLSConnectionInfo_f_ID) - [KeyExchangeAlgorithm](#TLSConnectionInfo_f_KeyExchangeAlgorithm) - [KeyExchangeKeyBits](#TLSConnectionInfo_f_KeyExchangeKeyBits) - [PFSCipher](#TLSConnectionInfo_f_PFSCipher) - [PreSharedIdentity](#TLSConnectionInfo_f_PreSharedIdentity) - [PreSharedIdentityHint](#TLSConnectionInfo_f_PreSharedIdentityHint) - [PublicKeyBits](#TLSConnectionInfo_f_PublicKeyBits) - [RemoteAddress](#TLSConnectionInfo_f_RemoteAddress) - [RemotePort](#TLSConnectionInfo_f_RemotePort) - [ResumedSession](#TLSConnectionInfo_f_ResumedSession) - [SecureConnection](#TLSConnectionInfo_f_SecureConnection) - [ServerAuthenticated](#TLSConnectionInfo_f_ServerAuthenticated) - [SignatureAlgorithm](#TLSConnectionInfo_f_SignatureAlgorithm) - [SymmetricBlockSize](#TLSConnectionInfo_f_SymmetricBlockSize) - [SymmetricKeyBits](#TLSConnectionInfo_f_SymmetricKeyBits) - [TotalBytesReceived](#TLSConnectionInfo_f_TotalBytesReceived) - [TotalBytesSent](#TLSConnectionInfo_f_TotalBytesSent) - [ValidationLog](#TLSConnectionInfo_f_ValidationLog) - [Version](#TLSConnectionInfo_f_Version) ## Fields **AEADCipher** *bool (read-only)* Default: False Indicates whether the encryption algorithm used is an AEAD cipher. **ChainValidationDetails** *int (read-only)* Default: 0 The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result. Returns a bit mask of the following options: | | | | | --- | --- | --- | | cvrBadData | 0x0001 | One or more certificates in the validation path are malformed | | cvrRevoked | 0x0002 | One or more certificates are revoked | | cvrNotYetValid | 0x0004 | One or more certificates are not yet valid | | cvrExpired | 0x0008 | One or more certificates are expired | | cvrInvalidSignature | 0x0010 | A certificate contains a non-valid digital signature | | cvrUnknownCA | 0x0020 | A CA certificate for one or more certificates has not been found (chain incomplete) | | cvrCAUnauthorized | 0x0040 | One of the CA certificates are not authorized to act as CA | | cvrCRLNotVerified | 0x0080 | One or more CRLs could not be verified | | cvrOCSPNotVerified | 0x0100 | One or more OCSP responses could not be verified | | cvrIdentityMismatch | 0x0200 | The identity protected by the certificate (a TLS endpoint or an e-mail addressee) does not match what is recorded in the certificate | | cvrNoKeyUsage | 0x0400 | A mandatory key usage is not enabled in one of the chain certificates | | cvrBlocked | 0x0800 | One or more certificates are blocked | | cvrFailure | 0x1000 | General validation failure | | cvrChainLoop | 0x2000 | Chain loop: one of the CA certificates recursively signs itself | | cvrWeakAlgorithm | 0x4000 | A weak algorithm is used in one of certificates or revocation elements | | cvrUserEnforced | 0x8000 | The chain was considered invalid following intervention from a user code | **ChainValidationResult** *ChainValidities (read-only)* Default: 0 The outcome of a certificate chain validation routine. Available options: | | | | | --- | --- | --- | | cvtValid | 0 | The chain is valid | | cvtValidButUntrusted | 1 | The chain is valid, but the root certificate is not trusted | | cvtInvalid | 2 | The chain is not valid (some of certificates are revoked, expired, or contain an invalid signature) | | cvtCantBeEstablished | 3 | The validity of the chain cannot be established because of missing or unavailable validation information (certificates, CRLs, or OCSP responses) | Use the ValidationLog property to access the detailed validation log. **Ciphersuite** *string (read-only)* Default: "" The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. **ClientAuthenticated** *bool (read-only)* Default: False Specifies whether client authentication was performed during this connection. **ClientAuthRequested** *bool (read-only)* Default: False Specifies whether client authentication was requested during this connection. **ConnectionEstablished** *bool (read-only)* Default: False Indicates whether the connection has been established fully. **ConnectionID** *byte[] (read-only)* Default: "" The unique identifier assigned to this connection. **DigestAlgorithm** *string (read-only)* Default: "" The digest algorithm used in a TLS-enabled connection. **EncryptionAlgorithm** *string (read-only)* Default: "" The symmetric encryption algorithm used in a TLS-enabled connection. **Exportable** *bool (read-only)* Default: False Indicates whether a TLS connection uses a reduced-strength exportable cipher. **Group** *string (read-only)* Default: "" The elliptic curve used in this connection. This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions. **ID** *long (read-only)* Default: -1 The client connection's unique identifier. This value is used throughout to refer to a particular client connection. **KeyExchangeAlgorithm** *string (read-only)* Default: "" The key exchange algorithm used in a TLS-enabled connection. **KeyExchangeKeyBits** *int (read-only)* Default: 0 The length of the key exchange key of a TLS-enabled connection. **PFSCipher** *bool (read-only)* Default: False Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). **PreSharedIdentity** *string* Default: "" Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. **PreSharedIdentityHint** *string (read-only)* Default: "" A hint professed by the server to help the client select the PSK identity to use. **PublicKeyBits** *int (read-only)* Default: 0 The length of the public key. **RemoteAddress** *string (read-only)* Default: "" The client's IP address. **RemotePort** *int (read-only)* Default: 0 The remote port of the client connection. **ResumedSession** *bool (read-only)* Default: False Indicates whether a TLS-enabled connection was spawned from another TLS connection **SecureConnection** *bool (read-only)* Default: False Indicates whether TLS or SSL is enabled for this connection. **ServerAuthenticated** *bool (read-only)* Default: False Indicates whether server authentication was performed during a TLS-enabled connection. **SignatureAlgorithm** *string (read-only)* Default: "" The signature algorithm used in a TLS handshake. **SymmetricBlockSize** *int (read-only)* Default: 0 The block size of the symmetric algorithm used. **SymmetricKeyBits** *int (read-only)* Default: 0 The key length of the symmetric algorithm used. **TotalBytesReceived** *long (read-only)* Default: 0 The total number of bytes received over this connection. **TotalBytesSent** *long (read-only)* Default: 0 The total number of bytes sent over this connection. **ValidationLog** *string (read-only)* Default: "" Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. **Version** *string (read-only)* Default: "" Indicates the version of SSL/TLS protocol negotiated during this connection. ## Constructors ```text public TLSConnectionInfo(); ``` Creates a new TLSConnectionInfo object. # TLSSettings Type A container for TLS connection settings. ## Remarks The TLS (Transport Layer Security) protocol provides security for information exchanged over insecure connections such as TCP/IP. The following fields are available: - [AutoValidateCertificates](#TLSSettings_f_AutoValidateCertificates) - [BaseConfiguration](#TLSSettings_f_BaseConfiguration) - [Ciphersuites](#TLSSettings_f_Ciphersuites) - [ClientAuth](#TLSSettings_f_ClientAuth) - [Extensions](#TLSSettings_f_Extensions) - [ForceResumeIfDestinationChanges](#TLSSettings_f_ForceResumeIfDestinationChanges) - [Groups](#TLSSettings_f_Groups) - [PreSharedIdentity](#TLSSettings_f_PreSharedIdentity) - [PreSharedKey](#TLSSettings_f_PreSharedKey) - [PreSharedKeyCiphersuite](#TLSSettings_f_PreSharedKeyCiphersuite) - [RenegotiationAttackPreventionMode](#TLSSettings_f_RenegotiationAttackPreventionMode) - [RevocationCheck](#TLSSettings_f_RevocationCheck) - [SSLOptions](#TLSSettings_f_SSLOptions) - [TLSMode](#TLSSettings_f_TLSMode) - [UseExtendedMasterSecret](#TLSSettings_f_UseExtendedMasterSecret) - [UseSessionResumption](#TLSSettings_f_UseSessionResumption) - [Versions](#TLSSettings_f_Versions) ## Fields **AutoValidateCertificates** *bool* Default: True Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. **BaseConfiguration** *SecureTransportPredefinedConfigurations* Default: 0 Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | **Ciphersuites** *string* Default: "" A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [BaseConfiguration](#TLSSettings_f_BaseConfiguration). Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below: - NULL_NULL_NULL - RSA_NULL_MD5 - RSA_NULL_SHA - RSA_RC4_MD5 - RSA_RC4_SHA - RSA_RC2_MD5 - RSA_IDEA_MD5 - RSA_IDEA_SHA - RSA_DES_MD5 - RSA_DES_SHA - RSA_3DES_MD5 - RSA_3DES_SHA - RSA_AES128_SHA - RSA_AES256_SHA - DH_DSS_DES_SHA - DH_DSS_3DES_SHA - DH_DSS_AES128_SHA - DH_DSS_AES256_SHA - DH_RSA_DES_SHA - DH_RSA_3DES_SHA - DH_RSA_AES128_SHA - DH_RSA_AES256_SHA - DHE_DSS_DES_SHA - DHE_DSS_3DES_SHA - DHE_DSS_AES128_SHA - DHE_DSS_AES256_SHA - DHE_RSA_DES_SHA - DHE_RSA_3DES_SHA - DHE_RSA_AES128_SHA - DHE_RSA_AES256_SHA - DH_ANON_RC4_MD5 - DH_ANON_DES_SHA - DH_ANON_3DES_SHA - DH_ANON_AES128_SHA - DH_ANON_AES256_SHA - RSA_RC2_MD5_EXPORT - RSA_RC4_MD5_EXPORT - RSA_DES_SHA_EXPORT - DH_DSS_DES_SHA_EXPORT - DH_RSA_DES_SHA_EXPORT - DHE_DSS_DES_SHA_EXPORT - DHE_RSA_DES_SHA_EXPORT - DH_ANON_RC4_MD5_EXPORT - DH_ANON_DES_SHA_EXPORT - RSA_CAMELLIA128_SHA - DH_DSS_CAMELLIA128_SHA - DH_RSA_CAMELLIA128_SHA - DHE_DSS_CAMELLIA128_SHA - DHE_RSA_CAMELLIA128_SHA - DH_ANON_CAMELLIA128_SHA - RSA_CAMELLIA256_SHA - DH_DSS_CAMELLIA256_SHA - DH_RSA_CAMELLIA256_SHA - DHE_DSS_CAMELLIA256_SHA - DHE_RSA_CAMELLIA256_SHA - DH_ANON_CAMELLIA256_SHA - PSK_RC4_SHA - PSK_3DES_SHA - PSK_AES128_SHA - PSK_AES256_SHA - DHE_PSK_RC4_SHA - DHE_PSK_3DES_SHA - DHE_PSK_AES128_SHA - DHE_PSK_AES256_SHA - RSA_PSK_RC4_SHA - RSA_PSK_3DES_SHA - RSA_PSK_AES128_SHA - RSA_PSK_AES256_SHA - RSA_SEED_SHA - DH_DSS_SEED_SHA - DH_RSA_SEED_SHA - DHE_DSS_SEED_SHA - DHE_RSA_SEED_SHA - DH_ANON_SEED_SHA - SRP_SHA_3DES_SHA - SRP_SHA_RSA_3DES_SHA - SRP_SHA_DSS_3DES_SHA - SRP_SHA_AES128_SHA - SRP_SHA_RSA_AES128_SHA - SRP_SHA_DSS_AES128_SHA - SRP_SHA_AES256_SHA - SRP_SHA_RSA_AES256_SHA - SRP_SHA_DSS_AES256_SHA - ECDH_ECDSA_NULL_SHA - ECDH_ECDSA_RC4_SHA - ECDH_ECDSA_3DES_SHA - ECDH_ECDSA_AES128_SHA - ECDH_ECDSA_AES256_SHA - ECDHE_ECDSA_NULL_SHA - ECDHE_ECDSA_RC4_SHA - ECDHE_ECDSA_3DES_SHA - ECDHE_ECDSA_AES128_SHA - ECDHE_ECDSA_AES256_SHA - ECDH_RSA_NULL_SHA - ECDH_RSA_RC4_SHA - ECDH_RSA_3DES_SHA - ECDH_RSA_AES128_SHA - ECDH_RSA_AES256_SHA - ECDHE_RSA_NULL_SHA - ECDHE_RSA_RC4_SHA - ECDHE_RSA_3DES_SHA - ECDHE_RSA_AES128_SHA - ECDHE_RSA_AES256_SHA - ECDH_ANON_NULL_SHA - ECDH_ANON_RC4_SHA - ECDH_ANON_3DES_SHA - ECDH_ANON_AES128_SHA - ECDH_ANON_AES256_SHA - RSA_NULL_SHA256 - RSA_AES128_SHA256 - RSA_AES256_SHA256 - DH_DSS_AES128_SHA256 - DH_RSA_AES128_SHA256 - DHE_DSS_AES128_SHA256 - DHE_RSA_AES128_SHA256 - DH_DSS_AES256_SHA256 - DH_RSA_AES256_SHA256 - DHE_DSS_AES256_SHA256 - DHE_RSA_AES256_SHA256 - DH_ANON_AES128_SHA256 - DH_ANON_AES256_SHA256 - RSA_AES128_GCM_SHA256 - RSA_AES256_GCM_SHA384 - DHE_RSA_AES128_GCM_SHA256 - DHE_RSA_AES256_GCM_SHA384 - DH_RSA_AES128_GCM_SHA256 - DH_RSA_AES256_GCM_SHA384 - DHE_DSS_AES128_GCM_SHA256 - DHE_DSS_AES256_GCM_SHA384 - DH_DSS_AES128_GCM_SHA256 - DH_DSS_AES256_GCM_SHA384 - DH_ANON_AES128_GCM_SHA256 - DH_ANON_AES256_GCM_SHA384 - ECDHE_ECDSA_AES128_SHA256 - ECDHE_ECDSA_AES256_SHA384 - ECDH_ECDSA_AES128_SHA256 - ECDH_ECDSA_AES256_SHA384 - ECDHE_RSA_AES128_SHA256 - ECDHE_RSA_AES256_SHA384 - ECDH_RSA_AES128_SHA256 - ECDH_RSA_AES256_SHA384 - ECDHE_ECDSA_AES128_GCM_SHA256 - ECDHE_ECDSA_AES256_GCM_SHA384 - ECDH_ECDSA_AES128_GCM_SHA256 - ECDH_ECDSA_AES256_GCM_SHA384 - ECDHE_RSA_AES128_GCM_SHA256 - ECDHE_RSA_AES256_GCM_SHA384 - ECDH_RSA_AES128_GCM_SHA256 - ECDH_RSA_AES256_GCM_SHA384 - PSK_AES128_GCM_SHA256 - PSK_AES256_GCM_SHA384 - DHE_PSK_AES128_GCM_SHA256 - DHE_PSK_AES256_GCM_SHA384 - RSA_PSK_AES128_GCM_SHA256 - RSA_PSK_AES256_GCM_SHA384 - PSK_AES128_SHA256 - PSK_AES256_SHA384 - PSK_NULL_SHA256 - PSK_NULL_SHA384 - DHE_PSK_AES128_SHA256 - DHE_PSK_AES256_SHA384 - DHE_PSK_NULL_SHA256 - DHE_PSK_NULL_SHA384 - RSA_PSK_AES128_SHA256 - RSA_PSK_AES256_SHA384 - RSA_PSK_NULL_SHA256 - RSA_PSK_NULL_SHA384 - RSA_CAMELLIA128_SHA256 - DH_DSS_CAMELLIA128_SHA256 - DH_RSA_CAMELLIA128_SHA256 - DHE_DSS_CAMELLIA128_SHA256 - DHE_RSA_CAMELLIA128_SHA256 - DH_ANON_CAMELLIA128_SHA256 - RSA_CAMELLIA256_SHA256 - DH_DSS_CAMELLIA256_SHA256 - DH_RSA_CAMELLIA256_SHA256 - DHE_DSS_CAMELLIA256_SHA256 - DHE_RSA_CAMELLIA256_SHA256 - DH_ANON_CAMELLIA256_SHA256 - ECDHE_ECDSA_CAMELLIA128_SHA256 - ECDHE_ECDSA_CAMELLIA256_SHA384 - ECDH_ECDSA_CAMELLIA128_SHA256 - ECDH_ECDSA_CAMELLIA256_SHA384 - ECDHE_RSA_CAMELLIA128_SHA256 - ECDHE_RSA_CAMELLIA256_SHA384 - ECDH_RSA_CAMELLIA128_SHA256 - ECDH_RSA_CAMELLIA256_SHA384 - RSA_CAMELLIA128_GCM_SHA256 - RSA_CAMELLIA256_GCM_SHA384 - DHE_RSA_CAMELLIA128_GCM_SHA256 - DHE_RSA_CAMELLIA256_GCM_SHA384 - DH_RSA_CAMELLIA128_GCM_SHA256 - DH_RSA_CAMELLIA256_GCM_SHA384 - DHE_DSS_CAMELLIA128_GCM_SHA256 - DHE_DSS_CAMELLIA256_GCM_SHA384 - DH_DSS_CAMELLIA128_GCM_SHA256 - DH_DSS_CAMELLIA256_GCM_SHA384 - DH_anon_CAMELLIA128_GCM_SHA256 - DH_anon_CAMELLIA256_GCM_SHA384 - ECDHE_ECDSA_CAMELLIA128_GCM_SHA256 - ECDHE_ECDSA_CAMELLIA256_GCM_SHA384 - ECDH_ECDSA_CAMELLIA128_GCM_SHA256 - ECDH_ECDSA_CAMELLIA256_GCM_SHA384 - ECDHE_RSA_CAMELLIA128_GCM_SHA256 - ECDHE_RSA_CAMELLIA256_GCM_SHA384 - ECDH_RSA_CAMELLIA128_GCM_SHA256 - ECDH_RSA_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_GCM_SHA256 - PSK_CAMELLIA256_GCM_SHA384 - DHE_PSK_CAMELLIA128_GCM_SHA256 - DHE_PSK_CAMELLIA256_GCM_SHA384 - RSA_PSK_CAMELLIA128_GCM_SHA256 - RSA_PSK_CAMELLIA256_GCM_SHA384 - PSK_CAMELLIA128_SHA256 - PSK_CAMELLIA256_SHA384 - DHE_PSK_CAMELLIA128_SHA256 - DHE_PSK_CAMELLIA256_SHA384 - RSA_PSK_CAMELLIA128_SHA256 - RSA_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_CAMELLIA128_SHA256 - ECDHE_PSK_CAMELLIA256_SHA384 - ECDHE_PSK_RC4_SHA - ECDHE_PSK_3DES_SHA - ECDHE_PSK_AES128_SHA - ECDHE_PSK_AES256_SHA - ECDHE_PSK_AES128_SHA256 - ECDHE_PSK_AES256_SHA384 - ECDHE_PSK_NULL_SHA - ECDHE_PSK_NULL_SHA256 - ECDHE_PSK_NULL_SHA384 - ECDHE_RSA_CHACHA20_POLY1305_SHA256 - ECDHE_ECDSA_CHACHA20_POLY1305_SHA256 - DHE_RSA_CHACHA20_POLY1305_SHA256 - PSK_CHACHA20_POLY1305_SHA256 - ECDHE_PSK_CHACHA20_POLY1305_SHA256 - DHE_PSK_CHACHA20_POLY1305_SHA256 - RSA_PSK_CHACHA20_POLY1305_SHA256 - AES128_GCM_SHA256 - AES256_GCM_SHA384 - CHACHA20_POLY1305_SHA256 - AES128_CCM_SHA256 - AES128_CCM8_SHA256 **ClientAuth** *ClientAuthTypes* Default: 0 Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | **Extensions** *string* Default: "" Provides access to TLS extensions. **ForceResumeIfDestinationChanges** *bool* Default: False Whether to force TLS session resumption when the destination address changes. **Groups** *string* Default: "" Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. **PreSharedIdentity** *string* Default: "" Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. **PreSharedKey** *string* Default: "" Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. **PreSharedKeyCiphersuite** *string* Default: "" Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. **RenegotiationAttackPreventionMode** *RenegotiationAttackPreventionModes* Default: 2 Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | **RevocationCheck** *RevocationCheckKinds* Default: 1 Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. **SSLOptions** *int* Default: 16 Various SSL (TLS) protocol options, set of | | | | | --- | --- | --- | | cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection | | cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions | | cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. | | cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. | | cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known | | cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only | | cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. | | cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled | | cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms | | cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks | | cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually | **TLSMode** *SSLModes* Default: 0 Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | **UseExtendedMasterSecret** *bool* Default: True Enables the Extended Master Secret Extension, as defined in RFC 7627. **UseSessionResumption** *bool* Default: False Enables or disables the TLS session resumption capability. **Versions** *int* Default: 48 The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | ## Constructors ```text public TLSSettings(); ``` Creates a new TLSSettings object. # Config Settings ([RESTClient](#restclient-component) Component) The component accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these *internal properties* is provided through the [Config](#config-method-restclient-component) method. ### RESTClient Config Settings **AuthStickToLastURL**: TBD.TBD **CachedCRLMaxAge**: Specifies the maximum age of a cached CRL.Use this setting to specify the maximum number of seconds that may pass since a CRL was added to the global cache. When the cached CRL is older than this value, it is disregarded and a new CRL should be fetched. The default value is 0, which disables the absolute CRL age check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLMaxAgeRatio**: Specifies the maximum age of a cached CRL as a percentage of its remaining lifetime.Use this setting to specify the percentage of the CRL's remaining lifetime, measured from the time the CRL was added to the global cache to the CRL's NextUpdate. When this portion of the remaining lifetime has passed, the cached CRL is disregarded and a new CRL should be fetched. The default value is 0, which disables the CRL ratio check. Values are interpreted in the 0..100 range. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedCRLOverlapTime**: Specifies the time period before a cached CRL's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached CRL should be disregarded, and a new CRL should be fetched. The default value is 0, which disables the CRL overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedCRLMaxAge](#CachedCRLMaxAge) and [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio). If several cached CRL freshness settings are enabled, the cached CRL is used only if it satisfies all of them. **CachedOCSPResponseMaxAge**: Specifies the maximum age of a cached OCSP response.Use this setting to specify the maximum number of seconds that may pass since an OCSP response was added to the global cache. When the cached OCSP response is older than this value, it is disregarded and a new OCSP response should be fetched. The default value is 0, which disables the absolute OCSP response age check. This setting is also used to limit open-ended OCSP responses that do not have NextUpdate. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseMaxAgeRatio**: Specifies the maximum age of a cached OCSP response as a percentage of its remaining lifetime.Use this setting to specify the percentage of the OCSP response's remaining lifetime, measured from the time the OCSP response was added to the global cache to the response's NextUpdate. When this portion of the remaining lifetime has passed, the cached OCSP response is disregarded and a new OCSP response should be fetched. The default value is 0, which disables the OCSP response ratio check. Values are interpreted in the 0..100 range. Open-ended OCSP responses without NextUpdate ignore this setting; use [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) to limit their age. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. **CachedOCSPResponseOverlapTime**: Specifies the time period before a cached OCSP response's NextUpdate when it is considered stale and must be refreshed.Use this setting to specify the number of seconds before the NextUpdate time at which the cached OCSP response should be disregarded, and a new OCSP response should be fetched. The default value is 0, which disables the OCSP response overlap check. See [RevocationCacheAgePolicy](#RevocationCacheAgePolicy) for configuring this setting together with the related cached revocation freshness settings. This setting is evaluated independently from [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge) and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio). If several cached OCSP response freshness settings are enabled, the cached OCSP response is used only if it satisfies all of them. **CacheStreamOutput**: Tells the component whether to cache stream- and file-bound responses in the component.Set this property to true to enable caching of potentially long responses obtained with Get method. If the response is cached, it will be available via OutputBytes and OutputString properties after the request is completed, but may occupy extra memory resources. **Cookies**: TBD.TBD **DefClientCookieFmt**: TBD.TBD **DeltaCRLPreference**: Specifies whether complete or delta CRLs are preferred.Use this setting to specify which CRL type should be preferred during TLS certificate revocation checks. The default value is **dcrlpPreferDelta** (0). Supported values: - **dcrlpPreferDelta** (0): retrieve and use delta CRLs when available, falling back to complete CRLs when needed. - **dcrlpPreferComplete** (1): try complete CRLs first, and use delta CRLs only if complete CRLs cannot be retrieved. **EvaluateSystemTrust**: Enables or disables usage of the platform's built-in trust validation facilities.Enable this property to delegate the chain validation to the operating system's native trust evaluation mechanism (e.g. SecTrustEvaluate on Apple platforms). This functionality is currently available on macOS and iOS systems only. This property is enabled by default. **ForceNTLMAuth**: Activates and enforces NTLM authentication.Set this property to True to force NTLM (Windows Integrated) authentication. **IgnoreCookieSecureFlag**: TBD.TBD **IgnoreSystemTrust**: Whether trusted Windows Certificate Stores should be treated as trusted.Specifies whether, during chain validation, the component should respect the trust to CA certificates as configured in the operating system. In Windows this effectively defines whether the component should trust the certificates residing in the Trusted Root Certification Authorities store. If [IgnoreSystemTrust](#IgnoreSystemTrust) is True, certificates residing in the trusted root store are treated as if they are known, rather than trusted. Only certificates provided via other means (such as the [TrustedCertificates](#trustedcertificates-property-restclient-component) property) are considered trusted. **IgnoreUnknownTransferEncodings**: All incoming responses with unknown transfer encodings are ignored if this property is true.All incoming responses with unknown transfer encodings are ignored if this property is true. **KeepConnectionOpen**: TBD.TBD **MaxRedirections**: The maximum number of HTTP redirects.Specifies the maximum number of HTTP redirects. Value 0 prevents any redirections, and -1 allows unlimited redirections. **OutputFile**: Specifies the file where the received content should be saved to.This is a backward-compatibility duplicate of the *OutputFile* property. Use *OutputFile* instead. **PersistentAuthHeader**: Whether to resend NTLM negotiation on every request.Specifies whether to resend NTLM negotiation on every request. **RequestCompressionGZip**: Ask server to enforce GZip compression.Ask the server to use GZip compression instead of Deflate. This setting only makes sense when UseCompression is set to true. Most modern servers support both Deflate and GZip, so primary use case for this setting is the need to communicate to an older server. **RequestCompressionLevel**: Ask server to use the specified compression level.Ask server to use the specified compression level. **RevocationCacheAgePolicy**: Specifies a preset policy for cached CRL and OCSP response freshness settings.Use this setting to configure all cached revocation freshness settings at once. The default value is Disabled. Supported values are case-insensitive: | | | | --- | --- | | Disabled | Sets [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) to 0. This value is the default. It only disables the cache-age freshness policy; it does not disable revocation checking or use of the revocation cache. | | Default | Applies the component default freshness settings. For this component, Default is equivalent to Disabled. | | Short | Uses crl:43200;50;300,ocsp:1800;50;300. This means: CRL maximum age 12 hours, CRL age ratio 50%, CRL overlap 5 minutes; OCSP response maximum age 30 minutes, OCSP response age ratio 50%, OCSP response overlap 5 minutes. | | Long | Uses crl:518400;50;3600,ocsp:21600;50;3600. This means: CRL maximum age 6 days, CRL age ratio 50%, CRL overlap 1 hour; OCSP response maximum age 6 hours, OCSP response age ratio 50%, OCSP response overlap 1 hour. | | N | Interprets N as an integer number of seconds. The overlap settings are set to N seconds, CRL maximum age is set to N * 144, OCSP response maximum age is set to N * 6, and both ratio settings are set to 50. | | crl:;;,ocsp:;; | Sets the CRL and OCSP response freshness values explicitly. | Ratios must be in the 0..100 range. Maximum age and overlap values must be non-negative. Short and Long are time-scale profiles: Long allows older cached revocation information by increasing maximum ages, but also uses a larger pre-expiry safety margin by increasing overlap times. For individual [CachedCRLOverlapTime](#CachedCRLOverlapTime), [CachedOCSPResponseOverlapTime](#CachedOCSPResponseOverlapTime), [CachedCRLMaxAge](#CachedCRLMaxAge), [CachedOCSPResponseMaxAge](#CachedOCSPResponseMaxAge), [CachedCRLMaxAgeRatio](#CachedCRLMaxAgeRatio), and [CachedOCSPResponseMaxAgeRatio](#CachedOCSPResponseMaxAgeRatio) settings, a value of 0 disables the corresponding freshness check. The individual settings remain available for advanced configuration and can be used after this setting to override specific values. **SendBufferSize**: Size of send buffer in bytes.The size of blocks used to send data to the server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **SuppressRedirectionContent**: Whether to suppress the redirection content.If this property is set to True, the redirection content will be silently suppressed by the component. Otherwise the message containing a redirection code will be processed as usual, the [Redirection](#redirection-event-restclient-component) event will be fired, and the data will be written to [OutputString](#outputstring-property-restclient-component) or [OutputBytes](#outputbytes-property-restclient-component). **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. **TLSCiphersuites**: Returns the list of ciphersuites activated in the component for the current session.Check this property to enumerate the list of TLS ciphersuites enabled in the component. A good place to do that is OnTLSHandshake event handler. **TLSExtensions**: TBD.TBD **TLSGroups**: Returns the list of TLS key exchange groups enabled in the component.Check this property to enumerate the list of TLS key exchange groups enabled in the component. **TLSPeerExtensions**: TBD.TBD **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the components. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **TLSVersions**: Returns the list of TLS versions enabled in the component.Check this property to obtain the list of TLS versions enabled in the component, as an integer bitmask. **TolerateMinorChainIssues**: Whether to tolerate minor chain issues.This parameter controls whether the chain validator should tolerate minor technical issues when validating the chain. Those are: - CA, revocation source, TLS key usage requirements are not mandated - Violation of OCSP issuer requirements are ignored - The AuthorityKeyID extension in CRL- and certificate-issuing CAs are ignored (helps with incorrectly renewed certificates) - Basic constraints and name constraints of CA certificates are ignored - Some weaker algorithms are tolerated **Use100Continue**: Whether to use 100-continue for POST and PUT commands.Set this property to True to use the 100-continue approach for POST and PUT commands. In this approach, prior to sending the request body, the client sends a request message asking the server whether it is willing to accept the request body. The request body is sent only if the server accepts it. **UseCompression**: Enables compression capability.Use this property to tell the server that it can compress the response data if it wants to. Deflate mechanism is requested by default; use RequestCompressionGZip to change that to GZip. **UseEnvStorages**: Enables or disables use of the environment storages.Enable this property to make the chain validation module automatically look up missing CA and intermediate certificates in the environment storages. **UseKerberosAuth**: TBD.TBD **UseMicrosoftCTL**: Enables or disables the automatic use of the Microsoft online certificate trust list.Enable this property to make the chain validation module automatically look up missing CA certificates in the public Windows Update repository. **UseSystemCertificates**: Enables or disables the use of the system certificates.Use this property to tell the chain validation module to automatically look up missing CA certificates in the system certificates. In many cases it is beneficial to switch this property on, as the operating system certificate configuration provides a representative trust framework. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the component. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the component.Use this property to get cookies from the internal cookie storage of the component and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the components that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other components. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the component. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the component) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the component is set to "*local*", the property returns/restores the rules from/to the internal storage of the component. If *StaticDNS* of the component is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the components. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([RESTClient](#restclient-component) Component) ### HTTPClient Errors | | | | --- | --- | | 1048577 | Invalid parameter ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 19922945 | Unsupported keep-alive policy ([SB_ERROR_HTTP_UNSUPPORTED_KEEPALIVEPOLICY](constants.md#const_SBERRORHTTPUNSUPPORTEDKEEPALIVEPOLICY)) | | 19922946 | Wrong request filter string format ([SB_ERROR_HTTP_WRONG_REQUEST_FILTER_FORMAT](constants.md#const_SBERRORHTTPWRONGREQUESTFILTERFORMAT)) | | 19922947 | Failed to subscribe to server-sent events service ([SB_ERROR_HTTP_FAILED_TO_SUBSCRIBE](constants.md#const_SBERRORHTTPFAILEDTOSUBSCRIBE)) |