# WebSocketServer Class The WebSocketServer class provides the server-side functionality of the WebSocket protocol. ## Syntax ```text class secureblackbox.WebSocketServer ``` ## Remarks Use this component to accept secure WebSocket connections in your application. WebSocket is an Internet technology that lets you build a data exchange channel over an HTTP connection. As such, WebSocket provides a firewall-friendly way to exchange non-HTTP data between remote parties. The task of configuring the WebSocket server component can be split into three subtasks: - configuring HTTP parameters, - configuring TLS parameters (for secure connections), - configuring WebSocket parameters. **Configuring HTTP parameters** The primary HTTP parameters are [host](#host-property) and [port](#port-property), which define the endpoint that your WebSocket server will be using. If you intend to authenticate users connecting to the endpoint using one of the supported HTTP authentication methods, please look into adjusting [auth_types](#auth_types-property) and users properties and [on_auth_attempt](#on_auth_attempt-event) event. **Configuring TLS parameters** TLS support requires that you set up a server-side certificate. This certificate needs to have an associated private key. You can either obtain it from a registered CA, or generate it yourself. Attach the certificate, together with its associated chain, to the tls_server_chain collection. General TLS properties, such as protocol versions and ciphersuite, can be adjusted via the tls_settings object. If you are looking to authenticate your clients using TLS certificates, subscribe to [on_tls_cert_validate](#on_tls_cert_validate-event) event to intercept the client handshakes and check the certificates in the event handler. **Configuring WebSocket parameters** This includes subscribing to [on_web_socket_connect](#on_web_socket_connect-event) and [on_web_socket_disconnect](#on_web_socket_disconnect-event), as well as [on_binary_data](#on_binary_data-event) and [on_text_data](#on_text_data-event) events. The first two events fire to report clients as they connect and disconnect from your server. The [on_web_socket_connect](#on_web_socket_connect-event) client includes the connection parameters, which you can use to verify or authorize clients. The further two events notify you of any data received from the clients. Each client is identified by a unique *Connection ID*. Use the connection ID to: - Access client details: pass it to [pin_client](#pin_client-method), and then access the details via pinned_client and pinned_client_chain properties. - Send data back to a particular client by passing it to [send_data](#send_data-method), [send_text](#send_text-method), and [send_keep_alive](#send_keep_alive-method) methods. - Force client disconnect by passing it to [drop_client](#drop_client-method) method. Once you have set up all the connecting parameters, call [start](#start-method) to activate the server. The server runs in a separate thread, so the call is non-blocking. To shut down the server, call [stop](#stop-method). ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [active](#active-property) | Indicates whether the server is active and is listening to new connections. | | [auth_types](#auth_types-property) | Defines allowed HTTP authentication types. | | [bound_port](#bound_port-property) | Indicates the bound listening port. | | [external_crypto_async_document_id](#external_crypto_async_document_id-property) | Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. | | [external_crypto_custom_params](#external_crypto_custom_params-property) | Custom parameters to be passed to the signing service (uninterpreted). | | [external_crypto_data](#external_crypto_data-property) | Additional data to be included in the async state and mirrored back by the requestor. | | [external_crypto_external_hash_calculation](#external_crypto_external_hash_calculation-property) | Specifies whether the message hash is to be calculated at the external endpoint. | | [external_crypto_hash_algorithm](#external_crypto_hash_algorithm-property) | Specifies the request's signature hash algorithm. | | [external_crypto_key_id](#external_crypto_key_id-property) | The ID of the pre-shared key used for DC request authentication. | | [external_crypto_key_secret](#external_crypto_key_secret-property) | The pre-shared key used for DC request authentication. | | [external_crypto_method](#external_crypto_method-property) | Specifies the asynchronous signing method. | | [external_crypto_mode](#external_crypto_mode-property) | Specifies the external cryptography mode. | | [external_crypto_public_key_algorithm](#external_crypto_public_key_algorithm-property) | Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | [fips_mode](#fips_mode-property) | Reserved. | | [handshake_timeout](#handshake_timeout-property) | Specifies the handshake timeout in milliseconds. | | [host](#host-property) | The host to bind the listening port to. | | [pinned_client_aead_cipher](#pinned_client_aead_cipher-property) | Indicates whether the encryption algorithm used is an AEAD cipher. | | [pinned_client_chain_validation_details](#pinned_client_chain_validation_details-property) | The details of a certificate chain validation outcome. | | [pinned_client_chain_validation_result](#pinned_client_chain_validation_result-property) | The outcome of a certificate chain validation routine. | | [pinned_client_ciphersuite](#pinned_client_ciphersuite-property) | The cipher suite employed by this connection. | | [pinned_client_client_authenticated](#pinned_client_client_authenticated-property) | Specifies whether client authentication was performed during this connection. | | [pinned_client_client_auth_requested](#pinned_client_client_auth_requested-property) | Specifies whether client authentication was requested during this connection. | | [pinned_client_connection_established](#pinned_client_connection_established-property) | Indicates whether the connection has been established fully. | | [pinned_client_connection_id](#pinned_client_connection_id-property) | The unique identifier assigned to this connection. | | [pinned_client_digest_algorithm](#pinned_client_digest_algorithm-property) | The digest algorithm used in a TLS-enabled connection. | | [pinned_client_encryption_algorithm](#pinned_client_encryption_algorithm-property) | The symmetric encryption algorithm used in a TLS-enabled connection. | | [pinned_client_exportable](#pinned_client_exportable-property) | Indicates whether a TLS connection uses a reduced-strength exportable cipher. | | [pinned_client_group](#pinned_client_group-property) | The elliptic curve used in this connection. | | [pinned_client_id](#pinned_client_id-property) | The client connection's unique identifier. | | [pinned_client_key_exchange_algorithm](#pinned_client_key_exchange_algorithm-property) | The key exchange algorithm used in a TLS-enabled connection. | | [pinned_client_key_exchange_key_bits](#pinned_client_key_exchange_key_bits-property) | The length of the key exchange key of a TLS-enabled connection. | | [pinned_client_pfs_cipher](#pinned_client_pfs_cipher-property) | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). | | [pinned_client_pre_shared_identity](#pinned_client_pre_shared_identity-property) | Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [pinned_client_pre_shared_identity_hint](#pinned_client_pre_shared_identity_hint-property) | A hint professed by the server to help the client select the PSK identity to use. | | [pinned_client_public_key_bits](#pinned_client_public_key_bits-property) | The length of the public key. | | [pinned_client_remote_address](#pinned_client_remote_address-property) | The client's IP address. | | [pinned_client_remote_port](#pinned_client_remote_port-property) | The remote port of the client connection. | | [pinned_client_resumed_session](#pinned_client_resumed_session-property) | Indicates whether a TLS-enabled connection was spawned from another TLS connection. | | [pinned_client_secure_connection](#pinned_client_secure_connection-property) | Indicates whether TLS or SSL is enabled for this connection. | | [pinned_client_server_authenticated](#pinned_client_server_authenticated-property) | Indicates whether server authentication was performed during a TLS-enabled connection. | | [pinned_client_signature_algorithm](#pinned_client_signature_algorithm-property) | The signature algorithm used in a TLS handshake. | | [pinned_client_symmetric_block_size](#pinned_client_symmetric_block_size-property) | The block size of the symmetric algorithm used. | | [pinned_client_symmetric_key_bits](#pinned_client_symmetric_key_bits-property) | The key length of the symmetric algorithm used. | | [pinned_client_total_bytes_received](#pinned_client_total_bytes_received-property) | The total number of bytes received over this connection. | | [pinned_client_total_bytes_sent](#pinned_client_total_bytes_sent-property) | The total number of bytes sent over this connection. | | [pinned_client_validation_log](#pinned_client_validation_log-property) | Contains the server certificate's chain validation log. | | [pinned_client_version](#pinned_client_version-property) | Indicates the version of SSL/TLS protocol negotiated during this connection. | | [pinned_client_cert_count](#pinned_client_cert_count-property) | The number of records in the PinnedClientCert arrays. | | [pinned_client_cert_bytes](#pinned_client_cert_bytes-property) | Returns the raw certificate data in DER format. | | [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property) | A unique identifier (fingerprint) of the CA certificate's cryptographic key. | | [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property) | Contains the fingerprint (a hash imprint) of this certificate. | | [pinned_client_cert_handle](#pinned_client_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [pinned_client_cert_issuer](#pinned_client_cert_issuer-property) | The common name of the certificate issuer (CA), typically a company name. | | [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate issuer. | | [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property) | Specifies the public key algorithm of this certificate. | | [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property) | Returns the length of the public key in bits. | | [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property) | Returns a SHA1 fingerprint of the public key contained in the certificate. | | [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property) | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. | | [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property) | Contains the certificate's public key in DER format. | | [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property) | Indicates whether the certificate is self-signed (root) or signed by an external CA. | | [pinned_client_cert_serial_number](#pinned_client_cert_serial_number-property) | Returns the certificate's serial number. | | [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property) | Indicates the algorithm that was used by the CA to sign this certificate. | | [pinned_client_cert_subject](#pinned_client_cert_subject-property) | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. | | [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property) | Contains a unique identifier of the certificate's cryptographic key. | | [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property) | A list of Property=Value pairs that uniquely identify the certificate holder (subject). | | [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property) | The time point at which the certificate becomes valid, in UTC. | | [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property) | The time point at which the certificate expires, in UTC. | | [port](#port-property) | Specifies the port number to listen for connections on. | | [port_range_from](#port_range_from-property) | Specifies the lower limit of the listening port range for incoming connections. | | [port_range_to](#port_range_to-property) | Specifies the upper limit of the listening port range for incoming connections. | | [session_timeout](#session_timeout-property) | Specifies the default session timeout value in milliseconds. | | [socket_incoming_speed_limit](#socket_incoming_speed_limit-property) | The maximum number of bytes to read from the socket, per second. | | [socket_local_address](#socket_local_address-property) | The local network interface to bind the socket to. | | [socket_local_port](#socket_local_port-property) | The local port number to bind the socket to. | | [socket_outgoing_speed_limit](#socket_outgoing_speed_limit-property) | The maximum number of bytes to write to the socket, per second. | | [socket_timeout](#socket_timeout-property) | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. | | [socket_use_ipv6](#socket_use_ipv6-property) | Enables or disables IP protocol version 6. | | [tls_auto_validate_certificates](#tls_auto_validate_certificates-property) | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. | | [tls_base_configuration](#tls_base_configuration-property) | Selects the base configuration for the TLS settings. | | [tls_ciphersuites](#tls_ciphersuites-property) | A list of ciphersuites separated with commas or semicolons. | | [tls_client_auth](#tls_client_auth-property) | Enables or disables certificate-based client authentication. | | [tls_extensions](#tls_extensions-property) | Provides access to TLS extensions. | | [tls_force_resume_if_destination_changes](#tls_force_resume_if_destination_changes-property) | Whether to force TLS session resumption when the destination address changes. | | [tls_groups](#tls_groups-property) | Specifies a list of key exchange groups to attempt during the TLS key exchange. | | [tls_pre_shared_identity](#tls_pre_shared_identity-property) | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. | | [tls_pre_shared_key](#tls_pre_shared_key-property) | Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. | | [tls_pre_shared_key_ciphersuite](#tls_pre_shared_key_ciphersuite-property) | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. | | [tls_renegotiation_attack_prevention_mode](#tls_renegotiation_attack_prevention_mode-property) | Selects the renegotiation attack prevention mechanism. | | [tls_revocation_check](#tls_revocation_check-property) | Specifies the kind(s) of revocation check to perform. | | [tls_ssl_options](#tls_ssl_options-property) | 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. | | [tls_mode](#tls_mode-property) | Specifies the TLS mode to use. | | [tls_use_extended_master_secret](#tls_use_extended_master_secret-property) | Enables the Extended Master Secret Extension, as defined in RFC 7627. | | [tls_use_session_resumption](#tls_use_session_resumption-property) | Enables or disables the TLS session resumption capability. | | [tls_versions](#tls_versions-property) | The SSL/TLS versions to enable by default. | | [tls_server_cert_count](#tls_server_cert_count-property) | The number of records in the TLSServerCert arrays. | | [tls_server_cert_bytes](#tls_server_cert_bytes-property) | Returns the raw certificate data in DER format. | | [tls_server_cert_handle](#tls_server_cert_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [user_count](#user_count-property) | The number of records in the User arrays. | | [user_associated_data](#user_associated_data-property) | Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. | | [user_base_path](#user_base_path-property) | Base path for this user in the server's file system. | | [user_data](#user_data-property) | Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. | | [user_handle](#user_handle-property) | Allows to get or set a 'handle', a unique identifier of the underlying property object. | | [user_hash_algorithm](#user_hash_algorithm-property) | Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. | | [user_incoming_speed_limit](#user_incoming_speed_limit-property) | Specifies the incoming speed limit for this user. | | [user_outgoing_speed_limit](#user_outgoing_speed_limit-property) | Specifies the outgoing speed limit for this user. | | [user_password](#user_password-property) | The user's authentication password. | | [user_shared_secret](#user_shared_secret-property) | Contains the user's secret key, which is essentially a shared secret between the client and server. | | [username](#username-property) | The registered name (login) of the user. | | [website_name](#website_name-property) | Specifies the web site name to use in the certificate. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [cleanup](#cleanup-method) | Cleans up the server environment by purging expired sessions and cleaning caches. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [do_action](#do_action-method) | Performs an additional action. | | [drop_client](#drop_client-method) | Terminates a client connection. | | [list_clients](#list_clients-method) | Enumerates the connected clients. | | [pin_client](#pin_client-method) | Takes a snapshot of the connection's properties. | | [reset](#reset-method) | Resets the class settings. | | [send_data](#send_data-method) | Sends a piece of binary data to the client. | | [send_keep_alive](#send_keep_alive-method) | Sends a keep-alive message. | | [send_text](#send_text-method) | Sends a piece of text data to the client. | | [set_response_bytes](#set_response_bytes-method) | Sets a byte array to be served as a response. | | [set_response_status](#set_response_status-method) | Sets an HTTP status to be sent with the response. | | [set_response_string](#set_response_string-method) | Sets a string to be served as a response. | | [start](#start-method) | Starts the server. | | [stop](#stop-method) | Stops the server. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_accept](#on_accept-event) | Reports an incoming connection. | | [on_auth_attempt](#on_auth_attempt-event) | Fires when a connected client makes an authentication attempt. | | [on_binary_data](#on_binary_data-event) | Passes a received chunk of binary data to the application. | | [on_connect](#on_connect-event) | Reports an accepted connection. | | [on_data](#on_data-event) | Supplies a data chunk received within a POST or PUT upload. | | [on_disconnect](#on_disconnect-event) | Fires to report a disconnected client. | | [on_error](#on_error-event) | Information about errors during data delivery. | | [on_external_sign](#on_external_sign-event) | Handles remote or external signing initiated by the server protocol. | | [on_get_request](#on_get_request-event) | Reports a GET request. | | [on_keep_alive_response](#on_keep_alive_response-event) | Reports a response to a keep-alive message. | | [on_notification](#on_notification-event) | This event notifies the application about an underlying control flow event. | | [on_text_data](#on_text_data-event) | Passes a received chunk of text data to the application. | | [on_tls_cert_validate](#on_tls_cert_validate-event) | Fires when a client certificate needs to be validated. | | [on_tls_established](#on_tls_established-event) | Reports the setup of a TLS session. | | [on_tls_handshake](#on_tls_handshake-event) | Fires when a newly established client connection initiates a TLS handshake. | | [on_tls_psk](#on_tls_psk-event) | Requests a pre-shared key for TLS-PSK. | | [on_tls_shutdown](#on_tls_shutdown-event) | Reports closure of a TLS session. | | [on_web_socket_connect](#on_web_socket_connect-event) | Reports an accepted WebSocket connection. | | [on_web_socket_disconnect](#on_web_socket_disconnect-event) | Fires to report a disconnected WebSocket client. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AllowKeepAlive](#AllowKeepAlive) | Enables or disables keep-alive mode. | | [AllowOptionsResponseWithoutAuth](#AllowOptionsResponseWithoutAuth) | Enables unauthenticated responses to OPTIONS requests. | | [AuthBasic](#AuthBasic) | Turns on/off the basic authentication. | | [AuthDigest](#AuthDigest) | Turns on/off the digest authentication. | | [AuthDigestExpire](#AuthDigestExpire) | Specifies digest expiration time for digest authentication. | | [AuthRealm](#AuthRealm) | Specifies authentication realm for digest and NTLM authentication. | | [BoundAddress](#BoundAddress) | Returns the bound address of the listening socket. | | [BoundPort](#BoundPort) | The port that was bound by the server. | | [CompressionLevel](#CompressionLevel) | The default compression level to use. | | [DocumentRoot](#DocumentRoot) | The document root of the server. | | [DualStack](#DualStack) | Allows the use of ip4 and ip6 simultaneously. | | [HandshakeTimeout](#HandshakeTimeout) | The HTTPS handshake timeout. | | [HomePage](#HomePage) | Specifies the home page resource name. | | [Host](#Host) | The host to bind to. | | [OAuthAllowAccessByDefault](#OAuthAllowAccessByDefault) | Specifies whether access to a resource is allowed by default. | | [OAuthAutoValidateTokens](#OAuthAutoValidateTokens) | Allows to validate OAuth 2.0 access tokens automatically. | | [OAuthIntrospectionClientID](#OAuthIntrospectionClientID) | Specifies a client ID on the authentication service. | | [OAuthIntrospectionClientSecret](#OAuthIntrospectionClientSecret) | Specifies a client secret on the authentication service. | | [OAuthIntrospectionURL](#OAuthIntrospectionURL) | Specifies the URL to be used to introspect access tokens. | | [OAuthTokenValidationKeys](#OAuthTokenValidationKeys) | Specifies JW keys in JSON format for validating access token signatures. | | [Port](#Port) | The port to listen on. | | [PortRangeFrom](#PortRangeFrom) | The lower bound of allowed port scope to listen on. | | [PortRangeTo](#PortRangeTo) | The higher bound of allowed port scope to listen on. | | [PreSharedIdentityHint](#PreSharedIdentityHint) | Gets or sets the PSK identity hint. | | [RequestFilter](#RequestFilter) | The request string modifier. | | [SessionTimeout](#SessionTimeout) | The HTTP session timeout. | | [SleepLen](#SleepLen) | Adjusts the server loop idling time. | | [TempDir](#TempDir) | A temporary directory to use. | | [TempPath](#TempPath) | Path for storing temporary files. | | [TLSCiphersuites](#TLSCiphersuites) | Returns the list of ciphersuites activated in the class for the current session. | | [TLSExtensions](#TLSExtensions) | TBD. | | [TLSGroups](#TLSGroups) | Returns the list of TLS key exchange groups enabled in the class. | | [TLSPeerExtensions](#TLSPeerExtensions) | TBD. | | [TLSServerCertIndex](#TLSServerCertIndex) | Specifies the index of the server certificate to use. | | [TLSVersions](#TLSVersions) | Returns the list of TLS versions enabled in the class. | | [UseChunkedTransfer](#UseChunkedTransfer) | Enables chunked transfer. | | [UseCompression](#UseCompression) | Enables or disables server-side compression. | | [WebsiteName](#WebsiteName) | The website name for the TLS certificate. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # active property Indicates whether the server is active and is listening to new connections. ## Syntax ```text def get_active() -> bool: ... active = property(get_active, None) ``` ## Default Value FALSE ## Remarks This read-only property returns True if the server is listening to incoming connections. This property is read-only. # auth_types property Defines allowed HTTP authentication types. ## Syntax ```text def get_auth_types() -> int: ... def set_auth_types(value: int) -> None: ... auth_types = property(get_auth_types, set_auth_types) ``` ## 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 | # bound_port property Indicates the bound listening port. ## Syntax ```text def get_bound_port() -> int: ... bound_port = property(get_bound_port, None) ``` ## Default Value 0 ## Remarks Check this property to find out the port that has been allocated to the server by the system. The bound port always equals [port](#port-property) if it is provided, or is allocated dynamically if configured to fall in the range between [port_range_from](#port_range_from-property) and [port_range_to](#port_range_to-property) constraints. This property is read-only. # external_crypto_async_document_id property Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. ## Syntax ```text def get_external_crypto_async_document_id() -> str: ... def set_external_crypto_async_document_id(value: str) -> None: ... external_crypto_async_document_id = property(get_external_crypto_async_document_id, set_external_crypto_async_document_id) ``` ## Default Value "" ## Remarks Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. # external_crypto_custom_params property Custom parameters to be passed to the signing service (uninterpreted). ## Syntax ```text def get_external_crypto_custom_params() -> str: ... def set_external_crypto_custom_params(value: str) -> None: ... external_crypto_custom_params = property(get_external_crypto_custom_params, set_external_crypto_custom_params) ``` ## Default Value "" ## Remarks Custom parameters to be passed to the signing service (uninterpreted). # external_crypto_data property Additional data to be included in the async state and mirrored back by the requestor. ## Syntax ```text def get_external_crypto_data() -> str: ... def set_external_crypto_data(value: str) -> None: ... external_crypto_data = property(get_external_crypto_data, set_external_crypto_data) ``` ## Default Value "" ## Remarks Additional data to be included in the async state and mirrored back by the requestor. # external_crypto_external_hash_calculation property Specifies whether the message hash is to be calculated at the external endpoint. ## Syntax ```text def get_external_crypto_external_hash_calculation() -> bool: ... def set_external_crypto_external_hash_calculation(value: bool) -> None: ... external_crypto_external_hash_calculation = property(get_external_crypto_external_hash_calculation, set_external_crypto_external_hash_calculation) ``` ## Default Value FALSE ## Remarks Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. # external_crypto_hash_algorithm property Specifies the request's signature hash algorithm. ## Syntax ```text def get_external_crypto_hash_algorithm() -> str: ... def set_external_crypto_hash_algorithm(value: str) -> None: ... external_crypto_hash_algorithm = property(get_external_crypto_hash_algorithm, set_external_crypto_hash_algorithm) ``` ## Default Value "SHA256" ## Remarks Specifies the request's signature hash algorithm. | | | | | --- | --- | --- | | SB_HASH_ALGORITHM_SHA1 | SHA1 | | | SB_HASH_ALGORITHM_SHA224 | SHA224 | | | SB_HASH_ALGORITHM_SHA256 | SHA256 | | | SB_HASH_ALGORITHM_SHA384 | SHA384 | | | SB_HASH_ALGORITHM_SHA512 | SHA512 | | | SB_HASH_ALGORITHM_MD2 | MD2 | | | SB_HASH_ALGORITHM_MD4 | MD4 | | | SB_HASH_ALGORITHM_MD5 | MD5 | | | SB_HASH_ALGORITHM_RIPEMD160 | RIPEMD160 | | | SB_HASH_ALGORITHM_CRC32 | CRC32 | | | SB_HASH_ALGORITHM_SSL3 | SSL3 | | | SB_HASH_ALGORITHM_GOST_R3411_1994 | GOST1994 | | | SB_HASH_ALGORITHM_WHIRLPOOL | WHIRLPOOL | | | SB_HASH_ALGORITHM_POLY1305 | POLY1305 | | | SB_HASH_ALGORITHM_SHA3_224 | SHA3_224 | | | SB_HASH_ALGORITHM_SHA3_256 | SHA3_256 | | | SB_HASH_ALGORITHM_SHA3_384 | SHA3_384 | | | SB_HASH_ALGORITHM_SHA3_512 | SHA3_512 | | | SB_HASH_ALGORITHM_BLAKE2S_128 | BLAKE2S_128 | | | SB_HASH_ALGORITHM_BLAKE2S_160 | BLAKE2S_160 | | | SB_HASH_ALGORITHM_BLAKE2S_224 | BLAKE2S_224 | | | SB_HASH_ALGORITHM_BLAKE2S_256 | BLAKE2S_256 | | | SB_HASH_ALGORITHM_BLAKE2B_160 | BLAKE2B_160 | | | SB_HASH_ALGORITHM_BLAKE2B_256 | BLAKE2B_256 | | | SB_HASH_ALGORITHM_BLAKE2B_384 | BLAKE2B_384 | | | SB_HASH_ALGORITHM_BLAKE2B_512 | BLAKE2B_512 | | | SB_HASH_ALGORITHM_SHAKE_128 | SHAKE_128 | | | SB_HASH_ALGORITHM_SHAKE_256 | SHAKE_256 | | | SB_HASH_ALGORITHM_SHAKE_128_LEN | SHAKE_128_LEN | | | SB_HASH_ALGORITHM_SHAKE_256_LEN | SHAKE_256_LEN | | # external_crypto_key_id property The ID of the pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_id() -> str: ... def set_external_crypto_key_id(value: str) -> None: ... external_crypto_key_id = property(get_external_crypto_key_id, set_external_crypto_key_id) ``` ## Default Value "" ## Remarks The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [external_crypto_key_secret](#external_crypto_key_secret-property) 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"; ``` # external_crypto_key_secret property The pre-shared key used for DC request authentication. ## Syntax ```text def get_external_crypto_key_secret() -> str: ... def set_external_crypto_key_secret(value: str) -> None: ... external_crypto_key_secret = property(get_external_crypto_key_secret, set_external_crypto_key_secret) ``` ## Default Value "" ## Remarks The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work. Read more about configuring authentication in the [external_crypto_key_id](#external_crypto_key_id-property) topic. # external_crypto_method property Specifies the asynchronous signing method. ## Syntax ```text def get_external_crypto_method() -> int: ... def set_external_crypto_method(value: int) -> None: ... external_crypto_method = property(get_external_crypto_method, set_external_crypto_method) ``` ## Possible Values ```text 0 # PKCS11 # PKCS7 ``` ## Default Value 0 ## Remarks Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | # external_crypto_mode property Specifies the external cryptography mode. ## Syntax ```text def get_external_crypto_mode() -> int: ... def set_external_crypto_mode(value: int) -> None: ... external_crypto_mode = property(get_external_crypto_mode, set_external_crypto_mode) ``` ## Possible Values ```text 0 # Default1 # Disabled2 # Generic3 # DCAuth4 # DCAuthJSON ``` ## Default Value 0 ## Remarks Specifies the external cryptography mode. Available options: | | | | --- | --- | | ecmDefault | The default value (0) | | ecmDisabled | Do not use DC or external signing (1) | | ecmGeneric | Generic external signing with the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | # external_crypto_public_key_algorithm property Provide the public key algorithm here if the certificate is not available on the pre-signing stage. ## Syntax ```text def get_external_crypto_public_key_algorithm() -> str: ... def set_external_crypto_public_key_algorithm(value: str) -> None: ... external_crypto_public_key_algorithm = property(get_external_crypto_public_key_algorithm, set_external_crypto_public_key_algorithm) ``` ## Default Value "" ## Remarks Provide the public key algorithm here if the certificate is not available on the pre-signing stage. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | # fips_mode property Reserved. ## Syntax ```text def get_fips_mode() -> bool: ... def set_fips_mode(value: bool) -> None: ... fips_mode = property(get_fips_mode, set_fips_mode) ``` ## Default Value FALSE ## Remarks This property is reserved for future use. # handshake_timeout property Specifies the handshake timeout in milliseconds. ## Syntax ```text def get_handshake_timeout() -> int: ... def set_handshake_timeout(value: int) -> None: ... handshake_timeout = property(get_handshake_timeout, set_handshake_timeout) ``` ## Default Value 20000 ## Remarks Use this property to set the TLS handshake timeout. # host property The host to bind the listening port to. ## Syntax ```text def get_host() -> str: ... def set_host(value: str) -> None: ... host = property(get_host, set_host) ``` ## Default Value "" ## Remarks Use this property to specify the IP address on which to listen to incoming connections. # pinned_client_aead_cipher property Indicates whether the encryption algorithm used is an AEAD cipher. ## Syntax ```text def get_pinned_client_aead_cipher() -> bool: ... pinned_client_aead_cipher = property(get_pinned_client_aead_cipher, None) ``` ## Default Value FALSE ## Remarks Indicates whether the encryption algorithm used is an AEAD cipher. This property is read-only. # pinned_client_chain_validation_details property The details of a certificate chain validation outcome. ## Syntax ```text def get_pinned_client_chain_validation_details() -> int: ... pinned_client_chain_validation_details = property(get_pinned_client_chain_validation_details, None) ``` ## Default Value 0 ## Remarks 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 | This property is read-only. # pinned_client_chain_validation_result property The outcome of a certificate chain validation routine. ## Syntax ```text def get_pinned_client_chain_validation_result() -> int: ... pinned_client_chain_validation_result = property(get_pinned_client_chain_validation_result, None) ``` ## Possible Values ```text 0 # Valid1 # ValidButUntrusted2 # Invalid3 # CantBeEstablished ``` ## Default Value 0 ## Remarks 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. This property is read-only. # pinned_client_ciphersuite property The cipher suite employed by this connection. ## Syntax ```text def get_pinned_client_ciphersuite() -> str: ... pinned_client_ciphersuite = property(get_pinned_client_ciphersuite, None) ``` ## Default Value "" ## Remarks The cipher suite employed by this connection. For TLS connections, this property returns the ciphersuite that was/is employed by the connection. This property is read-only. # pinned_client_client_authenticated property Specifies whether client authentication was performed during this connection. ## Syntax ```text def get_pinned_client_client_authenticated() -> bool: ... pinned_client_client_authenticated = property(get_pinned_client_client_authenticated, None) ``` ## Default Value FALSE ## Remarks Specifies whether client authentication was performed during this connection. This property is read-only. # pinned_client_client_auth_requested property Specifies whether client authentication was requested during this connection. ## Syntax ```text def get_pinned_client_client_auth_requested() -> bool: ... pinned_client_client_auth_requested = property(get_pinned_client_client_auth_requested, None) ``` ## Default Value FALSE ## Remarks Specifies whether client authentication was requested during this connection. This property is read-only. # pinned_client_connection_established property Indicates whether the connection has been established fully. ## Syntax ```text def get_pinned_client_connection_established() -> bool: ... pinned_client_connection_established = property(get_pinned_client_connection_established, None) ``` ## Default Value FALSE ## Remarks Indicates whether the connection has been established fully. This property is read-only. # pinned_client_connection_id property The unique identifier assigned to this connection. ## Syntax ```text def get_pinned_client_connection_id() -> bytes: ... pinned_client_connection_id = property(get_pinned_client_connection_id, None) ``` ## Remarks The unique identifier assigned to this connection. This property is read-only. # pinned_client_digest_algorithm property The digest algorithm used in a TLS-enabled connection. ## Syntax ```text def get_pinned_client_digest_algorithm() -> str: ... pinned_client_digest_algorithm = property(get_pinned_client_digest_algorithm, None) ``` ## Default Value "" ## Remarks The digest algorithm used in a TLS-enabled connection. This property is read-only. # pinned_client_encryption_algorithm property The symmetric encryption algorithm used in a TLS-enabled connection. ## Syntax ```text def get_pinned_client_encryption_algorithm() -> str: ... pinned_client_encryption_algorithm = property(get_pinned_client_encryption_algorithm, None) ``` ## Default Value "" ## Remarks The symmetric encryption algorithm used in a TLS-enabled connection. This property is read-only. # pinned_client_exportable property Indicates whether a TLS connection uses a reduced-strength exportable cipher. ## Syntax ```text def get_pinned_client_exportable() -> bool: ... pinned_client_exportable = property(get_pinned_client_exportable, None) ``` ## Default Value FALSE ## Remarks Indicates whether a TLS connection uses a reduced-strength exportable cipher. This property is read-only. # pinned_client_group property The elliptic curve used in this connection. ## Syntax ```text def get_pinned_client_group() -> str: ... pinned_client_group = property(get_pinned_client_group, None) ``` ## Default Value "" ## Remarks The elliptic curve used in this connection. This property was named *NamedECCurve* in SecureBlackbox 2024 and earlier versions. This property is read-only. # pinned_client_id property The client connection's unique identifier. ## Syntax ```text def get_pinned_client_id() -> int: ... pinned_client_id = property(get_pinned_client_id, None) ``` ## Default Value -1 ## Remarks The client connection's unique identifier. This value is used throughout to refer to a particular client connection. This property is read-only. # pinned_client_key_exchange_algorithm property The key exchange algorithm used in a TLS-enabled connection. ## Syntax ```text def get_pinned_client_key_exchange_algorithm() -> str: ... pinned_client_key_exchange_algorithm = property(get_pinned_client_key_exchange_algorithm, None) ``` ## Default Value "" ## Remarks The key exchange algorithm used in a TLS-enabled connection. This property is read-only. # pinned_client_key_exchange_key_bits property The length of the key exchange key of a TLS-enabled connection. ## Syntax ```text def get_pinned_client_key_exchange_key_bits() -> int: ... pinned_client_key_exchange_key_bits = property(get_pinned_client_key_exchange_key_bits, None) ``` ## Default Value 0 ## Remarks The length of the key exchange key of a TLS-enabled connection. This property is read-only. # pinned_client_pfs_cipher property Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). ## Syntax ```text def get_pinned_client_pfs_cipher() -> bool: ... pinned_client_pfs_cipher = property(get_pinned_client_pfs_cipher, None) ``` ## Default Value FALSE ## Remarks Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). This property is read-only. # pinned_client_pre_shared_identity property Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax ```text def get_pinned_client_pre_shared_identity() -> str: ... pinned_client_pre_shared_identity = property(get_pinned_client_pre_shared_identity, None) ``` ## Default Value "" ## Remarks Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. This property is read-only. # pinned_client_pre_shared_identity_hint property A hint professed by the server to help the client select the PSK identity to use. ## Syntax ```text def get_pinned_client_pre_shared_identity_hint() -> str: ... pinned_client_pre_shared_identity_hint = property(get_pinned_client_pre_shared_identity_hint, None) ``` ## Default Value "" ## Remarks A hint professed by the server to help the client select the PSK identity to use. This property is read-only. # pinned_client_public_key_bits property The length of the public key. ## Syntax ```text def get_pinned_client_public_key_bits() -> int: ... pinned_client_public_key_bits = property(get_pinned_client_public_key_bits, None) ``` ## Default Value 0 ## Remarks The length of the public key. This property is read-only. # pinned_client_remote_address property The client's IP address. ## Syntax ```text def get_pinned_client_remote_address() -> str: ... pinned_client_remote_address = property(get_pinned_client_remote_address, None) ``` ## Default Value "" ## Remarks The client's IP address. This property is read-only. # pinned_client_remote_port property The remote port of the client connection. ## Syntax ```text def get_pinned_client_remote_port() -> int: ... pinned_client_remote_port = property(get_pinned_client_remote_port, None) ``` ## Default Value 0 ## Remarks The remote port of the client connection. This property is read-only. # pinned_client_resumed_session property Indicates whether a TLS-enabled connection was spawned from another TLS connection. ## Syntax ```text def get_pinned_client_resumed_session() -> bool: ... pinned_client_resumed_session = property(get_pinned_client_resumed_session, None) ``` ## Default Value FALSE ## Remarks Indicates whether a TLS-enabled connection was spawned from another TLS connection This property is read-only. # pinned_client_secure_connection property Indicates whether TLS or SSL is enabled for this connection. ## Syntax ```text def get_pinned_client_secure_connection() -> bool: ... pinned_client_secure_connection = property(get_pinned_client_secure_connection, None) ``` ## Default Value FALSE ## Remarks Indicates whether TLS or SSL is enabled for this connection. This property is read-only. # pinned_client_server_authenticated property Indicates whether server authentication was performed during a TLS-enabled connection. ## Syntax ```text def get_pinned_client_server_authenticated() -> bool: ... pinned_client_server_authenticated = property(get_pinned_client_server_authenticated, None) ``` ## Default Value FALSE ## Remarks Indicates whether server authentication was performed during a TLS-enabled connection. This property is read-only. # pinned_client_signature_algorithm property The signature algorithm used in a TLS handshake. ## Syntax ```text def get_pinned_client_signature_algorithm() -> str: ... pinned_client_signature_algorithm = property(get_pinned_client_signature_algorithm, None) ``` ## Default Value "" ## Remarks The signature algorithm used in a TLS handshake. This property is read-only. # pinned_client_symmetric_block_size property The block size of the symmetric algorithm used. ## Syntax ```text def get_pinned_client_symmetric_block_size() -> int: ... pinned_client_symmetric_block_size = property(get_pinned_client_symmetric_block_size, None) ``` ## Default Value 0 ## Remarks The block size of the symmetric algorithm used. This property is read-only. # pinned_client_symmetric_key_bits property The key length of the symmetric algorithm used. ## Syntax ```text def get_pinned_client_symmetric_key_bits() -> int: ... pinned_client_symmetric_key_bits = property(get_pinned_client_symmetric_key_bits, None) ``` ## Default Value 0 ## Remarks The key length of the symmetric algorithm used. This property is read-only. # pinned_client_total_bytes_received property The total number of bytes received over this connection. ## Syntax ```text def get_pinned_client_total_bytes_received() -> int: ... pinned_client_total_bytes_received = property(get_pinned_client_total_bytes_received, None) ``` ## Default Value 0 ## Remarks The total number of bytes received over this connection. This property is read-only. # pinned_client_total_bytes_sent property The total number of bytes sent over this connection. ## Syntax ```text def get_pinned_client_total_bytes_sent() -> int: ... pinned_client_total_bytes_sent = property(get_pinned_client_total_bytes_sent, None) ``` ## Default Value 0 ## Remarks The total number of bytes sent over this connection. This property is read-only. # pinned_client_validation_log property Contains the server certificate's chain validation log. ## Syntax ```text def get_pinned_client_validation_log() -> str: ... pinned_client_validation_log = property(get_pinned_client_validation_log, None) ``` ## Default Value "" ## Remarks Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures. This property is read-only. # pinned_client_version property Indicates the version of SSL/TLS protocol negotiated during this connection. ## Syntax ```text def get_pinned_client_version() -> str: ... pinned_client_version = property(get_pinned_client_version, None) ``` ## Default Value "" ## Remarks Indicates the version of SSL/TLS protocol negotiated during this connection. This property is read-only. # pinned_client_cert_count property The number of records in the PinnedClientCert arrays. ## Syntax ```text def get_pinned_client_cert_count() -> int: ... pinned_client_cert_count = property(get_pinned_client_cert_count, None) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [pinned_client_cert_bytes](#pinned_client_cert_bytes-property) - [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property) - [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property) - [pinned_client_cert_handle](#pinned_client_cert_handle-property) - [pinned_client_cert_issuer](#pinned_client_cert_issuer-property) - [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property) - [pinned_client_cert_key_algorithm](#pinned_client_cert_key_algorithm-property) - [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property) - [pinned_client_cert_key_fingerprint](#pinned_client_cert_key_fingerprint-property) - [pinned_client_cert_key_usage](#pinned_client_cert_key_usage-property) - [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property) - [pinned_client_cert_self_signed](#pinned_client_cert_self_signed-property) - [pinned_client_cert_serial_number](#pinned_client_cert_serial_number-property) - [pinned_client_cert_sig_algorithm](#pinned_client_cert_sig_algorithm-property) - [pinned_client_cert_subject](#pinned_client_cert_subject-property) - [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property) - [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property) - [pinned_client_cert_valid_from](#pinned_client_cert_valid_from-property) - [pinned_client_cert_valid_to](#pinned_client_cert_valid_to-property) The array indices start at *0* and end at *pinned_client_cert_count - 1*. This property is read-only. # pinned_client_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_pinned_client_cert_bytes(pinned_client_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_ca_key_id property A unique identifier (fingerprint) of the CA certificate's cryptographic key. ## Syntax ```text def get_pinned_client_cert_ca_key_id(pinned_client_cert_index: int) -> bytes: ... ``` ## Remarks 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) generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property) setting, and for lower-level certificates, from the parent certificate's subject key ID extension. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_fingerprint property Contains the fingerprint (a hash imprint) of this certificate. ## Syntax ```text def get_pinned_client_cert_fingerprint(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Contains the fingerprint (a hash imprint) of this certificate. While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_pinned_client_cert_handle(pinned_client_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_issuer property The common name of the certificate issuer (CA), typically a company name. ## Syntax ```text def get_pinned_client_cert_issuer(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via [pinned_client_cert_issuer_rdn](#pinned_client_cert_issuer_rdn-property). The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_issuer_rdn property A list of Property=Value pairs that uniquely identify the certificate issuer. ## Syntax ```text def get_pinned_client_cert_issuer_rdn(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate issuer. Example: */C=US/O=Nationwide CA/CN=Web Certification Authority* The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_key_algorithm property Specifies the public key algorithm of this certificate. ## Syntax ```text def get_pinned_client_cert_key_algorithm(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "0" ## Remarks Specifies the public key algorithm of this certificate. | | | | | --- | --- | --- | | SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION | rsaEncryption | | | SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION | md2withRSAEncryption | | | SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION | md5withRSAEncryption | | | SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION | sha1withRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA | id-dsa | | | SB_CERT_ALGORITHM_ID_DSA_SHA1 | id-dsa-with-sha1 | | | SB_CERT_ALGORITHM_DH_PUBLIC | dhpublicnumber | | | SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION | sha224WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION | sha256WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION | sha384WithRSAEncryption | | | SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION | sha512WithRSAEncryption | | | SB_CERT_ALGORITHM_ID_RSAPSS | id-RSASSA-PSS | | | SB_CERT_ALGORITHM_ID_RSAOAEP | id-RSAES-OAEP | | | SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160 | ripemd160withRSA | | | SB_CERT_ALGORITHM_ID_ELGAMAL | elGamal | | | SB_CERT_ALGORITHM_SHA1_ECDSA | ecdsa-with-SHA1 | | | SB_CERT_ALGORITHM_RECOMMENDED_ECDSA | ecdsa-recommended | | | SB_CERT_ALGORITHM_SHA224_ECDSA | ecdsa-with-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA | ecdsa-with-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA | ecdsa-with-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA | ecdsa-with-SHA512 | | | SB_CERT_ALGORITHM_EC | id-ecPublicKey | | | SB_CERT_ALGORITHM_SPECIFIED_ECDSA | ecdsa-specified | | | SB_CERT_ALGORITHM_GOST_R3410_1994 | id-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3410_2001 | id-GostR3410-2001 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994 | id-GostR3411-94-with-GostR3410-94 | | | SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001 | id-GostR3411-94-with-GostR3410-2001 | | | SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN | ecdsa-plain-SHA1 | | | SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN | ecdsa-plain-SHA224 | | | SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN | ecdsa-plain-SHA256 | | | SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN | ecdsa-plain-SHA384 | | | SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN | ecdsa-plain-SHA512 | | | SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN | ecdsa-plain-RIPEMD160 | | | SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION | whirlpoolWithRSAEncryption | | | SB_CERT_ALGORITHM_ID_DSA_SHA224 | id-dsa-with-sha224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA256 | id-dsa-with-sha256 | | | SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA | id-ecdsa-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA | id-ecdsa-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA | id-ecdsa-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA | id-ecdsa-with-sha3-512 | | | SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-224 | | | SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-256 | | | SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-384 | | | SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN | id-ecdsa-plain-with-sha3-512 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_224 | id-dsa-with-sha3-224 | | | SB_CERT_ALGORITHM_ID_DSA_SHA3_256 | id-dsa-with-sha3-256 | | | SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION | id-rsassa-pkcs1-v1_5-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA | id-ecdsa-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA | id-ecdsa-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA | id-ecdsa-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA | id-ecdsa-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA | id-ecdsa-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA | id-ecdsa-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA | id-ecdsa-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA | id-ecdsa-with-blake2b512 | | | SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s128 | | | SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s160 | | | SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s224 | | | SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2s256 | | | SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b160 | | | SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b256 | | | SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b384 | | | SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN | id-ecdsa-plain-with-blake2b512 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224 | id-dsa-with-blake2s224 | | | SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256 | id-dsa-with-blake2s256 | | | SB_CERT_ALGORITHM_EDDSA_ED25519 | id-Ed25519 | | | SB_CERT_ALGORITHM_EDDSA_ED448 | id-Ed448 | | | SB_CERT_ALGORITHM_EDDSA_ED25519_PH | id-Ed25519ph | | | SB_CERT_ALGORITHM_EDDSA_ED448_PH | id-Ed448ph | | | SB_CERT_ALGORITHM_EDDSA | id-EdDSA | | | SB_CERT_ALGORITHM_EDDSA_SIGNATURE | id-EdDSA-sig | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | Use the [pinned_client_cert_key_bits](#pinned_client_cert_key_bits-property), [pinned_client_cert_curve](#WebSocketServer_p_PinnedClientCertCurve), and [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property) properties to get more details about the key the certificate contains. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_key_bits property Returns the length of the public key in bits. ## Syntax ```text def get_pinned_client_cert_key_bits(pinned_client_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Returns the length of the public key in bits. This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the [pinned_client_cert_public_key_bytes](#pinned_client_cert_public_key_bytes-property) or [pinned_client_cert_private_key_bytes](#WebSocketServer_p_PinnedClientCertPrivateKeyBytes) property would typically contain auxiliary values, and therefore be longer. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_key_fingerprint property Returns a SHA1 fingerprint of the public key contained in the certificate. ## Syntax ```text def get_pinned_client_cert_key_fingerprint(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks 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 [pinned_client_cert_fingerprint](#pinned_client_cert_fingerprint-property) property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_key_usage property Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. ## Syntax ```text def get_pinned_client_cert_key_usage(pinned_client_cert_index: int) -> int: ... ``` ## Default Value 0 ## Remarks Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. This value is a bit mask of the following values: | | | | | --- | --- | --- | | ckuUnknown | 0x00000 | Unknown key usage | | ckuDigitalSignature | 0x00001 | Digital signature | | ckuNonRepudiation | 0x00002 | Non-repudiation | | ckuKeyEncipherment | 0x00004 | Key encipherment | | ckuDataEncipherment | 0x00008 | Data encipherment | | ckuKeyAgreement | 0x00010 | Key agreement | | ckuKeyCertSign | 0x00020 | Certificate signing | | ckuCRLSign | 0x00040 | Revocation signing | | ckuEncipherOnly | 0x00080 | Encipher only | | ckuDecipherOnly | 0x00100 | Decipher only | | ckuServerAuthentication | 0x00200 | Server authentication | | ckuClientAuthentication | 0x00400 | Client authentication | | ckuCodeSigning | 0x00800 | Code signing | | ckuEmailProtection | 0x01000 | Email protection | | ckuTimeStamping | 0x02000 | Timestamping | | ckuOCSPSigning | 0x04000 | OCSP signing | | ckuSmartCardLogon | 0x08000 | Smartcard logon | | ckuKeyPurposeClientAuth | 0x10000 | Kerberos - client authentication | | ckuKeyPurposeKDC | 0x20000 | Kerberos - KDC | Set this property before generating the certificate to propagate the key usage flags to the new certificate. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_public_key_bytes property Contains the certificate's public key in DER format. ## Syntax ```text def get_pinned_client_cert_public_key_bytes(pinned_client_cert_index: int) -> bytes: ... ``` ## Remarks 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. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_self_signed property Indicates whether the certificate is self-signed (root) or signed by an external CA. ## Syntax ```text def get_pinned_client_cert_self_signed(pinned_client_cert_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether the certificate is self-signed (root) or signed by an external CA. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_serial_number property Returns the certificate's serial number. ## Syntax ```text def get_pinned_client_cert_serial_number(pinned_client_cert_index: int) -> bytes: ... ``` ## Remarks Returns the certificate's serial number. The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_sig_algorithm property Indicates the algorithm that was used by the CA to sign this certificate. ## Syntax ```text def get_pinned_client_cert_sig_algorithm(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks Indicates the algorithm that was used by the CA to sign this certificate. A signature algorithm typically combines hash and public key algorithms together, such as *sha256WithRSAEncryption* or *ecdsa-with-SHA256*. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_subject property The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. ## Syntax ```text def get_pinned_client_cert_subject(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via [pinned_client_cert_subject_rdn](#pinned_client_cert_subject_rdn-property). The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_subject_key_id property Contains a unique identifier of the certificate's cryptographic key. ## Syntax ```text def get_pinned_client_cert_subject_key_id(pinned_client_cert_index: int) -> bytes: ... ``` ## Remarks 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 [pinned_client_cert_subject_key_id](#pinned_client_cert_subject_key_id-property) and [pinned_client_cert_ca_key_id](#pinned_client_cert_ca_key_id-property) properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_subject_rdn property A list of Property=Value pairs that uniquely identify the certificate holder (subject). ## Syntax ```text def get_pinned_client_cert_subject_rdn(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks A list of *Property=Value* pairs that uniquely identify the certificate holder (subject). Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data. Example: */C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins*. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_valid_from property The time point at which the certificate becomes valid, in UTC. ## Syntax ```text def get_pinned_client_cert_valid_from(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate becomes valid, in UTC. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # pinned_client_cert_valid_to property The time point at which the certificate expires, in UTC. ## Syntax ```text def get_pinned_client_cert_valid_to(pinned_client_cert_index: int) -> str: ... ``` ## Default Value "" ## Remarks The time point at which the certificate expires, in UTC. The *pinned_client_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [pinned_client_cert_count](#pinned_client_cert_count-property) property. This property is read-only. # port property Specifies the port number to listen for connections on. ## Syntax ```text def get_port() -> int: ... def set_port(value: int) -> None: ... port = property(get_port, set_port) ``` ## Default Value 80 ## Remarks Use this property to specify the port number to listen to connections on. Standard port numbers are 80 for an HTTP server, and 443 for an HTTPS server. Alternatively, you may specify the acceptable range of listening ports via [port_range_from](#port_range_from-property) and [port_range_to](#port_range_to-property) properties. In this case the port will be allocated within the requested range by the operating system, and reported in [bound_port](#bound_port-property). # port_range_from property Specifies the lower limit of the listening port range for incoming connections. ## Syntax ```text def get_port_range_from() -> int: ... def set_port_range_from(value: int) -> None: ... port_range_from = property(get_port_range_from, set_port_range_from) ``` ## Default Value 0 ## Remarks Use this property to specify the lower limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via [port](#port-property)), the port will be allocated within the requested range by the operating system, and reported in [bound_port](#bound_port-property). Note that this property is ignored if the [port](#port-property) property is set to a non-zero value, in which case the server always aims to listen on that fixed port. # port_range_to property Specifies the upper limit of the listening port range for incoming connections. ## Syntax ```text def get_port_range_to() -> int: ... def set_port_range_to(value: int) -> None: ... port_range_to = property(get_port_range_to, set_port_range_to) ``` ## Default Value 0 ## Remarks Use this property to specify the upper limit of the port range to listen to connections on. When a port range is used to specify the listening port (as opposed to a fixed value provided via [port](#port-property)), the port will be allocated within the requested range by the operating system, and reported in [bound_port](#bound_port-property). Note that this property is ignored if the [port](#port-property) property is set to a non-zero value, in which case the server always aims to listen on that fixed port. # session_timeout property Specifies the default session timeout value in milliseconds. ## Syntax ```text def get_session_timeout() -> int: ... def set_session_timeout(value: int) -> None: ... session_timeout = property(get_session_timeout, set_session_timeout) ``` ## Default Value 360000 ## Remarks Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server. # socket_incoming_speed_limit property The maximum number of bytes to read from the socket, per second. ## Syntax ```text def get_socket_incoming_speed_limit() -> int: ... def set_socket_incoming_speed_limit(value: int) -> None: ... socket_incoming_speed_limit = property(get_socket_incoming_speed_limit, set_socket_incoming_speed_limit) ``` ## Default Value 0 ## Remarks The maximum number of bytes to read from the socket, per second. # socket_local_address property The local network interface to bind the socket to. ## Syntax ```text def get_socket_local_address() -> str: ... def set_socket_local_address(value: str) -> None: ... socket_local_address = property(get_socket_local_address, set_socket_local_address) ``` ## Default Value "" ## Remarks The local network interface to bind the socket to. # socket_local_port property The local port number to bind the socket to. ## Syntax ```text def get_socket_local_port() -> int: ... def set_socket_local_port(value: int) -> None: ... socket_local_port = property(get_socket_local_port, set_socket_local_port) ``` ## Default Value 0 ## Remarks The local port number to bind the socket to. # socket_outgoing_speed_limit property The maximum number of bytes to write to the socket, per second. ## Syntax ```text def get_socket_outgoing_speed_limit() -> int: ... def set_socket_outgoing_speed_limit(value: int) -> None: ... socket_outgoing_speed_limit = property(get_socket_outgoing_speed_limit, set_socket_outgoing_speed_limit) ``` ## Default Value 0 ## Remarks The maximum number of bytes to write to the socket, per second. # socket_timeout property The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. ## Syntax ```text def get_socket_timeout() -> int: ... def set_socket_timeout(value: int) -> None: ... socket_timeout = property(get_socket_timeout, set_socket_timeout) ``` ## Default Value 60000 ## Remarks The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. If *Timeout* is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack). # socket_use_ipv6 property Enables or disables IP protocol version 6. ## Syntax ```text def get_socket_use_ipv6() -> bool: ... def set_socket_use_ipv6(value: bool) -> None: ... socket_use_ipv6 = property(get_socket_use_ipv6, set_socket_use_ipv6) ``` ## Default Value FALSE ## Remarks Enables or disables IP protocol version 6. # tls_auto_validate_certificates property Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. ## Syntax ```text def get_tls_auto_validate_certificates() -> bool: ... def set_tls_auto_validate_certificates(value: bool) -> None: ... tls_auto_validate_certificates = property(get_tls_auto_validate_certificates, set_tls_auto_validate_certificates) ``` ## Default Value TRUE ## Remarks Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. # tls_base_configuration property Selects the base configuration for the TLS settings. ## Syntax ```text def get_tls_base_configuration() -> int: ... def set_tls_base_configuration(value: int) -> None: ... tls_base_configuration = property(get_tls_base_configuration, set_tls_base_configuration) ``` ## Possible Values ```text 0 # Default1 # Compatible2 # ComprehensiveInsecure3 # HighlySecure ``` ## Default Value 0 ## Remarks Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility. | | | | | --- | --- | --- | | stpcDefault | 0 | | | stpcCompatible | 1 | | | stpcComprehensiveInsecure | 2 | | | stpcHighlySecure | 3 | | # tls_ciphersuites property A list of ciphersuites separated with commas or semicolons. ## Syntax ```text def get_tls_ciphersuites() -> str: ... def set_tls_ciphersuites(value: str) -> None: ... tls_ciphersuites = property(get_tls_ciphersuites, set_tls_ciphersuites) ``` ## Default Value "" ## Remarks A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the *all* (and *-all*) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once. Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by [tls_base_configuration](#tls_base_configuration-property). 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 # tls_client_auth property Enables or disables certificate-based client authentication. ## Syntax ```text def get_tls_client_auth() -> int: ... def set_tls_client_auth(value: int) -> None: ... tls_client_auth = property(get_tls_client_auth, set_tls_client_auth) ``` ## Possible Values ```text 0 # NoAuth1 # RequestCert2 # RequireCert ``` ## Default Value 0 ## Remarks Enables or disables certificate-based client authentication. Set this property to true to tune up the client authentication type: | | | | | --- | --- | --- | | ccatNoAuth | 0 | | | ccatRequestCert | 1 | | | ccatRequireCert | 2 | | # tls_extensions property Provides access to TLS extensions. ## Syntax ```text def get_tls_extensions() -> str: ... def set_tls_extensions(value: str) -> None: ... tls_extensions = property(get_tls_extensions, set_tls_extensions) ``` ## Default Value "" ## Remarks Provides access to TLS extensions. # tls_force_resume_if_destination_changes property Whether to force TLS session resumption when the destination address changes. ## Syntax ```text def get_tls_force_resume_if_destination_changes() -> bool: ... def set_tls_force_resume_if_destination_changes(value: bool) -> None: ... tls_force_resume_if_destination_changes = property(get_tls_force_resume_if_destination_changes, set_tls_force_resume_if_destination_changes) ``` ## Default Value FALSE ## Remarks Whether to force TLS session resumption when the destination address changes. # tls_groups property Specifies a list of key exchange groups to attempt during the TLS key exchange. ## Syntax ```text def get_tls_groups() -> str: ... def set_tls_groups(value: str) -> None: ... tls_groups = property(get_tls_groups, set_tls_groups) ``` ## Default Value "" ## Remarks Specifies a list of key exchange groups to attempt during the TLS key exchange. Keep this setting at its default value (empty string) to stick with the default list of key exchange groups. You can tweak the list by using '+' and '-' modifiers that are immediately followed by a group name or the *all* placeholder: ```text // Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768"; ``` The list of groups supported by the component is provided below. All the names are case-insensitive: **Elliptic curve-based groups:** - SECT163K1 - SECT163R1 - SECT163R2 - SECT193R1 - SECT193R2 - SECT233K1 - SECT233R1 - SECT239K1 - SECT283K1 - SECT283R1 - SECT409K1 - SECT409R1 - SECT571K1 - SECT571R1 - SECP160K1 - SECP160R1 - SECP160R2 - SECP192K1 - SECP192R1 - SECP224K1 - SECP224R1 - SECP256K1 - SECP256R1 - SECP384R1 - SECP521R1 - BRAINPOOLP256R1 - BRAINPOOLP384R1 - BRAINPOOLP512R1 - X25519 - X448 **Finite field-based groups:** - FFDHE2048 - FFDHE3072 - FFDHE4096 - FFDHE6144 - FFDHE8192 **Post-Quantum and Hybrid groups:** - MLKEM512 - MLKEM768 - MLKEM1024 - SECP256R1MLKEM768 - X25519MLKEM768 - SECP384R1MLKEM1024 Note: this property was called *ECCurves* in SecureBlackbox 2024 and older. # tls_pre_shared_identity property Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. ## Syntax ```text def get_tls_pre_shared_identity() -> str: ... def set_tls_pre_shared_identity(value: str) -> None: ... tls_pre_shared_identity = property(get_tls_pre_shared_identity, set_tls_pre_shared_identity) ``` ## Default Value "" ## Remarks Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. # tls_pre_shared_key property Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. ## Syntax ```text def get_tls_pre_shared_key() -> str: ... def set_tls_pre_shared_key(value: str) -> None: ... tls_pre_shared_key = property(get_tls_pre_shared_key, set_tls_pre_shared_key) ``` ## Default Value "" ## Remarks Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. # tls_pre_shared_key_ciphersuite property Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. ## Syntax ```text def get_tls_pre_shared_key_ciphersuite() -> str: ... def set_tls_pre_shared_key_ciphersuite(value: str) -> None: ... tls_pre_shared_key_ciphersuite = property(get_tls_pre_shared_key_ciphersuite, set_tls_pre_shared_key_ciphersuite) ``` ## Default Value "" ## Remarks Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. # tls_renegotiation_attack_prevention_mode property Selects the renegotiation attack prevention mechanism. ## Syntax ```text def get_tls_renegotiation_attack_prevention_mode() -> int: ... def set_tls_renegotiation_attack_prevention_mode(value: int) -> None: ... tls_renegotiation_attack_prevention_mode = property(get_tls_renegotiation_attack_prevention_mode, set_tls_renegotiation_attack_prevention_mode) ``` ## Possible Values ```text 0 # Compatible1 # Strict2 # Auto ``` ## Default Value 2 ## Remarks Selects the renegotiation attack prevention mechanism. The following options are available: | | | | | --- | --- | --- | | crapmCompatible | 0 | TLS 1.0 and 1.1 compatibility mode (renegotiation indication extension is disabled). | | crapmStrict | 1 | Renegotiation attack prevention is enabled and enforced. | | crapmAuto | 2 | Automatically choose whether to enable or disable renegotiation attack prevention. | # tls_revocation_check property Specifies the kind(s) of revocation check to perform. ## Syntax ```text def get_tls_revocation_check() -> int: ... def set_tls_revocation_check(value: int) -> None: ... tls_revocation_check = property(get_tls_revocation_check, set_tls_revocation_check) ``` ## Possible Values ```text 0 # None1 # Auto2 # AllCRL3 # AllOCSP4 # AllCRLAndOCSP5 # AnyCRL6 # AnyOCSP7 # AnyCRLOrOCSP8 # AnyOCSPOrCRL ``` ## Default Value 1 ## Remarks Specifies the kind(s) of revocation check to perform. Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information. | | | | | --- | --- | --- | | crcNone | 0 | No revocation checking. | | crcAuto | 1 | Automatic mode selection. Currently this maps to crcAnyOCSPOrCRL, but it may change in the future. | | crcAllCRL | 2 | All provided CRL endpoints will be checked, and all checks must succeed. | | crcAllOCSP | 3 | All provided OCSP endpoints will be checked, and all checks must succeed. | | crcAllCRLAndOCSP | 4 | All provided CRL and OCSP endpoints will be checked, and all checks must succeed. | | crcAnyCRL | 5 | All provided CRL endpoints will be checked, and at least one check must succeed. | | crcAnyOCSP | 6 | All provided OCSP endpoints will be checked, and at least one check must succeed. | | crcAnyCRLOrOCSP | 7 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. CRL endpoints are checked first. | | crcAnyOCSPOrCRL | 8 | All provided CRL and OCSP endpoints will be checked, and at least one check must succeed. OCSP endpoints are checked first. | This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time. There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs). This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential. NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable. NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails. # tls_ssl_options property 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. ## Syntax ```text def get_tls_ssl_options() -> int: ... def set_tls_ssl_options(value: int) -> None: ... tls_ssl_options = property(get_tls_ssl_options, set_tls_ssl_options) ``` ## Default Value 16 ## Remarks Various SSL (TLS) protocol options, set of | | | | | --- | --- | --- | | cssloExpectShutdownMessage | 0x001 | Wait for the close-notify message when shutting down the connection | | cssloOpenSSLDTLSWorkaround | 0x002 | (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions | | cssloDisableKexLengthAlignment | 0x004 | Do not align the client-side PMS by the RSA modulus size. It is unlikely that you will ever need to adjust it. | | cssloForceUseOfClientCertHashAlg | 0x008 | Enforce the use of the client certificate hash algorithm. It is unlikely that you will ever need to adjust it. | | cssloAutoAddServerNameExtension | 0x010 | Automatically add the server name extension when known | | cssloAcceptTrustedSRPPrimesOnly | 0x020 | Accept trusted SRP primes only | | cssloDisableSignatureAlgorithmsExtension | 0x040 | Disable (do not send) the signature algorithms extension. It is unlikely that you will ever need to adjust it. | | cssloIntolerateHigherProtocolVersions | 0x080 | (server option) Do not allow fallback from TLS versions higher than currently enabled | | cssloStickToPrefCertHashAlg | 0x100 | Stick to preferred certificate hash algorithms | | cssloNoImplicitTLS12Fallback | 0x200 | Disable implicit TLS 1.3 to 1.2 fallbacks | | cssloUseHandshakeBatches | 0x400 | Send the handshake message as large batches rather than individually | # tls_mode property Specifies the TLS mode to use. ## Syntax ```text def get_tls_mode() -> int: ... def set_tls_mode(value: int) -> None: ... tls_mode = property(get_tls_mode, set_tls_mode) ``` ## Possible Values ```text 0 # Default1 # NoTLS2 # ExplicitTLS3 # ImplicitTLS4 # MixedTLS ``` ## Default Value 0 ## Remarks Specifies the TLS mode to use. | | | | | --- | --- | --- | | smDefault | 0 | | | smNoTLS | 1 | Do not use TLS | | smExplicitTLS | 2 | Connect to the server without any encryption and then request an SSL session. | | smImplicitTLS | 3 | Connect to the specified port, and establish the SSL session at once. | | smMixedTLS | 4 | Connect to the specified port, and establish the SSL session at once, but allow plain data. | # tls_use_extended_master_secret property Enables the Extended Master Secret Extension, as defined in RFC 7627. ## Syntax ```text def get_tls_use_extended_master_secret() -> bool: ... def set_tls_use_extended_master_secret(value: bool) -> None: ... tls_use_extended_master_secret = property(get_tls_use_extended_master_secret, set_tls_use_extended_master_secret) ``` ## Default Value TRUE ## Remarks Enables the Extended Master Secret Extension, as defined in RFC 7627. # tls_use_session_resumption property Enables or disables the TLS session resumption capability. ## Syntax ```text def get_tls_use_session_resumption() -> bool: ... def set_tls_use_session_resumption(value: bool) -> None: ... tls_use_session_resumption = property(get_tls_use_session_resumption, set_tls_use_session_resumption) ``` ## Default Value FALSE ## Remarks Enables or disables the TLS session resumption capability. # tls_versions property The SSL/TLS versions to enable by default. ## Syntax ```text def get_tls_versions() -> int: ... def set_tls_versions(value: int) -> None: ... tls_versions = property(get_tls_versions, set_tls_versions) ``` ## Default Value 48 ## Remarks The SSL/TLS versions to enable by default. | | | | | --- | --- | --- | | csbSSL2 | 0x01 | SSL 2 | | csbSSL3 | 0x02 | SSL 3 | | csbTLS1 | 0x04 | TLS 1.0 | | csbTLS11 | 0x08 | TLS 1.1 | | csbTLS12 | 0x10 | TLS 1.2 | | csbTLS13 | 0x20 | TLS 1.3 | # tls_server_cert_count property The number of records in the TLSServerCert arrays. ## Syntax ```text def get_tls_server_cert_count() -> int: ... def set_tls_server_cert_count(value: int) -> None: ... tls_server_cert_count = property(get_tls_server_cert_count, set_tls_server_cert_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [tls_server_cert_bytes](#tls_server_cert_bytes-property) - [tls_server_cert_handle](#tls_server_cert_handle-property) The array indices start at *0* and end at *tls_server_cert_count - 1*. # tls_server_cert_bytes property Returns the raw certificate data in DER format. ## Syntax ```text def get_tls_server_cert_bytes(tls_server_cert_index: int) -> bytes: ... ``` ## Remarks Returns the raw certificate data in DER format. The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. This property is read-only. # tls_server_cert_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_tls_server_cert_handle(tls_server_cert_index: int) -> int: ... def set_tls_server_cert_handle(tls_server_cert_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *tls_server_cert_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [tls_server_cert_count](#tls_server_cert_count-property) property. # user_count property The number of records in the User arrays. ## Syntax ```text def get_user_count() -> int: ... def set_user_count(value: int) -> None: ... user_count = property(get_user_count, set_user_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [user_associated_data](#user_associated_data-property) - [user_base_path](#user_base_path-property) - [user_data](#user_data-property) - [user_handle](#user_handle-property) - [user_hash_algorithm](#user_hash_algorithm-property) - [user_incoming_speed_limit](#user_incoming_speed_limit-property) - [username](#username-property) - [user_outgoing_speed_limit](#user_outgoing_speed_limit-property) - [user_password](#user_password-property) - [user_shared_secret](#user_shared_secret-property) The array indices start at *0* and end at *user_count - 1*. # user_associated_data property Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. ## Syntax ```text def get_user_associated_data(user_index: int) -> bytes: ... def set_user_associated_data(user_index: int, value: bytes) -> None: ... ``` ## Remarks Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_base_path property Base path for this user in the server's file system. ## Syntax ```text def get_user_base_path(user_index: int) -> str: ... def set_user_base_path(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks Base path for this user in the server's file system. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_data property Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. ## Syntax ```text def get_user_data(user_index: int) -> str: ... def set_user_data(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_handle property Allows to get or set a 'handle', a unique identifier of the underlying property object. ## Syntax ```text def get_user_handle(user_index: int) -> int: ... def set_user_handle(user_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise. When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_hash_algorithm property Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. ## Syntax ```text def get_user_hash_algorithm(user_index: int) -> str: ... def set_user_hash_algorithm(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user. Three HMAC algorithms are supported, with SHA-1, SHA-256, and SHA-512 digests: | | | | | --- | --- | --- | | SB_MAC_ALGORITHM_HMAC_SHA1 | SHA1 | | | SB_MAC_ALGORITHM_HMAC_SHA256 | SHA256 | | | SB_MAC_ALGORITHM_HMAC_SHA512 | SHA512 | | The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_incoming_speed_limit property Specifies the incoming speed limit for this user. ## Syntax ```text def get_user_incoming_speed_limit(user_index: int) -> int: ... def set_user_incoming_speed_limit(user_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation". The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_outgoing_speed_limit property Specifies the outgoing speed limit for this user. ## Syntax ```text def get_user_outgoing_speed_limit(user_index: int) -> int: ... def set_user_outgoing_speed_limit(user_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation". The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_password property The user's authentication password. ## Syntax ```text def get_user_password(user_index: int) -> str: ... def set_user_password(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The user's authentication password. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # user_shared_secret property Contains the user's secret key, which is essentially a shared secret between the client and server. ## Syntax ```text def get_user_shared_secret(user_index: int) -> bytes: ... def set_user_shared_secret(user_index: int, value: bytes) -> None: ... ``` ## Remarks Contains the user's secret key, which is essentially a shared secret between the client and server. Shared secrets can be used in TLS-driven protocols, as well as in OTP (where it is called a 'key secret') for generating one-time passwords on one side, and validate them on the other. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # username property The registered name (login) of the user. ## Syntax ```text def get_username(user_index: int) -> str: ... def set_username(user_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The registered name (login) of the user. The *user_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [user_count](#user_count-property) property. # website_name property Specifies the web site name to use in the certificate. ## Syntax ```text def get_website_name() -> str: ... def set_website_name(value: str) -> None: ... website_name = property(get_website_name, set_website_name) ``` ## Default Value "secureblackbox" ## Remarks If using an internally-generated certificate, use this property to specify the web site name to be included as a common name. A typical common name consists of the host name, such as '192.168.10.10' or 'domain.com'. # cleanup method Cleans up the server environment by purging expired sessions and cleaning caches. ## Syntax ```text def cleanup() -> None: ... ``` ## Remarks Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches. # config method Sets or retrieves a configuration setting. ## Syntax ```text def config(configuration_string: str) -> str: ... ``` ## Remarks config is a generic method available in every class. It is used to set and retrieve [configuration settings](#websocketserver-config-settings) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#websocketserver-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_action method Performs an additional action. ## Syntax ```text def do_action(action_id: str, action_params: str) -> str: ... ``` ## Remarks do_action is a generic method available in every class. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time. The unique identifier (case insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | # drop_client method Terminates a client connection. ## Syntax ```text def drop_client(connection_id: int, forced: bool) -> None: ... ``` ## Remarks Call this method to shut down a connected client. *Forced* indicates whether the connection should be closed in a graceful manner. # list_clients method Enumerates the connected clients. ## Syntax ```text def list_clients() -> str: ... ``` ## Remarks This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection. # pin_client method Takes a snapshot of the connection's properties. ## Syntax ```text def pin_client(connection_id: int) -> None: ... ``` ## Remarks Use this method to take a snapshot of a connected client. The captured properties are populated in pinned_client and pinned_client_chain properties. # reset method Resets the class settings. ## Syntax ```text def reset() -> None: ... ``` ## Remarks reset is a generic method available in every class. # send_data method Sends a piece of binary data to the client. ## Syntax ```text def send_data(connection_id: int, buffer: bytes) -> None: ... ``` ## Remarks Use this method to send a piece of binary data to the client. # send_keep_alive method Sends a keep-alive message. ## Syntax ```text def send_keep_alive(connection_id: int) -> None: ... ``` ## Remarks Use this method to send a keep-alive 'ping' to the client. The response, if it comes back, will be reported via the [on_keep_alive_response](#on_keep_alive_response-event) event. Keep-alive messages provide good means for keeping the connection alive and stay immune to timeouts. # send_text method Sends a piece of text data to the client. ## Syntax ```text def send_text(connection_id: int, text: str) -> None: ... ``` ## Remarks Use this method to send a piece of text data to the client. # set_response_bytes method Sets a byte array to be served as a response. ## Syntax ```text def set_response_bytes(connection_id: int, bytes: bytes, content_type: str, response_filter: str, more_to_follow: bool) -> None: ... ``` ## Remarks Use this property to provide the response content in a byte array. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. Set the *MoreToFollow* parameter to true if you expect to provide more response data for this request. Setting *MoreToFollow* to true tells the server to use chunked encoding when supplying the response. The only response filter currently supported is *parts*: | | | | --- | --- | | parts[Index] | The body of a particular part of a multipart response. | # set_response_status method Sets an HTTP status to be sent with the response. ## Syntax ```text def set_response_status(connection_id: int, status_code: int) -> None: ... ``` ## Remarks Use this method to set an HTTP status for the request. A good place to call this method is a request-marking event, such as [on_get_request](#on_get_request-event). # set_response_string method Sets a string to be served as a response. ## Syntax ```text def set_response_string(connection_id: int, data_str: str, content_type: str, response_filter: str, more_to_follow: bool) -> None: ... ``` ## Remarks Use this property to provide the response content in a string. The *ResponseFilter* parameter lets you select the element of the response that you would like to set with this call. The empty filter stands for the entire response body. Set the *MoreToFollow* parameter to true if you expect to provide more response data for this request. Setting *MoreToFollow* to true tells the server to use chunked encoding when supplying the response. The only response filter currently supported is *parts*: | | | | --- | --- | | parts[Index] | The body of a particular part of a multipart response. | # start method Starts the server. ## Syntax ```text def start() -> None: ... ``` ## Remarks Use this method to activate the server and start listening to incoming connections. # stop method Stops the server. ## Syntax ```text def stop() -> None: ... ``` ## Remarks Call this method to stop listening to incoming connections and deactivate the server. # on_accept event Reports an incoming connection. ## Syntax ```text class WebSocketServerAcceptEventParams(object): @property def remote_address() -> str: ... @property def remote_port() -> int: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class WebSocketServer: @property def on_accept() -> Callable[[WebSocketServerAcceptEventParams], None]: ... @on_accept.setter def on_accept(event_hook: Callable[[WebSocketServerAcceptEventParams], None]) -> None: ... ``` ## Remarks This event is fired when a new connection from *RemoteAddress*:*RemotePort* is ready to be accepted. Use the *Accept* parameter to accept or decline it. Subscribe to [on_connect](#on_connect-event) event to be notified of every connection that has been set up. # on_auth_attempt event Fires when a connected client makes an authentication attempt. ## Syntax ```text class WebSocketServerAuthAttemptEventParams(object): @property def connection_id() -> int: ... @property def http_method() -> str: ... @property def uri() -> str: ... @property def auth_method() -> str: ... @property def username() -> str: ... @property def password() -> str: ... @property def allow() -> bool: ... @allow.setter def allow(value) -> None: ... # In class WebSocketServer: @property def on_auth_attempt() -> Callable[[WebSocketServerAuthAttemptEventParams], None]: ... @on_auth_attempt.setter def on_auth_attempt(event_hook: Callable[[WebSocketServerAuthAttemptEventParams], None]) -> None: ... ``` ## Remarks The class fires this event whenever a client attempts to authenticate itself. Use the *Allow* parameter to let the client through. *ConnectionID* contains the unique session identifier for that client, *HTTPMethod* specifies the HTTP method (GET, POST, etc.) used to access the *URI* resource, *AuthMethod* specifies the authentication method, and *Username* and *Password* contain the professed credentials. **Note:** In case of OAuth 2.0 authentication, *Password* contains an access token to be validated. # on_binary_data event Passes a received chunk of binary data to the application. ## Syntax ```text class WebSocketServerBinaryDataEventParams(object): @property def connection_id() -> int: ... @property def buffer() -> bytes: ... @property def last() -> bool: ... # In class WebSocketServer: @property def on_binary_data() -> Callable[[WebSocketServerBinaryDataEventParams], None]: ... @on_binary_data.setter def on_binary_data(event_hook: Callable[[WebSocketServerBinaryDataEventParams], None]) -> None: ... ``` ## Remarks The class fires this event repeatedly to pass incoming pieces of binary data to the application. The *Last* parameter indicates that this is the last chunk. # on_connect event Reports an accepted connection. ## Syntax ```text class WebSocketServerConnectEventParams(object): @property def connection_id() -> int: ... @property def remote_address() -> str: ... @property def remote_port() -> int: ... # In class WebSocketServer: @property def on_connect() -> Callable[[WebSocketServerConnectEventParams], None]: ... @on_connect.setter def on_connect(event_hook: Callable[[WebSocketServerConnectEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to report that a new connection has been established. *ConnectionId* indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as [on_tls_handshake](#on_tls_handshake-event) or [on_data](#on_data-event). # on_data event Supplies a data chunk received within a POST or PUT upload. ## Syntax ```text class WebSocketServerDataEventParams(object): @property def connection_id() -> int: ... @property def buffer() -> bytes: ... # In class WebSocketServer: @property def on_data() -> Callable[[WebSocketServerDataEventParams], None]: ... @on_data.setter def on_data(event_hook: Callable[[WebSocketServerDataEventParams], None]) -> None: ... ``` ## Remarks This event is fired to supply another piece of data received within a POST or PUT upload operation. This event may fire multiple times during a single request upload to pass the uploaded data to the application chunk-by-chunk. # on_disconnect event Fires to report a disconnected client. ## Syntax ```text class WebSocketServerDisconnectEventParams(object): @property def connection_id() -> int: ... # In class WebSocketServer: @property def on_disconnect() -> Callable[[WebSocketServerDisconnectEventParams], None]: ... @on_disconnect.setter def on_disconnect(event_hook: Callable[[WebSocketServerDisconnectEventParams], None]) -> None: ... ``` ## Remarks The class fires this event when a connected client disconnects. # on_error event Information about errors during data delivery. ## Syntax ```text class WebSocketServerErrorEventParams(object): @property def connection_id() -> int: ... @property def error_code() -> int: ... @property def fatal() -> bool: ... @property def remote() -> bool: ... @property def description() -> str: ... # In class WebSocketServer: @property def on_error() -> Callable[[WebSocketServerErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[WebSocketServerErrorEventParams], None]) -> None: ... ``` ## 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](#websocketserver-errors) section. # on_external_sign event Handles remote or external signing initiated by the server protocol. ## Syntax ```text class WebSocketServerExternalSignEventParams(object): @property def connection_id() -> int: ... @property def operation_id() -> str: ... @property def hash_algorithm() -> str: ... @property def pars() -> str: ... @property def data() -> str: ... @property def signed_data() -> str: ... @signed_data.setter def signed_data(value) -> None: ... # In class WebSocketServer: @property def on_external_sign() -> Callable[[WebSocketServerExternalSignEventParams], None]: ... @on_external_sign.setter def on_external_sign(event_hook: Callable[[WebSocketServerExternalSignEventParams], None]) -> None: ... ``` ## Remarks Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed. The event handler must pass the value of *Data* to the signer, obtain the signature, and pass it back to the class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # on_get_request event Reports a GET request. ## Syntax ```text class WebSocketServerGetRequestEventParams(object): @property def connection_id() -> int: ... @property def uri() -> str: ... @property def handled() -> bool: ... @handled.setter def handled(value) -> None: ... # In class WebSocketServer: @property def on_get_request() -> Callable[[WebSocketServerGetRequestEventParams], None]: ... @on_get_request.setter def on_get_request(event_hook: Callable[[WebSocketServerGetRequestEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to notify the application about a GET request received from the client. *ConnectionID* indicates the connection that sent the request and *URI* suggests the requested resource. Set *Handled* to true to indicate that your application's code will take care of the request. The application does it by providing the necessary details via [set_response_status](#set_response_status-method), set_response_header, set_response_file or [set_response_string](#set_response_string-method) methods. If the returned value of *Handled* is false, the server will try to take care of the request automatically by searching for the requested resource in document_root. # on_keep_alive_response event Reports a response to a keep-alive message. ## Syntax ```text class WebSocketServerKeepAliveResponseEventParams(object): @property def connection_id() -> int: ... # In class WebSocketServer: @property def on_keep_alive_response() -> Callable[[WebSocketServerKeepAliveResponseEventParams], None]: ... @on_keep_alive_response.setter def on_keep_alive_response(event_hook: Callable[[WebSocketServerKeepAliveResponseEventParams], None]) -> None: ... ``` ## Remarks This event is triggered when a response to a previously sent keep-alive message is received. # on_notification event This event notifies the application about an underlying control flow event. ## Syntax ```text class WebSocketServerNotificationEventParams(object): @property def event_id() -> str: ... @property def event_param() -> str: ... # In class WebSocketServer: @property def on_notification() -> Callable[[WebSocketServerNotificationEventParams], None]: ... @on_notification.setter def on_notification(event_hook: Callable[[WebSocketServerNotificationEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. This class can fire this event with the following *EventID* values: | | | | --- | --- | | Open | Notifies the application about an established websocket request. This is a backward-compatibility-only notification: use OnWebSocketConnect event to get that notification instead. | | Close | Notifies the application that a websocket connection was closed. This is a backward-compatibility-only notification. Use OnWebSocketDisconnect event instead. | # on_text_data event Passes a received chunk of text data to the application. ## Syntax ```text class WebSocketServerTextDataEventParams(object): @property def connection_id() -> int: ... @property def text() -> str: ... @property def last() -> bool: ... # In class WebSocketServer: @property def on_text_data() -> Callable[[WebSocketServerTextDataEventParams], None]: ... @on_text_data.setter def on_text_data(event_hook: Callable[[WebSocketServerTextDataEventParams], None]) -> None: ... ``` ## Remarks The class fires this event repeatedly to pass incoming pieces of text data to the application. The *Last* parameter indicates that this is the last chunk. # on_tls_cert_validate event Fires when a client certificate needs to be validated. ## Syntax ```text class WebSocketServerTLSCertValidateEventParams(object): @property def connection_id() -> int: ... @property def accept() -> bool: ... @accept.setter def accept(value) -> None: ... # In class WebSocketServer: @property def on_tls_cert_validate() -> Callable[[WebSocketServerTLSCertValidateEventParams], None]: ... @on_tls_cert_validate.setter def on_tls_cert_validate(event_hook: Callable[[WebSocketServerTLSCertValidateEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the *Accept* parameter. # on_tls_established event Reports the setup of a TLS session. ## Syntax ```text class WebSocketServerTLSEstablishedEventParams(object): @property def connection_id() -> int: ... # In class WebSocketServer: @property def on_tls_established() -> Callable[[WebSocketServerTLSEstablishedEventParams], None]: ... @on_tls_established.setter def on_tls_established(event_hook: Callable[[WebSocketServerTLSEstablishedEventParams], None]) -> None: ... ``` ## Remarks Subscribe to this event to be notified about the setup of a TLS connection by a connected client. # on_tls_handshake event Fires when a newly established client connection initiates a TLS handshake. ## Syntax ```text class WebSocketServerTLSHandshakeEventParams(object): @property def connection_id() -> int: ... @property def server_name() -> str: ... @property def abort() -> bool: ... @abort.setter def abort(value) -> None: ... # In class WebSocketServer: @property def on_tls_handshake() -> Callable[[WebSocketServerTLSHandshakeEventParams], None]: ... @on_tls_handshake.setter def on_tls_handshake(event_hook: Callable[[WebSocketServerTLSHandshakeEventParams], None]) -> None: ... ``` ## Remarks Use this event to get notified about the initiation of the TLS handshake by the remote client. The *ServerName* parameter specifies the requested host from the client hello message. # on_tls_psk event Requests a pre-shared key for TLS-PSK. ## Syntax ```text class WebSocketServerTLSPSKEventParams(object): @property def connection_id() -> int: ... @property def identity() -> str: ... @property def psk() -> str: ... @psk.setter def psk(value) -> None: ... @property def ciphersuite() -> str: ... @ciphersuite.setter def ciphersuite(value) -> None: ... # In class WebSocketServer: @property def on_tls_psk() -> Callable[[WebSocketServerTLSPSKEventParams], None]: ... @on_tls_psk.setter def on_tls_psk(event_hook: Callable[[WebSocketServerTLSPSKEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to report that a client has requested a TLS-PSK negotiation. *ConnectionId* indicates the unique connection ID that requested the PSK handshake. Use *Identity* to look up for the corresponding pre-shared key in the server's database, then assign the key to the *PSK* parameter. If TLS 1.3 PSK is used, you will also need to assign the *Ciphersuite* parameter with the cipher suite associated with that identity and their key. # on_tls_shutdown event Reports closure of a TLS session. ## Syntax ```text class WebSocketServerTLSShutdownEventParams(object): @property def connection_id() -> int: ... # In class WebSocketServer: @property def on_tls_shutdown() -> Callable[[WebSocketServerTLSShutdownEventParams], None]: ... @on_tls_shutdown.setter def on_tls_shutdown(event_hook: Callable[[WebSocketServerTLSShutdownEventParams], None]) -> None: ... ``` ## Remarks The class fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a [on_disconnect](#on_disconnect-event), which marks the closure of the underlying TCP session. # on_web_socket_connect event Reports an accepted WebSocket connection. ## Syntax ```text class WebSocketServerWebSocketConnectEventParams(object): @property def connection_id() -> int: ... @property def query_string() -> str: ... @property def key() -> str: ... @property def sub_protocol() -> str: ... @property def extensions() -> str: ... # In class WebSocketServer: @property def on_web_socket_connect() -> Callable[[WebSocketServerWebSocketConnectEventParams], None]: ... @on_web_socket_connect.setter def on_web_socket_connect(event_hook: Callable[[WebSocketServerWebSocketConnectEventParams], None]) -> None: ... ``` ## Remarks The class fires this event to report that a new WebSocket connection has been established. *ConnectionId* indicates the unique ID assigned to this connection. # on_web_socket_disconnect event Fires to report a disconnected WebSocket client. ## Syntax ```text class WebSocketServerWebSocketDisconnectEventParams(object): @property def connection_id() -> int: ... # In class WebSocketServer: @property def on_web_socket_disconnect() -> Callable[[WebSocketServerWebSocketDisconnectEventParams], None]: ... @on_web_socket_disconnect.setter def on_web_socket_disconnect(event_hook: Callable[[WebSocketServerWebSocketDisconnectEventParams], None]) -> None: ... ``` ## Remarks The class fires this event when a connected WebSocket client disconnects. # WebSocketServer Config Settings The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [config](#config-method) method. ### WebSocketServer Config Settings **AllowKeepAlive**: Enables or disables keep-alive mode.Use this property to enable or disable the keep-alive connection mode. If keep-alive is enabled, clients that choose to use it may stay connected for a while. **AllowOptionsResponseWithoutAuth**: Enables unauthenticated responses to OPTIONS requests.Set this property to true to allow the server serve OPTIONS requests without prior authentication of the client. **AuthBasic**: Turns on/off the basic authentication.When switched on, connecting clients can use the basic authentication. **AuthDigest**: Turns on/off the digest authentication.When switched on, connecting clients can use the digest authentication. **AuthDigestExpire**: Specifies digest expiration time for digest authentication.Use this property to specify the digest expiration time for digest authentication, in seconds. The default setting is 20. **AuthRealm**: Specifies authentication realm for digest and NTLM authentication.Specifies authentication realm for digest and NTLM authentication types. **BoundAddress**: Returns the bound address of the listening socket.Use this property to obtain the bound address of the listening socket. **BoundPort**: The port that was bound by the server.Returns the port number that was bound by the server. **CompressionLevel**: The default compression level to use.Assign this property with the compression level (1 to 9) to apply for gzipped responses. 1 stands for the lightest but fastest compression, and 9 for the best but the slowest. **DocumentRoot**: The document root of the server.Use this property to specify a local folder which is going to be the server's document root (the mount point of the virtual home directory). **DualStack**: Allows the use of ip4 and ip6 simultaneously.This setting specifies a socket can use ip4 and ip6 simultaneously. **HandshakeTimeout**: The HTTPS handshake timeout.The HTTPS handshake timeout in milliseconds. **HomePage**: Specifies the home page resource name.Use this property to specify the home page (/) resource name. **Host**: The host to bind to.Specifies a specific interface the server should listen on. **OAuthAllowAccessByDefault**: Specifies whether access to a resource is allowed by default.Use this property to enable or disable access to a resource in case if no scopes defined or the resource doesn't match any of the user's scopes. **OAuthAutoValidateTokens**: Allows to validate OAuth 2.0 access tokens automatically.Use this property to enable or disable pre-validation of access tokens. **OAuthIntrospectionClientID**: Specifies a client ID on the authentication service.Use this property to provide a client ID for access token introspection. **OAuthIntrospectionClientSecret**: Specifies a client secret on the authentication service.Use this property to provide a client secret for access token introspection. **OAuthIntrospectionURL**: Specifies the URL to be used to introspect access tokens.Use this property to provide the URL for introspection. **OAuthTokenValidationKeys**: Specifies JW keys in JSON format for validating access token signatures. **Port**: The port to listen on.This config setting mimics the Port property. Please use that instead. **PortRangeFrom**: The lower bound of allowed port scope to listen on.Specifies the lowest port number the server may use if dynamic allocation is used. **PortRangeTo**: The higher bound of allowed port scope to listen on.Specifies the highest port number the server may use if dynamic allocation is used. **PreSharedIdentityHint**: Gets or sets the PSK identity hint.Use this property to get or set the PSK identity hint to be used during PSK-based TLS handshake. **RequestFilter**: The request string modifier.Use this property to tune up the request string as returned by GetRequestString method. Supported filters: params (request parameters only), params[Index] or params['Name'] (a specific request parameter), parts[Index] (the contents of a particular part of a multipart message). An empty request filter makes GetRequestString return the whole body of the request. **SessionTimeout**: The HTTP session timeout.The HTTP session timeout in milliseconds. **SleepLen**: Adjusts the server loop idling time.Use this property to adjust the server connection loop idling time between consecutive connection read calls. Increasing this setting may help combat excessive CPU usage in performance-restricted or busy environments. Setting it to zero removes the idling altogether, which maximizes the throughput but may cause excessive CPU load. **TempDir**: A temporary directory to use.Specifies the temporary directory to use during server operation. **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 **TLSServerCertIndex**: Specifies the index of the server certificate to use.This setting allows your code to specify the exact certificate/chain to use for the TLS handshake that has just commenced, if your server is configured with more than one chain. This property should typically be adjusted from within the OnTLSHandshake event handler. Note: the server component normally picks up the most appropriate certificate automatically. This setting is a wiretap for scenarios where unusual or cherry-picked certificate selection logic may be necessary. **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. **UseChunkedTransfer**: Enables chunked transfer.Use this property to enable chunked content encoding. **UseCompression**: Enables or disables server-side compression.Use this property to enable or disable server-side content compression. **WebsiteName**: The website name for the TLS certificate.Assign this property with a name to put in a self-generated TLS certificate. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # WebSocketServer Errors ### WebSocketServer 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)) |