WSServer Module

Properties   Methods   Events   Config Settings   Errors  

The WSServer module is used to create a WebSocket server.

Syntax

IPWorks.WSServer

Remarks

The WSServer class functions as a server that facilitates incoming WebSocket connections and offers a convenient means of transmitting and receiving data over the established connections.

To start, the LocalPort property must be specified to a valid port. This port will be used to accept incoming connections. Then, call the StartListening method to start listening on the specified port. The WSServer class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method. The SSLCert properties are used to select a certificate for the server.

Note: A valid certificate must be selected before the server can function.

Upon a client's connection, the WebSocketOpenRequest event will be fired. To accept the connection, simply allow the event to complete its execution. Conversely, to reject the request, the StatusCode parameter can be set to an appropriate HTTP error code, such as 401.

By default, each instance of WSServer has the capacity to handle up to 1,000 simultaneous incoming connections. You can change the maximum number of simultaneous connections by adjusting the MaxConnections configuration setting. This setting allows you to increase the limit up to 100,000 or decrease it to a lower value based on your needs.

Each connection is identified by a unique ConnectionId, an identifier generated by the component to distinguish individual connections. The ConnectionId is also included as a parameter in WSServer's events to identify the associated connection.

After receiving a connection, incoming data can be accessed through the DataIn event. To transmit data to a client, the Send, SendText, or SendFile methods can be employed.

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

Property List

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

ConnectionBacklogThis property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.
ConnectionsThis property includes a collection of currently connected WebSocket clients.
DefaultTimeoutThis property includes initial timeout value to be used by incoming connections.
ListeningThis property indicates whether the module is listening for incoming connections on LocalPort.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThis property includes the Transmission Control Protocol (TCP) port in the local host where the module listens.
SSLAuthenticateClientsIf set to True, the server asks the client(s) for a certificate.
SSLCertThe certificate to be used during Secure Sockets Layer (SSL) negotiation.
SSLProviderThe Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
UseSSLThis property determines if the Secure Sockets Layer (SSL) is negotiated with incoming connections.

Method List

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

ChangeLineModeThis method controls whether the module will fire DataIn when an EOL is received for the specified connection.
ConfigSets or retrieves a configuration setting.
DisconnectThis method disconnects the specified client.
DoEventsThis method processes events from the internal message queue.
InterruptThis method interrupts a synchronous send to the remote host.
PingThis method sends a ping request to the remote host.
SendThis method sends binary data to the client.
SendBytesThis method sends binary data to the specified client.
SendFileThis method sends the file to the remote host.
SendTextThis method sends text data to the client.
ShutdownThis method shuts down the server.
StartListeningThis method starts listening for incoming connections.
StopListeningThis method stops listening for new connections.

Event List

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

ConnectedThis event is fired when a WebSocket is successfully opened.
ConnectionRequestThis event is fired when a request for connection comes from a remote host.
DataInThis event is fired when data are received.
DisconnectedThis event is fired when a WebSocket connection is disconnected.
ErrorThis event is fired for information about errors during data delivery.
LogThis event fires once for each log message.
PingThis event is fired when a ping request or response is received.
ReadyToSendThis event is fired when the module is ready to send data.
SSLClientAuthenticationThis event is fired when the client presents its credentials to the server.
SSLConnectionRequestThis event fires when a Secure Sockets Layer (SSL) connection is requested.
SSLStatusThis event is fired to show the progress of the secure connection.
WebSocketOpenRequestThis event is fired when a client attempts to open a WebSocket.

Config Settings

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

BufferMessageIndicates whether or not the entire message is buffered before firing the DataIn event.
DisconnectStatusCodeSpecifies the status code when closing a connection.
DisconnectStatusDescriptionSpecifies the message associated with the disconnect status code.
EnablePermessageDeflateDetermines whether or not the module will enable the permessage-deflate extension.
MaxFrameSizeSpecifies the maximum size of the outgoing message in bytes before fragmentation occurs.
MaxLineLength[ConnectionId]Determines the maximum line length for a connection when LineMode is True.
MessageLength[ConnectionId]The length of the message (in bytes) when sending asynchronously.
WaitForCloseResponseDetermines whether or not the module will forcibly close a connection.
AllowedClientsA comma-separated list of host names or IP addresses that can access the module.
BindExclusivelyWhether or not the module considers a local port reserved for exclusive use.
BlockedClientsA comma-separated list of host names or IP addresses that cannot access the module.
DefaultConnectionTimeoutThe inactivity timeout applied to the SSL handshake.
InBufferSizeThe size in bytes of the incoming queue of the socket.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
MaxConnectionsThe maximum number of connections available.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLClientCACertsA newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveDataWhether sensitive data is masked in log messages.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

ConnectionBacklog Property (WSServer Module)

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

Syntax

public var connectionBacklog: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=connectionBacklog,setter=setConnectionBacklog:) int connectionBacklog;

- (int)connectionBacklog;
- (void)setConnectionBacklog :(int)newConnectionBacklog;

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.

Connections Property (WSServer Module)

This property includes a collection of currently connected WebSocket clients.

Syntax

public var connections: [Int32: WSConnection] {
  get {...}
}


@property (nonatomic,readonly,assign,getter=WSConnectionCount) int WSConnectionCount;

- (int)WSConnectionCount;

- (BOOL)WSConnectionAcceptData:(int)connectionId;

- (int)WSConnectionBytesSent:(int)connectionId;

- (BOOL)WSConnectionConnected:(int)connectionId;

- (int)WSConnectionConnectionId:(int)connectionId;

- (int)WSConnectionDataFormat:(int)connectionId;
- (void)setWSConnectionDataFormat:(int)connectionId :(int)newWSConnectionDataFormat;

