Struct ipworksssl::SSLServer

Properties   Methods   Events   Config Settings   Errors  

The SSLServer Struct is a generic Transmission Control Protocol (TCP) server struct based on an asynchronous, event-driven architecture. It is designed to balance the load between connections for a fast, powerful server.

Syntax

ipworksssl::SSLServer

Remarks

The SSLServer Struct supports Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL-related settings are also supported through the config method. The SSLCert properties are used to select a certificate for the server.

NOTE: A valid certificate MUST be selected before the server can function.

SSLServer is the server complement of SSLClient, which is used to create client applications. They share a common design philosophy and interface. We expect you will find SSLServer to be as easy to use as SSLClient.

By default, each instance of SSLServer can handle up to 1,000 simultaneous incoming connections. This number may be increased up to 100,000 or decreased to a lower value by using the MaxConnections configuration setting.

The connections are identified by a ConnectionId, an Id generated by the component to identify each connection. This Id is unique to each connection. SSLServer's events also include a ConnectionId as a parameter to identify the connection they relate to.

Our main goal in designing SSLServer was to make it easy to use without sacrificing performance. The struct has a minimum of properties, and six events: on_connection_request, on_connected, on_data_in, on_disconnected, on_ready_to_send, and on_error.

SSLServer can start to listen on a port by setting the listening property to True. When a remote host asks for a connection, the on_connection_request event is fired. At that point, the connection can either be accepted or rejected. If the connection is accepted, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to SSLClient. Data are sent by calling the send method with Text as a parameter. The address and port of the incoming connection can be found by querying the remote_host and remote_port properties.

NOTE: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, do_events should be called in a loop after the server is started.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksSSL. Due to this, the SSLServer struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of SSLServer 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.

connection_backlog property (SSLServer Struct)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Syntax

