WSServer Control
Properties Methods Events Config Settings Errors
The WSServer control is used to create a WebSocket server.
Syntax
WSServer
Remarks
The WSServer control functions as a server that facilitates incoming WebSocket connections and offers a convenient means of transmitting and receiving data over the established connections.
To start, the LocalPort property must be specified to a valid port. This port will be used to accept incoming connections. Then, call the StartListening method to start listening on the specified port. The WSServer control supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method. The SSLCert properties are used to select a certificate for the server.
Note: A valid certificate must be selected before the server can function.
Upon a client's connection, the WebSocketOpenRequest event will be fired. To accept the connection, simply allow the event to complete its execution. Conversely, to reject the request, the StatusCode parameter can be set to an appropriate HTTP error code, such as 401.
By default, each instance of WSServer has the capacity to handle up to 1,000 simultaneous incoming connections. You can change the maximum number of simultaneous connections by adjusting the MaxConnections configuration setting. This setting allows you to increase the limit up to 100,000 or decrease it to a lower value based on your needs.
Each connection is identified by a unique ConnectionId, an identifier generated by the component to distinguish individual connections. The ConnectionId is also included as a parameter in WSServer's events to identify the associated connection.
After receiving a connection, incoming data can be accessed through the DataIn event. To transmit data to a client, the Send, SendText, or SendFile methods can be employed.
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 control 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. |
| WSConnectionCount | The number of records in the WSConnection arrays. |
| WSConnectionAcceptData | This property indicates whether data reception is currently enabled. |
| WSConnectionBytesSent | This property shows how many bytes were sent after calling Send or SendBytes . |
| WSConnectionConnected | This property indicates the status of individual connections. |
| WSConnectionConnectionId | This property contains an identifier generated by the control to identify each connection. |
| WSConnectionDataFormat | This property includes the format of the data being sent. |
| WSConnectionHost | This property includes the Host header value of the connected client. |
| WSConnectionLineMode | When LineMode is False (default), the control will fire the DataIn event once for each message received from the server. |
| WSConnectionLocalAddress | This property shows the IP address of the interface through which the connection is passing. |
| WSConnectionOrigin | This property includes the origin header value of the connected client. |
| WSConnectionReadyToSend | This property indicates whether the control is ready to send data. |
| WSConnectionRemoteHost | This property shows the IP address of the connected client. |
| WSConnectionRemotePort | This property shows the port of the connected client. |
| WSConnectionRequestHeaders | The HTTP headers sent by the client in the initial WebSocket connection request. |
| WSConnectionRequestURI | This property includes the requested URI sent by the client in the initial WebSocket connection request. |
| WSConnectionSubProtocols | This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request. |
| WSConnectionTimeout | This property specifies a timeout for the control. |
| DefaultTimeout | This property includes initial timeout value to be used by incoming connections. |
| Listening | This property indicates whether the control is listening for 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 control listens. |
| SSLAuthenticateClients | If set to True, the server asks the client(s) for a certificate. |
| SSLCertEffectiveDate | The date on which this certificate becomes valid. |
| SSLCertExpirationDate | The date on which the certificate expires. |
| SSLCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SSLCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SSLCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SSLCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SSLCertIssuer | The issuer of the certificate. |
| SSLCertPrivateKey | The private key of the certificate (if available). |
| SSLCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SSLCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SSLCertPublicKey | The public key of the certificate. |
| SSLCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SSLCertPublicKeyLength | The length of the certificate's public key (in bits). |
| SSLCertSerialNumber | The serial number of the certificate encoded as a string. |
| SSLCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SSLCertStore | 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 | The type of certificate store for this certificate. |
| SSLCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SSLCertThumbprintMD5 | The MD5 hash of the certificate. |
| SSLCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SSLCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SSLCertUsage | The text description of UsageFlags . |
| SSLCertUsageFlags | The flags that show intended use for the certificate. |
| SSLCertVersion | The certificate's version number. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLCertEncoded | The certificate (PEM/Base64 encoded). |
| SSLProvider | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
| UseSSL | This property determines if the Secure Sockets Layer (SSL) is negotiated with incoming connections. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| ChangeLineMode | This method controls whether the control will fire DataIn when an EOL is received for the specified connection. |
| Config | Sets or retrieves a configuration setting. |
| Disconnect | This method disconnects the specified client. |
| DoEvents | This method processes events from the internal message queue. |
| Interrupt | This method interrupts a synchronous send to the remote host. |
| Ping | This method sends a ping request to the remote host. |
| Send | This method sends binary data to the client. |
| SendBytes | This method sends binary data to the specified client. |
| SendFile | This method sends the file to the remote host. |
| SendText | This method sends text data to the 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 control with short descriptions. Click on the links for further details.
| Connected | This event is fired when a WebSocket is successfully opened. |
| ConnectionRequest | This event is fired when a request for connection comes from a remote host. |
| DataIn | This event is fired when data are received. |
| Disconnected | This event is fired when a WebSocket connection is disconnected. |
| Error | This event is fired for information about errors during data delivery. |
| Log | This event fires once for each log message. |
| Ping | This event is fired when a ping request or response is received. |
| ReadyToSend | This event is fired when the control 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. |
| WebSocketOpenRequest | This event is fired when a client attempts to open a WebSocket. |
Config Settings
The following is a list of config settings for the control with short descriptions. Click on the links for further details.
| BufferMessage | Indicates whether or not the entire message is buffered before firing the DataIn event. |
| DisconnectStatusCode | Specifies the status code when closing a connection. |
| DisconnectStatusDescription | Specifies the message associated with the disconnect status code. |
| EnablePermessageDeflate | Determines whether or not the control will enable the permessage-deflate extension. |
| MaxFrameSize | Specifies the maximum size of the outgoing message in bytes before fragmentation occurs. |
| MaxLineLength[ConnectionId] | Determines the maximum line length for a connection when LineMode is True. |
| MessageLength[ConnectionId] | The length of the message (in bytes) when sending asynchronously. |
| WaitForCloseResponse | Determines whether or not the control will forcibly close a connection. |
| AllowedClients | A comma-separated list of host names or IP addresses that can access the control. |
| BindExclusively | Whether or not the control considers a local port reserved for exclusive use. |
| BlockedClients | A comma-separated list of host names or IP addresses that cannot access the control. |
| 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. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| MaxConnections | The maximum number of connections available. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseIPv6 | Whether to use IPv6. |
| 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. |
| SSLCACerts | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
| SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
| 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 certificates 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
ConnectionBacklog Property (WSServer Control)
This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.
Syntax
wsservercontrol.ConnectionBacklog[=integer]
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
WSConnectionCount Property (WSServer Control)
The number of records in the WSConnection arrays.
Syntax
wsservercontrol.WSConnectionCount
Default Value
0
Remarks
This property controls the size of the following arrays:
- WSConnectionAcceptData
- WSConnectionBytesSent
- WSConnectionConnected
- WSConnectionConnectionId
- WSConnectionDataFormat
- WSConnectionHost
- WSConnectionLineMode
- WSConnectionLocalAddress
- WSConnectionOrigin
- WSConnectionReadyToSend
- WSConnectionRemoteHost
- WSConnectionRemotePort
- WSConnectionRequestHeaders
- WSConnectionRequestURI
- WSConnectionSubProtocols
- WSConnectionTimeout
This property is read-only and not available at design time.
Data Type
Integer
WSConnectionAcceptData Property (WSServer Control)
This property indicates whether data reception is currently enabled.
Syntax
wsservercontrol.WSConnectionAcceptData(ConnectionId)
Default Value
True
Remarks
This property indicates whether data reception is currently enabled. When , data reception is disabled and the DataIn event will not fire for the connection. Use the PauseData and ProcessData methods to pause and resume data reception.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
Boolean
WSConnectionBytesSent Property (WSServer Control)
This property shows how many bytes were sent after calling Send or SendBytes .
Syntax
wsservercontrol.WSConnectionBytesSent(ConnectionId)
Default Value
0
Remarks
This property shows how many bytes were sent after calling Send or SendBytes. Please see Send or SendBytes for more information.
Note: This property will always return 0 when the control is operating in the synchronous mode (i.e., the WSConnectionTimeout 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 WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
Integer
WSConnectionConnected Property (WSServer Control)
This property indicates the status of individual connections.
Syntax
wsservercontrol.WSConnectionConnected(ConnectionId)
Default Value
False
Remarks
This property indicates the status of individual connections.
When , the connection is established. Use the Disconnect method to disconnect an existing connection.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
Boolean
WSConnectionConnectionId Property (WSServer Control)
This property contains an identifier generated by the control to identify each connection.
Syntax
wsservercontrol.WSConnectionConnectionId(ConnectionId)
Default Value
0
Remarks
This property contains an identifier generated by the control 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 WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
Integer
WSConnectionDataFormat Property (WSServer Control)
This property includes the format of the data being sent.
Syntax
wsservercontrol.WSConnectionDataFormat(ConnectionId)[=integer]
Possible Values
dfAutomatic(0), dfText(1), dfBinary(2), dfPing(9), dfPong(10)
Default Value
0
Remarks
This property includes the format of the data being sent. When data are sent over an established connection, it is either considered as text or binary data. Text data are UTF-8 encoded. Binary data have no encoding associated with it.
Possible values are as follows:
| 0 (dfAutomatic - default) | The control will attempt to automatically determine the correct data format. This is suitable for most cases. |
| 1 (dfText) | The control will UTF-8 encode the specified data before sending. Data that already have been UTF-8 encoded also may be supplied. |
| 2 (dfBinary) | The control will send the data exactly as they are provided. |
| 9 (dfPing) | The control will send the ping with data exactly as they are provided. |
| 10 (dfPong) | The control will send the pong with data exactly as they are provided. |
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is not available at design time.
Data Type
Integer
WSConnectionHost Property (WSServer Control)
This property includes the Host header value of the connected client.
Syntax
wsservercontrol.WSConnectionHost(ConnectionId)
Default Value
""
Remarks
This property includes the Host header value of the connected client.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
WSConnectionLineMode Property (WSServer Control)
When LineMode is False (default), the control will fire the DataIn event once for each message received from the server.
Syntax
wsservercontrol.WSConnectionLineMode(ConnectionId)
Default Value
False
Remarks
When WSConnectionLineMode is False (default), the component will fire the DataIn event once for each message received from the server. When LineMode is True, the component will instead fire DataIn for each line of data received. The maximum length of a line can be controlled by the MaxLineLength configuration setting.
Note: This property is read-only and should be set through the ChangeLineMode method.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
Boolean
WSConnectionLocalAddress Property (WSServer Control)
This property shows the IP address of the interface through which the connection is passing.
Syntax
wsservercontrol.WSConnectionLocalAddress(ConnectionId)
Default Value
""
Remarks
This property shows the IP address of the interface through which the connection is passing.
WSConnectionLocalAddress 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 WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
WSConnectionOrigin Property (WSServer Control)
This property includes the origin header value of the connected client.
Syntax
wsservercontrol.WSConnectionOrigin(ConnectionId)
Default Value
""
Remarks
This property includes the origin header value of the connected client.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
WSConnectionReadyToSend Property (WSServer Control)
This property indicates whether the control is ready to send data.
Syntax
wsservercontrol.WSConnectionReadyToSend(ConnectionId)
Default Value
False
Remarks
This property indicates whether the control is ready to send data.
This is after a client connects but will become after a failed call to Send or SendBytes. After a failed call to Send or SendBytes, the ReadyToSend event will fire and this property will be 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 WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
Boolean
WSConnectionRemoteHost Property (WSServer Control)
This property shows the IP address of the connected client.
Syntax
wsservercontrol.WSConnectionRemoteHost(ConnectionId)
Default Value
""
Remarks
This property shows the IP address of the connected client.
The connection must be valid or an error will be fired.
If the control 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 WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
WSConnectionRemotePort Property (WSServer Control)
This property shows the port of the connected client.
Syntax
wsservercontrol.WSConnectionRemotePort(ConnectionId)
Default Value
0
Remarks
This property shows the port of the connected client.
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 WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
Integer
WSConnectionRequestHeaders Property (WSServer Control)
The HTTP headers sent by the client in the initial WebSocket connection request.
Syntax
wsservercontrol.WSConnectionRequestHeaders(ConnectionId)
Default Value
""
Remarks
The HTTP headers sent by the client in the initial WebSocket connection request.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
WSConnectionRequestURI Property (WSServer Control)
This property includes the requested URI sent by the client in the initial WebSocket connection request.
Syntax
wsservercontrol.WSConnectionRequestURI(ConnectionId)
Default Value
""
Remarks
This property includes the requested URI sent by the client in the initial WebSocket connection request.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
WSConnectionSubProtocols Property (WSServer Control)
This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.
Syntax
wsservercontrol.WSConnectionSubProtocols(ConnectionId)
Default Value
""
Remarks
This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.
The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the WSConnectionCount property.
This property is read-only and not available at design time.
Data Type
String
WSConnectionTimeout Property (WSServer Control)
This property specifies a timeout for the control.
Syntax
wsservercontrol.WSConnectionTimeout(ConnectionId)[=integer]
Default Value
0
Remarks
This property specifies a timeout for the control.
If the WSConnectionTimeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.
If WSConnectionTimeout is set to a positive value, data is sent in a blocking manner and the control will wait for the operation to complete before returning control. The control will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of WSConnectionTimeout seconds.
The control 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 control fails with an error.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the WSConnectionTimeout 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 WSConnectionCount property.
This property is not available at design time.
Data Type
Integer
DefaultTimeout Property (WSServer Control)
This property includes initial timeout value to be used by incoming connections.
Syntax
wsservercontrol.DefaultTimeout[=integer]
Default Value
0
Remarks
This property is used by the control 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
Listening Property (WSServer Control)
This property indicates whether the control is listening for incoming connections on LocalPort.
Syntax
wsservercontrol.Listening
Default Value
False
Remarks
This property indicates whether the control is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the control is listening.
This property is read-only and not available at design time.
Data Type
Boolean
LocalHost Property (WSServer Control)
The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
wsservercontrol.LocalHost[=string]
Default Value
""
Remarks
This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the control 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 multihomed 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 (WSServer Control)
This property includes the Transmission Control Protocol (TCP) port in the local host where the control listens.
Syntax
wsservercontrol.LocalPort[=integer]
Default Value
0
Remarks
This property must be set before the control 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 control is listening (i.e., after successfully assigning True to the Listening property).
The service port is not shared among servers so two controls cannot be listening on the same port at the same time.
Data Type
Integer
SSLAuthenticateClients Property (WSServer Control)
If set to True, the server asks the client(s) for a certificate.
Syntax
wsservercontrol.SSLAuthenticateClients[=boolean]
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
SSLCertEffectiveDate Property (WSServer Control)
The date on which this certificate becomes valid.
Syntax
wsservercontrol.SSLCertEffectiveDate
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (WSServer Control)
The date on which the certificate expires.
Syntax
wsservercontrol.SSLCertExpirationDate
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (WSServer Control)
A comma-delimited list of extended key usage identifiers.
Syntax
wsservercontrol.SSLCertExtendedKeyUsage
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (WSServer Control)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
wsservercontrol.SSLCertFingerprint
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (WSServer Control)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
wsservercontrol.SSLCertFingerprintSHA1
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (WSServer Control)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
wsservercontrol.SSLCertFingerprintSHA256
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (WSServer Control)
The issuer of the certificate.
Syntax
wsservercontrol.SSLCertIssuer
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (WSServer Control)
The private key of the certificate (if available).
Syntax
wsservercontrol.SSLCertPrivateKey
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (WSServer Control)
Whether a PrivateKey is available for the selected certificate.
Syntax
wsservercontrol.SSLCertPrivateKeyAvailable
Default Value
False
Remarks
Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (WSServer Control)
The name of the PrivateKey container for the certificate (if available).
Syntax
wsservercontrol.SSLCertPrivateKeyContainer
Default Value
""
Remarks
The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (WSServer Control)
The public key of the certificate.
Syntax
wsservercontrol.SSLCertPublicKey
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (WSServer Control)
The textual description of the certificate's public key algorithm.
Syntax
wsservercontrol.SSLCertPublicKeyAlgorithm
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (WSServer Control)
The length of the certificate's public key (in bits).
Syntax
wsservercontrol.SSLCertPublicKeyLength
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (WSServer Control)
The serial number of the certificate encoded as a string.
Syntax
wsservercontrol.SSLCertSerialNumber
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (WSServer Control)
The text description of the certificate's signature algorithm.
Syntax
wsservercontrol.SSLCertSignatureAlgorithm
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (WSServer Control)
The name of the certificate store for the client certificate.
Syntax
wsservercontrol.SSLCertStore[=string]
Default Value
"MY"
Remarks
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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.
Data Type
Binary String
SSLCertStorePassword Property (WSServer Control)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
wsservercontrol.SSLCertStorePassword[=string]
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 (WSServer Control)
The type of certificate store for this certificate.
Syntax
wsservercontrol.SSLCertStoreType[=integer]
Possible Values
cstUser(0), cstMachine(1), cstPFXFile(2), cstPFXBlob(3), cstJKSFile(4), cstJKSBlob(5), cstPEMKeyFile(6), cstPEMKeyBlob(7), cstPublicKeyFile(8), cstPublicKeyBlob(9), cstSSHPublicKeyBlob(10), cstP7BFile(11), cstP7BBlob(12), cstSSHPublicKeyFile(13), cstPPKFile(14), cstPPKBlob(15), cstXMLFile(16), cstXMLBlob(17), cstJWKFile(18), cstJWKBlob(19), cstSecurityKey(20), cstBCFKSFile(21), cstBCFKSBlob(22), cstPKCS11(23), cstAuto(99)
Default Value
0
Remarks
The type of certificate store for this certificate.
The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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 control. 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
SSLCertSubjectAltNames Property (WSServer Control)
Comma-separated lists of alternative subject names for the certificate.
Syntax
wsservercontrol.SSLCertSubjectAltNames
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (WSServer Control)
The MD5 hash of the certificate.
Syntax
wsservercontrol.SSLCertThumbprintMD5
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (WSServer Control)
The SHA-1 hash of the certificate.
Syntax
wsservercontrol.SSLCertThumbprintSHA1
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (WSServer Control)
The SHA-256 hash of the certificate.
Syntax
wsservercontrol.SSLCertThumbprintSHA256
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (WSServer Control)
The text description of UsageFlags .
Syntax
wsservercontrol.SSLCertUsage
Default Value
""
Remarks
The text description of SSLCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (WSServer Control)
The flags that show intended use for the certificate.
Syntax
wsservercontrol.SSLCertUsageFlags
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (WSServer Control)
The certificate's version number.
Syntax
wsservercontrol.SSLCertVersion
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (WSServer Control)
The subject of the certificate used for client authentication.
Syntax
wsservercontrol.SSLCertSubject[=string]
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=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
SSLCertEncoded Property (WSServer Control)
The certificate (PEM/Base64 encoded).
Syntax
wsservercontrol.SSLCertEncoded[=string]
Default Value
""
Remarks
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.
To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.
This property is not available at design time.
Data Type
Binary String
SSLProvider Property (WSServer Control)
The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
wsservercontrol.SSLProvider[=integer]
Possible Values
sslpAutomatic(0), sslpPlatform(1), sslpInternal(2)
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 control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
| 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 control will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
Data Type
Integer
UseSSL Property (WSServer Control)
This property determines if the Secure Sockets Layer (SSL) is negotiated with incoming connections.
Syntax
wsservercontrol.UseSSL[=boolean]
Default Value
False
Remarks
When set to True, the control will attempt to negotiate SSL with all connecting clients. To enable SSL support, you must supply a valid certificate through the SSLCertStoreType, SSLCertStore, SSLCertStorePassword, and SSLCertSubject properties
The default value is False.
This property is not available at design time.
Data Type
Boolean
ChangeLineMode Method (WSServer Control)
This method controls whether the control will fire DataIn when an EOL is received for the specified connection.
Syntax
wsservercontrol.ChangeLineMode ConnectionId, LineMode
Remarks
When WSConnectionLineMode is set to False (default), the component will fire the DataIn event once for each message received from the client. When LineMode is set to True, the component will instead fire DataIn for each line of data received. The maximum length of a line can be controlled by the MaxLineLength[ConnectionId]; configuration setting.
Note: This method is offered as a convenience feature, and it has no effect on the behavior of the WebSocket protocol.
Config Method (WSServer Control)
Sets or retrieves a configuration setting.
Syntax
wsservercontrol.Config ConfigurationString
Remarks
Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Disconnect Method (WSServer Control)
This method disconnects the specified client.
Syntax
wsservercontrol.Disconnect ConnectionId
Remarks
Calling this method will disconnect the client specified by the ConnectionId parameter.
DoEvents Method (WSServer Control)
This method processes events from the internal message queue.
Syntax
wsservercontrol.DoEvents
Remarks
When DoEvents is called, the control processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Interrupt Method (WSServer Control)
This method interrupts a synchronous send to the remote host.
Syntax
wsservercontrol.Interrupt ConnectionId
Remarks
This property is called using the ConnectionId if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the control. If you use SendFile to upload a file, the control will run synchronously on that ConnectionId until it is completed.
Ping Method (WSServer Control)
This method sends a ping request to the remote host.
Syntax
wsservercontrol.Ping ConnectionId
Remarks
This method sends a ping request to the remote host and waits for a corresponding pong response.
The Timeout property specifies how long to wait for the pong response.
Send Method (WSServer Control)
This method sends binary data to the client.
Syntax
wsservercontrol.Send ConnectionId, Data
Remarks
This method sends the binary data specified by Data to the client specified by ConnectionId.
SendBytes Method (WSServer Control)
This method sends binary data to the specified client.
Syntax
wsservercontrol.SendBytes ConnectionId, Data
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 control 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 25036: "[10035] Operation would block" (WSAEWOULDBLOCK). You can trap 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.
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 control 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 25036: "[10035] Operation would block" (WSAEWOULDBLOCK). You can trap 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.
SendFile Method (WSServer Control)
This method sends the file to the remote host.
Syntax
wsservercontrol.SendFile ConnectionId, FileName
Remarks
This method sends the file to the client specified by the ConnectionId.
SendText Method (WSServer Control)
This method sends text data to the client.
Syntax
wsservercontrol.SendText ConnectionId, Text
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 control 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 25036: "[10035] Operation would block" (WSAEWOULDBLOCK). You can trap 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.
This method sends text to the client identified by ConnectionId. Data sent with this method will always be treated as text data regardless of the value of WSConnectionDataFormat. The control will UTF-8 encode the supplied text.
Shutdown Method (WSServer Control)
This method shuts down the server.
Syntax
wsservercontrol.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.
StartListening Method (WSServer Control)
This method starts listening for incoming connections.
Syntax
wsservercontrol.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.
StopListening Method (WSServer Control)
This method stops listening for new connections.
Syntax
wsservercontrol.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.
Connected Event (WSServer Control)
This event is fired when a WebSocket is successfully opened.
Syntax
Sub wsservercontrol_Connected(ConnectionId As Integer)
Remarks
The Connected event is fired when a WebSocket is successfully opened on a connection.
ConnectionId identifies the connection.
ConnectionRequest Event (WSServer Control)
This event is fired when a request for connection comes from a remote host.
Syntax
Sub wsservercontrol_ConnectionRequest(Address As String, Port As Integer, Accept As Boolean)
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 (WSServer Control)
This event is fired when data are received.
Syntax
Sub wsservercontrol_DataIn(ConnectionId As Integer, DataFormat As Integer, Text As String, EOM As Boolean, EOL As Boolean)
Remarks
The DataIn event provides the data received from the client identified by the ConnectionId parameter.
The incoming data are provided through the Text parameter.
The DataFormat parameter identifies the encoding (if any) of the data. Possible value are as follows:
| 0 | If LineMode is disabled, a value of 0 indicates a continuation packet. If LineMode is enabled, the value will always be 0, regardless of packet type. |
| 1 | The data are UTF-8 encoded. |
| 2 | The data are binary and have no encoding. |
The EOM parameter stands for End of Message. By default, the control will fire the DataIn event as data are received. Larger messages will be fragmented and will cause the event to fire multiple times. When EOM is True within the event, this indicates the current fragment is also the final fragment of the message. The control may also be configured to buffer the message internally until the complete message is received. To enable this, set BufferMessage to True.
The EOL parameter stands for End of Line. When LineMode is False, EOL will always be False. When LineMode is True, EOL will be True if the DataIn event fired because an EOL was received and will be False if the DataIn event fired because MaxLineLength was reached.
Disconnected Event (WSServer Control)
This event is fired when a WebSocket connection is disconnected.
Syntax
Sub wsservercontrol_Disconnected(ConnectionId As Integer, StatusCode As Integer, Description As String)
Remarks
When the connection is closed the StatusCode parameter may be used to determine if the disconnect occurred normally or if there was an error condition. If the connection is closed normally, the StatusCode will be 1000. The Description parameter will contain a textual description returned by the server. Common StatusCode values are as follows:
| 1000 (default) | Normal closure. |
| 1001 | The resource is going away. For instance, the server is shutting down or a browser is navigating away from the page. |
| 1002 | A protocol error occurred. |
| 1003 | Unexpected data were received (e.g., an endpoint that accepts only text data could send this if binary data are received). |
| 1007 | Invalid payload data were received (e.g., an endpoint that receives non-UTF-8 data in a text message could send this). |
| 1008 | A generic code that indicates the endpoint received a message that violates its policy. |
| 1009 | A message that was too large was received. |
| 1010 | A required extension could not be negotiated. |
| 1011 | An unexpected error occurred. |
Error Event (WSServer Control)
This event is fired for information about errors during data delivery.
Syntax
Sub wsservercontrol_Error(ConnectionId As Integer, ErrorCode As Integer, Description As String)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.
ConnectionId 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.
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.
Log Event (WSServer Control)
This event fires once for each log message.
Syntax
Sub wsservercontrol_Log(ConnectionId As Integer, LogLevel As Integer, Message As String, LogType As String)
Remarks
This event fires once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information including the URL, HTTP version, and connection status details.
The value 2 (Verbose) logs additional information about the initial HTTP request.
The value 3 (Debug) logs additional debug information (if available).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "Error"
- "Verbose"
- "Debug"
Ping Event (WSServer Control)
This event is fired when a ping request or response is received.
Syntax
Sub wsservercontrol_Ping(ConnectionId As Integer, Payload As String, Response As Boolean)
Remarks
This event fires when a ping request or response is received from the client identified by the ConnectionId parameter. This event is informational only. When the control receives a ping request, it will automatically reply with a pong.
Payload holds the payload of the request, if any.
Response is if the incoming packet is a ping response. If the incoming packet is a ping request this is .
ReadyToSend Event (WSServer Control)
This event is fired when the control is ready to send data.
Syntax
Sub wsservercontrol_ReadyToSend(ConnectionId As Integer)
Remarks
The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed Send. This event is also fired immediately after a connection is established.
SSLClientAuthentication Event (WSServer Control)
This event is fired when the client presents its credentials to the server.
Syntax
Sub wsservercontrol_SSLClientAuthentication(ConnectionId As Integer, CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)
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 (WSServer Control)
This event fires when a Secure Sockets Layer (SSL) connection is requested.
Syntax
Sub wsservercontrol_SSLConnectionRequest(ConnectionId As Integer, SupportedCipherSuites As String, SupportedSignatureAlgs As String, CertStoreType As Integer, CertStore As String, CertPassword As String, CertSubject As String)
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 control 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 control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control 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 control. 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
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 (WSServer Control)
This event is fired to show the progress of the secure connection.
Syntax
Sub wsservercontrol_SSLStatus(ConnectionId As Integer, Message As String)
Remarks
The event is fired for informational and logging purposes only. It is used to track the progress of the connection.
WebSocketOpenRequest Event (WSServer Control)
This event is fired when a client attempts to open a WebSocket.
Syntax
Sub wsservercontrol_WebSocketOpenRequest(ConnectionId As Integer, RequestURI As String, HostHeader As String, OriginHeader As String, SubProtocols As String, Extensions As String, RequestHeaders As String, StatusCode As Integer, ResponseHeaders As String)
Remarks
This event fires when a client connects. It provides an opportunity to inspect the WebSocket request and either accept or reject the connection attempt.
By default, the control will accept the connection. You do not need to set anything to accept the connection. The control will return a StatusCode of 101 to the connecting client, and the request will proceed as normal. To reject a connection, set StatusCode to an HTTP error code, such as 401.
ConnectionId identifies the connecting client.
RequestURI provides the URI requested by the connecting client. This may be used to implement logic to select appropriate SubProtocols or to determine if the connection should be accepted based on access restrictions to the URI.
HostHeader holds the value of the Host header sent by the client.
OriginHeader holds the value of the Origin header sent by the client.
SubProtocols holds a comma-separated list of subprotocols sent by the client (if any). Set SubProtocols to the selected value from the list sent by the client. The control will return this value to the client as the subprotocol the server has selected.
Extensions provides a list of extensions supported by the client.
RequestHeaders contains the HTTP headers sent in the request by the connecting client.
StatusCode determines success or failure. The value 101 (default) indicates success. This may be set to any HTTP status code. For instance, a value of 401 indicates an authorization failure.
ResponseHeaders may be set to include additional headers in the response. This is typically used when rejecting a request. For instance when StatusCode is set to 401, you might set ResponseHeaders to "WWW-Authenticate: Basic realm="Secure Realm"" to request authorization from the connecting client.
Config Settings (WSServer Control)
The control 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 control, access to these internal properties is provided through the Config method.WebSocketServer Config Settings
| 1000 (default) | Normal closure. |
| 1001 | The resource is going away. For instance, the server is shutting down or a browser is navigating away from the page. |
| 1002 | A protocol error occurred. |
| 1003 | Unexpected data were received (e.g., an endpoint that accepts only text data could send this if binary data are received). |
| 1007 | Invalid payload data were received (e.g., an endpoint that receives non-UTF-8 data in a text message could send this). |
| 1008 | A generic code that indicates the endpoint received a message that violates its policy. |
| 1009 | A message that was too large was received. |
| 1010 | A required extension could not be negotiated. |
| 1011 | An unexpected error occurred. |
The default value is .
When a message is fragmented, the receiving side may check the EOM parameter of the DataIn event to determine when the message is complete.
Note: When Timeout is set to 0 messages that are fragmented are always sent as individual smaller messages and EOM will always be True in the DataIn event on the receiving side.
When DefaultTimeout is set to 0 the control operates asynchronously and, by default, all data sent when Send is called is considered a complete message. Each packet leaving the control has the End-of-Message flag set.
To send messages that may be fragmented, set MessageLength to the length of the message (in bytes) that is being sent. When set, the control will consider the next MessageLength bytes sent as part of a single message and only the last packet will set the End-of-Message flag.
This setting is helpful when data are organized into messages and the receiving side expected the End-of-Message flag to signal the end of a message.
Note: This configuration setting is applicable only when DefaultTimeout is set to 0. When DefaultTimeout is set to a positive value, the message data may be passed in its entirety to Send and will be automatically handled as needed by the control.
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 . 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 . If no action is taken within the ConnectionRequest event, the client will not be connected.
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 control 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: Unix/Linux operating systems limit the number of simultaneous connections to 1024.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the control 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 configuration setting is set to False.
| 0 | IPv4 Only |
| 1 | IPv6 Only |
| 2 | IPv6 and IPv4 |
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 configuration 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). OpenSSL recommends the use of 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 the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. 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 control 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 control is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the control. When set to 1, it will attempt to perform the CRL check, but it will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the control will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration 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 configuration 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 configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the control 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 include the following:
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 the following:
- 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_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- 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_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 default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
| TLS1.3 | 12288 (Hex 3000) |
| TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
| TLS1.1 | 768 (Hex 300) (Default - Client) |
| TLS1 | 192 (Hex C0) (Default - Client) |
| SSL3 | 48 (Hex 30) |
| SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the control will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that 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 supported only 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 available only 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, these 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 control 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 configuration setting is applicable only 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 control 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 traffic for debugging purposes. When writing to this file, the control will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration 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 non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the control will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the control 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 configuration 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.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration 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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only 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 |
This setting only works on these controls: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to tells the control to use the internal implementation instead of using the system security libraries.
This setting is set to by default on all platforms.
Trappable Errors (WSServer Control)
WSServer Errors
| 24203 | Error sending data to the connected client. |
TCPServer Errors
| 20101 | You cannot change the RemotePort at this time. A connection is in progress. |
| 20102 | You cannot change the RemoteHost at this time. A connection is in progress. |
| 20103 | The RemoteHost address is invalid (0.0.0.0). |
| 20105 | TCPServer is already listening. |
| 20107 | Cannot change LocalPort when TCPServer is listening. |
| 20108 | Cannot change LocalHost when TCPServer is listening. |
| 20109 | Cannot change MaxConnections when TCPServer is listening. |
| 20113 | You cannot change MaxLineLength at this time. A connection is in progress. |
| 20117 | RemotePort cannot be zero. Please specify a valid service port number. |
| 20127 | Invalid ConnectionId. |
| 20136 | Operation would block. |
SSL Errors
| 20271 | Cannot load specified security library. |
| 20272 | Cannot open certificate store. |
| 20273 | Cannot find specified certificate. |
| 20274 | Cannot acquire security credentials. |
| 20275 | Cannot find certificate chain. |
| 20276 | Cannot verify certificate chain. |
| 20277 | Error during handshake. |
| 20281 | Error verifying certificate. |
| 20282 | Could not find client certificate. |
| 20283 | Could not find server certificate. |
| 20284 | Error encrypting data. |
| 20285 | Error decrypting data. |
TCP/IP Errors
| 25005 | [10004] Interrupted system call. |
| 25010 | [10009] Bad file number. |
| 25014 | [10013] Access denied. |
| 25015 | [10014] Bad address. |
| 25023 | [10022] Invalid argument. |
| 25025 | [10024] Too many open files. |
| 25036 | [10035] Operation would block. |
| 25037 | [10036] Operation now in progress. |
| 25038 | [10037] Operation already in progress. |
| 25039 | [10038] Socket operation on nonsocket. |
| 25040 | [10039] Destination address required. |
| 25041 | [10040] Message is too long. |
| 25042 | [10041] Protocol wrong type for socket. |
| 25043 | [10042] Bad protocol option. |
| 25044 | [10043] Protocol is not supported. |
| 25045 | [10044] Socket type is not supported. |
| 25046 | [10045] Operation is not supported on socket. |
| 25047 | [10046] Protocol family is not supported. |
| 25048 | [10047] Address family is not supported by protocol family. |
| 25049 | [10048] Address already in use. |
| 25050 | [10049] Cannot assign requested address. |
| 25051 | [10050] Network is down. |
| 25052 | [10051] Network is unreachable. |
| 25053 | [10052] Net dropped connection or reset. |
| 25054 | [10053] Software caused connection abort. |
| 25055 | [10054] Connection reset by peer. |
| 25056 | [10055] No buffer space available. |
| 25057 | [10056] Socket is already connected. |
| 25058 | [10057] Socket is not connected. |
| 25059 | [10058] Cannot send after socket shutdown. |
| 25060 | [10059] Too many references, cannot splice. |
| 25061 | [10060] Connection timed out. |
| 25062 | [10061] Connection refused. |
| 25063 | [10062] Too many levels of symbolic links. |
| 25064 | [10063] File name is too long. |
| 25065 | [10064] Host is down. |
| 25066 | [10065] No route to host. |
| 25067 | [10066] Directory is not empty |
| 25068 | [10067] Too many processes. |
| 25069 | [10068] Too many users. |
| 25070 | [10069] Disc Quota Exceeded. |
| 25071 | [10070] Stale NFS file handle. |
| 25072 | [10071] Too many levels of remote in path. |
| 25092 | [10091] Network subsystem is unavailable. |
| 25093 | [10092] WINSOCK DLL Version out of range. |
| 25094 | [10093] Winsock is not loaded yet. |
| 26002 | [11001] Host not found. |
| 26003 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
| 26004 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
| 26005 | [11004] Valid name, no data record (check DNS setup). |