- (NSString*)WSConnectionHost:(int)connectionId;

- (BOOL)WSConnectionLineMode:(int)connectionId;

- (NSString*)WSConnectionLocalAddress:(int)connectionId;

- (NSString*)WSConnectionOrigin:(int)connectionId;

- (BOOL)WSConnectionReadyToSend:(int)connectionId;

- (NSString*)WSConnectionRemoteHost:(int)connectionId;

- (int)WSConnectionRemotePort:(int)connectionId;

- (NSString*)WSConnectionRequestHeaders:(int)connectionId;

- (NSString*)WSConnectionRequestURI:(int)connectionId;

- (NSString*)WSConnectionSubProtocols:(int)connectionId;

- (int)WSConnectionTimeout:(int)connectionId;
- (void)setWSConnectionTimeout:(int)connectionId :(int)newWSConnectionTimeout;

Default Value

False

Remarks

This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the WSConnection type.

This collection is a hashtable type of collection, in which the ConnectionId string is used as the key to the desired connection. You may acquire the key for a given connection through the Connected or WebSocketOpenRequest events.

DefaultTimeout Property (WSServer Module)

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

Syntax

public var defaultTimeout: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=defaultTimeout,setter=setDefaultTimeout:) int defaultTimeout;

- (int)defaultTimeout;
- (void)setDefaultTimeout :(int)newDefaultTimeout;

Default Value

0

Remarks

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

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

Listening Property (WSServer Module)

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

Syntax

public var listening: Bool {
  get {...}
}


@property (nonatomic,readonly,assign,getter=listening) BOOL listening;

- (BOOL)listening;

Default Value

False

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setListening(listening: Bool) throws

LocalHost Property (WSServer Module)

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

Syntax

public var localHost: String {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

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 class initiate connections (or accept in the case of server classs) 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 class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for 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.

LocalPort Property (WSServer Module)

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

Syntax

public var localPort: Int32 {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;

- (int)localPort;
- (void)setLocalPort :(int)newLocalPort;

Default Value

0

Remarks

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

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

SSLAuthenticateClients Property (WSServer Module)

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

Syntax

public var sslAuthenticateClients: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=SSLAuthenticateClients,setter=setSSLAuthenticateClients:) BOOL SSLAuthenticateClients;

- (BOOL)SSLAuthenticateClients;
- (void)setSSLAuthenticateClients :(BOOL)newSSLAuthenticateClients;

Default Value

False

Remarks

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

SSLCert Property (WSServer Module)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

public var sslCert: Certificate {
  get {...}
  set {...}
}


@property (nonatomic,readonly,assign,getter=SSLCertEffectiveDate) NSString* SSLCertEffectiveDate;

- (NSString*)SSLCertEffectiveDate;

@property (nonatomic,readonly,assign,getter=SSLCertExpirationDate) NSString* SSLCertExpirationDate;

- (NSString*)SSLCertExpirationDate;

@property (nonatomic,readonly,assign,getter=SSLCertExtendedKeyUsage) NSString* SSLCertExtendedKeyUsage;

- (NSString*)SSLCertExtendedKeyUsage;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprint) NSString* SSLCertFingerprint;

- (NSString*)SSLCertFingerprint;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA1) NSString* SSLCertFingerprintSHA1;

- (NSString*)SSLCertFingerprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertFingerprintSHA256) NSString* SSLCertFingerprintSHA256;

- (NSString*)SSLCertFingerprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertIssuer) NSString* SSLCertIssuer;

- (NSString*)SSLCertIssuer;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKey) NSString* SSLCertPrivateKey;

- (NSString*)SSLCertPrivateKey;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyAvailable) BOOL SSLCertPrivateKeyAvailable;

- (BOOL)SSLCertPrivateKeyAvailable;

@property (nonatomic,readonly,assign,getter=SSLCertPrivateKeyContainer) NSString* SSLCertPrivateKeyContainer;

- (NSString*)SSLCertPrivateKeyContainer;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKey) NSString* SSLCertPublicKey;

- (NSString*)SSLCertPublicKey;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyAlgorithm) NSString* SSLCertPublicKeyAlgorithm;

- (NSString*)SSLCertPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=SSLCertPublicKeyLength) int SSLCertPublicKeyLength;

- (int)SSLCertPublicKeyLength;

@property (nonatomic,readonly,assign,getter=SSLCertSerialNumber) NSString* SSLCertSerialNumber;

- (NSString*)SSLCertSerialNumber;

@property (nonatomic,readonly,assign,getter=SSLCertSignatureAlgorithm) NSString* SSLCertSignatureAlgorithm;

- (NSString*)SSLCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;
@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

@property (nonatomic,readonly,assign,getter=SSLCertSubjectAltNames) NSString* SSLCertSubjectAltNames;

- (NSString*)SSLCertSubjectAltNames;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintMD5) NSString* SSLCertThumbprintMD5;

- (NSString*)SSLCertThumbprintMD5;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA1) NSString* SSLCertThumbprintSHA1;

- (NSString*)SSLCertThumbprintSHA1;

@property (nonatomic,readonly,assign,getter=SSLCertThumbprintSHA256) NSString* SSLCertThumbprintSHA256;

- (NSString*)SSLCertThumbprintSHA256;

@property (nonatomic,readonly,assign,getter=SSLCertUsage) NSString* SSLCertUsage;

- (NSString*)SSLCertUsage;

@property (nonatomic,readonly,assign,getter=SSLCertUsageFlags) int SSLCertUsageFlags;

- (int)SSLCertUsageFlags;

@property (nonatomic,readonly,assign,getter=SSLCertVersion) NSString* SSLCertVersion;

- (NSString*)SSLCertVersion;

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

