SSLServer Class
Properties Methods Events Config Settings Errors
The SSLServer Class is a generic Transmission Control Protocol (TCP) server class based on an asynchronous, event-driven architecture. It is designed to balance the load between connections for a fast, powerful server.
Syntax
SSLServer
Remarks
The SSLServer Class supports Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via 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 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 have 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 class has a minimum of properties, and six events: ConnectionRequest, Connected, DataIn, Disconnected, ReadyToSend, and 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 ConnectionRequest 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 assigning the data string to the DataToSend property. The address and port of the incoming connection can be found by querying the RemoteHost and RemotePort properties.
Note: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, DoEvents should be called in a loop after the server is started.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
ConnectionBacklog | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. |
ConnectionCount | The number of records in the arrays. |
AcceptData | Setting this property to false temporarily disables data reception (and the DataIn event) for the connection. |
BytesSent | This property shows how many bytes were sent after the last assignment to DataToSend . |
Connected | This property is used to disconnect individual connections or to show their status. |
ConnectionId | This property contains an identifier generated by the class to identify each connection. |
DataToSend | This property contains a string of data to be sent to the remote host. |
EOL | The EOL property is used to define boundaries in the input stream using the value of the property. |
IdleTimeout | This property contains the idle timeout for this connection. |
LocalAddress | This property shows the IP address of the interface through which the connection is passing. |
ReadyToSend | This indicates whether the class is ready to send data. |
RecordLength | If set to a positive value, this setting defines the length of the data records to be received. |
RemoteHost | This property shows the IP address of the remote host through which the connection is coming. |
RemotePort | This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming. |
SingleLineMode | This property shows the special mode for line-oriented protocols. |
Timeout | This property specifies a timeout for the class. |
UserData | The UserData property holds connection-specific user-specified data. |
DefaultEOL | This property includes a default end-of-line (EOL) value to be used by incoming connections. |
DefaultIdleTimeout | This property includes the default idle timeout for inactive clients. |
DefaultMaxLineLength | The property includes the default maximum line length value for inbound connections. |
DefaultSingleLineMode | This property tells the class whether or not to treat new connections as line oriented. |
DefaultTimeout | This property includes an initial timeout value to be used by incoming connections. |
KeepAlive | When True, KEEPALIVE packets are enabled (for long connections). |
Linger | When set to True, connections are terminated gracefully. |
Listening | If set to True, the class accepts incoming connections on LocalPort. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LocalPort | This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens. |
SSLAuthenticateClients | If set to True, the server asks the client(s) for a certificate. |
SSLCertEncoded | This is the certificate (PEM/base64 encoded). |
SSLCertStore | This is the name of the certificate store for the client certificate. |
SSLCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLCertStoreType | This is the type of certificate store for this certificate. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLProvider | This specifies the SSL/TLS implementation to use. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
ChangeRecordLength | This method changes the length of received data records. |
Config | Sets or retrieves a configuration setting. |
Disconnect | This method disconnects the specified client. |
DoEvents | Processes events from the internal message queue. |
Interrupt | This method interrupts a synchronous send to the remote host. |
PauseData | This method pauses data reception. |
ProcessData | This method reenables data reception after a call to PauseData . |
Reset | Reset the class. |
Send | This method sends binary data to the specified client. |
SendBytes | This method sends binary data to the specified client. |
SendFile | This method sends the file to the remote host. |
SendLine | This method sends a string followed by a new line. |
SendText | This method sends text to the specified client. |
Shutdown | This method shuts down the server. |
StartListening | This method starts listening for incoming connections. |
StopListening | This method stops listening for new connections. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
Connected | This event is fired immediately after a connection completes (or fails). |
ConnectionRequest | This event is fired when a request for connection comes from a remote host. |
DataIn | This event is fired when data come in. |
Disconnected | This event is fired when a connection is closed. |
Error | This event fires information about errors during data delivery. |
ReadyToSend | This event is fired when the class is ready to send data. |
SSLClientAuthentication | This event is fired when the client presents its credentials to the server. |
SSLConnectionRequest | This event fires when a Secure Sockets Layer (SSL) connection is requested. |
SSLStatus | This event is fired to show the progress of the secure connection. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowedClients | A comma-separated list of host names or IP addresses that can access the class. |
BindExclusively | Whether or not the class considers a local port reserved for exclusive use. |
BlockedClients | A comma-separated list of host names or IP addresses that cannot access the class. |
ConnectionUID | The unique connectionId for a connection. |
DefaultConnectionTimeout | The inactivity timeout applied to the SSL handshake. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveRetryCount | The number of keep-alive packets to be sent before the remotehost is considered disconnected. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
MaxConnections | The maximum number of connections available. |
MaxReadTime | The maximum time spent reading data from each connection. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIOCP | Whether to use the completion port I/O model. |
UseIPv6 | Whether to use IPv6. |
UseWindowsMessages | Whether to use the WSAAsyncSelect I/O model. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLKeyLogFile | The location of a file where per-session secrets are written for debugging purposes. |
SSLNegotiatedCipher | Returns the negotiated cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
ConnectionBacklog Property (SSLServer Class)
This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.
Syntax
ANSI (Cross Platform) int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog); Unicode (Windows) INT GetConnectionBacklog();
INT SetConnectionBacklog(INT iConnectionBacklog);
int ipworksssl_sslserver_getconnectionbacklog(void* lpObj);
int ipworksssl_sslserver_setconnectionbacklog(void* lpObj, int iConnectionBacklog);
int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);
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.
This property is not available at design time.
Data Type
Integer
ConnectionCount Property (SSLServer Class)
The number of records in the arrays.
Syntax
ANSI (Cross Platform) int GetConnectionCount(); Unicode (Windows) INT GetConnectionCount();
int ipworksssl_sslserver_getconnectioncount(void* lpObj);
int GetConnectionCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- AcceptData
- BytesSent
- Connected
- ConnectionId
- DataToSend
- EOL
- IdleTimeout
- LocalAddress
- ReadyToSend
- RecordLength
- RemoteHost
- RemotePort
- SingleLineMode
- SSLCertEncoded
- SSLCertStore
- SSLCertStorePassword
- SSLCertStoreType
- SSLCertSubject
- Timeout
- UserData
This property is read-only and not available at design time.
Data Type
Integer
AcceptData Property (SSLServer Class)
Setting this property to false temporarily disables data reception (and the DataIn event) for the connection.
Syntax
ANSI (Cross Platform) int GetAcceptData(int iConnectionId);
int SetAcceptData(int iConnectionId, int bAcceptData); Unicode (Windows) BOOL GetAcceptData(INT iConnectionId);
INT SetAcceptData(INT iConnectionId, BOOL bAcceptData);
int ipworksssl_sslserver_getacceptdata(void* lpObj, int connectionid);
int ipworksssl_sslserver_setacceptdata(void* lpObj, int connectionid, int bAcceptData);
bool GetAcceptData(int iConnectionId);
int SetAcceptData(int iConnectionId, bool bAcceptData);
Default Value
TRUE
Remarks
Setting this property to false temporarily disables data reception (and the DataIn event) for the connection. Setting this to true re-enables data reception.
Note: It is recommended to use the PauseData or ProcessData method instead of setting this property.
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 not available at design time.
Data Type
Boolean
BytesSent Property (SSLServer Class)
This property shows how many bytes were sent after the last assignment to DataToSend .
Syntax
ANSI (Cross Platform) int GetBytesSent(int iConnectionId); Unicode (Windows) INT GetBytesSent(INT iConnectionId);
int ipworksssl_sslserver_getbytessent(void* lpObj, int connectionid);
int GetBytesSent(int iConnectionId);
Default Value
0
Remarks
This property shows how many bytes were sent after the last assignment to DataToSend. Please check DataToSend for more information.
Note: This property will always return 0 when the class 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 and not available at design time.
Data Type
Integer
Connected Property (SSLServer Class)
This property is used to disconnect individual connections or to show their status.
Syntax
ANSI (Cross Platform) int GetConnected(int iConnectionId);
int SetConnected(int iConnectionId, int bConnected); Unicode (Windows) BOOL GetConnected(INT iConnectionId);
INT SetConnected(INT iConnectionId, BOOL bConnected);
int ipworksssl_sslserver_getconnected(void* lpObj, int connectionid);
int ipworksssl_sslserver_setconnected(void* lpObj, int connectionid, int bConnected);
bool GetConnected(int iConnectionId);
int SetConnected(int iConnectionId, bool bConnected);
Default Value
FALSE
Remarks
This property is used to disconnect individual connections or to show their status.
The Connected property may be set to false to close the connection.
Connected also shows the status of a particular connection (connected/disconnected).
How and when the connection is closed is controlled by the Linger property. Please refer to its description for more information.
Note: It is recommended to use the Disconnect method instead of setting this property.
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 not available at design time.
Data Type
Boolean
ConnectionId Property (SSLServer Class)
This property contains an identifier generated by the class to identify each connection.
Syntax
ANSI (Cross Platform) char* GetConnectionId(int iConnectionId); Unicode (Windows) LPWSTR GetConnectionId(INT iConnectionId);
char* ipworksssl_sslserver_getconnectionid(void* lpObj, int connectionid);
QString GetConnectionId(int iConnectionId);
Default Value
""
Remarks
This property contains an identifier generated by the class 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 and not available at design time.
Data Type
String
DataToSend Property (SSLServer Class)
This property contains a string of data to be sent to the remote host.
Syntax
ANSI (Cross Platform) int SetDataToSend(int iConnectionId, const char* lpDataToSend, int lenDataToSend); Unicode (Windows) INT SetDataToSend(INT iConnectionId, LPCSTR lpDataToSend, INT lenDataToSend);
int ipworksssl_sslserver_setdatatosend(void* lpObj, int connectionid, const char* lpDataToSend, int lenDataToSend);
int SetDataToSend(int iConnectionId, QByteArray qbaDataToSend);
Default Value
""
Remarks
This property contains a string of data to be sent to the remote host. It is a write-only property.
Assigning a string to the DataToSend makes the class send the string to the remote host. The Send method provides similar functionality.
When Timeout is set to 0, the class 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 BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.
Note: The ReadyToSend event is not fired when part of the data is sent successfully.
Note: It is recommended to use the Send or SendBytes method instead of setting this property.
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 write-only and not available at design time.
Data Type
Binary String
EOL Property (SSLServer Class)
The EOL property is used to define boundaries in the input stream using the value of the property.
Syntax
ANSI (Cross Platform) int GetEOL(int iConnectionId, char* &lpEOL, int &lenEOL);
int SetEOL(int iConnectionId, const char* lpEOL, int lenEOL); Unicode (Windows) INT GetEOL(INT iConnectionId, LPSTR &lpEOL, INT &lenEOL);
INT SetEOL(INT iConnectionId, LPCSTR lpEOL, INT lenEOL);
int ipworksssl_sslserver_geteol(void* lpObj, int connectionid, char** lpEOL, int* lenEOL);
int ipworksssl_sslserver_seteol(void* lpObj, int connectionid, const char* lpEOL, int lenEOL);
QByteArray GetEOL(int iConnectionId);
int SetEOL(int iConnectionId, QByteArray qbaEOL);
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 LastError property will contain a corresponding error message. If no error is encountered, then LastError 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.
This property is not available at design time.
Data Type
Binary String
IdleTimeout Property (SSLServer Class)
This property contains the idle timeout for this connection.
Syntax
ANSI (Cross Platform) int GetIdleTimeout(int iConnectionId);
int SetIdleTimeout(int iConnectionId, int iIdleTimeout); Unicode (Windows) INT GetIdleTimeout(INT iConnectionId);
INT SetIdleTimeout(INT iConnectionId, INT iIdleTimeout);
int ipworksssl_sslserver_getidletimeout(void* lpObj, int connectionid);
int ipworksssl_sslserver_setidletimeout(void* lpObj, int connectionid, int iIdleTimeout);
int GetIdleTimeout(int iConnectionId);
int SetIdleTimeout(int iConnectionId, int iIdleTimeout);
Default Value
0
Remarks
This property contains the idle timeout for this connection. This property is similar to DefaultIdleTimeout but may be set on a per-connection basis to override DefaultIdleTimeout. This property specifies the idle timeout (in seconds) for the connected client. When set to a positive value, the class 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: DoEvents must be called for the class 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.
This property is not available at design time.
Data Type
Integer
LocalAddress Property (SSLServer Class)
This property shows the IP address of the interface through which the connection is passing.
Syntax
ANSI (Cross Platform) char* GetLocalAddress(int iConnectionId); Unicode (Windows) LPWSTR GetLocalAddress(INT iConnectionId);
char* ipworksssl_sslserver_getlocaladdress(void* lpObj, int connectionid);
QString GetLocalAddress(int iConnectionId);
Default Value
""
Remarks
This property shows the IP address of the interface through which the connection is passing.
LocalAddress 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 and not available at design time.
Data Type
String
ReadyToSend Property (SSLServer Class)
This indicates whether the class is ready to send data.
Syntax
ANSI (Cross Platform) int GetReadyToSend(int iConnectionId); Unicode (Windows) BOOL GetReadyToSend(INT iConnectionId);
int ipworksssl_sslserver_getreadytosend(void* lpObj, int connectionid);
bool GetReadyToSend(int iConnectionId);
Default Value
FALSE
Remarks
This indicates whether the class is ready to send data.
This property indicates that the underlying TCP/IP subsystem is ready to accept data. This is True after a client connects but will become False after a failed DataToSend.
After a failed DataToSend, the ReadyToSend 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 and not available at design time.
Data Type
Boolean
RecordLength Property (SSLServer Class)
If set to a positive value, this setting defines the length of the data records to be received.
Syntax
ANSI (Cross Platform) int GetRecordLength(int iConnectionId);
int SetRecordLength(int iConnectionId, int iRecordLength); Unicode (Windows) INT GetRecordLength(INT iConnectionId);
INT SetRecordLength(INT iConnectionId, INT iRecordLength);
int ipworksssl_sslserver_getrecordlength(void* lpObj, int connectionid);
int ipworksssl_sslserver_setrecordlength(void* lpObj, int connectionid, int iRecordLength);
int GetRecordLength(int iConnectionId);
int SetRecordLength(int iConnectionId, int iRecordLength);
Default Value
0
Remarks
If set to a positive value, this setting defines the length of the data records to be received. The class will accumulate data until RecordLength is reached and only then will fire the DataIn event with the data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.
A value of 0 (default) means this setting is not used.
Note: It is recommended to use the ChangeRecordLength method instead of setting this property.
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 not available at design time.
Data Type
Integer
RemoteHost Property (SSLServer Class)
This property shows the IP address of the remote host through which the connection is coming.
Syntax
ANSI (Cross Platform) char* GetRemoteHost(int iConnectionId); Unicode (Windows) LPWSTR GetRemoteHost(INT iConnectionId);
char* ipworksssl_sslserver_getremotehost(void* lpObj, int connectionid);
QString GetRemoteHost(int iConnectionId);
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 class 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 and not available at design time.
Data Type
String
RemotePort Property (SSLServer Class)
This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.
Syntax
ANSI (Cross Platform) int GetRemotePort(int iConnectionId); Unicode (Windows) INT GetRemotePort(INT iConnectionId);
int ipworksssl_sslserver_getremoteport(void* lpObj, int connectionid);
int GetRemotePort(int iConnectionId);
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 and not available at design time.
Data Type
Integer
SingleLineMode Property (SSLServer Class)
This property shows the special mode for line-oriented protocols.
Syntax
ANSI (Cross Platform) int GetSingleLineMode(int iConnectionId);
int SetSingleLineMode(int iConnectionId, int bSingleLineMode); Unicode (Windows) BOOL GetSingleLineMode(INT iConnectionId);
INT SetSingleLineMode(INT iConnectionId, BOOL bSingleLineMode);
int ipworksssl_sslserver_getsinglelinemode(void* lpObj, int connectionid);
int ipworksssl_sslserver_setsinglelinemode(void* lpObj, int connectionid, int bSingleLineMode);
bool GetSingleLineMode(int iConnectionId);
int SetSingleLineMode(int iConnectionId, bool bSingleLineMode);
Default Value
FALSE
Remarks
This property shows the special mode for line-oriented protocols. When SingleLineMode is True, the class 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.
This property is not available at design time.
Data Type
Boolean
Timeout Property (SSLServer Class)
This property specifies a timeout for the class.
Syntax
ANSI (Cross Platform) int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout); Unicode (Windows) INT GetTimeout(INT iConnectionId);
INT SetTimeout(INT iConnectionId, INT iTimeout);
int ipworksssl_sslserver_gettimeout(void* lpObj, int connectionid);
int ipworksssl_sslserver_settimeout(void* lpObj, int connectionid, int iTimeout);
int GetTimeout(int iConnectionId);
int SetTimeout(int iConnectionId, int iTimeout);
Default Value
0
Remarks
This property specifies a timeout for the class.
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 class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.
The class will use DoEvents 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 class fails with an error.
Please note that by default, all timeouts are inactivity timeouts, i.e. 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.
This property is not available at design time.
Data Type
Integer
UserData Property (SSLServer Class)
The UserData property holds connection-specific user-specified data.
Syntax
ANSI (Cross Platform) int GetUserData(int iConnectionId, char* &lpUserData, int &lenUserData);
int SetUserData(int iConnectionId, const char* lpUserData, int lenUserData); Unicode (Windows) INT GetUserData(INT iConnectionId, LPSTR &lpUserData, INT &lenUserData);
INT SetUserData(INT iConnectionId, LPCSTR lpUserData, INT lenUserData);
int ipworksssl_sslserver_getuserdata(void* lpObj, int connectionid, char** lpUserData, int* lenUserData);
int ipworksssl_sslserver_setuserdata(void* lpObj, int connectionid, const char* lpUserData, int lenUserData);
QByteArray GetUserData(int iConnectionId);
int SetUserData(int iConnectionId, QByteArray qbaUserData);
Default Value
""
Remarks
The UserData 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.
This property is not available at design time.
Data Type
Binary String
DefaultEOL Property (SSLServer Class)
This property includes a default end-of-line (EOL) value to be used by incoming connections.
Syntax
ANSI (Cross Platform) int GetDefaultEOL(char* &lpDefaultEOL, int &lenDefaultEOL);
int SetDefaultEOL(const char* lpDefaultEOL, int lenDefaultEOL); Unicode (Windows) INT GetDefaultEOL(LPSTR &lpDefaultEOL, INT &lenDefaultEOL);
INT SetDefaultEOL(LPCSTR lpDefaultEOL, INT lenDefaultEOL);
int ipworksssl_sslserver_getdefaulteol(void* lpObj, char** lpDefaultEOL, int* lenDefaultEOL);
int ipworksssl_sslserver_setdefaulteol(void* lpObj, const char* lpDefaultEOL, int lenDefaultEOL);
QByteArray GetDefaultEOL();
int SetDefaultEOL(QByteArray qbaDefaultEOL);
Default Value
""
Remarks
This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the class 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
Binary String
DefaultIdleTimeout Property (SSLServer Class)
This property includes the default idle timeout for inactive clients.
Syntax
ANSI (Cross Platform) int GetDefaultIdleTimeout();
int SetDefaultIdleTimeout(int iDefaultIdleTimeout); Unicode (Windows) INT GetDefaultIdleTimeout();
INT SetDefaultIdleTimeout(INT iDefaultIdleTimeout);
int ipworksssl_sslserver_getdefaultidletimeout(void* lpObj);
int ipworksssl_sslserver_setdefaultidletimeout(void* lpObj, int iDefaultIdleTimeout);
int GetDefaultIdleTimeout();
int SetDefaultIdleTimeout(int iDefaultIdleTimeout);
Default Value
0
Remarks
This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the class will disconnect idle clients after the specified timeout.
This applies only to clients that have not sent or received data within DefaultIdleTimeout seconds.
If set to 0 (default), no idle timeout is applied.
Note: DoEvents must be called for the class to check existing connections.
Data Type
Integer
DefaultMaxLineLength Property (SSLServer Class)
The property includes the default maximum line length value for inbound connections.
Syntax
ANSI (Cross Platform) int GetDefaultMaxLineLength();
int SetDefaultMaxLineLength(int iDefaultMaxLineLength); Unicode (Windows) INT GetDefaultMaxLineLength();
INT SetDefaultMaxLineLength(INT iDefaultMaxLineLength);
int ipworksssl_sslserver_getdefaultmaxlinelength(void* lpObj);
int ipworksssl_sslserver_setdefaultmaxlinelength(void* lpObj, int iDefaultMaxLineLength);
int GetDefaultMaxLineLength();
int SetDefaultMaxLineLength(int iDefaultMaxLineLength);
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
Integer
DefaultSingleLineMode Property (SSLServer Class)
This property tells the class whether or not to treat new connections as line oriented.
Syntax
ANSI (Cross Platform) int GetDefaultSingleLineMode();
int SetDefaultSingleLineMode(int bDefaultSingleLineMode); Unicode (Windows) BOOL GetDefaultSingleLineMode();
INT SetDefaultSingleLineMode(BOOL bDefaultSingleLineMode);
int ipworksssl_sslserver_getdefaultsinglelinemode(void* lpObj);
int ipworksssl_sslserver_setdefaultsinglelinemode(void* lpObj, int bDefaultSingleLineMode);
bool GetDefaultSingleLineMode();
int SetDefaultSingleLineMode(bool bDefaultSingleLineMode);
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
Boolean
DefaultTimeout Property (SSLServer Class)
This property includes an initial timeout value to be used by incoming connections.
Syntax
ANSI (Cross Platform) int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout); Unicode (Windows) INT GetDefaultTimeout();
INT SetDefaultTimeout(INT iDefaultTimeout);
int ipworksssl_sslserver_getdefaulttimeout(void* lpObj);
int ipworksssl_sslserver_setdefaulttimeout(void* lpObj, int iDefaultTimeout);
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);
Default Value
0
Remarks
This property is used by the class 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
Integer
KeepAlive Property (SSLServer Class)
When True, KEEPALIVE packets are enabled (for long connections).
Syntax
ANSI (Cross Platform) int GetKeepAlive();
int SetKeepAlive(int bKeepAlive); Unicode (Windows) BOOL GetKeepAlive();
INT SetKeepAlive(BOOL bKeepAlive);
int ipworksssl_sslserver_getkeepalive(void* lpObj);
int ipworksssl_sslserver_setkeepalive(void* lpObj, int bKeepAlive);
bool GetKeepAlive();
int SetKeepAlive(bool bKeepAlive);
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
Boolean
Linger Property (SSLServer Class)
When set to True, connections are terminated gracefully.
Syntax
ANSI (Cross Platform) int GetLinger();
int SetLinger(int bLinger); Unicode (Windows) BOOL GetLinger();
INT SetLinger(BOOL bLinger);
int ipworksssl_sslserver_getlinger(void* lpObj);
int ipworksssl_sslserver_setlinger(void* lpObj, int bLinger);
bool GetLinger();
int SetLinger(bool bLinger);
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 class 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
Boolean
Listening Property (SSLServer Class)
If set to True, the class accepts incoming connections on LocalPort.
Syntax
ANSI (Cross Platform) int GetListening();
int SetListening(int bListening); Unicode (Windows) BOOL GetListening();
INT SetListening(BOOL bListening);
int ipworksssl_sslserver_getlistening(void* lpObj);
int ipworksssl_sslserver_setlistening(void* lpObj, int bListening);
bool GetListening();
int SetListening(bool bListening);
Default Value
FALSE
Remarks
This property indicates whether the class is listening for connections on the port specified by the LocalPort property.
Note: Use the StartListening and StopListening methods to control whether the class is listening.
This property is not available at design time.
Data Type
Boolean
LocalHost Property (SSLServer Class)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
ANSI (Cross Platform) char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* ipworksssl_sslserver_getlocalhost(void* lpObj);
int ipworksssl_sslserver_setlocalhost(void* lpObj, const char* lpszLocalHost);
QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);
Default Value
""
Remarks
The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.
If the class is connected, the LocalHost 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 multi-homed hosts (machines with more than one IP interface).
NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
LocalPort Property (SSLServer Class)
This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens.
Syntax
ANSI (Cross Platform) int GetLocalPort();
int SetLocalPort(int iLocalPort); Unicode (Windows) INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);
int ipworksssl_sslserver_getlocalport(void* lpObj);
int ipworksssl_sslserver_setlocalport(void* lpObj, int iLocalPort);
int GetLocalPort();
int SetLocalPort(int iLocalPort);
Default Value
0
Remarks
This property must be set before the class 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 class is listening (i.e., after successfully assigning True to the Listening property).
The service port is not shared among servers so two classs cannot be listening on the same port at the same time.
Data Type
Integer
SSLAuthenticateClients Property (SSLServer Class)
If set to True, the server asks the client(s) for a certificate.
Syntax
ANSI (Cross Platform) int GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(int bSSLAuthenticateClients); Unicode (Windows) BOOL GetSSLAuthenticateClients();
INT SetSSLAuthenticateClients(BOOL bSSLAuthenticateClients);
int ipworksssl_sslserver_getsslauthenticateclients(void* lpObj);
int ipworksssl_sslserver_setsslauthenticateclients(void* lpObj, int bSSLAuthenticateClients);
bool GetSSLAuthenticateClients();
int SetSSLAuthenticateClients(bool bSSLAuthenticateClients);
Default Value
FALSE
Remarks
This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.
Data Type
Boolean
SSLCertEncoded Property (SSLServer Class)
This is the certificate (PEM/base64 encoded).
Syntax
ANSI (Cross Platform) int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded); Unicode (Windows) INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);
int ipworksssl_sslserver_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksssl_sslserver_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);
QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);
Default Value
""
Remarks
This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.
When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.
This property is not available at design time.
Data Type
Binary String
SSLCertStore Property (SSLServer Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore); Unicode (Windows) INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);
int ipworksssl_sslserver_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksssl_sslserver_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);
QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
Binary String
SSLCertStorePassword Property (SSLServer Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* ipworksssl_sslserver_getsslcertstorepassword(void* lpObj);
int ipworksssl_sslserver_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);
QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);
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
SSLCertStoreType Property (SSLServer Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksssl_sslserver_getsslcertstoretype(void* lpObj);
int ipworksssl_sslserver_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
Integer
SSLCertSubject Property (SSLServer Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* ipworksssl_sslserver_getsslcertsubject(void* lpObj);
int ipworksssl_sslserver_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);
QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);
Default Value
""
Remarks
This is 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=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SSLProvider Property (SSLServer Class)
This specifies the SSL/TLS implementation to use.
Syntax
ANSI (Cross Platform) int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);
Possible Values
SSLP_AUTOMATIC(0),
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int ipworksssl_sslserver_getsslprovider(void* lpObj);
int ipworksssl_sslserver_setsslprovider(void* lpObj, int iSSLProvider);
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);
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 class 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:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.
When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.
Data Type
Integer
ChangeRecordLength Method (SSLServer Class)
This method changes the length of received data records.
Syntax
ANSI (Cross Platform) int ChangeRecordLength(int iConnectionId, int iRecordLength); Unicode (Windows) INT ChangeRecordLength(INT iConnectionId, INT iRecordLength);
int ipworksssl_sslserver_changerecordlength(void* lpObj, int iConnectionId, int iRecordLength);
int ChangeRecordLength(int iConnectionId, int iRecordLength);
Remarks
This method defines the length of data records to be received (in bytes) for the specified ConnectionId.
If RecordLength is set to a positive value, the class will accumulate data until RecordLength bytes of data are received and only then will fire the DataIn event with data of the specified length RecordLength. 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 DataIn event.
A value of 0 (default) means this functionality is not used.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Config Method (SSLServer Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksssl_sslserver_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Disconnect Method (SSLServer Class)
This method disconnects the specified client.
Syntax
ANSI (Cross Platform) int Disconnect(int iConnectionId); Unicode (Windows) INT Disconnect(INT iConnectionId);
int ipworksssl_sslserver_disconnect(void* lpObj, int iConnectionId);
int Disconnect(int iConnectionId);
Remarks
Calling this method will disconnect the client specified by the ConnectionId parameter.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (SSLServer Class)
Processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworksssl_sslserver_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Interrupt Method (SSLServer Class)
This method interrupts a synchronous send to the remote host.
Syntax
ANSI (Cross Platform) int Interrupt(int iConnectionId); Unicode (Windows) INT Interrupt(INT iConnectionId);
int ipworksssl_sslserver_interrupt(void* lpObj, int iConnectionId);
int Interrupt(int iConnectionId);
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 class. If you use SendFile to upload a file, the class will run synchronously on that Connection Id until it is completed.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
PauseData Method (SSLServer Class)
This method pauses data reception.
Syntax
ANSI (Cross Platform) int PauseData(int iConnectionId); Unicode (Windows) INT PauseData(INT iConnectionId);
int ipworksssl_sslserver_pausedata(void* lpObj, int iConnectionId);
int PauseData(int iConnectionId);
Remarks
This method pauses data reception for the connection identified by ConnectionId when called. While data reception is paused, the DataIn event will not fire for the specified connection. Call ProcessData to reenable data reception.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
ProcessData Method (SSLServer Class)
This method reenables data reception after a call to PauseData .
Syntax
ANSI (Cross Platform) int ProcessData(int iConnectionId); Unicode (Windows) INT ProcessData(INT iConnectionId);
int ipworksssl_sslserver_processdata(void* lpObj, int iConnectionId);
int ProcessData(int iConnectionId);
Remarks
This method reenables data reception for the connection identified by ConnectionId after a previous call to PauseData. When PauseData is called, the DataIn event will not fire for the specified connection. To reenable data reception and allow DataIn to fire, call this method.
Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (SSLServer Class)
Reset the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksssl_sslserver_reset(void* lpObj);
int Reset();
Remarks
This method will reset the class's properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Send Method (SSLServer Class)
This method sends binary data to the specified client.
Syntax
ANSI (Cross Platform) int Send(int iConnectionId, const char* lpText, int lenText); Unicode (Windows) INT Send(INT iConnectionId, LPCSTR lpText, INT lenText);
int ipworksssl_sslserver_send(void* lpObj, int iConnectionId, const char* lpText, int lenText);
int Send(int iConnectionId, QByteArray qbaText);
Remarks
This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.
When WSConnectionTimeout is set to 0, the class 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 BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.
Note: The ReadyToSend event is not fired when part of the data is sent successfully.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendBytes Method (SSLServer Class)
This method sends binary data to the specified client.
Syntax
ANSI (Cross Platform) int SendBytes(int iConnectionId, const char* lpData, int lenData); Unicode (Windows) INT SendBytes(INT iConnectionId, LPCSTR lpData, INT lenData);
int ipworksssl_sslserver_sendbytes(void* lpObj, int iConnectionId, const char* lpData, int lenData);
int SendBytes(int iConnectionId, QByteArray qbaData);
Remarks
This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.
When WSConnectionTimeout is set to 0, the class 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 BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.
Note: The ReadyToSend event is not fired when part of the data is sent successfully.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendFile Method (SSLServer Class)
This method sends the file to the remote host.
Syntax
ANSI (Cross Platform) int SendFile(int iConnectionId, const char* lpszFileName); Unicode (Windows) INT SendFile(INT iConnectionId, LPCWSTR lpszFileName);
int ipworksssl_sslserver_sendfile(void* lpObj, int iConnectionId, const char* lpszFileName);
int SendFile(int iConnectionId, const QString& qsFileName);
Remarks
This method sends the file to the client specified by the ConnectionId.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendLine Method (SSLServer Class)
This method sends a string followed by a new line.
Syntax
ANSI (Cross Platform) int SendLine(int iConnectionId, const char* lpszText); Unicode (Windows) INT SendLine(INT iConnectionId, LPCWSTR lpszText);
int ipworksssl_sslserver_sendline(void* lpObj, int iConnectionId, const char* lpszText);
int SendLine(int iConnectionId, const QString& qsText);
Remarks
This method is used to send data with line-oriented protocols. The line is followed by CRLF ("\r\n") .
Please refer to the GetLine method and SingleLineMode property for more information.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SendText Method (SSLServer Class)
This method sends text to the specified client.
Syntax
ANSI (Cross Platform) int SendText(int iConnectionId, const char* lpszText); Unicode (Windows) INT SendText(INT iConnectionId, LPCWSTR lpszText);
int ipworksssl_sslserver_sendtext(void* lpObj, int iConnectionId, const char* lpszText);
int SendText(int iConnectionId, const QString& qsText);
Remarks
This method sends text to the client identified by ConnectionId. To send binary data, use the SendBytes method instead.
When WSConnectionTimeout is set to 0, the class 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 BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.
Note: The ReadyToSend event is not fired when part of the data is sent successfully.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Shutdown Method (SSLServer Class)
This method shuts down the server.
Syntax
ANSI (Cross Platform) int Shutdown(); Unicode (Windows) INT Shutdown();
int ipworksssl_sslserver_shutdown(void* lpObj);
int Shutdown();
Remarks
This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
StartListening Method (SSLServer Class)
This method starts listening for incoming connections.
Syntax
ANSI (Cross Platform) int StartListening(); Unicode (Windows) INT StartListening();
int ipworksssl_sslserver_startlistening(void* lpObj);
int StartListening();
Remarks
This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.
To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
StopListening Method (SSLServer Class)
This method stops listening for new connections.
Syntax
ANSI (Cross Platform) int StopListening(); Unicode (Windows) INT StopListening();
int ipworksssl_sslserver_stoplistening(void* lpObj);
int StopListening();
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Connected Event (SSLServer Class)
This event is fired immediately after a connection completes (or fails).
Syntax
ANSI (Cross Platform) virtual int FireConnected(SSLServerConnectedEventParams *e);
typedef struct {
int ConnectionId;
int StatusCode;
const char *Description; int reserved; } SSLServerConnectedEventParams;
Unicode (Windows) virtual INT FireConnected(SSLServerConnectedEventParams *e);
typedef struct {
INT ConnectionId;
INT StatusCode;
LPCWSTR Description; INT reserved; } SSLServerConnectedEventParams;
#define EID_SSLSERVER_CONNECTED 1 virtual INT IPWORKSSSL_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);
class SSLServerConnectedEventParams { public: int ConnectionId(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Connected(SSLServerConnectedEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireConnected(SSLServerConnectedEventParams *e) {...}
Remarks
If the connection is made normally, StatusCode is 0, and Description is "OK".
If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.
Please refer to the Error Codes section for more information.
ConnectionRequest Event (SSLServer Class)
This event is fired when a request for connection comes from a remote host.
Syntax
ANSI (Cross Platform) virtual int FireConnectionRequest(SSLServerConnectionRequestEventParams *e);
typedef struct {
const char *Address;
int Port;
int Accept; int reserved; } SSLServerConnectionRequestEventParams;
Unicode (Windows) virtual INT FireConnectionRequest(SSLServerConnectionRequestEventParams *e);
typedef struct {
LPCWSTR Address;
INT Port;
BOOL Accept; INT reserved; } SSLServerConnectionRequestEventParams;
#define EID_SSLSERVER_CONNECTIONREQUEST 2 virtual INT IPWORKSSSL_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);
class SSLServerConnectionRequestEventParams { public: const QString &Address(); int Port(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ConnectionRequest(SSLServerConnectionRequestEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireConnectionRequest(SSLServerConnectionRequestEventParams *e) {...}
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.
DataIn Event (SSLServer Class)
This event is fired when data come in.
Syntax
ANSI (Cross Platform) virtual int FireDataIn(SSLServerDataInEventParams *e);
typedef struct {
int ConnectionId;
const char *Text; int lenText;
int EOL; int reserved; } SSLServerDataInEventParams;
Unicode (Windows) virtual INT FireDataIn(SSLServerDataInEventParams *e);
typedef struct {
INT ConnectionId;
LPCSTR Text; INT lenText;
BOOL EOL; INT reserved; } SSLServerDataInEventParams;
#define EID_SSLSERVER_DATAIN 3 virtual INT IPWORKSSSL_CALL FireDataIn(INT &iConnectionId, LPSTR &lpText, INT &lenText, BOOL &bEOL);
class SSLServerDataInEventParams { public: int ConnectionId(); const QByteArray &Text(); bool EOL(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void DataIn(SSLServerDataInEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireDataIn(SSLServerDataInEventParams *e) {...}
Remarks
Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. 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 DefaultMaxLineLength or with no EOL strings in it, then EOL is False. Please note that this means that one or more DataIn 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.
Disconnected Event (SSLServer Class)
This event is fired when a connection is closed.
Syntax
ANSI (Cross Platform) virtual int FireDisconnected(SSLServerDisconnectedEventParams *e);
typedef struct {
int ConnectionId;
int StatusCode;
const char *Description; int reserved; } SSLServerDisconnectedEventParams;
Unicode (Windows) virtual INT FireDisconnected(SSLServerDisconnectedEventParams *e);
typedef struct {
INT ConnectionId;
INT StatusCode;
LPCWSTR Description; INT reserved; } SSLServerDisconnectedEventParams;
#define EID_SSLSERVER_DISCONNECTED 4 virtual INT IPWORKSSSL_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);
class SSLServerDisconnectedEventParams { public: int ConnectionId(); int StatusCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Disconnected(SSLServerDisconnectedEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireDisconnected(SSLServerDisconnectedEventParams *e) {...}
Remarks
If the connection is broken normally, StatusCode is 0, and Description is "OK".
If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.
Please refer to the Error Codes section for more information.
Error Event (SSLServer Class)
This event fires information about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(SSLServerErrorEventParams *e);
typedef struct {
int ConnectionId;
int ErrorCode;
const char *Description; int reserved; } SSLServerErrorEventParams;
Unicode (Windows) virtual INT FireError(SSLServerErrorEventParams *e);
typedef struct {
INT ConnectionId;
INT ErrorCode;
LPCWSTR Description; INT reserved; } SSLServerErrorEventParams;
#define EID_SSLSERVER_ERROR 5 virtual INT IPWORKSSSL_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);
class SSLServerErrorEventParams { public: int ConnectionId(); int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(SSLServerErrorEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireError(SSLServerErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally, the class fails with an error.
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 Error Codes section.
ConnectionId indicates the connection for which the error is applicable.
ReadyToSend Event (SSLServer Class)
This event is fired when the class is ready to send data.
Syntax
ANSI (Cross Platform) virtual int FireReadyToSend(SSLServerReadyToSendEventParams *e);
typedef struct {
int ConnectionId; int reserved; } SSLServerReadyToSendEventParams;
Unicode (Windows) virtual INT FireReadyToSend(SSLServerReadyToSendEventParams *e);
typedef struct {
INT ConnectionId; INT reserved; } SSLServerReadyToSendEventParams;
#define EID_SSLSERVER_READYTOSEND 6 virtual INT IPWORKSSSL_CALL FireReadyToSend(INT &iConnectionId);
class SSLServerReadyToSendEventParams { public: int ConnectionId(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void ReadyToSend(SSLServerReadyToSendEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireReadyToSend(SSLServerReadyToSendEventParams *e) {...}
Remarks
The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed DataToSend. This event is also fired immediately after a connection is established.
SSLClientAuthentication Event (SSLServer Class)
This event is fired when the client presents its credentials to the server.
Syntax
ANSI (Cross Platform) virtual int FireSSLClientAuthentication(SSLServerSSLClientAuthenticationEventParams *e);
typedef struct {
int ConnectionId;
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } SSLServerSSLClientAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLClientAuthentication(SSLServerSSLClientAuthenticationEventParams *e);
typedef struct {
INT ConnectionId;
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } SSLServerSSLClientAuthenticationEventParams;
#define EID_SSLSERVER_SSLCLIENTAUTHENTICATION 7 virtual INT IPWORKSSSL_CALL FireSSLClientAuthentication(INT &iConnectionId, LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class SSLServerSSLClientAuthenticationEventParams { public: int ConnectionId(); const QByteArray &CertEncoded(); const QString &CertSubject(); const QString &CertIssuer(); const QString &Status(); bool Accept(); void SetAccept(bool bAccept); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLClientAuthentication(SSLServerSSLClientAuthenticationEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireSSLClientAuthentication(SSLServerSSLClientAuthenticationEventParams *e) {...}
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").
SSLConnectionRequest Event (SSLServer Class)
This event fires when a Secure Sockets Layer (SSL) connection is requested.
Syntax
ANSI (Cross Platform) virtual int FireSSLConnectionRequest(SSLServerSSLConnectionRequestEventParams *e);
typedef struct {
int ConnectionId;
const char *SupportedCipherSuites;
const char *SupportedSignatureAlgs;
int CertStoreType;
char *CertStore;
char *CertPassword;
char *CertSubject; int reserved; } SSLServerSSLConnectionRequestEventParams;
Unicode (Windows) virtual INT FireSSLConnectionRequest(SSLServerSSLConnectionRequestEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR SupportedCipherSuites;
LPCWSTR SupportedSignatureAlgs;
INT CertStoreType;
LPWSTR CertStore;
LPWSTR CertPassword;
LPWSTR CertSubject; INT reserved; } SSLServerSSLConnectionRequestEventParams;
#define EID_SSLSERVER_SSLCONNECTIONREQUEST 8 virtual INT IPWORKSSSL_CALL FireSSLConnectionRequest(INT &iConnectionId, LPSTR &lpszSupportedCipherSuites, LPSTR &lpszSupportedSignatureAlgs, INT &iCertStoreType, LPSTR &lpszCertStore, LPSTR &lpszCertPassword, LPSTR &lpszCertSubject);
class SSLServerSSLConnectionRequestEventParams { public: int ConnectionId(); const QString &SupportedCipherSuites(); const QString &SupportedSignatureAlgs(); int CertStoreType(); void SetCertStoreType(int iCertStoreType); const QString &CertStore(); void SetCertStore(const QString &qsCertStore); const QString &CertPassword(); void SetCertPassword(const QString &qsCertPassword); const QString &CertSubject(); void SetCertSubject(const QString &qsCertSubject); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLConnectionRequest(SSLServerSSLConnectionRequestEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireSSLConnectionRequest(SSLServerSSLConnectionRequestEventParams *e) {...}
Remarks
This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.
This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.
ConnectionId is the connection Id of the client requesting the connection.
SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.
SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.
CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the and set to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
CertStore 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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.
CertSubject 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=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
SSLStatus Event (SSLServer Class)
This event is fired to show the progress of the secure connection.
Syntax
ANSI (Cross Platform) virtual int FireSSLStatus(SSLServerSSLStatusEventParams *e);
typedef struct {
int ConnectionId;
const char *Message; int reserved; } SSLServerSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(SSLServerSSLStatusEventParams *e);
typedef struct {
INT ConnectionId;
LPCWSTR Message; INT reserved; } SSLServerSSLStatusEventParams;
#define EID_SSLSERVER_SSLSTATUS 9 virtual INT IPWORKSSSL_CALL FireSSLStatus(INT &iConnectionId, LPSTR &lpszMessage);
class SSLServerSSLStatusEventParams { public: int ConnectionId(); const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void SSLStatus(SSLServerSSLStatusEventParams *e);
// Or, subclass SSLServer and override this emitter function. virtual int FireSSLStatus(SSLServerSSLStatusEventParams *e) {...}
Remarks
The event is fired for informational and logging purposes only. It is used to track the progress of the connection.
Config Settings (SSLServer Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.TCPServer Config Settings
When a client connects, the client's address is checked against the list defined here. If there is no match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will be disconnected.
When a client connects, the client's address is checked against the list defined here. If there is a match, the ConnectionRequest event fires with an Accept value set to False. If no action is taken within the ConnectionRequest event, the client will not be connected.
Connection5UID = obj.config("ConnectionUID[5]")
Note: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated, the InBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.
InBufferSize 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.
Note: This value is not applicable in macOS.
Note: This configuration setting is available only in the Unix platform, and it is not supported in macOS or FreeBSD.
Note: Unix/Linux operating systems limit the number of simultaneous connections to 1024.
The default value is 50 (milliseconds).
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.
OutBufferSize 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.
By default, this config is set to false.
Nothing else is required to begin accepting IOCP connections. One major benefit to using this model is that there will be no thread blocked waiting for a request to complete. The system notifies the process through an Asynchronous Procedure Call (APC) once the device driver finishes servicing the I/O request. IOCP allows a single I/O worker thread handle multiple clients' input/output "fairly".
Note: When set to True, this setting will automatically set UseWindowsMessages to False.
0 | IPv4 Only |
1 | IPv6 Only |
2 | IPv6 and IPv4 |
Nothing else is required to begin accepting connections using the Windows message queue. In high-traffic environments, messages will be discarded if the queue is full. Additionally, because a single window procedure will service all events on thousands of sockets, the Windows message queue is not scalable from a performance perspective.
If this setting is set to False, the class will instead use the Winsock select model instead. The component supports additional I/O models. Please see UseIOCP for more information.
SSL Config Settings
When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.
Enabling this setting has no effect if SSLProvider is set to Platform.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.
If set to true, the class will reuse the context if and only if the following criteria are met:
- The target host name is the same.
- The system cache entry has not expired (default timeout is 10 hours).
- The application process that calls the function is the same.
- The logon session is the same.
- The instance of the class is the same.
The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.
The default value is:
/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.
Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.
Multiple cipher suites are separated by semicolons.
Example values when SSLProvider is set to Platform:
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
Possible values when SSLProvider is set to Platform include:
- CALG_3DES
- CALG_3DES_112
- CALG_AES
- CALG_AES_128
- CALG_AES_192
- CALG_AES_256
- CALG_AGREEDKEY_ANY
- CALG_CYLINK_MEK
- CALG_DES
- CALG_DESX
- CALG_DH_EPHEM
- CALG_DH_SF
- CALG_DSS_SIGN
- CALG_ECDH
- CALG_ECDH_EPHEM
- CALG_ECDSA
- CALG_ECMQV
- CALG_HASH_REPLACE_OWF
- CALG_HUGHES_MD5
- CALG_HMAC
- CALG_KEA_KEYX
- CALG_MAC
- CALG_MD2
- CALG_MD4
- CALG_MD5
- CALG_NO_SIGN
- CALG_OID_INFO_CNG_ONLY
- CALG_OID_INFO_PARAMETERS
- CALG_PCT1_MASTER
- CALG_RC2
- CALG_RC4
- CALG_RC5
- CALG_RSA_KEYX
- CALG_RSA_SIGN
- CALG_SCHANNEL_ENC_KEY
- CALG_SCHANNEL_MAC_KEY
- CALG_SCHANNEL_MASTER_HASH
- CALG_SEAL
- CALG_SHA
- CALG_SHA1
- CALG_SHA_256
- CALG_SHA_384
- CALG_SHA_512
- CALG_SKIPJACK
- CALG_SSL2_MASTER
- CALG_SSL3_MASTER
- CALG_SSL3_SHAMD5
- CALG_TEK
- CALG_TLS1_MASTER
- CALG_TLS1PRF
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include:
- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
- TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA
When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:
- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256
SSLEnabledCipherSuites is used together with SSLCipherStrength.
Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default) |
TLS1.1 | 768 (Hex 300) (Default) |
TLS1 | 192 (Hex C0) (Default) |
SSL3 | 48 (Hex 30) [Platform Only] |
SSL2 | 12 (Hex 0C) [Platform Only] |
SSLEnabledProtocols - TLS 1.3 Notes
By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.
If set to 1 (Platform provider) please be aware of the following notes:
- The platform provider is only available on Windows 11 / Windows Server 2022 and up.
- SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
- If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This setting is only applicable when SSLProvider is set to Internal.
If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.
When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.
Note: This setting is only applicable when SSLProvider is set to Internal.
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
0x00000001 | Ignore time validity status of certificate. |
0x00000002 | Ignore time validity status of CTL. |
0x00000004 | Ignore non-nested certificate times. |
0x00000010 | Allow unknown Certificate Authority. |
0x00000020 | Ignore wrong certificate usage. |
0x00000100 | Ignore unknown certificate revocation status. |
0x00000200 | Ignore unknown CTL signer revocation status. |
0x00000400 | Ignore unknown Certificate Authority revocation status. |
0x00000800 | Ignore unknown Root revocation status. |
0x00008000 | Allow test Root certificate. |
0x00004000 | Trust test Root certificate. |
0x80000000 | Ignore non-matching CN (certificate CN not-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this setting is a newline (CrLf) separated list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp .. d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.
The format of this value is a comma separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.
In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.
When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.
In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.
The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448"
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1"
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096"
- "ffdhe_6144"
- "ffdhe_8192"
- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)
The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details please see the FIPS 140-2 Compliance article.
Note: This setting is only applicable on Windows.
Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (SSLServer Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
SSLServer Errors
100 You cannot change the RemotePort at this time. A connection is in progress. | |
101 You cannot change the RemoteHost at this time. A connection is in progress. | |
102 The RemoteHost address is invalid (0.0.0.0). | |
104 SSLServer is already listening. | |
106 Cannot change LocalPort when SSLServer is listening. | |
107 Cannot change LocalHost when SSLServer is listening. | |
108 Cannot change MaxConnections when SSLServer is listening. | |
112 You cannot change MaxLineLength at this time. A connection is in progress. | |
116 RemotePort cannot be zero. Please specify a valid service port number. | |
126 Invalid ConnectionId. | |
135 Operation would block. |
SSL Errors
270 Cannot load specified security library. | |
271 Cannot open certificate store. | |
272 Cannot find specified certificate. | |
273 Cannot acquire security credentials. | |
274 Cannot find certificate chain. | |
275 Cannot verify certificate chain. | |
276 Error during handshake. | |
280 Error verifying certificate. | |
281 Could not find client certificate. | |
282 Could not find server certificate. | |
283 Error encrypting data. | |
284 Error decrypting data. |
TCP/IP Errors
10004 [10004] Interrupted system call. | |
10009 [10009] Bad file number. | |
10013 [10013] Access denied. | |
10014 [10014] Bad address. | |
10022 [10022] Invalid argument. | |
10024 [10024] Too many open files. | |
10035 [10035] Operation would block. | |
10036 [10036] Operation now in progress. | |
10037 [10037] Operation already in progress. | |
10038 [10038] Socket operation on non-socket. | |
10039 [10039] Destination address required. | |
10040 [10040] Message too long. | |
10041 [10041] Protocol wrong type for socket. | |
10042 [10042] Bad protocol option. | |
10043 [10043] Protocol not supported. | |
10044 [10044] Socket type not supported. | |
10045 [10045] Operation not supported on socket. | |
10046 [10046] Protocol family not supported. | |
10047 [10047] Address family not supported by protocol family. | |
10048 [10048] Address already in use. | |
10049 [10049] Can't assign requested address. | |
10050 [10050] Network is down. | |
10051 [10051] Network is unreachable. | |
10052 [10052] Net dropped connection or reset. | |
10053 [10053] Software caused connection abort. | |
10054 [10054] Connection reset by peer. | |
10055 [10055] No buffer space available. | |
10056 [10056] Socket is already connected. | |
10057 [10057] Socket is not connected. | |
10058 [10058] Can't send after socket shutdown. | |
10059 [10059] Too many references, can't splice. | |
10060 [10060] Connection timed out. | |
10061 [10061] Connection refused. | |
10062 [10062] Too many levels of symbolic links. | |
10063 [10063] File name too long. | |
10064 [10064] Host is down. | |
10065 [10065] No route to host. | |
10066 [10066] Directory not empty | |
10067 [10067] Too many processes. | |
10068 [10068] Too many users. | |
10069 [10069] Disc Quota Exceeded. | |
10070 [10070] Stale NFS file handle. | |
10071 [10071] Too many levels of remote in path. | |
10091 [10091] Network subsystem is unavailable. | |
10092 [10092] WINSOCK DLL Version out of range. | |
10093 [10093] Winsock not loaded yet. | |
11001 [11001] Host not found. | |
11002 [11002] Non-authoritative 'Host not found' (try again or check DNS setup). | |
11003 [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP. | |
11004 [11004] Valid name, no data record (check DNS setup). |