# WSServer Component The WSServer class is used to create a WebSocket server. ## Syntax ```text ipworksssl.WSServer ``` ## Remarks The WSServer struct 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](#localport-property-wsserver-component) property must be specified to a valid port. This port will be used to accept incoming connections. Then, call the [StartListening](#startlistening-method-wsserver-component) method to start listening on the specified port. The WSServer struct 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](#websocketopenrequest-event-wsserver-component) 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](#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](#send-method-wsserver-component), [SendText](#sendtext-method-wsserver-component), or [SendFile](#sendfile-method-wsserver-component) 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](#doevents-method-wsserver-component) should be called in a loop after the server is started. ## Property List *The following is the full list of the properties of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ConnectionBacklog](#connectionbacklog-property-wsserver-component) | This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. | | [WSConnectionCount](#wsconnectioncount-property-wsserver-component) | The number of records in the WSConnection arrays. | | [WSConnectionAcceptData](#wsconnectionacceptdata-property-wsserver-component) | This property indicates whether data reception is currently enabled. | | [WSConnectionBytesSent](#wsconnectionbytessent-property-wsserver-component) | This property shows how many bytes were sent after calling Send or SendBytes . | | [WSConnectionConnected](#wsconnectionconnected-property-wsserver-component) | This property indicates the status of individual connections. | | [WSConnectionConnectionId](#wsconnectionconnectionid-property-wsserver-component) | This property contains an identifier generated by the class to identify each connection. | | [WSConnectionDataFormat](#wsconnectiondataformat-property-wsserver-component) | This property includes the format of the data being sent. | | [WSConnectionHost](#wsconnectionhost-property-wsserver-component) | This property includes the Host header value of the connected client. | | [WSConnectionLineMode](#wsconnectionlinemode-property-wsserver-component) | When LineMode is False (default), the class will fire the DataIn event once for each message received from the server. | | [WSConnectionLocalAddress](#wsconnectionlocaladdress-property-wsserver-component) | This property shows the IP address of the interface through which the connection is passing. | | [WSConnectionOrigin](#wsconnectionorigin-property-wsserver-component) | This property includes the origin header value of the connected client. | | [WSConnectionReadyToSend](#wsconnectionreadytosend-property-wsserver-component) | This property indicates whether the class is ready to send data. | | [WSConnectionRemoteHost](#wsconnectionremotehost-property-wsserver-component) | This property shows the IP address of the connected client. | | [WSConnectionRemotePort](#wsconnectionremoteport-property-wsserver-component) | This property shows the port of the connected client. | | [WSConnectionRequestHeaders](#wsconnectionrequestheaders-property-wsserver-component) | The HTTP headers sent by the client in the initial WebSocket connection request. | | [WSConnectionRequestURI](#wsconnectionrequesturi-property-wsserver-component) | This property includes the requested URI sent by the client in the initial WebSocket connection request. | | [WSConnectionSubProtocols](#wsconnectionsubprotocols-property-wsserver-component) | This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request. | | [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) | This property specifies a timeout for the class. | | [DefaultTimeout](#defaulttimeout-property-wsserver-component) | This property includes initial timeout value to be used by incoming connections. | | [Listening](#listening-property-wsserver-component) | This property indicates whether the class is listening for incoming connections on LocalPort. | | [LocalHost](#localhost-property-wsserver-component) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [LocalPort](#localport-property-wsserver-component) | This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens. | | [SSLAuthenticateClients](#sslauthenticateclients-property-wsserver-component) | If set to True, the server asks the client(s) for a certificate. | | [SSLCertEffectiveDate](#sslcerteffectivedate-property-wsserver-component) | The date on which this certificate becomes valid. | | [SSLCertExpirationDate](#sslcertexpirationdate-property-wsserver-component) | The date on which the certificate expires. | | [SSLCertExtendedKeyUsage](#sslcertextendedkeyusage-property-wsserver-component) | A comma-delimited list of extended key usage identifiers. | | [SSLCertFingerprint](#sslcertfingerprint-property-wsserver-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SSLCertFingerprintSHA1](#sslcertfingerprintsha1-property-wsserver-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SSLCertFingerprintSHA256](#sslcertfingerprintsha256-property-wsserver-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SSLCertIssuer](#sslcertissuer-property-wsserver-component) | The issuer of the certificate. | | [SSLCertPrivateKey](#sslcertprivatekey-property-wsserver-component) | The private key of the certificate (if available). | | [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-wsserver-component) | Whether a PrivateKey is available for the selected certificate. | | [SSLCertPrivateKeyContainer](#sslcertprivatekeycontainer-property-wsserver-component) | The name of the PrivateKey container for the certificate (if available). | | [SSLCertPublicKey](#sslcertpublickey-property-wsserver-component) | The public key of the certificate. | | [SSLCertPublicKeyAlgorithm](#sslcertpublickeyalgorithm-property-wsserver-component) | The textual description of the certificate's public key algorithm. | | [SSLCertPublicKeyLength](#sslcertpublickeylength-property-wsserver-component) | The length of the certificate's public key (in bits). | | [SSLCertSerialNumber](#sslcertserialnumber-property-wsserver-component) | The serial number of the certificate encoded as a string. | | [SSLCertSignatureAlgorithm](#sslcertsignaturealgorithm-property-wsserver-component) | The text description of the certificate's signature algorithm. | | [SSLCertStore](#sslcertstore-property-wsserver-component) | The name of the certificate store for the client certificate. | | [SSLCertStorePassword](#sslcertstorepassword-property-wsserver-component) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SSLCertStoreType](#sslcertstoretype-property-wsserver-component) | The type of certificate store for this certificate. | | [SSLCertSubjectAltNames](#sslcertsubjectaltnames-property-wsserver-component) | Comma-separated lists of alternative subject names for the certificate. | | [SSLCertThumbprintMD5](#sslcertthumbprintmd5-property-wsserver-component) | The MD5 hash of the certificate. | | [SSLCertThumbprintSHA1](#sslcertthumbprintsha1-property-wsserver-component) | The SHA-1 hash of the certificate. | | [SSLCertThumbprintSHA256](#sslcertthumbprintsha256-property-wsserver-component) | The SHA-256 hash of the certificate. | | [SSLCertUsage](#sslcertusage-property-wsserver-component) | The text description of UsageFlags . | | [SSLCertUsageFlags](#sslcertusageflags-property-wsserver-component) | The flags that show intended use for the certificate. | | [SSLCertVersion](#sslcertversion-property-wsserver-component) | The certificate's version number. | | [SSLCertSubject](#sslcertsubject-property-wsserver-component) | The subject of the certificate used for client authentication. | | [SSLCertEncoded](#sslcertencoded-property-wsserver-component) | The certificate (PEM/Base64 encoded). | | [SSLProvider](#sslprovider-property-wsserver-component) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ChangeLineMode](#changelinemode-method-wsserver-component) | This method controls whether the class will fire DataIn when an EOL is received for the specified connection. | | [Config](#config-method-wsserver-component) | Sets or retrieves a configuration setting. | | [Disconnect](#disconnect-method-wsserver-component) | This method disconnects the specified client. | | [DoEvents](#doevents-method-wsserver-component) | This method processes events from the internal message queue. | | [Interrupt](#interrupt-method-wsserver-component) | This method interrupts a synchronous send to the remote host. | | [Ping](#ping-method-wsserver-component) | This method sends a ping request to the remote host. | | [Send](#send-method-wsserver-component) | This method sends binary data to the client. | | [SendBytes](#sendbytes-method-wsserver-component) | This method sends binary data to the specified client. | | [SendFile](#sendfile-method-wsserver-component) | This method sends the file to the remote host. | | [SendText](#sendtext-method-wsserver-component) | This method sends text data to the client. | | [Shutdown](#shutdown-method-wsserver-component) | This method shuts down the server. | | [StartListening](#startlistening-method-wsserver-component) | This method starts listening for incoming connections. | | [StopListening](#stoplistening-method-wsserver-component) | This method stops listening for new connections. | ## Event List *The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Connected](#connected-event-wsserver-component) | This event is fired when a WebSocket is successfully opened. | | [ConnectionRequest](#connectionrequest-event-wsserver-component) | This event is fired when a request for connection comes from a remote host. | | [DataIn](#datain-event-wsserver-component) | This event is fired when data are received. | | [Disconnected](#disconnected-event-wsserver-component) | This event is fired when a WebSocket connection is disconnected. | | [Error](#error-event-wsserver-component) | This event is fired for information about errors during data delivery. | | [Log](#log-event-wsserver-component) | This event fires once for each log message. | | [Ping](#ping-event-wsserver-component) | This event is fired when a ping request or response is received. | | [ReadyToSend](#readytosend-event-wsserver-component) | This event is fired when the class is ready to send data. | | [SSLClientAuthentication](#sslclientauthentication-event-wsserver-component) | This event is fired when the client presents its credentials to the server. | | [SSLConnectionRequest](#sslconnectionrequest-event-wsserver-component) | This event fires when a Secure Sockets Layer (SSL) connection is requested. | | [SSLStatus](#sslstatus-event-wsserver-component) | This event is fired to show the progress of the secure connection. | | [WebSocketOpenRequest](#websocketopenrequest-event-wsserver-component) | This event is fired when a client attempts to open a WebSocket. | ## Config Settings *The following is a list of config settings for the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BufferMessage](#BufferMessage) | Indicates whether or not the entire message is buffered before firing the DataIn event. | | [DisconnectStatusCode](#DisconnectStatusCode) | Specifies the status code when closing a connection. | | [DisconnectStatusDescription](#DisconnectStatusDescription) | Specifies the message associated with the disconnect status code. | | [EnablePermessageDeflate](#EnablePermessageDeflate) | Determines whether or not the class will enable the permessage-deflate extension. | | [MaxFrameSize](#MaxFrameSize) | Specifies the maximum size of the outgoing message in bytes before fragmentation occurs. | | [MaxLineLength\[ConnectionId\]](#MaxLineLength[ConnectionId]) | Determines the maximum line length for a connection when LineMode is True. | | [MessageLength\[ConnectionId\]](#MessageLength[ConnectionId]) | The length of the message (in bytes) when sending asynchronously. | | [WaitForCloseResponse](#WaitForCloseResponse) | Determines whether or not the class will forcibly close a connection. | | [AllowedClients](#AllowedClients) | A comma-separated list of host names or IP addresses that can access the class. | | [BindExclusively](#BindExclusively) | Whether or not the class considers a local port reserved for exclusive use. | | [BlockedClients](#BlockedClients) | A comma-separated list of host names or IP addresses that cannot access the class. | | [DefaultConnectionTimeout](#DefaultConnectionTimeout) | The inactivity timeout applied to the SSL handshake. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [MaxConnections](#MaxConnections) | The maximum number of connections available. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # ConnectionBacklog Property ([WSServer](#wsserver-component) Component) This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem. ## Syntax *Go Syntax* ```text func (obj *WSServer) ConnectionBacklog() (int32, error)func (obj *WSServer) SetConnectionBacklog(value int32) error ``` ## Default Value 5 ## Remarks This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable. ## Data Type **int32** # WSConnectionCount Property ([WSServer](#wsserver-component) Component) The number of records in the WSConnection arrays. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionCount() (int32, error) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [WSConnectionAcceptData](#wsconnectionacceptdata-property-wsserver-component) - [WSConnectionBytesSent](#wsconnectionbytessent-property-wsserver-component) - [WSConnectionConnected](#wsconnectionconnected-property-wsserver-component) - [WSConnectionConnectionId](#wsconnectionconnectionid-property-wsserver-component) - [WSConnectionDataFormat](#wsconnectiondataformat-property-wsserver-component) - [WSConnectionHost](#wsconnectionhost-property-wsserver-component) - [WSConnectionLineMode](#wsconnectionlinemode-property-wsserver-component) - [WSConnectionLocalAddress](#wsconnectionlocaladdress-property-wsserver-component) - [WSConnectionOrigin](#wsconnectionorigin-property-wsserver-component) - [WSConnectionReadyToSend](#wsconnectionreadytosend-property-wsserver-component) - [WSConnectionRemoteHost](#wsconnectionremotehost-property-wsserver-component) - [WSConnectionRemotePort](#wsconnectionremoteport-property-wsserver-component) - [WSConnectionRequestHeaders](#wsconnectionrequestheaders-property-wsserver-component) - [WSConnectionRequestURI](#wsconnectionrequesturi-property-wsserver-component) - [WSConnectionSubProtocols](#wsconnectionsubprotocols-property-wsserver-component) - [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) The array indices start at *0* and end at *WSConnectionCount - 1*. This property is read-only. ## Data Type **int32** # WSConnectionAcceptData Property ([WSServer](#wsserver-component) Component) This property indicates whether data reception is currently enabled. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionAcceptData(ConnectionId int32) (bool, error) ``` ## Default Value true ## Remarks This property indicates whether data reception is currently enabled. When *false*, 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **bool** # WSConnectionBytesSent Property ([WSServer](#wsserver-component) Component) This property shows how many bytes were sent after calling Send or SendBytes . ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionBytesSent(ConnectionId int32) (int32, error) ``` ## 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 struct is operating in the synchronous mode (i.e., the [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **int32** # WSConnectionConnected Property ([WSServer](#wsserver-component) Component) This property indicates the status of individual connections. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionConnected(ConnectionId int32) (bool, error) ``` ## Default Value false ## Remarks This property indicates the status of individual connections. When *true*, the connection is established. Use the [Disconnect](#disconnect-method-wsserver-component) 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **bool** # WSConnectionConnectionId Property ([WSServer](#wsserver-component) Component) This property contains an identifier generated by the class to identify each connection. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionConnectionId(ConnectionId int32) (int32, error) ``` ## Default Value 0 ## Remarks This property contains an identifier generated by the struct to identify each connection. This identifier is unique to this connection. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [WSConnectionCount](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **int32** # WSConnectionDataFormat Property ([WSServer](#wsserver-component) Component) This property includes the format of the data being sent. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionDataFormat(ConnectionId int32) (int32, error)func (obj *WSServer) SetWSConnectionDataFormat(ConnectionId int32, value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Text2 // Binary9 // Ping10 // Pong ``` ## 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 struct will attempt to automatically determine the correct data format. This is suitable for most cases. | | 1 (dfText) | The struct will UTF-8 encode the specified data before sending. Data that already have been UTF-8 encoded also may be supplied. | | 2 (dfBinary) | The struct will send the data exactly as they are provided. | | 9 (dfPing) | The struct will send the ping with data exactly as they are provided. | | 10 (dfPong) | The struct 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](#wsconnectioncount-property-wsserver-component) property. ## Data Type **int32** # WSConnectionHost Property ([WSServer](#wsserver-component) Component) This property includes the Host header value of the connected client. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionHost(ConnectionId int32) (string, error) ``` ## 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **string** # WSConnectionLineMode Property ([WSServer](#wsserver-component) Component) When LineMode is False (default), the class will fire the DataIn event once for each message received from the server. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionLineMode(ConnectionId int32) (bool, error) ``` ## Default Value false ## Remarks When [WSConnectionLineMode](#wsconnectionlinemode-property-wsserver-component) is False (default), the component will fire the [DataIn](#datain-event-wsserver-component) event once for each message received from the server. When [WSConnectionLineMode](#wsconnectionlinemode-property-wsserver-component) is True, the component will instead fire [DataIn](#datain-event-wsserver-component) for each line of data received. The maximum length of a line can be controlled by the [MaxLineLength](#MaxLineLength) configuration setting. NOTE: This property is read-only and should be set through the [ChangeLineMode](#changelinemode-method-wsserver-component) method. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [WSConnectionCount](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **bool** # WSConnectionLocalAddress Property ([WSServer](#wsserver-component) Component) This property shows the IP address of the interface through which the connection is passing. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionLocalAddress(ConnectionId int32) (string, error) ``` ## Default Value "" ## Remarks This property shows the IP address of the interface through which the connection is passing. [WSConnectionLocalAddress](#wsconnectionlocaladdress-property-wsserver-component) 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **string** # WSConnectionOrigin Property ([WSServer](#wsserver-component) Component) This property includes the origin header value of the connected client. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionOrigin(ConnectionId int32) (string, error) ``` ## 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **string** # WSConnectionReadyToSend Property ([WSServer](#wsserver-component) Component) This property indicates whether the class is ready to send data. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionReadyToSend(ConnectionId int32) (bool, error) ``` ## Default Value false ## Remarks This property indicates whether the struct is ready to send data. This is *true* after a client connects but will become *false* after a failed call to Send or SendBytes. After a failed call to Send or SendBytes, the ReadyToSend event will fire and this property will be *true* when data can be sent again. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [WSConnectionCount](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **bool** # WSConnectionRemoteHost Property ([WSServer](#wsserver-component) Component) This property shows the IP address of the connected client. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionRemoteHost(ConnectionId int32) (string, error) ``` ## 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 struct is configured to use a *SOCKS* firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution. The *ConnectionId* parameter specifies the index of the item in the array. The size of the array is controlled by the [WSConnectionCount](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **string** # WSConnectionRemotePort Property ([WSServer](#wsserver-component) Component) This property shows the port of the connected client. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionRemotePort(ConnectionId int32) (int32, error) ``` ## 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **int32** # WSConnectionRequestHeaders Property ([WSServer](#wsserver-component) Component) The HTTP headers sent by the client in the initial WebSocket connection request. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionRequestHeaders(ConnectionId int32) (string, error) ``` ## 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **string** # WSConnectionRequestURI Property ([WSServer](#wsserver-component) Component) This property includes the requested URI sent by the client in the initial WebSocket connection request. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionRequestURI(ConnectionId int32) (string, error) ``` ## 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **string** # WSConnectionSubProtocols Property ([WSServer](#wsserver-component) Component) This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionSubProtocols(ConnectionId int32) (string, error) ``` ## 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](#wsconnectioncount-property-wsserver-component) property. This property is read-only. ## Data Type **string** # WSConnectionTimeout Property ([WSServer](#wsserver-component) Component) This property specifies a timeout for the class. ## Syntax *Go Syntax* ```text func (obj *WSServer) WSConnectionTimeout(ConnectionId int32) (int32, error)func (obj *WSServer) SetWSConnectionTimeout(ConnectionId int32, value int32) error ``` ## Default Value 0 ## Remarks This property specifies a timeout for the struct. If the [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) property is set to 0, all operations return immediately, potentially failing with a *WOULDBLOCK* error if data cannot be sent immediately. If [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential *WOULDBLOCK* errors internally and automatically retry the operation for a maximum of [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) seconds. The struct 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 struct fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received. The default value for the [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) 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](#wsconnectioncount-property-wsserver-component) property. ## Data Type **int32** # DefaultTimeout Property ([WSServer](#wsserver-component) Component) This property includes initial timeout value to be used by incoming connections. ## Syntax *Go Syntax* ```text func (obj *WSServer) DefaultTimeout() (int32, error)func (obj *WSServer) SetDefaultTimeout(value int32) error ``` ## Default Value 0 ## Remarks This property is used by the struct to set the operational timeout value of all inbound connections once they are established. By default, the timeout is 0, meaning that all inbound connections will behave asynchronously. ## Data Type **int32** # Listening Property ([WSServer](#wsserver-component) Component) This property indicates whether the class is listening for incoming connections on LocalPort. ## Syntax *Go Syntax* ```text func (obj *WSServer) Listening() (bool, error) ``` ## Default Value false ## Remarks This property indicates whether the struct is listening for connections on the port specified by the [LocalPort](#localport-property-wsserver-component) property. Use the [StartListening](#startlistening-method-wsserver-component) and [StopListening](#stoplistening-method-wsserver-component) methods to control whether the struct is listening. This property is read-only. ## Data Type **bool** # LocalHost Property ([WSServer](#wsserver-component) Component) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Go Syntax* ```text func (obj *WSServer) LocalHost() (string, error)func (obj *WSServer) SetLocalHost(value string) error ``` ## Default Value "" ## Remarks This property contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used. If the struct is connected, the 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](#wsserver-component) Component) This property includes the Transmission Control Protocol (TCP) port in the local host where the class listens. ## Syntax *Go Syntax* ```text func (obj *WSServer) LocalPort() (int32, error)func (obj *WSServer) SetLocalPort(value int32) error ``` ## Default Value 0 ## Remarks This property must be set before the struct can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the struct is listening (i.e., after successfully assigning True to the [Listening](#listening-property-wsserver-component) property). The service port is not shared among servers so two structs cannot be listening on the same port at the same time. ## Data Type **int32** # SSLAuthenticateClients Property ([WSServer](#wsserver-component) Component) If set to True, the server asks the client(s) for a certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLAuthenticateClients() (bool, error)func (obj *WSServer) SetSSLAuthenticateClients(value bool) error ``` ## Default Value false ## Remarks This property is used in conjunction with the [SSLClientAuthentication](#sslclientauthentication-event-wsserver-component) event. Please refer to the documentation of the [SSLClientAuthentication](#sslclientauthentication-event-wsserver-component) event for details. ## Data Type **bool** # SSLCertEffectiveDate Property ([WSServer](#wsserver-component) Component) The date on which this certificate becomes valid. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertEffectiveDate() (string, error) ``` ## 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](#wsserver-component) Component) The date on which the certificate expires. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertExpirationDate() (string, error) ``` ## 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](#wsserver-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertExtendedKeyUsage() (string, error) ``` ## 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](#wsserver-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertFingerprint() (string, error) ``` ## 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](#wsserver-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertFingerprintSHA1() (string, error) ``` ## 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](#wsserver-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertFingerprintSHA256() (string, error) ``` ## 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](#wsserver-component) Component) The issuer of the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertIssuer() (string, error) ``` ## 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](#wsserver-component) Component) The private key of the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertPrivateKey() (string, error) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SSLCertPrivateKey](#sslcertprivatekey-property-wsserver-component) may be available but not exportable. In this case, [SSLCertPrivateKey](#sslcertprivatekey-property-wsserver-component) returns an empty string. This property is read-only. ## Data Type **string** # SSLCertPrivateKeyAvailable Property ([WSServer](#wsserver-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertPrivateKeyAvailable() (bool, error) ``` ## Default Value false ## Remarks Whether a [SSLCertPrivateKey](#sslcertprivatekey-property-wsserver-component) is available for the selected certificate. If [SSLCertPrivateKeyAvailable](#sslcertprivatekeyavailable-property-wsserver-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type **bool** # SSLCertPrivateKeyContainer Property ([WSServer](#wsserver-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertPrivateKeyContainer() (string, error) ``` ## Default Value "" ## Remarks The name of the [SSLCertPrivateKey](#sslcertprivatekey-property-wsserver-component) 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](#wsserver-component) Component) The public key of the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertPublicKey() (string, error) ``` ## 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](#wsserver-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertPublicKeyAlgorithm() (string, error) ``` ## 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](#wsserver-component) Component) The length of the certificate's public key (in bits). ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertPublicKeyLength() (int32, error) ``` ## 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 **int32** # SSLCertSerialNumber Property ([WSServer](#wsserver-component) Component) The serial number of the certificate encoded as a string. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertSerialNumber() (string, error) ``` ## 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](#wsserver-component) Component) The text description of the certificate's signature algorithm. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertSignatureAlgorithm() (string, error) ``` ## 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](#wsserver-component) Component) The name of the certificate store for the client certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertStore() ([]byte, error)func (obj *WSServer) SetSSLCertStore(value []byte) error ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SSLCertStoreType](#sslcertstoretype-property-wsserver-component) property denotes the type of the certificate store specified by [SSLCertStore](#sslcertstore-property-wsserver-component). If the store is password-protected, specify the password in [SSLCertStorePassword](#sslcertstorepassword-property-wsserver-component). [SSLCertStore](#sslcertstore-property-wsserver-component) is used in conjunction with the [SSLCertSubject](#sslcertsubject-property-wsserver-component) property to specify client certificates. If [SSLCertStore](#sslcertstore-property-wsserver-component) has a value, and [SSLCertSubject](#sslcertsubject-property-wsserver-component) or [SSLCertEncoded](#sslcertencoded-property-wsserver-component) is set, a search for a certificate is initiated. Please see the [SSLCertSubject](#sslcertsubject-property-wsserver-component) 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). ## Data Type **[]byte** # SSLCertStorePassword Property ([WSServer](#wsserver-component) Component) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertStorePassword() (string, error)func (obj *WSServer) SetSSLCertStorePassword(value string) error ``` ## 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](#wsserver-component) Component) The type of certificate store for this certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertStoreType() (int32, error)func (obj *WSServer) SetSSLCertStoreType(value int32) error ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [SSLCertStoreType](#sslcertstoretype-property-wsserver-component), the full path of the PKCS#11 DLL as the [SSLCertStore](#sslcertstore-property-wsserver-component), and the PIN as the [SSLCertStorePassword](#sslcertstorepassword-property-wsserver-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [SSLCertStore](#sslcertstore-property-wsserver-component) and set [SSLCertStorePassword](#sslcertstorepassword-property-wsserver-component) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 **int32** # SSLCertSubjectAltNames Property ([WSServer](#wsserver-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertSubjectAltNames() (string, error) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type **string** # SSLCertThumbprintMD5 Property ([WSServer](#wsserver-component) Component) The MD5 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertThumbprintMD5() (string, error) ``` ## 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](#wsserver-component) Component) The SHA-1 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertThumbprintSHA1() (string, error) ``` ## 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](#wsserver-component) Component) The SHA-256 hash of the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertThumbprintSHA256() (string, error) ``` ## 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](#wsserver-component) Component) The text description of UsageFlags . ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertUsage() (string, error) ``` ## Default Value "" ## Remarks The text description of [SSLCertUsageFlags](#sslcertusageflags-property-wsserver-component). 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](#wsserver-component) Component) The flags that show intended use for the certificate. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertUsageFlags() (int32, error) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SSLCertUsageFlags](#sslcertusageflags-property-wsserver-component) 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](#sslcertusage-property-wsserver-component) property for a text representation of [SSLCertUsageFlags](#sslcertusageflags-property-wsserver-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type **int32** # SSLCertVersion Property ([WSServer](#wsserver-component) Component) The certificate's version number. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertVersion() (string, error) ``` ## 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](#wsserver-component) Component) The subject of the certificate used for client authentication. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertSubject() (string, error)func (obj *WSServer) SetSSLCertSubject(value string) error ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | 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](#wsserver-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLCertEncoded() ([]byte, error)func (obj *WSServer) SetSSLCertEncoded(value []byte) error ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SSLCertStore](#sslcertstore-property-wsserver-component) and [SSLCertSubject](#sslcertsubject-property-wsserver-component) properties also may be used to specify a certificate. When [SSLCertEncoded](#sslcertencoded-property-wsserver-component) is set, a search is initiated in the current [SSLCertStore](#sslcertstore-property-wsserver-component) for the private key of the certificate. If the key is found, [SSLCertSubject](#sslcertsubject-property-wsserver-component) is updated to reflect the full subject of the selected certificate; otherwise, [SSLCertSubject](#sslcertsubject-property-wsserver-component) is set to an empty string. ## Data Type **[]byte** # SSLProvider Property ([WSServer](#wsserver-component) Component) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Go Syntax* ```text func (obj *WSServer) SSLProvider() (int32, error)func (obj *WSServer) SetSSLProvider(value int32) error ``` ## Possible Values ```text 0 // Automatic1 // Platform2 // Internal ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the struct will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. | | 1 (sslpPlatform) | Uses the platform/system implementation. | | 2 (sslpInternal) | Uses the internal implementation. | **Additional Notes** In most cases using the default value (Automatic) is recommended. The struct will select a provider depending on the current platform. When Automatic is selected, on Windows, the struct will use the platform implementation. On Linux/macOS, the struct will use the internal implementation. When TLS 1.3 is enabled via [SSLEnabledProtocols](#SSLEnabledProtocols), the struct will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. ## Data Type **int32** # ChangeLineMode Method ([WSServer](#wsserver-component) Component) This method controls whether the class will fire DataIn when an EOL is received for the specified connection. ## Syntax *Go Syntax* ```text func (obj *WSServer) ChangeLineMode(ConnectionId int32, LineMode bool) error ``` ## Remarks When [WSConnectionLineMode](#wsconnectionlinemode-property-wsserver-component) is set to False (default), the component will fire the [DataIn](#datain-event-wsserver-component) event once for each message received from the client. When LineMode is set to True, the component will instead fire [DataIn](#datain-event-wsserver-component) for each line of data received. The maximum length of a line can be controlled by the [MaxLineLength](#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](#wsserver-component) Component) Sets or retrieves a configuration setting. ## Syntax *Go Syntax* ```text func (obj *WSServer) Config(ConfigurationString string) (string, error) ``` ## Remarks Config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-wsserver-component) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-wsserver-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # Disconnect Method ([WSServer](#wsserver-component) Component) This method disconnects the specified client. ## Syntax *Go Syntax* ```text func (obj *WSServer) Disconnect(ConnectionId int32) error ``` ## Remarks Calling this method will disconnect the client specified by the *ConnectionId* parameter. # DoEvents Method ([WSServer](#wsserver-component) Component) This method processes events from the internal message queue. ## Syntax *Go Syntax* ```text func (obj *WSServer) DoEvents() error ``` ## Remarks When DoEvents is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # Interrupt Method ([WSServer](#wsserver-component) Component) This method interrupts a synchronous send to the remote host. ## Syntax *Go Syntax* ```text func (obj *WSServer) Interrupt(ConnectionId int32) error ``` ## 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 struct. If you use [SendFile](#sendfile-method-wsserver-component) to upload a file, the struct will run synchronously on that ConnectionId until it is completed. # Ping Method ([WSServer](#wsserver-component) Component) This method sends a ping request to the remote host. ## Syntax *Go Syntax* ```text func (obj *WSServer) Ping(ConnectionId int32) error ``` ## 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](#wsserver-component) Component) This method sends binary data to the client. ## Syntax *Go Syntax* ```text func (obj *WSServer) Send(ConnectionId int32, Data []byte) error ``` ## Remarks This method sends the binary data specified by *Data* to the client specified by *ConnectionId*. # SendBytes Method ([WSServer](#wsserver-component) Component) This method sends binary data to the specified client. ## Syntax *Go Syntax* ```text func (obj *WSServer) SendBytes(ConnectionId int32, Data []byte) error ``` ## Remarks This method sends binary data to the client identified by *ConnectionId*. To send text, use the [SendText](#sendtext-method-wsserver-component) method instead. When [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) is set to 0, the struct will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-wsserver-component) event before attempting to send data again. NOTE: The [ReadyToSend](#readytosend-event-wsserver-component) event is not fired when part of the data is sent successfully. # SendFile Method ([WSServer](#wsserver-component) Component) This method sends the file to the remote host. ## Syntax *Go Syntax* ```text func (obj *WSServer) SendFile(ConnectionId int32, FileName string) error ``` ## Remarks This method sends the file to the client specified by the *ConnectionId*. # SendText Method ([WSServer](#wsserver-component) Component) This method sends text data to the client. ## Syntax *Go Syntax* ```text func (obj *WSServer) SendText(ConnectionId int32, Text string) error ``` ## Remarks This method sends text to the client identified by *ConnectionId*. To send binary data, use the [SendBytes](#sendbytes-method-wsserver-component) method instead. When [WSConnectionTimeout](#wsconnectiontimeout-property-wsserver-component) is set to 0, the struct will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the [ReadyToSend](#readytosend-event-wsserver-component) event before attempting to send data again. NOTE: The [ReadyToSend](#readytosend-event-wsserver-component) 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](#wsconnectiondataformat-property-wsserver-component). The struct will UTF-8 encode the supplied text. # Shutdown Method ([WSServer](#wsserver-component) Component) This method shuts down the server. ## Syntax *Go Syntax* ```text func (obj *WSServer) Shutdown() error ``` ## Remarks This method shuts down the server. Calling this method is equivalent to calling [StopListening](#stoplistening-method-wsserver-component) and then breaking every client connection by calling [Disconnect](#disconnect-method-wsserver-component). # StartListening Method ([WSServer](#wsserver-component) Component) This method starts listening for incoming connections. ## Syntax *Go Syntax* ```text func (obj *WSServer) StartListening() error ``` ## Remarks This method begins listening for incoming connections on the port specified by [LocalPort](#localport-property-wsserver-component). Once listening, events will fire as new clients connect and data are transferred. To stop listening for new connections, call [StopListening](#stoplistening-method-wsserver-component). To stop listening for new connections and to disconnect all existing clients, call [Shutdown](#shutdown-method-wsserver-component). # StopListening Method ([WSServer](#wsserver-component) Component) This method stops listening for new connections. ## Syntax *Go Syntax* ```text func (obj *WSServer) StopListening() error ``` ## 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](#shutdown-method-wsserver-component) instead. # Connected Event ([WSServer](#wsserver-component) Component) This event is fired when a WebSocket is successfully opened. ## Syntax *Go Syntax* ```text // WSServerConnectedEventArgs carries the WSServer Connected event's parameters. type WSServerConnectedEventArgs struct {...} func (args *WSServerConnectedEventArgs) ConnectionId() int32 // WSServerConnectedEvent defines the signature of the WSServer Connected event's handler function. type WSServerConnectedEvent func(sender *WSServer, args *WSServerConnectedEventArgs) func (obj *WSServer) GetOnConnectedHandler() WSServerConnectedEvent func (obj *WSServer) SetOnConnectedHandler(handlerFunc WSServerConnectedEvent) ``` ## Remarks The Connected event is fired when a WebSocket is successfully opened on a connection. *ConnectionId* identifies the connection. # ConnectionRequest Event ([WSServer](#wsserver-component) Component) This event is fired when a request for connection comes from a remote host. ## Syntax *Go Syntax* ```text // WSServerConnectionRequestEventArgs carries the WSServer ConnectionRequest event's parameters. type WSServerConnectionRequestEventArgs struct {...} func (args *WSServerConnectionRequestEventArgs) Address() string func (args *WSServerConnectionRequestEventArgs) Port() int32 func (args *WSServerConnectionRequestEventArgs) Accept() bool func (args *WSServerConnectionRequestEventArgs) SetAccept(value bool) // WSServerConnectionRequestEvent defines the signature of the WSServer ConnectionRequest event's handler function. type WSServerConnectionRequestEvent func(sender *WSServer, args *WSServerConnectionRequestEventArgs) func (obj *WSServer) GetOnConnectionRequestHandler() WSServerConnectionRequestEvent func (obj *WSServer) SetOnConnectionRequestHandler(handlerFunc WSServerConnectionRequestEvent) ``` ## 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](#wsserver-component) Component) This event is fired when data are received. ## Syntax *Go Syntax* ```text // WSServerDataInEventArgs carries the WSServer DataIn event's parameters. type WSServerDataInEventArgs struct {...} func (args *WSServerDataInEventArgs) ConnectionId() int32 func (args *WSServerDataInEventArgs) DataFormat() int32 func (args *WSServerDataInEventArgs) Text() []byte func (args *WSServerDataInEventArgs) EOM() bool func (args *WSServerDataInEventArgs) EOL() bool // WSServerDataInEvent defines the signature of the WSServer DataIn event's handler function. type WSServerDataInEvent func(sender *WSServer, args *WSServerDataInEventArgs) func (obj *WSServer) GetOnDataInHandler() WSServerDataInEvent func (obj *WSServer) SetOnDataInHandler(handlerFunc WSServerDataInEvent) ``` ## 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 struct 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 struct may also be configured to buffer the message internally until the complete message is received. To enable this, set [BufferMessage](#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](#MaxLineLength) was reached. # Disconnected Event ([WSServer](#wsserver-component) Component) This event is fired when a WebSocket connection is disconnected. ## Syntax *Go Syntax* ```text // WSServerDisconnectedEventArgs carries the WSServer Disconnected event's parameters. type WSServerDisconnectedEventArgs struct {...} func (args *WSServerDisconnectedEventArgs) ConnectionId() int32 func (args *WSServerDisconnectedEventArgs) StatusCode() int32 func (args *WSServerDisconnectedEventArgs) Description() string // WSServerDisconnectedEvent defines the signature of the WSServer Disconnected event's handler function. type WSServerDisconnectedEvent func(sender *WSServer, args *WSServerDisconnectedEventArgs) func (obj *WSServer) GetOnDisconnectedHandler() WSServerDisconnectedEvent func (obj *WSServer) SetOnDisconnectedHandler(handlerFunc WSServerDisconnectedEvent) ``` ## 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](#wsserver-component) Component) This event is fired for information about errors during data delivery. ## Syntax *Go Syntax* ```text // WSServerErrorEventArgs carries the WSServer Error event's parameters. type WSServerErrorEventArgs struct {...} func (args *WSServerErrorEventArgs) ConnectionId() int32 func (args *WSServerErrorEventArgs) ErrorCode() int32 func (args *WSServerErrorEventArgs) Description() string // WSServerErrorEvent defines the signature of the WSServer Error event's handler function. type WSServerErrorEvent func(sender *WSServer, args *WSServerErrorEventArgs) func (obj *WSServer) GetOnErrorHandler() WSServerErrorEvent func (obj *WSServer) SetOnErrorHandler(handlerFunc WSServerErrorEvent) ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the struct 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](#trappable-errors-wsserver-component) 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](#trappable-errors-wsserver-component) section. # Log Event ([WSServer](#wsserver-component) Component) This event fires once for each log message. ## Syntax *Go Syntax* ```text // WSServerLogEventArgs carries the WSServer Log event's parameters. type WSServerLogEventArgs struct {...} func (args *WSServerLogEventArgs) ConnectionId() int32 func (args *WSServerLogEventArgs) LogLevel() int32 func (args *WSServerLogEventArgs) Message() string func (args *WSServerLogEventArgs) LogType() string // WSServerLogEvent defines the signature of the WSServer Log event's handler function. type WSServerLogEvent func(sender *WSServer, args *WSServerLogEventArgs) func (obj *WSServer) GetOnLogHandler() WSServerLogEvent func (obj *WSServer) SetOnLogHandler(handlerFunc WSServerLogEvent) ``` ## Remarks This event fires once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#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" **ConnectionId** specifies the Id of the connection to which the log applies. # Ping Event ([WSServer](#wsserver-component) Component) This event is fired when a ping request or response is received. ## Syntax *Go Syntax* ```text // WSServerPingEventArgs carries the WSServer Ping event's parameters. type WSServerPingEventArgs struct {...} func (args *WSServerPingEventArgs) ConnectionId() int32 func (args *WSServerPingEventArgs) Payload() []byte func (args *WSServerPingEventArgs) Response() bool // WSServerPingEvent defines the signature of the WSServer Ping event's handler function. type WSServerPingEvent func(sender *WSServer, args *WSServerPingEventArgs) func (obj *WSServer) GetOnPingHandler() WSServerPingEvent func (obj *WSServer) SetOnPingHandler(handlerFunc WSServerPingEvent) ``` ## 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 struct receives a ping request, it will automatically reply with a pong. *Payload* holds the payload of the request, if any. *Response* is *true* if the incoming packet is a ping response. If the incoming packet is a ping request this is *false*. # ReadyToSend Event ([WSServer](#wsserver-component) Component) This event is fired when the class is ready to send data. ## Syntax *Go Syntax* ```text // WSServerReadyToSendEventArgs carries the WSServer ReadyToSend event's parameters. type WSServerReadyToSendEventArgs struct {...} func (args *WSServerReadyToSendEventArgs) ConnectionId() int32 // WSServerReadyToSendEvent defines the signature of the WSServer ReadyToSend event's handler function. type WSServerReadyToSendEvent func(sender *WSServer, args *WSServerReadyToSendEventArgs) func (obj *WSServer) GetOnReadyToSendHandler() WSServerReadyToSendEvent func (obj *WSServer) SetOnReadyToSendHandler(handlerFunc WSServerReadyToSendEvent) ``` ## Remarks The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed [Send](#send-method-wsserver-component). This event is also fired immediately after a connection is established. # SSLClientAuthentication Event ([WSServer](#wsserver-component) Component) This event is fired when the client presents its credentials to the server. ## Syntax *Go Syntax* ```text // WSServerSSLClientAuthenticationEventArgs carries the WSServer SSLClientAuthentication event's parameters. type WSServerSSLClientAuthenticationEventArgs struct {...} func (args *WSServerSSLClientAuthenticationEventArgs) ConnectionId() int32 func (args *WSServerSSLClientAuthenticationEventArgs) CertEncoded() []byte func (args *WSServerSSLClientAuthenticationEventArgs) CertSubject() string func (args *WSServerSSLClientAuthenticationEventArgs) CertIssuer() string func (args *WSServerSSLClientAuthenticationEventArgs) Status() string func (args *WSServerSSLClientAuthenticationEventArgs) Accept() bool func (args *WSServerSSLClientAuthenticationEventArgs) SetAccept(value bool) // WSServerSSLClientAuthenticationEvent defines the signature of the WSServer SSLClientAuthentication event's handler function. type WSServerSSLClientAuthenticationEvent func(sender *WSServer, args *WSServerSSLClientAuthenticationEventArgs) func (obj *WSServer) GetOnSSLClientAuthenticationHandler() WSServerSSLClientAuthenticationEvent func (obj *WSServer) SetOnSSLClientAuthenticationHandler(handlerFunc WSServerSSLClientAuthenticationEvent) ``` ## 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](#wsserver-component) Component) This event fires when a Secure Sockets Layer (SSL) connection is requested. ## Syntax *Go Syntax* ```text // WSServerSSLConnectionRequestEventArgs carries the WSServer SSLConnectionRequest event's parameters. type WSServerSSLConnectionRequestEventArgs struct {...} func (args *WSServerSSLConnectionRequestEventArgs) ConnectionId() int32 func (args *WSServerSSLConnectionRequestEventArgs) SupportedCipherSuites() string func (args *WSServerSSLConnectionRequestEventArgs) SupportedSignatureAlgs() string func (args *WSServerSSLConnectionRequestEventArgs) CertStoreType() int32 func (args *WSServerSSLConnectionRequestEventArgs) SetCertStoreType(value int32) func (args *WSServerSSLConnectionRequestEventArgs) CertStore() string func (args *WSServerSSLConnectionRequestEventArgs) SetCertStore(value string) func (args *WSServerSSLConnectionRequestEventArgs) CertPassword() string func (args *WSServerSSLConnectionRequestEventArgs) SetCertPassword(value string) func (args *WSServerSSLConnectionRequestEventArgs) CertSubject() string func (args *WSServerSSLConnectionRequestEventArgs) SetCertSubject(value string) // WSServerSSLConnectionRequestEvent defines the signature of the WSServer SSLConnectionRequest event's handler function. type WSServerSSLConnectionRequestEvent func(sender *WSServer, args *WSServerSSLConnectionRequestEventArgs) func (obj *WSServer) GetOnSSLConnectionRequestHandler() WSServerSSLConnectionRequestEvent func (obj *WSServer) SetOnSSLConnectionRequestHandler(handlerFunc WSServerSSLConnectionRequestEvent) ``` ## Remarks This event fires when an SSL connection is requested and [SSLProvider](#sslprovider-property-wsserver-component) 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](#sslprovider-property-wsserver-component) is set to *Platform*. This event allows the struct to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities. *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 struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new Certificate object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) struct by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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=example@email.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](#wsserver-component) Component) This event is fired to show the progress of the secure connection. ## Syntax *Go Syntax* ```text // WSServerSSLStatusEventArgs carries the WSServer SSLStatus event's parameters. type WSServerSSLStatusEventArgs struct {...} func (args *WSServerSSLStatusEventArgs) ConnectionId() int32 func (args *WSServerSSLStatusEventArgs) Message() string // WSServerSSLStatusEvent defines the signature of the WSServer SSLStatus event's handler function. type WSServerSSLStatusEvent func(sender *WSServer, args *WSServerSSLStatusEventArgs) func (obj *WSServer) GetOnSSLStatusHandler() WSServerSSLStatusEvent func (obj *WSServer) SetOnSSLStatusHandler(handlerFunc WSServerSSLStatusEvent) ``` ## Remarks The event is fired for informational and logging purposes only. It is used to track the progress of the connection. # WebSocketOpenRequest Event ([WSServer](#wsserver-component) Component) This event is fired when a client attempts to open a WebSocket. ## Syntax *Go Syntax* ```text // WSServerWebSocketOpenRequestEventArgs carries the WSServer WebSocketOpenRequest event's parameters. type WSServerWebSocketOpenRequestEventArgs struct {...} func (args *WSServerWebSocketOpenRequestEventArgs) ConnectionId() int32 func (args *WSServerWebSocketOpenRequestEventArgs) RequestURI() string func (args *WSServerWebSocketOpenRequestEventArgs) HostHeader() string func (args *WSServerWebSocketOpenRequestEventArgs) OriginHeader() string func (args *WSServerWebSocketOpenRequestEventArgs) SubProtocols() string func (args *WSServerWebSocketOpenRequestEventArgs) SetSubProtocols(value string) func (args *WSServerWebSocketOpenRequestEventArgs) Extensions() string func (args *WSServerWebSocketOpenRequestEventArgs) RequestHeaders() string func (args *WSServerWebSocketOpenRequestEventArgs) StatusCode() int32 func (args *WSServerWebSocketOpenRequestEventArgs) SetStatusCode(value int32) func (args *WSServerWebSocketOpenRequestEventArgs) ResponseHeaders() string func (args *WSServerWebSocketOpenRequestEventArgs) SetResponseHeaders(value string) // WSServerWebSocketOpenRequestEvent defines the signature of the WSServer WebSocketOpenRequest event's handler function. type WSServerWebSocketOpenRequestEvent func(sender *WSServer, args *WSServerWebSocketOpenRequestEventArgs) func (obj *WSServer) GetOnWebSocketOpenRequestHandler() WSServerWebSocketOpenRequestEvent func (obj *WSServer) SetOnWebSocketOpenRequestHandler(handlerFunc WSServerWebSocketOpenRequestEvent) ``` ## 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 struct will accept the connection. You do not need to set anything to accept the connection. The struct 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 struct 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](#wsserver-component) Component) The struct accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these *internal properties* is provided through the [Config](#config-method-wsserver-component) method. ### WebSocketServer Config Settings **BufferMessage**: Indicates whether or not the entire message is buffered before firing the DataIn event.When receiving large messages the [DataIn](#datain-event-wsserver-component), this event may fire multiple times to provide data as it is received in each message fragment. When [BufferMessage](#BufferMessage) is set to True, the struct will internally buffer the message as it is received until it is complete before firing the [DataIn](#datain-event-wsserver-component) event. The default value is False. **DisconnectStatusCode**: Specifies the status code when closing a connection.When the [Disconnect](#disconnect-method-wsserver-component) method is called, the struct will send the status code specified here. By default, the value is 1,000, which indicates a normal closure. Any other value represents an error condition. You may set any value you wish, but the protocol defines the following common values. | | | | --- | --- | | 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. | **DisconnectStatusDescription**: Specifies the message associated with the disconnect status code.This configuration setting may be used to provide a textual description of the status code sent when closing the connection. This configuration setting works in conjunction with [DisconnectStatusCode](#DisconnectStatusCode). For any of the standard codes listed in [DisconnectStatusCode](#DisconnectStatusCode), the struct will use a default description that may be overridden with this setting. For any nonstandard codes that are not listed, this setting should be set or no description will be sent. **EnablePermessageDeflate**: Determines whether or not the struct will enable the permessage-deflate extension.When *true*, the struct will allow the *permessage-deflate* extension to be enabled, if the WebSocket client requests the *permessage-deflate* extension. When this setting is set to *false*, the struct will keep the *permessage-deflate* extension disabled, regardless of what the WebSocket client requests. The default value is *true*. **MaxFrameSize**: Specifies the maximum size of the outgoing message in bytes before fragmentation occurs.This configuration setting specifies the maximum size of the outgoing message in bytes before fragmentation will occur. When a message that is larger than [MaxFrameSize](#MaxFrameSize) is sent, it will be broken into fragments with the maximum size specified here. The default value is 131072 (128K). When a message is fragmented, the receiving side may check the *EOM* parameter of the [DataIn](#datain-event-wsserver-component) 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](#datain-event-wsserver-component) event on the receiving side. **MaxLineLength[ConnectionId]**: Determines the maximum line length for a connection when LineMode is True.When [WSConnectionLineMode](#wsconnectionlinemode-property-wsserver-component) is True, setting this will cause the component to fire the [DataIn](#datain-event-wsserver-component) event when the length of the received data reaches the value of this setting. When the [DataIn](#datain-event-wsserver-component) event fires, the *EOL* parameter will be False if this setting caused the event to fire and True if an *EOL* caused the event to fire. **MessageLength[ConnectionId]**: The length of the message (in bytes) when sending asynchronously.This configuration setting specifies the length of messages being sent when operating asynchronously. When [DefaultTimeout](#defaulttimeout-property-wsserver-component) is set to *0* the struct operates asynchronously and, by default, all data sent when [Send](#send-method-wsserver-component) is called is considered a complete message. Each packet leaving the struct has the End-of-Message flag set. To send messages that may be fragmented, set [MessageLength](#MessageLength) to the length of the message (in bytes) that is being sent. When set, the struct will consider the next [MessageLength](#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](#defaulttimeout-property-wsserver-component) is set to *0*. When [DefaultTimeout](#defaulttimeout-property-wsserver-component) is set to a positive value, the message data may be passed in its entirety to [Send](#send-method-wsserver-component) and will be automatically handled as needed by the struct. **WaitForCloseResponse**: Determines whether or not the struct will forcibly close a connection.When this configuration setting is set to True (default), the struct will wait for a response from the client when closing the connection. When this configuration setting is set to False, the struct will forcibly close the connection without waiting for a response from the client. ### TCPServer Config Settings **AllowedClients**: A comma-separated list of host names or IP addresses that can access the struct.This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the struct. The wildcard character "*" is supported. The default value is "*" and all connections are accepted. When a client connects, the client's address is checked against the list defined here. If there is no match, the [ConnectionRequest](#connectionrequest-event-wsserver-component) event fires with an *Accept* value set to *false*. If no action is taken within the [ConnectionRequest](#connectionrequest-event-wsserver-component) event, the client will be disconnected. **BindExclusively**: Whether or not the component considers a local port reserved for exclusive use.If this is *true* (default), the component will bind to the local port with the ExclusiveAddressUse option set, meaning that nothing else can bind to the same port. Also the component will not be able to bind to local ports that are already in use by some other instance, and attempts to do so will result in failure. **BlockedClients**: A comma-separated list of host names or IP addresses that cannot access the struct.This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the struct.The default value is "" and all connections are accepted. When a client connects, the client's address is checked against the list defined here. If there is a match, the [ConnectionRequest](#connectionrequest-event-wsserver-component) event fires with an *Accept* value set to *false*. If no action is taken within the [ConnectionRequest](#connectionrequest-event-wsserver-component) event, the client will not be connected. **DefaultConnectionTimeout**: The inactivity timeout applied to the SSL handshake.This configuration setting specifies the inactivity (in seconds) to apply to incoming Secure Sockets Layer (SSL) connections. When set to a positive value, if the other end is unresponsive for the specified number of seconds, the connection will timeout. This is not applicable to the entire handshake. It is applicable only to the inactivity of the connecting client during the handshake if a response is expected and none is received within the timeout window. The default value is 0, and no connection-specific timeout is applied. NOTE: This is applicable only to incoming SSL connections. This should be set only if there is a specific reason to do so. **InBufferSize**: The size in bytes of the incoming queue of the socket. This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the [InBufferSize](#InBufferSize) setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated, the [InBufferSize](#InBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. [InBufferSize](#InBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.A TCP keep-alive packet will be sent after a period of inactivity, as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. If this value is not specified here, the system default is 1 second. This setting is applicable to all connections. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.By default, the operating system will determine the time a connection is idle before a TCP keep-alive packet is sent. If this value is not specified here, the system default is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. This setting is applicable to all connections. **MaxConnections**: The maximum number of connections available. This is the maximum number of connections available. This setting must be set before [Listening](#listening-property-wsserver-component) is set to *true*, and once set, it can no longer be changed for the current instance of the struct. The maximum value for this setting is 100,000 connections. Use this setting with caution. Extremely large values may affect performance. The default value is 1000. NOTE: Unix/Linux operating systems limit the number of simultaneous connections to 1024. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the [OutBufferSize](#OutBufferSize) setting can provide significant improvements in performance in some cases. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the [OutBufferSize](#OutBufferSize) reverts to its defined size. The same thing will happen if you attempt to make it too large or too small. [OutBufferSize](#OutBufferSize) is shared among incoming connections. When the setting is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to 0 (default), the struct will use IPv4 exclusively. When set to 1, the struct will use IPv6 exclusively. When set to 2, the struct will listen for both IPv4 and IPv6 connections. If IPv6 is not available on the system, only IPv4 will be used. The default value is 0. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 Only | | 1 | IPv6 Only | | 2 | IPv6 and IPv4 | ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [SSLProvider](#sslprovider-property-wsserver-component) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [SSLStatus](#sslstatus-event-wsserver-component) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [SSLProvider](#sslprovider-property-wsserver-component) is set to *Platform*. **OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL. 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. **OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL. 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. **OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL. 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". **OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL. 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. **ReuseSSLSession**: Determines if the SSL session is reused. If set to True, the struct 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 struct is the same. **SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When [SSLProvider](#sslprovider-property-wsserver-component) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the SSLCert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the struct will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the struct will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The struct will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the struct fails with an error. When set to 0 (default), the CRL check will not be performed by the struct. 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. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the struct will use OCSP to check the validity of the server certificate. If set to 1 or 2, the struct will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The struct will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation, the struct fails with an error. When set to 0 (default), the struct 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. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated. 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](#sslstatus-event-wsserver-component) 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when [SSLAuthenticateClients](#sslauthenticateclients-property-wsserver-component) is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#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](#sslprovider-property-wsserver-component) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [SSLProvider](#sslprovider-property-wsserver-component) 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 Example values when [SSLProvider](#sslprovider-property-wsserver-component) is set to *Internal*include the following: ```text 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](#sslprovider-property-wsserver-component) 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](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. 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 struct will first try to use the platform TLS 1.3 implementation when the [SSLProvider](#sslprovider-property-wsserver-component) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [SSLProvider](#sslprovider-property-wsserver-component) 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](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#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 struct when the [SSLProvider](#sslprovider-property-wsserver-component) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [SSLProvider](#sslprovider-property-wsserver-component) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension. This configuration setting is applicable only when [SSLProvider](#sslprovider-property-wsserver-component) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event. 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. **SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes. When set, the struct 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 struct will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [SSLProvider](#sslprovider-property-wsserver-component) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 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. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----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----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [SSLProvider](#sslprovider-property-wsserver-component) is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2. When specified the struct 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 struct fails with an error. The format of this value is a comma-separated list of hash-signature combinations. For instance: ```csharp 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. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [SSLProvider](#sslprovider-property-wsserver-component) 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) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. 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" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "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 *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* 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) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). 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 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | 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 | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([WSServer](#wsserver-component) Component) ### WSServer Errors | | | | --- | --- | | 4202 | Error sending data to the connected client. | ### SSLServer Errors | | | | --- | --- | | 100 | You cannot change the RemotePort at this time. A connection is in progress. | | 101 | You cannot change the RemoteHost at this time. A connection is in progress. | | 102 | The RemoteHost address is invalid (0.0.0.0). | | 104 | SSLServer is already listening. | | 106 | Cannot change [LocalPort](#localport-property-wsserver-component) when SSLServer is listening. | | 107 | Cannot change [LocalHost](#localhost-property-wsserver-component) when SSLServer is listening. | | 108 | Cannot change [MaxConnections](#MaxConnections) when SSLServer is listening. | | 112 | You cannot change [MaxLineLength](#MaxLineLength) at this time. A connection is in progress. | | 116 | RemotePort cannot be zero. Please specify a valid service port number. | | 126 | Invalid ConnectionId. | | 135 | Operation would block. | ### SSL Errors | | | | --- | --- | | 270 | Cannot load specified security library. | | 271 | Cannot open certificate store. | | 272 | Cannot find specified certificate. | | 273 | Cannot acquire security credentials. | | 274 | Cannot find certificate chain. | | 275 | Cannot verify certificate chain. | | 276 | Error during handshake. | | 280 | Error verifying certificate. | | 281 | Could not find client certificate. | | 282 | Could not find server certificate. | | 283 | Error encrypting data. | | 284 | Error decrypting data. | ### TCP/IP Errors | | | | --- | --- | | 10004 | [10004] Interrupted system call. | | 10009 | [10009] Bad file number. | | 10013 | [10013] Access denied. | | 10014 | [10014] Bad address. | | 10022 | [10022] Invalid argument. | | 10024 | [10024] Too many open files. | | 10035 | [10035] Operation would block. | | 10036 | [10036] Operation now in progress. | | 10037 | [10037] Operation already in progress. | | 10038 | [10038] Socket operation on nonsocket. | | 10039 | [10039] Destination address required. | | 10040 | [10040] Message is too long. | | 10041 | [10041] Protocol wrong type for socket. | | 10042 | [10042] Bad protocol option. | | 10043 | [10043] Protocol is not supported. | | 10044 | [10044] Socket type is not supported. | | 10045 | [10045] Operation is not supported on socket. | | 10046 | [10046] Protocol family is not supported. | | 10047 | [10047] Address family is not supported by protocol family. | | 10048 | [10048] Address already in use. | | 10049 | [10049] Cannot assign requested address. | | 10050 | [10050] Network is down. | | 10051 | [10051] Network is unreachable. | | 10052 | [10052] Net dropped connection or reset. | | 10053 | [10053] Software caused connection abort. | | 10054 | [10054] Connection reset by peer. | | 10055 | [10055] No buffer space available. | | 10056 | [10056] Socket is already connected. | | 10057 | [10057] Socket is not connected. | | 10058 | [10058] Cannot send after socket shutdown. | | 10059 | [10059] Too many references, cannot splice. | | 10060 | [10060] Connection timed out. | | 10061 | [10061] Connection refused. | | 10062 | [10062] Too many levels of symbolic links. | | 10063 | [10063] File name is too long. | | 10064 | [10064] Host is down. | | 10065 | [10065] No route to host. | | 10066 | [10066] Directory is not empty | | 10067 | [10067] Too many processes. | | 10068 | [10068] Too many users. | | 10069 | [10069] Disc Quota Exceeded. | | 10070 | [10070] Stale NFS file handle. | | 10071 | [10071] Too many levels of remote in path. | | 10091 | [10091] Network subsystem is unavailable. | | 10092 | [10092] WINSOCK DLL Version out of range. | | 10093 | [10093] Winsock is not loaded yet. | | 11001 | [11001] Host not found. | | 11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). | | 11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. | | 11004 | [11004] Valid name, no data record (check DNS setup). |