False

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the store and subject fields.

SSLProvider Property (WSServer Module)

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

Syntax

public var sslProvider: WSServerSSLProviders {
  get {...}
  set {...}
}

public enum WSServerSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}


@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

0

Remarks

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

Possible values are 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 class will select a provider depending on the current platform.

When Automatic is selected, the platform implementation will be used by default in all cases in the macOS edition.

UseSSL Property (WSServer Module)

This property determines if the Secure Sockets Layer (SSL) is negotiated with incoming connections.

Syntax

public var useSSL: Bool {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=useSSL,setter=setUseSSL:) BOOL useSSL;

- (BOOL)useSSL;
- (void)setUseSSL :(BOOL)newUseSSL;

Default Value

False

Remarks

When set to True, the class will attempt to negotiate SSL with all connecting clients. To enable SSL support, you must supply a valid certificate through the SSLCertStoreType, SSLCertStore, SSLCertStorePassword, and SSLCertSubject properties

The default value is False.

ChangeLineMode Method (WSServer Module)

This method controls whether the component will fire DataIn when an EOL is received for the specified connection.

Syntax

public func changeLineMode(connectionId: Int32, lineMode: Bool) throws -> Void

- (void)changeLineMode:(int)connectionId :(BOOL)lineMode;

Remarks

When ConnectionsLineMode is set to False (default), the component will fire the DataIn event once for each message received from the client. When LineMode is set to True, the component will instead fire DataIn for each line of data received. The maximum length of a line can be controlled by the MaxLineLength[ConnectionId]; configuration setting.

Note: This method is offered as a convenience feature, and it has no effect on the behavior of the WebSocket protocol.

Config Method (WSServer Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Disconnect Method (WSServer Module)

This method disconnects the specified client.

Syntax

public func disconnect(connectionId: Int32) throws -> Void

- (void)disconnect:(int)connectionId;

Remarks

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

DoEvents Method (WSServer Module)

This method processes events from the internal message queue.

Syntax

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

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

Interrupt Method (WSServer Module)

This method interrupts a synchronous send to the remote host.

Syntax

public func interrupt(connectionId: Int32) throws -> Void

- (void)interrupt:(int)connectionId;

Remarks

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

Ping Method (WSServer Module)

This method sends a ping request to the remote host.

Syntax

public func ping(connectionId: Int32) throws -> Void

- (void)ping:(int)connectionId;

Remarks

This method sends a ping request to the remote host and waits for a corresponding pong response.

The Timeout property specifies how long to wait for the pong response.

Send Method (WSServer Module)

This method sends binary data to the client.

Syntax

public func send(connectionId: Int32, data: Data) throws -> Void

- (void)send:(int)connectionId :(NSData*)data;

Remarks

This method sends the binary data specified by Data to the client specified by ConnectionId.

SendBytes Method (WSServer Module)

This method sends binary data to the specified client.

Syntax

public func sendBytes(connectionId: Int32, data: Data) throws -> Void

- (void)sendBytes:(int)connectionId :(NSData*)data;

Remarks

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

When ConnectionsTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

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

When ConnectionsTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

SendFile Method (WSServer Module)

This method sends the file to the remote host.

Syntax

public func sendFile(connectionId: Int32, fileName: String) throws -> Void

- (void)sendFile:(int)connectionId :(NSString*)fileName;

Remarks

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

SendText Method (WSServer Module)

This method sends text data to the client.

Syntax

public func sendText(connectionId: Int32, text: String) throws -> Void

- (void)sendText:(int)connectionId :(NSString*)text;

Remarks

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

When ConnectionsTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

This method sends text to the client identified by ConnectionId. Data sent with this method will always be treated as text data regardless of the value of ConnectionsDataFormat. The class will UTF-8 encode the supplied text.

Shutdown Method (WSServer Module)

This method shuts down the server.

Syntax

public func shutdown() throws -> Void

- (void)shutdown;

Remarks

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

StartListening Method (WSServer Module)

This method starts listening for incoming connections.

Syntax

public func startListening() throws -> Void

- (void)startListening;

Remarks

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

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (WSServer Module)

This method stops listening for new connections.

Syntax

public func stopListening() throws -> Void

- (void)stopListening;

Remarks

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

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

Connected Event (WSServer Module)

This event is fired when a WebSocket is successfully opened.

Syntax

func onConnected(connectionId: Int32)

- (void)onConnected:(int)connectionId;

Remarks

The Connected event is fired when a WebSocket is successfully opened on a connection.

ConnectionId identifies the connection.

ConnectionRequest Event (WSServer Module)

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

Syntax

func onConnectionRequest(address: String, port: Int32, accept: inout Bool)

- (void)onConnectionRequest:(NSString*)address :(int)port :(int*)accept;

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 Module)

This event is fired when data are received.

Syntax

func onDataIn(connectionId: Int32, dataFormat: Int32, text: Data, eom: Bool, eol: Bool)

- (void)onDataIn:(int)connectionId :(int)dataFormat :(NSData*)text :(BOOL)EOM :(BOOL)EOL;

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 class 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 class may also be configured to buffer the message internally until the complete message is received. To enable this, set BufferMessage to True.

The EOL parameter stands for End of Line. When LineMode is False, EOL will always be False. When LineMode is True, EOL will be True if the DataIn event fired because an EOL was received and will be False if the DataIn event fired because MaxLineLength was reached.

Disconnected Event (WSServer Module)

This event is fired when a WebSocket connection is disconnected.

Syntax

func onDisconnected(connectionId: Int32, statusCode: Int32, description: String)

- (void)onDisconnected:(int)connectionId :(int)statusCode :(NSString*)description;

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 Module)

This event is fired for information about errors during data delivery.