fn connection_backlog(&self ) -> Result<i32, IPWorksSSLError> 
fn set_connection_backlog(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

Data Type

i32

connection_count property (SSLServer Struct)

The number of records in the arrays.

Syntax

fn connection_count(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• accept_data
• bytes_sent
• connected
• connection_id
• eol
• idle_timeout
• local_address
• ready_to_send
• record_length
• remote_host
• remote_port
• single_line_mode
• ssl_cert_effective_date
• ssl_cert_encoded
• ssl_cert_expiration_date
• ssl_cert_extended_key_usage
• ssl_cert_fingerprint
• ssl_cert_fingerprint_sha1
• ssl_cert_fingerprint_sha256
• ssl_cert_issuer
• ssl_cert_private_key
• ssl_cert_private_key_available
• ssl_cert_private_key_container
• ssl_cert_public_key
• ssl_cert_public_key_algorithm
• ssl_cert_public_key_length
• ssl_cert_serial_number
• ssl_cert_signature_algorithm
• ssl_cert_store
• ssl_cert_store_password
• ssl_cert_store_type
• ssl_cert_subject
• ssl_cert_subject_alt_names
• ssl_cert_thumbprint_md5
• ssl_cert_thumbprint_sha1
• ssl_cert_thumbprint_sha256
• ssl_cert_usage
• ssl_cert_usage_flags
• ssl_cert_version
• timeout
• user_data

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

This property is read-only.

Data Type

i32

accept_data property (SSLServer Struct)

This property indicates whether data reception is currently enabled.

Syntax

fn accept_data(&self , ConnectionId : i32) -> Result<bool, IPWorksSSLError> 

Default Value

true

Remarks

This property indicates whether data reception is currently enabled. When false, data reception is disabled and the on_data_in event will not fire for the connection. Use the pause_data and process_data methods to pause and resume data reception.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

bool

bytes_sent property (SSLServer Struct)

This property shows how many bytes were sent after calling Send or SendBytes .

Syntax

fn bytes_sent(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property shows how many bytes were sent after calling send or send_bytes. Please see send or send_bytes for more information.

NOTE: This property will always return 0 when the struct is operating in the synchronous mode (i.e., the timeout property is set to a positive value).

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

i32

connected property (SSLServer Struct)

This property indicates the status of individual connections.

Syntax

fn connected(&self , ConnectionId : i32) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

This property indicates the status of individual connections.

When true, the connection is established. Use the disconnect method to disconnect an existing connection.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

bool

connection_id property (SSLServer Struct)

This property contains an identifier generated by the struct to identify each connection.

Syntax

fn connection_id(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property contains an identifier generated by the struct to identify each connection. This identifier is unique to this connection.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

i32

eol property (SSLServer Struct)

The EOL property is used to define boundaries in the input stream using the value of the property.

Syntax

fn eol(&self , ConnectionId : i32) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_eol(&self, ConnectionId : i32, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_eol_ref(&self, ConnectionId : i32, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The eol property is used to define boundaries in the input stream using the value of the property.

The eol property is especially useful with ASCII files. By setting it to CRLF ("\r\n") , the incoming ASCII text stream can be split into lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\n") . bytes are discarded.

The eol property is a binary string. This means that it can be more than one byte long, and it can contain NULL bytes.

When reading the value of the property, if ConnectionId does not belong to a valid connection, then NULL will be returned, and the last_error property will contain a corresponding error message. If no error is encountered, then last_error will contain NULL.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

Data Type

Vec

idle_timeout property (SSLServer Struct)

This property contains the idle timeout for this connection.

Syntax

fn idle_timeout(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 
fn set_idle_timeout(&self, ConnectionId : i32, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property contains the idle timeout for this connection. This property is similar to default_idle_timeout but may be set on a per-connection basis to override default_idle_timeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value, the struct will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent to received data within the specified number of seconds.

If set to 0 (default), no idle timeout is applied.

NOTE: do_events must be called for the struct to check existing connections.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

Data Type

i32

local_address property (SSLServer Struct)

This property shows the IP address of the interface through which the connection is passing.

Syntax

fn local_address(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property shows the IP address of the interface through which the connection is passing.

local_address is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

String

ready_to_send property (SSLServer Struct)

This property indicates whether the struct is ready to send data.

Syntax

fn ready_to_send(&self , ConnectionId : i32) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

This property indicates whether the struct is ready to send data.

This is true after a client connects but will become false after a failed call to send or send_bytes. After a failed call to send or send_bytes, the on_ready_to_send event will fire and this property will be true when data can be sent again.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

bool

record_length property (SSLServer Struct)

This property holds the current record length set by ChangeRecordLength .

Syntax

fn record_length(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property holds the current record length set by change_record_length. When this value is a positive number, the struct will accumulate data until record_length is reached and only then will fire the on_data_in event with the data of length record_length. This allows data to be received as records of known length. This value can be changed at any time by calling change_record_length, including within the on_data_in event.

A value of 0 (default) means this setting is not used.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

i32

remote_host property (SSLServer Struct)

This property shows the IP address of the remote host through which the connection is coming.

Syntax

fn remote_host(&self , ConnectionId : i32) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

This property shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the struct is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

String

remote_port property (SSLServer Struct)

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Syntax

fn remote_port(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

This property is read-only.

Data Type

i32

single_line_mode property (SSLServer Struct)

This property shows the special mode for line-oriented protocols.

Syntax

fn single_line_mode(&self , ConnectionId : i32) -> Result<bool, IPWorksSSLError> 
fn set_single_line_mode(&self, ConnectionId : i32, value : bool) ->  Option<IPWorksSSLError> 

Default Value

false

Remarks

This property shows the special mode for line-oriented protocols. When single_line_mode is True, the struct treats the incoming data stream as lines separated by carriage return (CR), line feed (LF), or CRLF. The eol property is ignored.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

Data Type

bool

timeout property (SSLServer Struct)

This property specifies a timeout for the struct.

Syntax

fn timeout(&self , ConnectionId : i32) -> Result<i32, IPWorksSSLError> 
fn set_timeout(&self, ConnectionId : i32, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property specifies a timeout for the struct.

If the timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If timeout is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of timeout seconds.

The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 0 (asynchronous operation).

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

Data Type

i32

user_data property (SSLServer Struct)

The UserData property holds connection-specific user-specified data.

Syntax

fn user_data(&self , ConnectionId : i32) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_user_data(&self, ConnectionId : i32, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_user_data_ref(&self, ConnectionId : i32, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The user_data property holds connection-specific user-specified data.

User-specified data may be set or retrieved at any point while the connection is valid. This provides a simple way to associate arbitrary data with a specific connection.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the ConnectionCount property.

Data Type

Vec

default_eol property (SSLServer Struct)

This property includes a default end-of-line (EOL) value to be used by incoming connections.

Syntax

fn default_eol(&self ) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_default_eol(&self, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_default_eol_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the struct accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

Data Type

Vec

default_idle_timeout property (SSLServer Struct)

This property includes the default idle timeout for inactive clients.

Syntax

fn default_idle_timeout(&self ) -> Result<i32, IPWorksSSLError> 
fn set_default_idle_timeout(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the struct will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent or received data within default_idle_timeout seconds.

If set to 0 (default), no idle timeout is applied.

NOTE: do_events must be called for the struct to check existing connections.

Data Type

i32

default_max_line_length property (SSLServer Struct)

The property includes the default maximum line length value for inbound connections.

Syntax

fn default_max_line_length(&self ) -> Result<i32, IPWorksSSLError> 
fn set_default_max_line_length(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

2048

Remarks

This property controls the default size of an internal buffer that holds received data while waiting for an end-of-line (EOL) string.

The minimum value for this property is 256 bytes. The default value is 2048 bytes.

Data Type

i32

default_single_line_mode property (SSLServer Struct)

This property tells the struct whether or not to treat new connections as line oriented.

Syntax

fn default_single_line_mode(&self ) -> Result<bool, IPWorksSSLError> 
fn set_default_single_line_mode(&self, value : bool) ->  Option<IPWorksSSLError> 

Default Value

false

Remarks

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs).

Data Type

bool

default_timeout property (SSLServer Struct)

This property includes an initial timeout value to be used by incoming connections.

Syntax

fn default_timeout(&self ) -> Result<i32, IPWorksSSLError> 
fn set_default_timeout(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property is used by the struct to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

Data Type

i32

keep_alive property (SSLServer Struct)

When True, KEEPALIVE packets are enabled (for long connections).

Syntax

fn keep_alive(&self ) -> Result<bool, IPWorksSSLError> 
fn set_keep_alive(&self, value : bool) ->  Option<IPWorksSSLError> 

Default Value

false

Remarks

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

NOTE: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Data Type

bool

linger property (SSLServer Struct)

When set to True, connections are terminated gracefully.

Syntax

fn linger(&self ) -> Result<bool, IPWorksSSLError> 
fn set_linger(&self, value : bool) ->  Option<IPWorksSSLError> 

Default Value

true

Remarks

This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the struct returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted.

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (e.g., by a client acknowledgment), then setting this property to False might be the appropriate course of action.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Data Type

bool

listening property (SSLServer Struct)

This property indicates whether the struct is listening for incoming connections on LocalPort.

Syntax

fn listening(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

This property indicates whether the struct is listening for connections on the port specified by the local_port property. Use the start_listening and stop_listening methods to control whether the struct is listening.

This property is read-only.

Data Type

bool

local_host property (SSLServer Struct)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

fn local_host(&self ) -> Result<String, IPWorksSSLError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the struct is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

NOTE: local_host is not persistent. You must always set it in code, and never in the property window.

Data Type

String

local_port property (SSLServer Struct)

This property includes the Transmission Control Protocol (TCP) port in the local host where the struct listens.

Syntax

fn local_port(&self ) -> Result<i32, IPWorksSSLError> 
fn set_local_port(&self, value : i32) ->  Option<IPWorksSSLError> 

Default Value

0

Remarks

This property must be set before the struct can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the struct is listening (i.e., after successfully assigning True to the listening property).

The service port is not shared among servers so two structs cannot be listening on the same port at the same time.

Data Type

i32

ssl_authenticate_clients property (SSLServer Struct)

If set to True, the server asks the client(s) for a certificate.

Syntax

fn ssl_authenticate_clients(&self ) -> Result<bool, IPWorksSSLError> 
fn set_ssl_authenticate_clients(&self, value : bool) ->  Option<IPWorksSSLError> 

Default Value

false

Remarks

This property is used in conjunction with the on_ssl_client_authentication event. Please refer to the documentation of the on_ssl_client_authentication event for details.

Data Type

bool

ssl_cert_effective_date property (SSLServer Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_expiration_date property (SSLServer Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (SSLServer Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

ssl_cert_fingerprint property (SSLServer Struct)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha1 property (SSLServer Struct)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

ssl_cert_fingerprint_sha256 property (SSLServer Struct)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

ssl_cert_issuer property (SSLServer Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

ssl_cert_private_key property (SSLServer Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

Data Type

String

ssl_cert_private_key_available property (SSLServer Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksSSLError> 

Default Value

false

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

bool

ssl_cert_private_key_container property (SSLServer Struct)

The name of the PrivateKey container for the certificate (if available).

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

ssl_cert_public_key property (SSLServer Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (SSLServer Struct)

The textual description of the certificate's public key algorithm.

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (SSLServer Struct)

The length of the certificate's public key (in bits).

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (SSLServer Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

ssl_cert_signature_algorithm property (SSLServer Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

ssl_cert_store property (SSLServer Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Vec

ssl_cert_store_password property (SSLServer Struct)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksSSLError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

ssl_cert_store_type property (SSLServer Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksSSLError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // User
1   // Machine
2   // PFXFile
3   // PFXBlob
4   // JKSFile
5   // JKSBlob
6   // PEMKeyFile
7   // PEMKeyBlob
8   // PublicKeyFile
9   // PublicKeyBlob
10   // SSHPublicKeyBlob
11   // P7BFile
12   // P7BBlob
13   // SSHPublicKeyFile
14   // PPKFile
15   // PPKBlob
16   // XMLFile
17   // XMLBlob
18   // JWKFile
19   // JWKBlob
20   // SecurityKey
21   // BCFKSFile
22   // BCFKSBlob
23   // PKCS11
99   // Auto

Default Value

0

Remarks

The type of certificate store for this certificate.

The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

Data Type

i32

ssl_cert_subject_alt_names property (SSLServer Struct)

Comma-separated lists of alternative subject names for the certificate.

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (SSLServer Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha1 property (SSLServer Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_thumbprint_sha256 property (SSLServer Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

ssl_cert_usage property (SSLServer Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

ssl_cert_usage_flags property (SSLServer Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksSSLError> 

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

i32

ssl_cert_version property (SSLServer Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksSSLError> 

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

ssl_cert_subject property (SSLServer Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksSSLError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksSSLError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ssl_cert_encoded property (SSLServer Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksSSLError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksSSLError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksSSLError> 

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

Data Type

Vec

ssl_provider property (SSLServer Struct)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

fn ssl_provider(&self ) -> Result<i32, IPWorksSSLError> 
fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksSSLError> 

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform.

When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

Data Type

i32

change_record_length method (SSLServer Struct)

This method changes the length of received data records.

Syntax

fn change_record_length(&self, connection_id : i32, record_length : i32) -> Result<(), IPWorksSSLError>

Remarks

This method defines the length of data records to be received (in bytes) for the specified connection_id.

If record_length is set to a positive value, the struct will accumulate data until record_length bytes of data are received and only then will fire the on_data_in event with data of the specified length record_length. This allows data to be received as records of known length. This method can be called at any time to change the record length, including within the on_data_in event.

A value of 0 (default) means this functionality is not used.

config method (SSLServer Struct)

Sets or retrieves a configuration setting.

Syntax

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

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.

disconnect method (SSLServer Struct)

This method disconnects the specified client.

Syntax

fn disconnect(&self, connection_id : i32) -> Result<(), IPWorksSSLError>

Remarks

Calling this method will disconnect the client specified by the connection_id parameter.

do_events method (SSLServer Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksSSLError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

interrupt method (SSLServer Struct)

This method interrupts a synchronous send to the remote host.

Syntax

fn interrupt(&self, connection_id : i32) -> Result<(), IPWorksSSLError>

Remarks

This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the struct. If you use send_file to upload a file, the struct will run synchronously on that Connection Id until it is completed.

pause_data method (SSLServer Struct)

This method pauses data reception.

Syntax

fn pause_data(&self, connection_id : i32) -> Result<(), IPWorksSSLError>

Remarks

This method pauses data reception for the connection identified by connection_id when called. While data reception is paused, the on_data_in event will not fire for the specified connection. Call process_data to reenable data reception.

process_data method (SSLServer Struct)

This method reenables data reception after a call to PauseData .

Syntax

fn process_data(&self, connection_id : i32) -> Result<(), IPWorksSSLError>

Remarks

This method reenables data reception for the connection identified by connection_id after a previous call to pause_data. When pause_data is called, the on_data_in event will not fire for the specified connection. To reenable data reception and allow on_data_in to fire, call this method.

NOTE: This method is used only after previously calling pause_data. It does not need to be called to process incoming data by default.

reset method (SSLServer Struct)

This method will reset the struct.

Syntax

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

Remarks

This method will reset the struct's properties to their default values.

send method (SSLServer Struct)

This method sends binary data to the specified client.

Syntax

fn send(&self, connection_id : i32, text : &[u8]) -> Result<(), IPWorksSSLError>

Remarks

This method sends binary data to the client identified by connection_id. To send text, use the send_text method instead.

When ws_connection_timeout is set to 0, the struct will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again.

NOTE: The on_ready_to_send event is not fired when part of the data is sent successfully.

send_bytes method (SSLServer Struct)

This method sends binary data to the specified client.

Syntax

fn send_bytes(&self, connection_id : i32, data : &[u8]) -> Result<(), IPWorksSSLError>

Remarks

This method sends binary data to the client identified by connection_id. To send text, use the send_text method instead.

When ws_connection_timeout is set to 0, the struct will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again.

NOTE: The on_ready_to_send event is not fired when part of the data is sent successfully.

send_file method (SSLServer Struct)

This method sends the file to the remote host.

Syntax

fn send_file(&self, connection_id : i32, file_name : &str) -> Result<(), IPWorksSSLError>

Remarks

This method sends the file to the client specified by the connection_id.

send_line method (SSLServer Struct)

This method sends a string followed by a new line.

Syntax

fn send_line(&self, connection_id : i32, text : &str) -> Result<(), IPWorksSSLError>

Remarks

This method is used to send data with line-oriented protocols. The line is followed by CRLF ("\r\n") .

Please refer to the get_line method and single_line_mode property for more information.

send_text method (SSLServer Struct)

This method sends text to the specified client.

Syntax

fn send_text(&self, connection_id : i32, text : &str) -> Result<(), IPWorksSSLError>

Remarks

This method sends text to the client identified by connection_id. To send binary data, use the send_bytes method instead.

When ws_connection_timeout is set to 0, the struct will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again.

NOTE: The on_ready_to_send event is not fired when part of the data is sent successfully.

shutdown method (SSLServer Struct)

This method shuts down the server.

Syntax

fn shutdown(&self) -> Result<(), IPWorksSSLError>

Remarks

This method shuts down the server. Calling this method is equivalent to calling stop_listening and then breaking every client connection by calling disconnect.

start_listening method (SSLServer Struct)

This method starts listening for incoming connections.

Syntax

fn start_listening(&self) -> Result<(), IPWorksSSLError>

Remarks

This method begins listening for incoming connections on the port specified by local_port. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call stop_listening. To stop listening for new connections and to disconnect all existing clients, call shutdown.

stop_listening method (SSLServer Struct)

This method stops listening for new connections.

Syntax

fn stop_listening(&self) -> Result<(), IPWorksSSLError>

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call shutdown instead.

on_connected event (SSLServer Struct)

This event is fired immediately after a connection completes (or fails).

Syntax

// SSLServerConnectedEventArgs carries the SSLServer Connected event's parameters.
pub struct SSLServerConnectedEventArgs {
  fn connection_id(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SSLServerConnectedEvent defines the signature of the SSLServer Connected event's handler function.
pub trait SSLServerConnectedEvent {
  fn on_connected(&self, sender : SSLServer, e : &mut SSLServerConnectedEventArgs);
}

impl <'a> SSLServer<'a> {
  pub fn on_connected(&self) -> &'a dyn SSLServerConnectedEvent;
  pub fn set_on_connected(&mut self, value : &'a dyn SSLServerConnectedEvent);
  ...
}

Remarks

If the connection is made normally, status_code is 0, and description is "OK".

If the connection fails, status_code has the error code returned by the system. description contains a description of this code. The value of status_code is equal to the value of the system error.

Please refer to the Error Codes section for more information.

on_connection_request event (SSLServer Struct)

This event is fired when a request for connection comes from a remote host.

Syntax

// SSLServerConnectionRequestEventArgs carries the SSLServer ConnectionRequest event's parameters.
pub struct SSLServerConnectionRequestEventArgs {
  fn address(&self) -> &String
  fn port(&self) -> i32
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SSLServerConnectionRequestEvent defines the signature of the SSLServer ConnectionRequest event's handler function.
pub trait SSLServerConnectionRequestEvent {
  fn on_connection_request(&self, sender : SSLServer, e : &mut SSLServerConnectionRequestEventArgs);
}

impl <'a> SSLServer<'a> {
  pub fn on_connection_request(&self) -> &'a dyn SSLServerConnectionRequestEvent;
  pub fn set_on_connection_request(&mut self, value : &'a dyn SSLServerConnectionRequestEvent);
  ...
}

Remarks

This event indicates an incoming connection. The connection is accepted by default. address and port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the accept parameter to False.

on_data_in event (SSLServer Struct)

This event is fired when data come in.

Syntax

// SSLServerDataInEventArgs carries the SSLServer DataIn event's parameters.
pub struct SSLServerDataInEventArgs {
  fn connection_id(&self) -> i32
  fn text(&self) -> &[u8]
  fn eol(&self) -> bool
}

// SSLServerDataInEvent defines the signature of the SSLServer DataIn event's handler function.
pub trait SSLServerDataInEvent {
  fn on_data_in(&self, sender : SSLServer, e : &mut SSLServerDataInEventArgs);
}

impl <'a> SSLServer<'a> {
  pub fn on_data_in(&self) -> &'a dyn SSLServerDataInEvent;
  pub fn set_on_data_in(&mut self, value : &'a dyn SSLServerDataInEvent);
  ...
}

Remarks

Trapping the on_data_in event is your only chance to get the data coming from the other end of the connection specified by connection_id. The incoming data are provided through the text parameter.

eol indicates whether or not the eol string was found at the end of text. If the eol string was found, then eol is True.

If Text is part of the data portion of length larger than either default_max_line_length or with no eol strings in it, then eol is False. Please note that this means that one or more on_data_in events with eol set to False can be received during a connection.

If the eol property is "" (empty string), then eol can be disregarded (it is always True).

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

on_disconnected event (SSLServer Struct)

This event is fired when a connection is closed.

Syntax

// SSLServerDisconnectedEventArgs carries the SSLServer Disconnected event's parameters.
pub struct SSLServerDisconnectedEventArgs {
  fn connection_id(&self) -> i32
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// SSLServerDisconnectedEvent defines the signature of the SSLServer Disconnected event's handler function.
pub trait SSLServerDisconnectedEvent {
  fn on_disconnected(&self, sender : SSLServer, e : &mut SSLServerDisconnectedEventArgs);
}

impl <'a> SSLServer<'a> {
  pub fn on_disconnected(&self) -> &'a dyn SSLServerDisconnectedEvent;
  pub fn set_on_disconnected(&mut self, value : &'a dyn SSLServerDisconnectedEvent);
  ...
}

Remarks

If the connection is broken normally, status_code is 0, and description is "OK".

If the connection is broken for any other reason, status_code has the error code returned by the system. description contains a description of this code. The value of status_code is equal to the value of the system error.

Please refer to the Error Codes section for more information.

on_error event (SSLServer Struct)

This event fires information about errors during data delivery.

Syntax

// SSLServerErrorEventArgs carries the SSLServer Error event's parameters.
pub struct SSLServerErrorEventArgs {
  fn connection_id(&self) -> i32
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

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

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

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally, the struct fails with an error.

error_code 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 Error Codes section.

connection_id indicates the connection for which the error is applicable.

on_ready_to_send event (SSLServer Struct)

This event is fired when the struct is ready to send data.

Syntax

// SSLServerReadyToSendEventArgs carries the SSLServer ReadyToSend event's parameters.
pub struct SSLServerReadyToSendEventArgs {
  fn connection_id(&self) -> i32
}

// SSLServerReadyToSendEvent defines the signature of the SSLServer ReadyToSend event's handler function.
pub trait SSLServerReadyToSendEvent {
  fn on_ready_to_send(&self, sender : SSLServer, e : &mut SSLServerReadyToSendEventArgs);
}

impl <'a> SSLServer<'a> {
  pub fn on_ready_to_send(&self) -> &'a dyn SSLServerReadyToSendEvent;
  pub fn set_on_ready_to_send(&mut self, value : &'a dyn SSLServerReadyToSendEvent);
  ...
}

Remarks

The on_ready_to_send event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed send. This event is also fired immediately after a connection is established.

on_ssl_client_authentication event (SSLServer Struct)

This event is fired when the client presents its credentials to the server.

Syntax

// SSLServerSSLClientAuthenticationEventArgs carries the SSLServer SSLClientAuthentication event's parameters.
pub struct SSLServerSSLClientAuthenticationEventArgs {
  fn connection_id(&self) -> i32
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// SSLServerSSLClientAuthenticationEvent defines the signature of the SSLServer SSLClientAuthentication event's handler function.
pub trait SSLServerSSLClientAuthenticationEvent {
  fn on_ssl_client_authentication(&self, sender : SSLServer, e : &mut SSLServerSSLClientAuthenticationEventArgs);
}

impl <'a> SSLServer<'a> {
  pub fn on_ssl_client_authentication(&self) -> &'a dyn SSLServerSSLClientAuthenticationEvent;
  pub fn set_on_ssl_client_authentication(&mut self, value : &'a dyn SSLServerSSLClientAuthenticationEvent);
  ...
}

Remarks

This event enables the server to decide whether or not to continue. The accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When accept is False, status shows why the verification failed (otherwise, status contains the string "OK").

on_ssl_connection_request event (SSLServer Struct)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Syntax

// SSLServerSSLConnectionRequestEventArgs carries the SSLServer SSLConnectionRequest event's parameters.
pub struct SSLServerSSLConnectionRequestEventArgs {
  fn connection_id(&self) -> i32
  fn supported_cipher_suites(&self) -> &String
  fn supported_signature_algs(&self) -> &String
  fn cert_store_type(&self) -> i32
  fn set_cert_store_type(&self, value : i32)
  fn cert_store(&self) -> &String
  fn set_cert_store(&self, value : &str)
  fn set_cert_store_ref(&self, value : &String)
  fn cert_password(&self) -> &String
  fn set_cert_password(&self, value : &str)
  fn set_cert_password_ref(&self, value : &String)
  fn cert_subject(&self) -> &String
  fn set_cert_subject(&self, value : &str)
  fn set_cert_subject_ref(&self, value : &String)
}

// SSLServerSSLConnectionRequestEvent defines the signature of the SSLServer SSLConnectionRequest event's handler function.
pub trait SSLServerSSLConnectionRequestEvent {
  fn on_ssl_connection_request(&self, sender : SSLServer, e : &mut SSLServerSSLConnectionRequestEventArgs);
}

impl <'a> SSLServer<'a> {
  pub fn on_ssl_connection_request(&self) -> &'a dyn SSLServerSSLConnectionRequestEvent;
  pub fn set_on_ssl_connection_request(&mut self, value : &'a dyn SSLServerSSLConnectionRequestEvent);
  ...
}

Remarks

This event fires when an SSL connection is requested and ssl_provider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when ssl_provider is set to Platform.

This event allows the struct to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

connection_id is the connection Id of the client requesting the connection.

supported_cipher_suites is a comma-separated list of cipher suites that the client supports.

supported_signature_algs is a comma-separated list of certificate signature algorithms that the client supports.

cert_store_type is the store type of the alternate certificate to use for this connection. The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:

cert_store is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

cert_password is the password of the certificate store containing the alternate certificate to use for this connection.

cert_subject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

on_ssl_status event (SSLServer Struct)

This event is fired to show the progress of the secure connection.

Syntax

// SSLServerSSLStatusEventArgs carries the SSLServer SSLStatus event's parameters.
pub struct SSLServerSSLStatusEventArgs {
  fn connection_id(&self) -> i32
  fn message(&self) -> &String
}

// SSLServerSSLStatusEvent defines the signature of the SSLServer SSLStatus event's handler function.
pub trait SSLServerSSLStatusEvent {
  fn on_ssl_status(&self, sender : SSLServer, e : &mut SSLServerSSLStatusEventArgs);
}

impl <'a> SSLServer<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn SSLServerSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn SSLServerSSLStatusEvent);
  ...
}

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

Config Settings (SSLServer Struct)

TCPServer Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Base Config Settings

Trappable Errors (SSLServer Struct)

SSLServer Errors

SSL Errors

TCP/IP Errors