WebSocketClient Class
Properties Methods Events Configuration Settings Errors
The WebSocketClient class provides the client-side functionality of the WebSocket protocol.
Syntax
class secureblackbox.WebSocketClient
Remarks
Use this component to set up secure connections from your application with a WebSocket server.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
blocked_cert_count | The number of records in the BlockedCert arrays. |
blocked_cert_bytes | Returns raw certificate data in DER format. |
blocked_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
client_cert_count | The number of records in the ClientCert arrays. |
client_cert_bytes | Returns raw certificate data in DER format. |
client_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
connected | Indicates whether the connection is active. |
conn_info_aead_cipher | Indicates whether the encryption algorithm used is an AEAD cipher. |
conn_info_chain_validation_details | The details of a certificate chain validation outcome. |
conn_info_chain_validation_result | The outcome of a certificate chain validation routine. |
conn_info_ciphersuite | The cipher suite employed by this connection. |
conn_info_client_authenticated | Specifies whether client authentication was performed during this connection. |
conn_info_client_auth_requested | Specifies whether client authentication was requested during this connection. |
conn_info_connection_established | Indicates whether the connection has been established fully. |
conn_info_connection_id | The unique identifier assigned to this connection. |
conn_info_digest_algorithm | The digest algorithm used in a TLS-enabled connection. |
conn_info_encryption_algorithm | The symmetric encryption algorithm used in a TLS-enabled connection. |
conn_info_exportable | Indicates whether a TLS connection uses a reduced-strength exportable cipher. |
conn_info_key_exchange_algorithm | The key exchange algorithm used in a TLS-enabled connection. |
conn_info_key_exchange_key_bits | The length of the key exchange key of a TLS-enabled connection. |
conn_info_named_ec_curve | The elliptic curve used in this connection. |
conn_info_pfs_cipher | Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS). |
conn_info_pre_shared_identity_hint | A hint professed by the server to help the client select the PSK identity to use. |
conn_info_public_key_bits | The length of the public key. |
conn_info_resumed_session | Indicates whether a TLS-enabled connection was spawned from another TLS connection. |
conn_info_secure_connection | Indicates whether TLS or SSL is enabled for this connection. |
conn_info_server_authenticated | Indicates whether server authentication was performed during a TLS-enabled connection. |
conn_info_signature_algorithm | The signature algorithm used in a TLS handshake. |
conn_info_symmetric_block_size | The block size of the symmetric algorithm used. |
conn_info_symmetric_key_bits | The key length of the symmetric algorithm used. |
conn_info_total_bytes_received | The total number of bytes received over this connection. |
conn_info_total_bytes_sent | The total number of bytes sent over this connection. |
conn_info_validation_log | Contains the server certificate's chain validation log. |
conn_info_version | Indicates the version of SSL/TLS protocol negotiated during this connection. |
external_crypto_custom_params | Custom parameters to be passed to the signing service (uninterpreted). |
external_crypto_data | Additional data to be included in the async state and mirrored back by the requestor. |
external_crypto_external_hash_calculation | Specifies whether the message hash is to be calculated at the external endpoint. |
external_crypto_hash_algorithm | Specifies the request's signature hash algorithm. |
external_crypto_key_id | The ID of the pre-shared key used for DC request authentication. |
external_crypto_key_secret | The pre-shared key used for DC request authentication. |
external_crypto_method | Specifies the asynchronous signing method. |
external_crypto_mode | Specifies the external cryptography mode. |
external_crypto_public_key_algorithm | Provide public key algorithm here if the certificate is not available on the pre-signing stage. |
known_cert_count | The number of records in the KnownCert arrays. |
known_cert_bytes | Returns raw certificate data in DER format. |
known_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
known_crl_count | The number of records in the KnownCRL arrays. |
known_crl_bytes | Returns raw CRL data in DER format. |
known_crl_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
known_ocsp_count | The number of records in the KnownOCSP arrays. |
known_ocsp_bytes | Buffer containing raw OCSP response data. |
known_ocsp_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
proxy_address | The IP address of the proxy server. |
proxy_authentication | The authentication type used by the proxy server. |
proxy_password | The password to authenticate to the proxy server. |
proxy_port | The port on the proxy server to connect to. |
proxy_proxy_type | The type of the proxy server. |
proxy_request_headers | Contains HTTP request headers for WebTunnel and HTTP proxy. |
proxy_response_body | Contains the HTTP or HTTPS (WebTunnel) proxy response body. |
proxy_response_headers | Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. |
proxy_use_i_pv6 | Specifies whether IPv6 should be used when connecting through the proxy. |
proxy_use_proxy | Enables or disables proxy-driven connection. |
proxy_username | Specifies the username credential for proxy authentication. |
req_params_accept | Specifies the Accept header property of the HTTP request. |
req_params_accept_charset | Specifies the Accept-Charset header property of the HTTP request. |
req_params_accept_language | Specifies the Accept-Language header property of the HTTP request. |
req_params_accept_range_end | This property, in combination with AcceptRangeStart, defines the media-range of the HTTP request. |
req_params_accept_range_start | This property, in combination with AcceptRangeEnd, defines the media-range of the HTTP request. |
req_params_authorization | Specifies the Authorization header of the HTTP request. |
req_params_connection | Specifies the value to pass to the Connection header property of HTTP request. |
req_params_content_length | Specifies the size of the entity-body of the HTTP request. |
req_params_content_range_end | Specifies the upper bound used in the Content-Range header of the HTTP request. |
req_params_content_range_full_size | Specifies the total length of the full entity-body of the HTTP request. |
req_params_content_range_start | Specifies the lower bound used in the Content-Range header of the HTTP request. |
req_params_content_type | The Content-Type header property of the HTTP request. |
req_params_cookie | This header is expected to be assigned with cookies previously received from the server and stored by the client. |
req_params_custom_headers | Assign any custom HTTP headers to be passed to the server to this property. |
req_params_date | The date and time of the request. |
req_params_from | Contains the From header property of the HTTP request. |
req_params_host | This property contains the Host header property of the HTTP request. |
req_params_http_version | Specifies the version of HTTP protocol to use: 1. |
req_params_if_match | Contains the If-Match request header property. |
req_params_if_modified_since | Contains the If-Modified-Since request header property. |
req_params_if_none_match | Contains the If-None-Match request header property. |
req_params_if_unmodified_since | Contains the If-Unmodified-Since request header property. |
req_params_password | Assign this property with the user's password. |
req_params_referer | The Referer property of the HTTP request header specifies the address of the resource from which the Request-URI was obtained (the referrer). |
req_params_user_agent | The User-Agent property of the HTTP request provides information about the software that initiates the request. |
req_params_username | Assign this property with the user's login name. |
server_cert_count | The number of records in the ServerCert arrays. |
server_cert_bytes | Returns raw certificate data in DER format. |
server_cert_ca_key_id | A unique identifier (fingerprint) of the CA certificate's private key. |
server_cert_fingerprint | Contains the fingerprint (a hash imprint) of this certificate. |
server_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
server_cert_issuer | The common name of the certificate issuer (CA), typically a company name. |
server_cert_issuer_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer. |
server_cert_key_algorithm | Specifies the public key algorithm of this certificate. |
server_cert_key_bits | Returns the length of the public key. |
server_cert_key_fingerprint | Returns a fingerprint of the public key contained in the certificate. |
server_cert_key_usage | Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set. |
server_cert_public_key_bytes | Contains the certificate's public key in DER format. |
server_cert_self_signed | Indicates whether the certificate is self-signed (root) or signed by an external CA. |
server_cert_serial_number | Returns the certificate's serial number. |
server_cert_sig_algorithm | Indicates the algorithm that was used by the CA to sign this certificate. |
server_cert_subject | The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. |
server_cert_subject_key_id | Contains a unique identifier (fingerprint) of the certificate's private key. |
server_cert_subject_rdn | A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject). |
server_cert_valid_from | The time point at which the certificate becomes valid, in UTC. |
server_cert_valid_to | The time point at which the certificate expires, in UTC. |
socket_dns_mode | Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system. |
socket_dns_port | Specifies the port number to be used for sending queries to the DNS server. |
socket_dns_query_timeout | The timeout (in milliseconds) for each DNS query. |
socket_dns_servers | The addresses of DNS servers to use for address resolution, separated by commas or semicolons. |
socket_dns_total_timeout | The timeout (in milliseconds) for the whole resolution process. |
socket_incoming_speed_limit | The maximum number of bytes to read from the socket, per second. |
socket_local_address | The local network interface to bind the socket to. |
socket_local_port | The local port number to bind the socket to. |
socket_outgoing_speed_limit | The maximum number of bytes to write to the socket, per second. |
socket_timeout | The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful. |
socket_use_i_pv6 | Enables or disables IP protocol version 6. |
tls_auto_validate_certificates | Specifies whether server-side TLS certificates should be validated automatically using internal validation rules. |
tls_base_configuration | Selects the base configuration for the TLS settings. |
tls_ciphersuites | A list of ciphersuites separated with commas or semicolons. |
tlsec_curves | Defines the elliptic curves to enable. |
tls_force_resume_if_destination_changes | Whether to force TLS session resumption when the destination address changes. |
tls_pre_shared_identity | Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated. |
tls_pre_shared_key | Contains the pre-shared for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16. |
tls_pre_shared_key_ciphersuite | Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation. |
tls_renegotiation_attack_prevention_mode | Selects renegotiation attack prevention mechanism. |
tls_revocation_check | Specifies the kind(s) of revocation check to perform. |
tlsssl_options | 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. |
tlstls_mode | Specifies the TLS mode to use. |
tls_use_extended_master_secret | Enables Extended Master Secret Extension, as defined in RFC 7627. |
tls_use_session_resumption | Enables or disables TLS session resumption capability. |
tls_versions | Th SSL/TLS versions to enable by default. |
trusted_cert_count | The number of records in the TrustedCert arrays. |
trusted_cert_bytes | Returns raw certificate data in DER format. |
trusted_cert_handle | Allows to get or set a 'handle', a unique identifier of the underlying property object. |
use_digest_auth | Enables or disables the HTTP Digest authentication. |
use_ntlm_auth | Enables or disables NTLM authentication. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
config | Sets or retrieves a configuration setting. |
connect | Establishes connection to the server. |
disconnect | Disconnects from the server. |
send_data | Sends a piece of binary data to the server. |
send_keep_alive | Sends a keep-alive message. |
send_text | Sends a piece of text data to 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_binary_data | Passes a received chunk of binary data to the application. |
on_certificate_validate | Fires when the server's TLS certificate has to be validated. |
on_error | Information about errors during data delivery. |
on_external_sign | Handles remote or external signing initiated by the SignExternal method or other source. |
on_keep_alive_response | Reports a response to a keep-alive message. |
on_notification | This event notifies the application about an underlying control flow event. |
on_text_data | Passes a received chunk of text data to the application. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
CacheStreamOutput | Tells the class whether to cache stream- and file-bound responses in the class. |
ForceNTLMAuth | Activates and enforces NTLM authentication. |
IgnoreUnknownTransferEncodings | All incoming responses with unknown transfer encodings are ignored if this property is true. |
MaxRedirections | The maximum number of HTTP redirects. |
PersistentAuthHeader | Whether to resend NTLM negotiation on every request. |
RequestCompressionGZip | Ask server to use GZip compression. |
RequestCompressionLevel | Ask server to use the specified compression level. |
SendBufferSize | Size of send buffer in bytes. |
SuppressRedirectionContent | Whether to suppress the redirection content. |
TempPath | Path for storing temporary files. |
Use100Continue | Whether to use 100-continue for POST and PUT commands. |
UseCompression | Whether to use GZip compression. |
CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
Cookies | Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only). |
DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
LogDestination | Specifies the debug log destination. |
LogDetails | Specifies the debug log details to dump. |
LogFile | Specifies the debug log filename. |
LogFilters | Specifies the debug log filters. |
LogFlushMode | Specifies the log flush mode. |
LogLevel | Specifies the debug log level. |
LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
LogRotationMode | Specifies the log rotation mode. |
MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
UseSystemRandom | Enables or disables the use of the OS PRNG. |