Syntax

func onError(connectionId: Int32, errorCode: Int32, description: String)

- (void)onError:(int)connectionId :(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

ConnectionId contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (WSServer Module)

This event fires once for each log message.

Syntax

func onLog(connectionId: Int32, logLevel: Int32, message: String, logType: String)

- (void)onLog:(int)connectionId :(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

The value 1 (Info) logs basic information including the URL, HTTP version, and connection status details.

The value 2 (Verbose) logs additional information about the initial HTTP request.

The value 3 (Debug) logs additional debug information (if available).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

  • "Info"
  • "Error"
  • "Verbose"
  • "Debug"
ConnectionId specifies the Id of the connection to which the log applies.

Ping Event (WSServer Module)

This event is fired when a ping request or response is received.

Syntax

func onPing(connectionId: Int32, payload: Data, response: Bool)

- (void)onPing:(int)connectionId :(NSData*)payload :(BOOL)response;

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 class receives a ping request, it will automatically reply with a pong.

Payload holds the payload of the request, if any.

Response is if the incoming packet is a ping response. If the incoming packet is a ping request this is .

ReadyToSend Event (WSServer Module)

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

Syntax

func onReadyToSend(connectionId: Int32)

- (void)onReadyToSend:(int)connectionId;

Remarks

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

SSLClientAuthentication Event (WSServer Module)

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

Syntax

func onSSLClientAuthentication(connectionId: Int32, certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLClientAuthentication:(int)connectionId :(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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 Module)

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

Syntax

func onSSLConnectionRequest(connectionId: Int32, supportedCipherSuites: String, supportedSignatureAlgs: String, certStoreType: inout Int32, certStore: inout String, certPassword: inout String, certSubject: inout String)

- (void)onSSLConnectionRequest:(int)connectionId :(NSString*)supportedCipherSuites :(NSString*)supportedSignatureAlgs :(int*)certStoreType :(NSString**)certStore :(NSString**)certPassword :(NSString**)certSubject;

Remarks

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

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

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

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

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

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: This store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the and set to the PIN.

Code Example. SSH Authentication with Security Key: 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);

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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

SSLStatus Event (WSServer Module)

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

Syntax

func onSSLStatus(connectionId: Int32, message: String)

- (void)onSSLStatus:(int)connectionId :(NSString*)message;

Remarks

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

WebSocketOpenRequest Event (WSServer Module)

This event is fired when a client attempts to open a WebSocket.

Syntax

func onWebSocketOpenRequest(connectionId: Int32, requestURI: String, hostHeader: String, originHeader: String, subProtocols: inout String, extensions: String, requestHeaders: String, statusCode: inout Int32, responseHeaders: inout String)

- (void)onWebSocketOpenRequest:(int)connectionId :(NSString*)requestURI :(NSString*)hostHeader :(NSString*)originHeader :(NSString**)subProtocols :(NSString*)extensions :(NSString*)requestHeaders :(int*)statusCode :(NSString**)responseHeaders;

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 class will accept the connection. You do not need to set anything to accept the connection. The class 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 class 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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

The following fields are available:
  • EffectiveDate
  • ExpirationDate
  • ExtendedKeyUsage
  • Fingerprint
  • FingerprintSHA1
  • FingerprintSHA256
  • Issuer
  • PrivateKey
  • PrivateKeyAvailable
  • PrivateKeyContainer
  • PublicKey
  • PublicKeyAlgorithm
  • PublicKeyLength
  • SerialNumber
  • SignatureAlgorithm
  • Store
  • StorePassword
  • StoreType
  • SubjectAltNames
  • ThumbprintMD5
  • ThumbprintSHA1
  • ThumbprintSHA256
  • Usage
  • UsageFlags
  • Version
  • Subject
  • Encoded

    • Fields

    effectiveDate
    String (read-only)
    Default Value: ""

    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.

    expirationDate
    String (read-only)
    Default Value: ""

    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.

    extendedKeyUsage
    String (read-only)
    Default Value: ""

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

    fingerprint
    String (read-only)
    Default Value: ""

    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

    fingerprintSHA1
    String (read-only)
    Default Value: ""

    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

    fingerprintSHA256
    String (read-only)
    Default Value: ""

    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

    issuer
    String (read-only)
    Default Value: ""

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

    privateKey
    String (read-only)
    Default Value: ""

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

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

    privateKeyAvailable
    Bool (read-only)
    Default Value: False

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

    privateKeyContainer
    String (read-only)
    Default Value: ""

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

    publicKey
    String (read-only)
    Default Value: ""

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

    publicKeyAlgorithm
    String (read-only)
    Default Value: ""

    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.

    publicKeyLength
    Int32 (read-only)
    Default Value: 0

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

    serialNumber
    String (read-only)
    Default Value: ""

    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.

    signatureAlgorithm
    String (read-only)
    Default Value: ""

    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.

    storeB
    Data
    Default Value: "MY"

    The name of the certificate store for the client certificate.

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

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

    Designations of certificate stores are platform dependent.

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

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot 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).

    store
    String
    Default Value: "MY"

    The name of the certificate store for the client certificate.

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

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

    Designations of certificate stores are platform dependent.

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

    MYA certificate store holding personal certificates with their associated private keys.
    CACertifying authority certificates.
    ROOTRoot 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).

    storePassword
    String
    Default Value: ""

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

    storeType
    CertStoreTypes
    Default Value: 0

    The type of certificate store for this certificate.

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

    0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

    Note: This store type is not available in Java.

    1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

    Note: This store type is not available in Java.

    2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
    3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
    4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

    Note: This store type is only available in Java.

    5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

    Note: This store type is only available in Java.

    6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
    7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
    8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
    9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
    10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
    11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
    12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
    13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
    14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
    15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
    16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
    17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
    18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
    19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
    21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

    Note: This store type is only available in Java and .NET.

    22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

    Note: This store type is only available in Java and .NET.

    23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

    To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

    When using a certificate, pass the previously saved security key information as the and set to the PIN.

    Code Example. SSH Authentication with Security Key: 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);

    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.

    subjectAltNames
    String (read-only)
    Default Value: ""

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

    thumbprintMD5
    String (read-only)
    Default Value: ""

    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.

    thumbprintSHA1
    String (read-only)
    Default Value: ""

    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.

    thumbprintSHA256
    String (read-only)
    Default Value: ""

    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.

    usage
    String (read-only)
    Default Value: ""

    The text description of .

    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.

    usageFlags
    Int32 (read-only)
    Default Value: 0

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

    0x80Digital Signature
    0x40Non-Repudiation
    0x20Key Encipherment
    0x10Data Encipherment
    0x08Key Agreement
    0x04Certificate Signing
    0x02CRL Signing
    0x01Encipher Only

    Please see the property for a text representation of .

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

    version
    String (read-only)
    Default Value: ""

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

    subject
    String
    Default Value: ""

    The subject of the certificate used for client authentication.

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

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

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

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

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

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

    FieldMeaning
    CNCommon Name. This is commonly a hostname like www.server.com.
    OOrganization
    OUOrganizational Unit
    LLocality
    SState
    CCountry
    EEmail Address

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

    encodedB
    Data
    Default Value: ""

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

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

    encoded
    String
    Default Value: ""

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

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

    Constructors

    public init()

    Creates a instance whose properties can be set. This is useful for use with when generating new certificates. 

    public init(encoded: )

    Parses Encoded as an X.509 public key. 

    public init(storeType: , store: , storePassword: , subject: )

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. 

    public init(storeType: , store: , storePassword: , subject: )

    StoreType identifies the type of certificate store to use. See for descriptions of the different certificate stores. Store is a byte array containing the certificate data. StorePassword is the password used to protect the store.

    After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The Subject parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

    WSConnection Type

    This type describes a currently connected client.

    Remarks

    This type describes the connection of a client that is currently connected to the class. You may use the different fields of this type to manage the connection.

    The following fields are available:
  • AcceptData
  • BytesSent
  • Connected
  • ConnectionId
  • DataFormat
  • Host
  • LineMode
  • LocalAddress
  • Origin
  • ReadyToSend
  • RemoteHost
  • RemotePort
  • RequestHeaders
  • RequestURI
  • SubProtocols
  • Timeout

    • Fields

    acceptData
    Bool (read-only)
    Default Value: True

    This property indicates whether data reception is currently enabled. When , data reception is disabled and the DataIn event will not fire for the connection. Use the PauseData and ProcessData methods to pause and resume data reception.

    bytesSent
    Int32 (read-only)
    Default Value: 0

    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 class is operating in the synchronous mode (i.e., the property is set to a positive value).

    connected
    Bool (read-only)
    Default Value: False

    This property indicates the status of individual connections.

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

    connectionId
    Int32 (read-only)
    Default Value: 0

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

    dataFormat
    DataFormats
    Default Value: 0

    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 class will attempt to automatically determine the correct data format. This is suitable for most cases.
    1 (dfText) The class will UTF-8 encode the specified data before sending. Data that already have been UTF-8 encoded also may be supplied.
    2 (dfBinary) The class will send the data exactly as they are provided.
    9 (dfPing) The class will send the ping with data exactly as they are provided.
    10 (dfPong) The class will send the pong with data exactly as they are provided.

    host
    String (read-only)
    Default Value: ""

    This property includes the Host header value of the connected client.

    lineMode
    Bool (read-only)
    Default Value: False

    When ConnectionsLineMode is False (default), the component will fire the DataIn event once for each message received from the server. When LineMode is True, the component will instead fire DataIn for each line of data received. The maximum length of a line can be controlled by the MaxLineLength configuration setting.

    Note: This property is read-only and should be set through the ChangeLineMode method.

    localAddress
    String (read-only)
    Default Value: ""

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

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

    origin
    String (read-only)
    Default Value: ""

    This property includes the origin header value of the connected client.

    readyToSend
    Bool (read-only)
    Default Value: False

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

    This is after a client connects but will become after a failed call to Send or SendBytes. After a failed call to Send or SendBytes, the ReadyToSend event will fire and this property will be when data can be sent again.

    remoteHost
    String (read-only)
    Default Value: ""

    This property shows the IP address of the connected client.

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

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

    remotePort
    Int32 (read-only)
    Default Value: 0

    This property shows the port of the connected client.

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

    requestHeaders
    String (read-only)
    Default Value: ""

    The HTTP headers sent by the client in the initial WebSocket connection request.

    requestURI
    String (read-only)
    Default Value: ""

    This property includes the requested URI sent by the client in the initial WebSocket connection request.

    subProtocols
    String (read-only)
    Default Value: ""

    This property includes the subprotocols (application-level protocols layered over the WebSocket Protocol) sent by the client in the initial WebSocket connection request.

    timeout
    Int32
    Default Value: 0

    This property specifies a timeout for the class.

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

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

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

    If Timeout expires, and the operation is not yet complete, the class .

    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 property is 0 (asynchronous operation).

    Constructors

    public init()

    Config Settings (WSServer Module)

    The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

    WebSocketServer Config Settings

    BufferMessage:   Indicates whether or not the entire message is buffered before firing the DataIn event.

    When receiving large messages the DataIn, this event may fire multiple times to provide data as it is received in each message fragment. When BufferMessage is set to True, the class will internally buffer the message as it is received until it is complete before firing the DataIn event. The default value is False.

    DisconnectStatusCode:   Specifies the status code when closing a connection.

    When the Disconnect method is called, the class 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. For any of the standard codes listed in DisconnectStatusCode, the class 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 class will enable the permessage-deflate extension.

    When , the class will allow the permessage-deflate extension to be enabled, if the WebSocket client requests the permessage-deflate extension. When this setting is set to , the class will keep the permessage-deflate extension disabled, regardless of what the WebSocket client requests.

    The default value is .

    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 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 event to determine when the message is complete.

    Note: When Timeout is set to 0 messages that are fragmented are always sent as individual smaller messages and EOM will always be True in the DataIn event on the receiving side.

    MaxLineLength[ConnectionId]:   Determines the maximum line length for a connection when LineMode is True.

    When ConnectionsLineMode is True, setting this will cause the component to fire the DataIn event when the length of the received data reaches the value of this setting. When the DataIn 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 is set to 0 the class operates asynchronously and, by default, all data sent when Send is called is considered a complete message. Each packet leaving the class has the End-of-Message flag set.

    To send messages that may be fragmented, set MessageLength to the length of the message (in bytes) that is being sent. When set, the class will consider the next MessageLength bytes sent as part of a single message and only the last packet will set the End-of-Message flag.

    This setting is helpful when data are organized into messages and the receiving side expected the End-of-Message flag to signal the end of a message.

    Note: This configuration setting is applicable only when DefaultTimeout is set to 0. When DefaultTimeout is set to a positive value, the message data may be passed in its entirety to Send and will be automatically handled as needed by the class.

    WaitForCloseResponse:   Determines whether or not the class will forcibly close a connection.

    When this configuration setting is set to True (default), the class will wait for a response from the client when closing the connection. When this configuration setting is set to False, the class 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 class.

    This configuration setting defines a comma-separated list of host names or IPv4 addresses that may access the class. 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 event fires with an Accept value set to . If no action is taken within the ConnectionRequest event, the client will be disconnected.

    BindExclusively:   Whether or not the component considers a local port reserved for exclusive use.

    If this is (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 class.

    This configuration setting defines a comma-separated list of host names or IPv4 addresses that cannot access the class.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 event fires with an Accept value set to . If no action is taken within the ConnectionRequest 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 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 class is activated, the InBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.

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

    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. 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 property must be set before Listening is set to , and once set, it can no longer be changed for the current instance of the class. 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 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 class is activated the OutBufferSize reverts to its defined size. The same thing will happen if you attempt to make it too large or too small.

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

    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 class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. When set to 2, the class 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 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 event, which will fire each time an SSL packet is sent or received.

    Enabling this configuration setting has no effect if SSLProvider is set to Platform.

    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 class will reuse the context if and only if the following criteria are met:

    • The target host name is the same.
    • The system cache entry has not expired (default timeout is 10 hours).
    • The application process that calls the function is the same.
    • The logon session is the same.
    • The instance of the class is the same.

    SSLCACerts:   A newline separated list of CA certificates to be included when performing an SSL handshake.

    When SSLProvider 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: 

    -----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 class will check the Certificate Revocation List (CRL) specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class 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 class .

    When set to 0 (default), the CRL check will not be performed by the class. 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 class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class 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 class .

    When set to 0 (default), the class 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 event.

    Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

    When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList configuration setting.

    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 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 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: 

    -----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 class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

    Multiple cipher suites are separated by semicolons.

    Example values when SSLProvider is set to Platform include the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include the following:

    • CALG_3DES
    • CALG_3DES_112
    • CALG_AES
    • CALG_AES_128
    • CALG_AES_192
    • CALG_AES_256
    • CALG_AGREEDKEY_ANY
    • CALG_CYLINK_MEK
    • CALG_DES
    • CALG_DESX
    • CALG_DH_EPHEM
    • CALG_DH_SF
    • CALG_DSS_SIGN
    • CALG_ECDH
    • CALG_ECDH_EPHEM
    • CALG_ECDSA
    • CALG_ECMQV
    • CALG_HASH_REPLACE_OWF
    • CALG_HUGHES_MD5
    • CALG_HMAC
    • CALG_KEA_KEYX
    • CALG_MAC
    • CALG_MD2
    • CALG_MD4
    • CALG_MD5
    • CALG_NO_SIGN
    • CALG_OID_INFO_CNG_ONLY
    • CALG_OID_INFO_PARAMETERS
    • CALG_PCT1_MASTER
    • CALG_RC2
    • CALG_RC4
    • CALG_RC5
    • CALG_RSA_KEYX
    • CALG_RSA_SIGN
    • CALG_SCHANNEL_ENC_KEY
    • CALG_SCHANNEL_MAC_KEY
    • CALG_SCHANNEL_MASTER_HASH
    • CALG_SEAL
    • CALG_SHA
    • CALG_SHA1
    • CALG_SHA_256
    • CALG_SHA_384
    • CALG_SHA_512
    • CALG_SKIPJACK
    • CALG_SSL2_MASTER
    • CALG_SSL3_MASTER
    • CALG_SSL3_SHAMD5
    • CALG_TEK
    • CALG_TLS1_MASTER
    • CALG_TLS1PRF
    Example values when SSLProvider is set to Internalinclude the following: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include the following:
    • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
    • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
    • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
    • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
    • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
    • TLS_RSA_WITH_AES_256_GCM_SHA384
    • TLS_RSA_WITH_AES_128_GCM_SHA256
    • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
    • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
    • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
    • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
    • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
    • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
    • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
    • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
    • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
    • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
    • TLS_RSA_WITH_AES_256_CBC_SHA256
    • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
    • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
    • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
    • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
    • TLS_RSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
    • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
    • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
    • TLS_RSA_WITH_AES_256_CBC_SHA
    • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
    • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
    • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
    • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
    • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
    • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
    • TLS_RSA_WITH_AES_128_CBC_SHA
    • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
    • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
    • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
    • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
    • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
    • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
    • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
    • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
    • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
    • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
    • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
    • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
    • TLS_RSA_WITH_3DES_EDE_CBC_SHA
    • TLS_RSA_WITH_DES_CBC_SHA
    • TLS_DHE_RSA_WITH_DES_CBC_SHA
    • TLS_DHE_DSS_WITH_DES_CBC_SHA
    • TLS_RSA_WITH_RC4_128_MD5
    • TLS_RSA_WITH_RC4_128_SHA

    When TLS 1.3 is negotiated (see SSLEnabledProtocols), only the following cipher suites are supported:

    • TLS_AES_256_GCM_SHA384
    • TLS_CHACHA20_POLY1305_SHA256
    • TLS_AES_128_GCM_SHA256

    SSLEnabledCipherSuites is used together with SSLCipherStrength.

    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.312288 (Hex 3000)
    TLS1.23072 (Hex C00) (Default - Client and Server)
    TLS1.1768 (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 class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

    In editions that are designed to run on Windows, SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is supported only on Windows 11/Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

    If set to 1 (Platform provider), please be aware of the following notes:

    • The platform provider is available only on Windows 11/Windows Server 2022 and up.
    • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
    • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

    SSLEnabledProtocols: SSL2 and SSL3 Notes:

    SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

    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 by default, but it can be set to to enable the extension.

    This configuration setting is applicable only when SSLProvider 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 class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

    Note: This configuration setting is applicable only when SSLProvider 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: 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: 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: 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: 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: 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: 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:

    0x00000001Ignore time validity status of certificate.
    0x00000002Ignore time validity status of CTL.
    0x00000004Ignore non-nested certificate times.
    0x00000010Allow unknown certificate authority.
    0x00000020Ignore wrong certificate usage.
    0x00000100Ignore unknown certificate revocation status.
    0x00000200Ignore unknown CTL signer revocation status.
    0x00000400Ignore unknown certificate authority revocation status.
    0x00000800Ignore unknown root revocation status.
    0x00008000Allow test root certificate.
    0x00004000Trust test root certificate.
    0x80000000Ignore 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 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: 

    -----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 is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

    When specified the class 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 class .

    The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

    To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

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

    The values are ordered from most preferred to least preferred. The following values are supported:

    • "ecdhe_x25519" (default)
    • "ecdhe_x448" (default)
    • "ecdhe_secp256r1" (default)
    • "ecdhe_secp384r1" (default)
    • "ecdhe_secp521r1" (default)
    • "ffdhe_2048" (default)
    • "ffdhe_3072" (default)
    • "ffdhe_4096" (default)
    • "ffdhe_6144" (default)
    • "ffdhe_8192" (default)

    Base Config Settings

    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:

    IdentifierName
    037IBM EBCDIC - U.S./Canada
    437OEM - United States
    500IBM EBCDIC - International
    708Arabic - ASMO 708
    709Arabic - ASMO 449+, BCON V4
    710Arabic - Transparent Arabic
    720Arabic - Transparent ASMO
    737OEM - Greek (formerly 437G)
    775OEM - Baltic
    850OEM - Multilingual Latin I
    852OEM - Latin II
    855OEM - Cyrillic (primarily Russian)
    857OEM - Turkish
    858OEM - Multilingual Latin I + Euro symbol
    860OEM - Portuguese
    861OEM - Icelandic
    862OEM - Hebrew
    863OEM - Canadian-French
    864OEM - Arabic
    865OEM - Nordic
    866OEM - Russian
    869OEM - Modern Greek
    870IBM EBCDIC - Multilingual/ROECE (Latin-2)
    874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
    875IBM EBCDIC - Modern Greek
    932ANSI/OEM - Japanese, Shift-JIS
    936ANSI/OEM - Simplified Chinese (PRC, Singapore)
    949ANSI/OEM - Korean (Unified Hangul Code)
    950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
    1026IBM EBCDIC - Turkish (Latin-5)
    1047IBM EBCDIC - Latin 1/Open System
    1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
    1141IBM EBCDIC - Germany (20273 + Euro symbol)
    1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
    1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
    1144IBM EBCDIC - Italy (20280 + Euro symbol)
    1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
    1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
    1147IBM EBCDIC - France (20297 + Euro symbol)
    1148IBM EBCDIC - International (500 + Euro symbol)
    1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
    1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
    1201Unicode UCS-2 Big-Endian
    1250ANSI - Central European
    1251ANSI - Cyrillic
    1252ANSI - Latin I
    1253ANSI - Greek
    1254ANSI - Turkish
    1255ANSI - Hebrew
    1256ANSI - Arabic
    1257ANSI - Baltic
    1258ANSI/OEM - Vietnamese
    1361Korean (Johab)
    10000MAC - Roman
    10001MAC - Japanese
    10002MAC - Traditional Chinese (Big5)
    10003MAC - Korean
    10004MAC - Arabic
    10005MAC - Hebrew
    10006MAC - Greek I
    10007MAC - Cyrillic
    10008MAC - Simplified Chinese (GB 2312)
    10010MAC - Romania
    10017MAC - Ukraine
    10021MAC - Thai
    10029MAC - Latin II
    10079MAC - Icelandic
    10081MAC - Turkish
    10082MAC - Croatia
    12000Unicode UCS-4 Little-Endian
    12001Unicode UCS-4 Big-Endian
    20000CNS - Taiwan
    20001TCA - Taiwan
    20002Eten - Taiwan
    20003IBM5550 - Taiwan
    20004TeleText - Taiwan
    20005Wang - Taiwan
    20105IA5 IRV International Alphabet No. 5 (7-bit)
    20106IA5 German (7-bit)
    20107IA5 Swedish (7-bit)
    20108IA5 Norwegian (7-bit)
    20127US-ASCII (7-bit)
    20261T.61
    20269ISO 6937 Non-Spacing Accent
    20273IBM EBCDIC - Germany
    20277IBM EBCDIC - Denmark/Norway
    20278IBM EBCDIC - Finland/Sweden
    20280IBM EBCDIC - Italy
    20284IBM EBCDIC - Latin America/Spain
    20285IBM EBCDIC - United Kingdom
    20290IBM EBCDIC - Japanese Katakana Extended
    20297IBM EBCDIC - France
    20420IBM EBCDIC - Arabic
    20423IBM EBCDIC - Greek
    20424IBM EBCDIC - Hebrew
    20833IBM EBCDIC - Korean Extended
    20838IBM EBCDIC - Thai
    20866Russian - KOI8-R
    20871IBM EBCDIC - Icelandic
    20880IBM EBCDIC - Cyrillic (Russian)
    20905IBM EBCDIC - Turkish
    20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
    20932JIS X 0208-1990 & 0121-1990
    20936Simplified Chinese (GB2312)
    21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
    21027Extended Alpha Lowercase
    21866Ukrainian (KOI8-U)
    28591ISO 8859-1 Latin I
    28592ISO 8859-2 Central Europe
    28593ISO 8859-3 Latin 3
    28594ISO 8859-4 Baltic
    28595ISO 8859-5 Cyrillic
    28596ISO 8859-6 Arabic
    28597ISO 8859-7 Greek
    28598ISO 8859-8 Hebrew
    28599ISO 8859-9 Latin 5
    28605ISO 8859-15 Latin 9
    29001Europa 3
    38598ISO 8859-8 Hebrew
    50220ISO 2022 Japanese with no halfwidth Katakana
    50221ISO 2022 Japanese with halfwidth Katakana
    50222ISO 2022 Japanese JIS X 0201-1989
    50225ISO 2022 Korean
    50227ISO 2022 Simplified Chinese
    50229ISO 2022 Traditional Chinese
    50930Japanese (Katakana) Extended
    50931US/Canada and Japanese
    50933Korean Extended and Korean
    50935Simplified Chinese Extended and Simplified Chinese
    50936Simplified Chinese
    50937US/Canada and Traditional Chinese
    50939Japanese (Latin) Extended and Japanese
    51932EUC - Japanese
    51936EUC - Simplified Chinese
    51949EUC - Korean
    51950EUC - Traditional Chinese
    52936HZ-GB2312 Simplified Chinese
    54936Windows XP: GB18030 Simplified Chinese (4 Byte)
    57002ISCII Devanagari
    57003ISCII Bengali
    57004ISCII Tamil
    57005ISCII Telugu
    57006ISCII Assamese
    57007ISCII Oriya
    57008ISCII Kannada
    57009ISCII Malayalam
    57010ISCII Gujarati
    57011ISCII Punjabi
    65000Unicode UTF-7
    65001Unicode UTF-8
    The following is a list of valid code page identifiers for Mac OS only:
    IdentifierName
    1ASCII
    2NEXTSTEP
    3JapaneseEUC
    4UTF8
    5ISOLatin1
    6Symbol
    7NonLossyASCII
    8ShiftJIS
    9ISOLatin2
    10Unicode
    11WindowsCP1251
    12WindowsCP1252
    13WindowsCP1253
    14WindowsCP1254
    15WindowsCP1250
    21ISO2022JP
    30MacOSRoman
    10UTF16String
    0x90000100UTF16BigEndian
    0x94000100UTF16LittleEndian
    0x8c000100UTF32String
    0x98000100UTF32BigEndian
    0x9c000100UTF32LittleEndian
    65536Proprietary

    LicenseInfo:   Information about the current license.

    When queried, this setting will return a string containing information about the license this instance of a class 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 to mask sensitive data. The default is .

    This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

    UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

    When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

    Setting this configuration setting to tells the class to use the internal implementation instead of using the system security libraries.

    This setting is set to by default on all platforms.

    Trappable Errors (WSServer Module)

    WSServer Errors

    4202   Error sending data to the connected client.

    TCPServer 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   TCPServer is already listening.
    106   Cannot change LocalPort when TCPServer is listening.
    107   Cannot change LocalHost when TCPServer is listening.
    108   Cannot change MaxConnections when TCPServer is listening.
    112   You cannot change MaxLineLength at this time. A connection is in progress.
    116   RemotePort cannot be zero. Please specify a valid service port number.
    126   Invalid ConnectionId.
    135   Operation would block.

    SSL Errors

    270   Cannot load specified security library.
    271   Cannot open certificate store.
    272   Cannot find specified certificate.
    273   Cannot acquire security credentials.
    274   Cannot find certificate chain.
    275   Cannot verify certificate chain.
    276   Error during handshake.
    280   Error verifying certificate.
    281   Could not find client certificate.
    282   Could not find server certificate.
    283   Error encrypting data.
    284   Error decrypting data.

    TCP/IP Errors

    10004   [10004] Interrupted system call.
    10009   [10009] Bad file number.
    10013   [10013] Access denied.
    10014   [10014] Bad address.
    10022   [10022] Invalid argument.
    10024   [10024] Too many open files.
    10035   [10035] Operation would block.
    10036   [10036] Operation now in progress.
    10037   [10037] Operation already in progress.
    10038   [10038] Socket operation on 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).