Struct secureblackbox::WebSocketServer

Properties   Methods   Events   Config Settings   Errors  

The WebSocketServer struct provides the server-side functionality of the WebSocket protocol.

Syntax

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 and port, 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 and users properties and on_auth_attempt 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 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 and on_web_socket_disconnect, as well as on_binary_data and on_text_data events.

The first two events fire to report clients as they connect and disconnect from your server. The on_web_socket_connect 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, 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_text, and send_keep_alive methods.
• Force client disconnect by passing it to drop_client method.

Once you have set up all the connecting parameters, call start to activate the server. The server runs in a separate thread, so the call is non-blocking. To shut down the server, call stop.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the WebSocketServer struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of WebSocketServer when you have finished using the instance.

Property List

---

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

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

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

active property (WebSocketServer Struct)

Indicates whether the server is active and is listening to new connections.

Syntax

fn active(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

This read-only property returns True if the server is listening to incoming connections.

This property is read-only.

Data Type

bool

auth_types property (WebSocketServer Struct)

Defines allowed HTTP authentication types.

Syntax

fn auth_types(&self ) -> Result<i32, SecureBlackboxError> 
fn set_auth_types(&self, value : i32) ->  Option<SecureBlackboxError> 

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:

Data Type

i32

bound_port property (WebSocketServer Struct)

Indicates the bound listening port.

Syntax

fn bound_port(&self ) -> Result<i32, SecureBlackboxError> 

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 if it is provided, or is allocated dynamically if configured to fall in the range between port_range_from and port_range_to constraints.

This property is read-only.

Data Type

i32

external_crypto_async_document_id property (WebSocketServer Struct)

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

Syntax

fn external_crypto_async_document_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_async_document_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_async_document_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

external_crypto_custom_params property (WebSocketServer Struct)

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

Syntax

fn external_crypto_custom_params(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_custom_params(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_custom_params_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_data property (WebSocketServer Struct)

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

Syntax

fn external_crypto_data(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_data(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_data_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

external_crypto_external_hash_calculation property (WebSocketServer Struct)

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

Syntax

fn external_crypto_external_hash_calculation(&self ) -> Result<bool, SecureBlackboxError> 
fn set_external_crypto_external_hash_calculation(&self, value : bool) ->  Option<SecureBlackboxError> 

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

If set to true, the struct will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

bool

external_crypto_hash_algorithm property (WebSocketServer Struct)

Specifies the request's signature hash algorithm.

Syntax

fn external_crypto_hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

external_crypto_key_id property (WebSocketServer Struct)

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

Syntax

fn external_crypto_key_id(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_id(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_id_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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 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: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

external_crypto_key_secret property (WebSocketServer Struct)

The pre-shared key used for DC request authentication.

Syntax

fn external_crypto_key_secret(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_key_secret(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_key_secret_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

Data Type

String

external_crypto_method property (WebSocketServer Struct)

Specifies the asynchronous signing method.

Syntax

fn external_crypto_method(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_method(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // PKCS1
1   // PKCS7

Default Value

0

Remarks

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

Available options:

Data Type

i32

external_crypto_mode property (WebSocketServer Struct)

Specifies the external cryptography mode.

Syntax

fn external_crypto_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_external_crypto_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Disabled
2   // Generic
3   // DCAuth
4   // DCAuthJSON

Default Value

0

Remarks

Specifies the external cryptography mode.

Available options:

Data Type

i32

external_crypto_public_key_algorithm property (WebSocketServer Struct)

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

Syntax

fn external_crypto_public_key_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_external_crypto_public_key_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

fips_mode property (WebSocketServer Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

handshake_timeout property (WebSocketServer Struct)

Specifies the handshake timeout in milliseconds.

Syntax

fn handshake_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_handshake_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Data Type

i32

host property (WebSocketServer Struct)

The host to bind the listening port to.

Syntax

fn host(&self ) -> Result<String, SecureBlackboxError> 
fn set_host(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_host_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the IP address on which to listen to incoming connections.

Data Type

String

pinned_client_aead_cipher property (WebSocketServer Struct)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

fn pinned_client_aead_cipher(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

bool

pinned_client_chain_validation_details property (WebSocketServer Struct)

The details of a certificate chain validation outcome.

Syntax

fn pinned_client_chain_validation_details(&self ) -> Result<i32, SecureBlackboxError> 

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:

This property is read-only.

Data Type

i32

pinned_client_chain_validation_result property (WebSocketServer Struct)

The outcome of a certificate chain validation routine.

Syntax

fn pinned_client_chain_validation_result(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Valid
1   // ValidButUntrusted
2   // Invalid
3   // CantBeEstablished

Default Value

0

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

This property is read-only.

Data Type

i32

pinned_client_ciphersuite property (WebSocketServer Struct)

The cipher suite employed by this connection.

Syntax

fn pinned_client_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

pinned_client_client_authenticated property (WebSocketServer Struct)

Specifies whether client authentication was performed during this connection.

Syntax

fn pinned_client_client_authenticated(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

bool

pinned_client_client_auth_requested property (WebSocketServer Struct)

Specifies whether client authentication was requested during this connection.

Syntax

fn pinned_client_client_auth_requested(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

bool

pinned_client_connection_established property (WebSocketServer Struct)

Indicates whether the connection has been established fully.

Syntax

fn pinned_client_connection_established(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

bool

pinned_client_connection_id property (WebSocketServer Struct)

The unique identifier assigned to this connection.

Syntax

fn pinned_client_connection_id(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

The unique identifier assigned to this connection.

This property is read-only.

Data Type

Vec

pinned_client_digest_algorithm property (WebSocketServer Struct)

The digest algorithm used in a TLS-enabled connection.

Syntax

fn pinned_client_digest_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

pinned_client_encryption_algorithm property (WebSocketServer Struct)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

fn pinned_client_encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

pinned_client_exportable property (WebSocketServer Struct)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

fn pinned_client_exportable(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only.

Data Type

bool

pinned_client_group property (WebSocketServer Struct)

The elliptic curve used in this connection.

Syntax

fn pinned_client_group(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

pinned_client_id property (WebSocketServer Struct)

The client connection's unique identifier.

Syntax

fn pinned_client_id(&self ) -> Result<i64, SecureBlackboxError> 

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.

Data Type

i64

pinned_client_key_exchange_algorithm property (WebSocketServer Struct)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

fn pinned_client_key_exchange_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

pinned_client_key_exchange_key_bits property (WebSocketServer Struct)

The length of the key exchange key of a TLS-enabled connection.

Syntax

fn pinned_client_key_exchange_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only.

Data Type

i32

pinned_client_pfs_cipher property (WebSocketServer Struct)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

fn pinned_client_pfs_cipher(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only.

Data Type

bool

pinned_client_pre_shared_identity property (WebSocketServer Struct)

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

Syntax

fn pinned_client_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

pinned_client_pre_shared_identity_hint property (WebSocketServer Struct)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

fn pinned_client_pre_shared_identity_hint(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only.

Data Type

String

pinned_client_public_key_bits property (WebSocketServer Struct)

The length of the public key.

Syntax

fn pinned_client_public_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

i32

pinned_client_remote_address property (WebSocketServer Struct)

The client's IP address.

Syntax

fn pinned_client_remote_address(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

pinned_client_remote_port property (WebSocketServer Struct)

The remote port of the client connection.

Syntax

fn pinned_client_remote_port(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

i32

pinned_client_resumed_session property (WebSocketServer Struct)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

fn pinned_client_resumed_session(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only.

Data Type

bool

pinned_client_secure_connection property (WebSocketServer Struct)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

fn pinned_client_secure_connection(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

bool

pinned_client_server_authenticated property (WebSocketServer Struct)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

fn pinned_client_server_authenticated(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only.

Data Type

bool

pinned_client_signature_algorithm property (WebSocketServer Struct)

The signature algorithm used in a TLS handshake.

Syntax

fn pinned_client_signature_algorithm(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

pinned_client_symmetric_block_size property (WebSocketServer Struct)

The block size of the symmetric algorithm used.

Syntax

fn pinned_client_symmetric_block_size(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

i32

pinned_client_symmetric_key_bits property (WebSocketServer Struct)

The key length of the symmetric algorithm used.

Syntax

fn pinned_client_symmetric_key_bits(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

i32

pinned_client_total_bytes_received property (WebSocketServer Struct)

The total number of bytes received over this connection.

Syntax

fn pinned_client_total_bytes_received(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

i64

pinned_client_total_bytes_sent property (WebSocketServer Struct)

The total number of bytes sent over this connection.

Syntax

fn pinned_client_total_bytes_sent(&self ) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

i64

pinned_client_validation_log property (WebSocketServer Struct)

Contains the server certificate's chain validation log.

Syntax

fn pinned_client_validation_log(&self ) -> Result<String, SecureBlackboxError> 

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.

Data Type

String

pinned_client_version property (WebSocketServer Struct)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

fn pinned_client_version(&self ) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only.

Data Type

String

pinned_client_cert_count property (WebSocketServer Struct)

The number of records in the PinnedClientCert arrays.

Syntax

fn pinned_client_cert_count(&self ) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• pinned_client_cert_bytes
• pinned_client_cert_ca_key_id
• pinned_client_cert_fingerprint
• pinned_client_cert_handle
• pinned_client_cert_issuer
• pinned_client_cert_issuer_rdn
• pinned_client_cert_key_algorithm
• pinned_client_cert_key_bits
• pinned_client_cert_key_fingerprint
• pinned_client_cert_key_usage
• pinned_client_cert_public_key_bytes
• pinned_client_cert_self_signed
• pinned_client_cert_serial_number
• pinned_client_cert_sig_algorithm
• pinned_client_cert_subject
• pinned_client_cert_subject_key_id
• pinned_client_cert_subject_rdn
• pinned_client_cert_valid_from
• pinned_client_cert_valid_to

The array indices start at 0 and end at pinned_client_cert_count - 1.

This property is read-only.

Data Type

i32

pinned_client_cert_bytes property (WebSocketServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn pinned_client_cert_bytes(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_ca_key_id property (WebSocketServer Struct)

A unique identifier (fingerprint) of the CA certificate's cryptographic key.

Syntax

fn pinned_client_cert_ca_key_id(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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 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 setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_fingerprint property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_fingerprint(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_handle property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_handle(&self , PinnedClientCertIndex : i32) -> Result<i64, SecureBlackboxError> 

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i64

pinned_client_cert_issuer property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_issuer(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_issuer_rdn property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_issuer_rdn(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_algorithm property (WebSocketServer Struct)

Specifies the public key algorithm of this certificate.

Syntax

fn pinned_client_cert_key_algorithm(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the pinned_client_cert_key_bits, pinned_client_cert_curve, and pinned_client_cert_public_key_bytes properties to get more details about the key the certificate contains.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_bits property (WebSocketServer Struct)

Returns the length of the public key in bits.

Syntax

fn pinned_client_cert_key_bits(&self , PinnedClientCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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 or pinned_client_cert_private_key_bytes property would typically contain auxiliary values, and therefore be longer.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i32

pinned_client_cert_key_fingerprint property (WebSocketServer Struct)

Returns a SHA1 fingerprint of the public key contained in the certificate.

Syntax

fn pinned_client_cert_key_fingerprint(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

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 property. The key fingerprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_key_usage property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_key_usage(&self , PinnedClientCertIndex : i32) -> Result<i32, SecureBlackboxError> 

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:

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

i32

pinned_client_cert_public_key_bytes property (WebSocketServer Struct)

Contains the certificate's public key in DER format.

Syntax

fn pinned_client_cert_public_key_bytes(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_self_signed property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_self_signed(&self , PinnedClientCertIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

bool

pinned_client_cert_serial_number property (WebSocketServer Struct)

Returns the certificate's serial number.

Syntax

fn pinned_client_cert_serial_number(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_sig_algorithm property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_sig_algorithm(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_subject property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_subject(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

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.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_subject_key_id property (WebSocketServer Struct)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

fn pinned_client_cert_subject_key_id(&self , PinnedClientCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

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 and pinned_client_cert_ca_key_id properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

Vec

pinned_client_cert_subject_rdn property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_subject_rdn(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

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 PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_valid_from property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_valid_from(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

pinned_client_cert_valid_to property (WebSocketServer Struct)

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

Syntax

fn pinned_client_cert_valid_to(&self , PinnedClientCertIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

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

The PinnedClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PinnedClientCertCount property.

This property is read-only.

Data Type

String

port property (WebSocketServer Struct)

Specifies the port number to listen for connections on.

Syntax

fn port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_port(&self, value : i32) ->  Option<SecureBlackboxError> 

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 and port_range_to properties. In this case the port will be allocated within the requested range by the operating system, and reported in bound_port.

Data Type

i32

port_range_from property (WebSocketServer Struct)

Specifies the lower limit of the listening port range for incoming connections.

Syntax

fn port_range_from(&self ) -> Result<i32, SecureBlackboxError> 
fn set_port_range_from(&self, value : i32) ->  Option<SecureBlackboxError> 

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), the port will be allocated within the requested range by the operating system, and reported in bound_port.

Note that this property is ignored if the port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

i32

port_range_to property (WebSocketServer Struct)

Specifies the upper limit of the listening port range for incoming connections.

Syntax

fn port_range_to(&self ) -> Result<i32, SecureBlackboxError> 
fn set_port_range_to(&self, value : i32) ->  Option<SecureBlackboxError> 

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), the port will be allocated within the requested range by the operating system, and reported in bound_port.

Note that this property is ignored if the port property is set to a non-zero value, in which case the server always aims to listen on that fixed port.

Data Type

i32

session_timeout property (WebSocketServer Struct)

Specifies the default session timeout value in milliseconds.

Syntax

fn session_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_session_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

360000

Remarks

Specifies the period of inactivity (in milliseconds) after which the connection will be terminated by the server.

Data Type

i32

socket_incoming_speed_limit property (WebSocketServer Struct)

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

Syntax

fn socket_incoming_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_incoming_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_local_address property (WebSocketServer Struct)

The local network interface to bind the socket to.

Syntax

fn socket_local_address(&self ) -> Result<String, SecureBlackboxError> 
fn set_socket_local_address(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_socket_local_address_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

socket_local_port property (WebSocketServer Struct)

The local port number to bind the socket to.

Syntax

fn socket_local_port(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_local_port(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

i32

socket_outgoing_speed_limit property (WebSocketServer Struct)

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

Syntax

fn socket_outgoing_speed_limit(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_outgoing_speed_limit(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

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

Data Type

i32

socket_timeout property (WebSocketServer Struct)

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

Syntax

fn socket_timeout(&self ) -> Result<i32, SecureBlackboxError> 
fn set_socket_timeout(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

60000

Remarks

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

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

Data Type

i32

socket_use_ipv6 property (WebSocketServer Struct)

Enables or disables IP protocol version 6.

Syntax

fn socket_use_ipv6(&self ) -> Result<bool, SecureBlackboxError> 
fn set_socket_use_ipv6(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

bool

tls_server_cert_count property (WebSocketServer Struct)

The number of records in the TLSServerCert arrays.

Syntax

fn tls_server_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_server_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• tls_server_cert_bytes
• tls_server_cert_handle

The array indices start at 0 and end at tls_server_cert_count - 1.

Data Type

i32

tls_server_cert_bytes property (WebSocketServer Struct)

Returns the raw certificate data in DER format.

Syntax

fn tls_server_cert_bytes(&self , TLSServerCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

This property is read-only.

Data Type

Vec

tls_server_cert_handle property (WebSocketServer Struct)

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

Syntax

fn tls_server_cert_handle(&self , TLSServerCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_tls_server_cert_handle(&self, TLSServerCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

Data Type

i64

tls_auto_validate_certificates property (WebSocketServer Struct)

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

Syntax

fn tls_auto_validate_certificates(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_auto_validate_certificates(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

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

Data Type

bool

tls_base_configuration property (WebSocketServer Struct)

Selects the base configuration for the TLS settings.

Syntax

fn tls_base_configuration(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_base_configuration(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // Compatible
2   // ComprehensiveInsecure
3   // 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.

Data Type

i32

tls_ciphersuites property (WebSocketServer Struct)

A list of ciphersuites separated with commas or semicolons.

Syntax

fn tls_ciphersuites(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_ciphersuites(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_ciphersuites_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

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

Data Type

String

tls_client_auth property (WebSocketServer Struct)

Enables or disables certificate-based client authentication.

Syntax

fn tls_client_auth(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_client_auth(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // NoAuth
1   // RequestCert
2   // RequireCert

Default Value

0

Remarks

Enables or disables certificate-based client authentication.

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

Data Type

i32

tls_extensions property (WebSocketServer Struct)

Provides access to TLS extensions.

Syntax

fn tls_extensions(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_extensions(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_extensions_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

tls_force_resume_if_destination_changes property (WebSocketServer Struct)

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

Syntax

fn tls_force_resume_if_destination_changes(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_force_resume_if_destination_changes(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

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

Data Type

bool

tls_groups property (WebSocketServer Struct)

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

Syntax

fn tls_groups(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_groups(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_groups_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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:

// Ensure the two x25519-based groups are enabled and the finite field DHE2048 is disabled client.TLSSettings.Groups = "+x25519mlkem768;+x25519;-ffdhe2048"; // Only enable the hybrid X25519/ML-KEM768 group client.TLSSettings.Groups = "-all;+x25519mlkem768";

The list of groups supported by the component is provided below. All the names are case-insensitive:

Elliptic curve-based groups:

• SECT163K1
• SECT163R1
• SECT163R2
• SECT193R1
• SECT193R2
• SECT233K1
• SECT233R1
• SECT239K1
• SECT283K1
• SECT283R1
• SECT409K1
• SECT409R1
• SECT571K1
• SECT571R1
• SECP160K1
• SECP160R1
• SECP160R2
• SECP192K1
• SECP192R1
• SECP224K1
• SECP224R1
• SECP256K1
• SECP256R1
• SECP384R1
• SECP521R1
• BRAINPOOLP256R1
• BRAINPOOLP384R1
• BRAINPOOLP512R1
• X25519
• X448

Finite field-based groups:

• FFDHE2048
• FFDHE3072
• FFDHE4096
• FFDHE6144
• FFDHE8192

Post-Quantum and Hybrid groups:

• MLKEM512
• MLKEM768
• MLKEM1024
• SECP256R1MLKEM768
• X25519MLKEM768
• SECP384R1MLKEM1024

Note: this property was called ECCurves in SecureBlackbox 2024 and older.

Data Type

String

tls_pre_shared_identity property (WebSocketServer Struct)

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

Syntax

fn tls_pre_shared_identity(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_identity(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_identity_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key property (WebSocketServer Struct)

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

Syntax

fn tls_pre_shared_key(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_pre_shared_key_ciphersuite property (WebSocketServer Struct)

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

Syntax

fn tls_pre_shared_key_ciphersuite(&self ) -> Result<String, SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_tls_pre_shared_key_ciphersuite_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

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

Data Type

String

tls_renegotiation_attack_prevention_mode property (WebSocketServer Struct)

Selects the renegotiation attack prevention mechanism.

Syntax

fn tls_renegotiation_attack_prevention_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_renegotiation_attack_prevention_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Compatible
1   // Strict
2   // Auto

Default Value

2

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

i32

tls_revocation_check property (WebSocketServer Struct)

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

Syntax

fn tls_revocation_check(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_revocation_check(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // None
1   // Auto
2   // AllCRL
3   // AllOCSP
4   // AllCRLAndOCSP
5   // AnyCRL
6   // AnyOCSP
7   // AnyCRLOrOCSP
8   // 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.

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

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

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

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

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

Data Type

i32

tls_ssl_options property (WebSocketServer Struct)

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

fn tls_ssl_options(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_ssl_options(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

i32

tls_mode property (WebSocketServer Struct)

Specifies the TLS mode to use.

Syntax

fn tls_mode(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_mode(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoTLS
2   // ExplicitTLS
3   // ImplicitTLS
4   // MixedTLS

Default Value

0

Remarks

Specifies the TLS mode to use.

Data Type

i32

tls_use_extended_master_secret property (WebSocketServer Struct)

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

Syntax

fn tls_use_extended_master_secret(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_extended_master_secret(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

true

Remarks

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

Data Type

bool

tls_use_session_resumption property (WebSocketServer Struct)

Enables or disables the TLS session resumption capability.

Syntax

fn tls_use_session_resumption(&self ) -> Result<bool, SecureBlackboxError> 
fn set_tls_use_session_resumption(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

bool

tls_versions property (WebSocketServer Struct)

The SSL/TLS versions to enable by default.

Syntax

fn tls_versions(&self ) -> Result<i32, SecureBlackboxError> 
fn set_tls_versions(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

48

Remarks

The SSL/TLS versions to enable by default.

Data Type

i32

user_count property (WebSocketServer Struct)

The number of records in the User arrays.

Syntax

fn user_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_user_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• user_associated_data
• user_base_path
• user_data
• user_handle
• user_hash_algorithm
• user_incoming_speed_limit
• username
• user_outgoing_speed_limit
• user_password
• user_shared_secret

The array indices start at 0 and end at user_count - 1.

Data Type

i32

user_associated_data property (WebSocketServer Struct)

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

Syntax

fn user_associated_data(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_associated_data(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_associated_data_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Contains the user's Associated Data when SSH AEAD (Authenticated Encryption with Associated Data) algorithm is used.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

user_base_path property (WebSocketServer Struct)

Base path for this user in the server's file system.

Syntax

fn user_base_path(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_base_path(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_base_path_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Base path for this user in the server's file system.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_data property (WebSocketServer Struct)

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

Syntax

fn user_data(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_data(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_data_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Contains uninterpreted user-defined data that should be associated with the user account, such as comments or custom settings.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_handle property (WebSocketServer Struct)

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

Syntax

fn user_handle(&self , UserIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_user_handle(&self, UserIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

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. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i64

user_hash_algorithm property (WebSocketServer Struct)

Specifies the hash algorithm used to generate TOTP (Time-based One-Time Passwords) passwords for this user.

Syntax

fn user_hash_algorithm(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_hash_algorithm(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_hash_algorithm_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

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:

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_incoming_speed_limit property (WebSocketServer Struct)

Specifies the incoming speed limit for this user.

Syntax

fn user_incoming_speed_limit(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_incoming_speed_limit(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the incoming speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_outgoing_speed_limit property (WebSocketServer Struct)

Specifies the outgoing speed limit for this user.

Syntax

fn user_outgoing_speed_limit(&self , UserIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_user_outgoing_speed_limit(&self, UserIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Specifies the outgoing speed limit for this user. The value of 0 (zero) means "no limitation".

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

i32

user_password property (WebSocketServer Struct)

The user's authentication password.

Syntax

fn user_password(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_user_password(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_user_password_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The user's authentication password.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

user_shared_secret property (WebSocketServer Struct)

Contains the user's secret key, which is essentially a shared secret between the client and server.

Syntax

fn user_shared_secret(&self , UserIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_user_shared_secret(&self, UserIndex : i32, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_user_shared_secret_ref(&self, UserIndex : i32, value : &[u8]) ->  Option<SecureBlackboxError> 

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 UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

Vec

username property (WebSocketServer Struct)

The registered name (login) of the user.

Syntax

fn username(&self , UserIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_username(&self, UserIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_username_ref(&self, UserIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

The registered name (login) of the user.

The UserIndex parameter specifies the index of the item in the array. The size of the array is controlled by the UserCount property.

Data Type

String

website_name property (WebSocketServer Struct)

Specifies the web site name to use in the certificate.

Syntax

fn website_name(&self ) -> Result<String, SecureBlackboxError> 
fn set_website_name(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_website_name_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

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

Data Type

String

cleanup method (WebSocketServer Struct)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

fn cleanup(&self) -> Result<(), SecureBlackboxError>

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 (WebSocketServer Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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, you must call Config("PROPERTY"). The value will be returned as a string.

do_action method (WebSocketServer Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. 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:

drop_client method (WebSocketServer Struct)

Terminates a client connection.

Syntax

fn drop_client(&self, connection_id : i64, forced : bool) -> Result<(), SecureBlackboxError>

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 (WebSocketServer Struct)

Enumerates the connected clients.

Syntax

fn list_clients(&self) ->  Result<String, SecureBlackboxError>

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 (WebSocketServer Struct)

Takes a snapshot of the connection's properties.

Syntax

fn pin_client(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

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 (WebSocketServer Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

send_data method (WebSocketServer Struct)

Sends a piece of binary data to the client.

Syntax

fn send_data(&self, connection_id : i64, buffer : &[u8]) -> Result<(), SecureBlackboxError>

Remarks

Use this method to send a piece of binary data to the client.

send_keep_alive method (WebSocketServer Struct)

Sends a keep-alive message.

Syntax

fn send_keep_alive(&self, connection_id : i64) -> Result<(), SecureBlackboxError>

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

Keep-alive messages provide good means for keeping the connection alive and stay immune to timeouts.

send_text method (WebSocketServer Struct)

Sends a piece of text data to the client.

Syntax

fn send_text(&self, connection_id : i64, text : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to send a piece of text data to the client.

set_response_bytes method (WebSocketServer Struct)

Sets a byte array to be served as a response.

Syntax

fn set_response_bytes(&self, connection_id : i64, bytes : &[u8], content_type : &str, response_filter : &str, more_to_follow : bool) -> Result<(), SecureBlackboxError>

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:

set_response_status method (WebSocketServer Struct)

Sets an HTTP status to be sent with the response.

Syntax

fn set_response_status(&self, connection_id : i64, status_code : i32) -> Result<(), SecureBlackboxError>

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.

set_response_string method (WebSocketServer Struct)

Sets a string to be served as a response.

Syntax

fn set_response_string(&self, connection_id : i64, data_str : &str, content_type : &str, response_filter : &str, more_to_follow : bool) -> Result<(), SecureBlackboxError>

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:

start method (WebSocketServer Struct)

Starts the server.

Syntax

fn start(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to activate the server and start listening to incoming connections.

stop method (WebSocketServer Struct)

Stops the server.

Syntax

fn stop(&self) -> Result<(), SecureBlackboxError>

Remarks

Call this method to stop listening to incoming connections and deactivate the server.

on_accept event (WebSocketServer Struct)

Reports an incoming connection.

Syntax

// WebSocketServerAcceptEventArgs carries the WebSocketServer Accept event's parameters.
pub struct WebSocketServerAcceptEventArgs {
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// WebSocketServerAcceptEvent defines the signature of the WebSocketServer Accept event's handler function.
pub trait WebSocketServerAcceptEvent {
  fn on_accept(&self, sender : WebSocketServer, e : &mut WebSocketServerAcceptEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_accept(&self) -> &'a dyn WebSocketServerAcceptEvent;
  pub fn set_on_accept(&mut self, value : &'a dyn WebSocketServerAcceptEvent);
  ...
}

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 event to be notified of every connection that has been set up.

on_auth_attempt event (WebSocketServer Struct)

Fires when a connected client makes an authentication attempt.

Syntax

// WebSocketServerAuthAttemptEventArgs carries the WebSocketServer AuthAttempt event's parameters.
pub struct WebSocketServerAuthAttemptEventArgs {
  fn connection_id(&self) -> i64
  fn http_method(&self) -> &String
  fn uri(&self) -> &String
  fn auth_method(&self) -> &String
  fn username(&self) -> &String
  fn password(&self) -> &String
  fn allow(&self) -> bool
  fn set_allow(&self, value : bool)
}

// WebSocketServerAuthAttemptEvent defines the signature of the WebSocketServer AuthAttempt event's handler function.
pub trait WebSocketServerAuthAttemptEvent {
  fn on_auth_attempt(&self, sender : WebSocketServer, e : &mut WebSocketServerAuthAttemptEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_auth_attempt(&self) -> &'a dyn WebSocketServerAuthAttemptEvent;
  pub fn set_on_auth_attempt(&mut self, value : &'a dyn WebSocketServerAuthAttemptEvent);
  ...
}

Remarks

The struct 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 (WebSocketServer Struct)

Passes a received chunk of binary data to the application.

Syntax

// WebSocketServerBinaryDataEventArgs carries the WebSocketServer BinaryData event's parameters.
pub struct WebSocketServerBinaryDataEventArgs {
  fn connection_id(&self) -> i64
  fn buffer(&self) -> &[u8]
  fn last(&self) -> bool
}

// WebSocketServerBinaryDataEvent defines the signature of the WebSocketServer BinaryData event's handler function.
pub trait WebSocketServerBinaryDataEvent {
  fn on_binary_data(&self, sender : WebSocketServer, e : &mut WebSocketServerBinaryDataEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_binary_data(&self) -> &'a dyn WebSocketServerBinaryDataEvent;
  pub fn set_on_binary_data(&mut self, value : &'a dyn WebSocketServerBinaryDataEvent);
  ...
}

Remarks

The struct 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 (WebSocketServer Struct)

Reports an accepted connection.

Syntax

// WebSocketServerConnectEventArgs carries the WebSocketServer Connect event's parameters.
pub struct WebSocketServerConnectEventArgs {
  fn connection_id(&self) -> i64
  fn remote_address(&self) -> &String
  fn remote_port(&self) -> i32
}

// WebSocketServerConnectEvent defines the signature of the WebSocketServer Connect event's handler function.
pub trait WebSocketServerConnectEvent {
  fn on_connect(&self, sender : WebSocketServer, e : &mut WebSocketServerConnectEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_connect(&self) -> &'a dyn WebSocketServerConnectEvent;
  pub fn set_on_connect(&mut self, value : &'a dyn WebSocketServerConnectEvent);
  ...
}

Remarks

The struct 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 or on_data.

on_data event (WebSocketServer Struct)

Supplies a data chunk received within a POST or PUT upload.

Syntax

// WebSocketServerDataEventArgs carries the WebSocketServer Data event's parameters.
pub struct WebSocketServerDataEventArgs {
  fn connection_id(&self) -> i64
  fn buffer(&self) -> &[u8]
}

// WebSocketServerDataEvent defines the signature of the WebSocketServer Data event's handler function.
pub trait WebSocketServerDataEvent {
  fn on_data(&self, sender : WebSocketServer, e : &mut WebSocketServerDataEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_data(&self) -> &'a dyn WebSocketServerDataEvent;
  pub fn set_on_data(&mut self, value : &'a dyn WebSocketServerDataEvent);
  ...
}

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 (WebSocketServer Struct)

Fires to report a disconnected client.

Syntax

// WebSocketServerDisconnectEventArgs carries the WebSocketServer Disconnect event's parameters.
pub struct WebSocketServerDisconnectEventArgs {
  fn connection_id(&self) -> i64
}

// WebSocketServerDisconnectEvent defines the signature of the WebSocketServer Disconnect event's handler function.
pub trait WebSocketServerDisconnectEvent {
  fn on_disconnect(&self, sender : WebSocketServer, e : &mut WebSocketServerDisconnectEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_disconnect(&self) -> &'a dyn WebSocketServerDisconnectEvent;
  pub fn set_on_disconnect(&mut self, value : &'a dyn WebSocketServerDisconnectEvent);
  ...
}

Remarks

The struct fires this event when a connected client disconnects.

on_error event (WebSocketServer Struct)

Information about errors during data delivery.

Syntax

// WebSocketServerErrorEventArgs carries the WebSocketServer Error event's parameters.
pub struct WebSocketServerErrorEventArgs {
  fn connection_id(&self) -> i64
  fn error_code(&self) -> i32
  fn fatal(&self) -> bool
  fn remote(&self) -> bool
  fn description(&self) -> &String
}

// WebSocketServerErrorEvent defines the signature of the WebSocketServer Error event's handler function.
pub trait WebSocketServerErrorEvent {
  fn on_error(&self, sender : WebSocketServer, e : &mut WebSocketServerErrorEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_error(&self) -> &'a dyn WebSocketServerErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn WebSocketServerErrorEvent);
  ...
}

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

on_external_sign event (WebSocketServer Struct)

Handles remote or external signing initiated by the server protocol.

Syntax

// WebSocketServerExternalSignEventArgs carries the WebSocketServer ExternalSign event's parameters.
pub struct WebSocketServerExternalSignEventArgs {
  fn connection_id(&self) -> i64
  fn operation_id(&self) -> &String
  fn hash_algorithm(&self) -> &String
  fn pars(&self) -> &String
  fn data(&self) -> &String
  fn signed_data(&self) -> &String
  fn set_signed_data(&self, value : &str)
  fn set_signed_data_ref(&self, value : &String)
}

// WebSocketServerExternalSignEvent defines the signature of the WebSocketServer ExternalSign event's handler function.
pub trait WebSocketServerExternalSignEvent {
  fn on_external_sign(&self, sender : WebSocketServer, e : &mut WebSocketServerExternalSignEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_external_sign(&self) -> &'a dyn WebSocketServerExternalSignEvent;
  pub fn set_on_external_sign(&mut self, value : &'a dyn WebSocketServerExternalSignEvent);
  ...
}

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 struct via the SignedData parameter.

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

The struct 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: 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 (WebSocketServer Struct)

Reports a GET request.

Syntax

// WebSocketServerGetRequestEventArgs carries the WebSocketServer GetRequest event's parameters.
pub struct WebSocketServerGetRequestEventArgs {
  fn connection_id(&self) -> i64
  fn uri(&self) -> &String
  fn handled(&self) -> bool
  fn set_handled(&self, value : bool)
}

// WebSocketServerGetRequestEvent defines the signature of the WebSocketServer GetRequest event's handler function.
pub trait WebSocketServerGetRequestEvent {
  fn on_get_request(&self, sender : WebSocketServer, e : &mut WebSocketServerGetRequestEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_get_request(&self) -> &'a dyn WebSocketServerGetRequestEvent;
  pub fn set_on_get_request(&mut self, value : &'a dyn WebSocketServerGetRequestEvent);
  ...
}

Remarks

The struct 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_header, set_response_file or set_response_string 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 (WebSocketServer Struct)

Reports a response to a keep-alive message.

Syntax

// WebSocketServerKeepAliveResponseEventArgs carries the WebSocketServer KeepAliveResponse event's parameters.
pub struct WebSocketServerKeepAliveResponseEventArgs {
  fn connection_id(&self) -> i64
}

// WebSocketServerKeepAliveResponseEvent defines the signature of the WebSocketServer KeepAliveResponse event's handler function.
pub trait WebSocketServerKeepAliveResponseEvent {
  fn on_keep_alive_response(&self, sender : WebSocketServer, e : &mut WebSocketServerKeepAliveResponseEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_keep_alive_response(&self) -> &'a dyn WebSocketServerKeepAliveResponseEvent;
  pub fn set_on_keep_alive_response(&mut self, value : &'a dyn WebSocketServerKeepAliveResponseEvent);
  ...
}

Remarks

This event is triggered when a response to a previously sent keep-alive message is received.

on_notification event (WebSocketServer Struct)

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

Syntax

// WebSocketServerNotificationEventArgs carries the WebSocketServer Notification event's parameters.
pub struct WebSocketServerNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// WebSocketServerNotificationEvent defines the signature of the WebSocketServer Notification event's handler function.
pub trait WebSocketServerNotificationEvent {
  fn on_notification(&self, sender : WebSocketServer, e : &mut WebSocketServerNotificationEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_notification(&self) -> &'a dyn WebSocketServerNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn WebSocketServerNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. 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 struct, the exact action it is performing, or the document being processed, one or both may be omitted.

This struct can fire this event with the following EventID values:

on_text_data event (WebSocketServer Struct)

Passes a received chunk of text data to the application.

Syntax

// WebSocketServerTextDataEventArgs carries the WebSocketServer TextData event's parameters.
pub struct WebSocketServerTextDataEventArgs {
  fn connection_id(&self) -> i64
  fn text(&self) -> &String
  fn last(&self) -> bool
}

// WebSocketServerTextDataEvent defines the signature of the WebSocketServer TextData event's handler function.
pub trait WebSocketServerTextDataEvent {
  fn on_text_data(&self, sender : WebSocketServer, e : &mut WebSocketServerTextDataEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_text_data(&self) -> &'a dyn WebSocketServerTextDataEvent;
  pub fn set_on_text_data(&mut self, value : &'a dyn WebSocketServerTextDataEvent);
  ...
}

Remarks

The struct 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 (WebSocketServer Struct)

Fires when a client certificate needs to be validated.

Syntax

// WebSocketServerTLSCertValidateEventArgs carries the WebSocketServer TLSCertValidate event's parameters.
pub struct WebSocketServerTLSCertValidateEventArgs {
  fn connection_id(&self) -> i64
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// WebSocketServerTLSCertValidateEvent defines the signature of the WebSocketServer TLSCertValidate event's handler function.
pub trait WebSocketServerTLSCertValidateEvent {
  fn on_tls_cert_validate(&self, sender : WebSocketServer, e : &mut WebSocketServerTLSCertValidateEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_tls_cert_validate(&self) -> &'a dyn WebSocketServerTLSCertValidateEvent;
  pub fn set_on_tls_cert_validate(&mut self, value : &'a dyn WebSocketServerTLSCertValidateEvent);
  ...
}

Remarks

The struct 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 (WebSocketServer Struct)

Reports the setup of a TLS session.

Syntax

// WebSocketServerTLSEstablishedEventArgs carries the WebSocketServer TLSEstablished event's parameters.
pub struct WebSocketServerTLSEstablishedEventArgs {
  fn connection_id(&self) -> i64
}

// WebSocketServerTLSEstablishedEvent defines the signature of the WebSocketServer TLSEstablished event's handler function.
pub trait WebSocketServerTLSEstablishedEvent {
  fn on_tls_established(&self, sender : WebSocketServer, e : &mut WebSocketServerTLSEstablishedEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_tls_established(&self) -> &'a dyn WebSocketServerTLSEstablishedEvent;
  pub fn set_on_tls_established(&mut self, value : &'a dyn WebSocketServerTLSEstablishedEvent);
  ...
}

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

on_tls_handshake event (WebSocketServer Struct)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

// WebSocketServerTLSHandshakeEventArgs carries the WebSocketServer TLSHandshake event's parameters.
pub struct WebSocketServerTLSHandshakeEventArgs {
  fn connection_id(&self) -> i64
  fn server_name(&self) -> &String
  fn abort(&self) -> bool
  fn set_abort(&self, value : bool)
}

// WebSocketServerTLSHandshakeEvent defines the signature of the WebSocketServer TLSHandshake event's handler function.
pub trait WebSocketServerTLSHandshakeEvent {
  fn on_tls_handshake(&self, sender : WebSocketServer, e : &mut WebSocketServerTLSHandshakeEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_tls_handshake(&self) -> &'a dyn WebSocketServerTLSHandshakeEvent;
  pub fn set_on_tls_handshake(&mut self, value : &'a dyn WebSocketServerTLSHandshakeEvent);
  ...
}

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 (WebSocketServer Struct)

Requests a pre-shared key for TLS-PSK.

Syntax

// WebSocketServerTLSPSKEventArgs carries the WebSocketServer TLSPSK event's parameters.
pub struct WebSocketServerTLSPSKEventArgs {
  fn connection_id(&self) -> i64
  fn identity(&self) -> &String
  fn psk(&self) -> &String
  fn set_psk(&self, value : &str)
  fn set_psk_ref(&self, value : &String)
  fn ciphersuite(&self) -> &String
  fn set_ciphersuite(&self, value : &str)
  fn set_ciphersuite_ref(&self, value : &String)
}

// WebSocketServerTLSPSKEvent defines the signature of the WebSocketServer TLSPSK event's handler function.
pub trait WebSocketServerTLSPSKEvent {
  fn on_tls_psk(&self, sender : WebSocketServer, e : &mut WebSocketServerTLSPSKEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_tls_psk(&self) -> &'a dyn WebSocketServerTLSPSKEvent;
  pub fn set_on_tls_psk(&mut self, value : &'a dyn WebSocketServerTLSPSKEvent);
  ...
}

Remarks

The struct 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 (WebSocketServer Struct)

Reports closure of a TLS session.

Syntax

// WebSocketServerTLSShutdownEventArgs carries the WebSocketServer TLSShutdown event's parameters.
pub struct WebSocketServerTLSShutdownEventArgs {
  fn connection_id(&self) -> i64
}

// WebSocketServerTLSShutdownEvent defines the signature of the WebSocketServer TLSShutdown event's handler function.
pub trait WebSocketServerTLSShutdownEvent {
  fn on_tls_shutdown(&self, sender : WebSocketServer, e : &mut WebSocketServerTLSShutdownEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_tls_shutdown(&self) -> &'a dyn WebSocketServerTLSShutdownEvent;
  pub fn set_on_tls_shutdown(&mut self, value : &'a dyn WebSocketServerTLSShutdownEvent);
  ...
}

Remarks

The struct fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a on_disconnect, which marks the closure of the underlying TCP session.

on_web_socket_connect event (WebSocketServer Struct)

Reports an accepted WebSocket connection.

Syntax

// WebSocketServerWebSocketConnectEventArgs carries the WebSocketServer WebSocketConnect event's parameters.
pub struct WebSocketServerWebSocketConnectEventArgs {
  fn connection_id(&self) -> i64
  fn query_string(&self) -> &String
  fn key(&self) -> &String
  fn sub_protocol(&self) -> &String
  fn extensions(&self) -> &String
}

// WebSocketServerWebSocketConnectEvent defines the signature of the WebSocketServer WebSocketConnect event's handler function.
pub trait WebSocketServerWebSocketConnectEvent {
  fn on_web_socket_connect(&self, sender : WebSocketServer, e : &mut WebSocketServerWebSocketConnectEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_web_socket_connect(&self) -> &'a dyn WebSocketServerWebSocketConnectEvent;
  pub fn set_on_web_socket_connect(&mut self, value : &'a dyn WebSocketServerWebSocketConnectEvent);
  ...
}

Remarks

The struct 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 (WebSocketServer Struct)

Fires to report a disconnected WebSocket client.

Syntax

// WebSocketServerWebSocketDisconnectEventArgs carries the WebSocketServer WebSocketDisconnect event's parameters.
pub struct WebSocketServerWebSocketDisconnectEventArgs {
  fn connection_id(&self) -> i64
}

// WebSocketServerWebSocketDisconnectEvent defines the signature of the WebSocketServer WebSocketDisconnect event's handler function.
pub trait WebSocketServerWebSocketDisconnectEvent {
  fn on_web_socket_disconnect(&self, sender : WebSocketServer, e : &mut WebSocketServerWebSocketDisconnectEventArgs);
}

impl <'a> WebSocketServer<'a> {
  pub fn on_web_socket_disconnect(&self) -> &'a dyn WebSocketServerWebSocketDisconnectEvent;
  pub fn set_on_web_socket_disconnect(&mut self, value : &'a dyn WebSocketServerWebSocketDisconnectEvent);
  ...
}

Remarks

The struct fires this event when a connected WebSocket client disconnects.

Config Settings (WebSocketServer Struct)

The struct 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 struct, access to these internal properties is provided through the config method.

WebSocketServer Config Settings

Base Config Settings

Trappable Errors (WebSocketServer Struct)

WebSocketServer Errors