SSHDaemon Class

Properties   Methods   Events   Configuration Settings   Errors  

The SSHDaemon class is used to create Secure Shell (SSH) servers. The class handles multiple simultaneous connections on the same TCP/IP port (service port). It is designed to balance the load between connections for a fast, powerful server.

Syntax

ipworksssh.sshdaemon()

Remarks

The SSHDaemon class is the SSH-enabled equivalent of the IPWorks IPDaemon class, extended by a set of new properties and events that deal with SSH security. The SSHCompressionAlgorithms and SSHEncryptionAlgorithms properties determine which protocols are enabled for the SSH handshake. The SSHCert* properties are used to select a certificate for the server (please note that a valid certificate MUST be selected before the server can function). The SSHUserAuthRequest event will allow you to use authenticate clients using digital certificates or passwords. Finally, the SSHStatus event provides information about the SSH handshake and underlying protocol notifications.

By default, each instance of SSHDaemon can handle up to 1000 simultaneous incoming connections (this number may be increased up to 100,000, or decreased to a lower value by using the MaxConnections configuration setting).

SSH connections are identified by a ConnectionId. Events relating to these connections as a whole will use the ConnectionId to identify the specific connection. Connections may also contained one or more multiplexed channels, which are identified by a ChannelId. Channel-level events will specify the ChannelId to which they relate.

SSHDaemon can start to listen on a port by setting the Listening property to True. When a remote host asks for a connection, the ConnectionRequest event is fired. At that point, the connection can either be accepted or rejected. If the connection is accepted, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to SSHClient. Data can be sent to an individual SSHChannel using SendChannelData. The address and port of the incoming connection can be found by querying the ConnectionsRemoteHost and ConnectionsRemotePort properties.

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

Property List

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

Method List

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

Event List

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

Configuration Settings

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

SSHDaemon.Channels Property

A collection of currently open channels.

Syntax

 getChannels(): SSHChannelMap;

Default Value

Remarks

The SSH 2.0 specification allows for multiple channels to be opened over a single TCP/IP connection. The Channels property represents the channels that are currently open. A new SSHChannel can be opened with OpenChannel.

This collection is a hashtable where the channel's Id string is used as the key to the desired SSH channel object.

Example (Sending Data to a Channel)

This property is read-only.

SSHDaemon.ConnectionBacklog Property

The maximum number of pending connections maintained by the TCP/IP subsystem.

Syntax

 getConnectionBacklog(): number;


 setConnectionBacklog(connectionBacklog: number): void;

Default Value

5

Remarks

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

This property is not available at design time.

SSHDaemon.Connections Property

A collection of currently connected SSH clients.

Syntax

 getConnections(): SSHConnectionMap;

Default Value

Remarks

This property is 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 SSHConnection type.

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

This property is read-only.

SSHDaemon.DefaultAuthMethods Property

Specifies the supported authentication methods.

Syntax

 getDefaultAuthMethods(): string;


 setDefaultAuthMethods(defaultAuthMethods: string): void;

Default Value

"password,publickey"

Remarks

This property specifies the supported authentication methods. The client will choose one of the supported mechanisms when authenticating to the class.

This must be a comma separated list of values. For more information on authenticating clients see the SSHUserAuthRequest event.

The following is a list of methods implemented by the class:

SSHDaemon.DefaultTimeout Property

An initial timeout value to be used by incoming connections.

Syntax

 getDefaultTimeout(): number;


 setDefaultTimeout(defaultTimeout: number): void;

Default Value

60

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established. If the timeout is set to 0, all inbound connections will behave asynchronously. The default value is 60, meaning the class will behave synchronously.

SSHDaemon.KeyboardInteractiveMessage Property

The instructions to send to the client during keyboard-interactive authentication.

Syntax

 getKeyboardInteractiveMessage(): string;


 setKeyboardInteractiveMessage(keyboardInteractiveMessage: string): void;

Default Value

""

Remarks

This property should be set to the main instructions to send to the client during keyboard-interactive authentication.

SSHDaemon.KeyboardInteractivePrompts Property

A collection of prompts to present to the user for keyboard-interactive authentication.

Syntax

 getKeyboardInteractivePrompts(): SSHPromptList;


 setKeyboardInteractivePrompts(keyboardInteractivePrompts: SSHPromptList): void;

Default Value

Remarks

This property is a collection of prompts to present to the user during keyboard-authentication. It is used together with the KeyboardInteractiveMessage property.

SSHDaemon.Listening Property

If True, the class accepts incoming connections on LocalPort.

Syntax

 isListening(): boolean;

 getLocalHost(): string;


 setLocalHost(localHost: string): void;

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

SSHDaemon.LocalPort Property

The TCP port in the local host where the class listens.

Syntax

 getLocalPort(): number;


 setLocalPort(localPort: number): void;

Default Value

22

Remarks

The LocalPort property must be set before IPDaemon starts 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 the LocalPort property after IPDaemon is in listening mode (after successfully assigning True to the Listening property).

The service port is not shared among servers (i.e. there can be only one IPDaemon 'listening' on a particular port at one time).

SSHDaemon.SSHCert Property

A certificate to be used during SSH negotiation.

Syntax

 getSSHCert(): Certificate;


 setSSHCert(SSHCert: Certificate): void;

Default Value

Remarks

The digital certificate that the server will use during SSH negotiation. A certificate with a private key is required for session authentication and encryption.

This is the server's certificate, and must be set prior to setting Listening to True.

SSHDaemon.SSHCompressionAlgorithms Property

A comma-separated list containing all allowable compression algorithms.

Syntax

 getSSHCompressionAlgorithms(): string;


 setSSHCompressionAlgorithms(SSHCompressionAlgorithms: string): void;

Default Value

"none,zlib"

Remarks

During the SSH handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:

• zlib
• zlib@openssh.com
• none

SSHDaemon.SSHEncryptionAlgorithms Property

A comma-separated list containing all allowable encryption algorithms.

Syntax

 getSSHEncryptionAlgorithms(): string;


 setSSHEncryptionAlgorithms(SSHEncryptionAlgorithms: string): void;

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,aes256-cbc,aes192-cbc,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,arcfour256,arcfour128,arcfour,cast128-cbc,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

During the SSH handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, the class will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:

SSHDaemon.changeRecordLength Method

Changes the length of received data records.

Syntax

async sshdaemon.changeRecordLength(channelId : string, recordLength : number): Promise<void>

Remarks

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

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

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

SSHDaemon.closeChannel Method

Closes a existing SSHChannel .

Syntax

async sshdaemon.closeChannel(channelId : string): Promise<void>

Remarks

ChannelId is the identifier for the SSH channel to be closed.

SSHDaemon.config Method

Sets or retrieves a configuration setting.

Syntax

async sshdaemon.config(configurationString : string): Promise<string>

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.

SSHDaemon.disconnect Method

Disconnect the specified client.

Syntax

async sshdaemon.disconnect(connectionId : string): Promise<void>

Remarks

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

SSHDaemon.doEvents Method

Processes events from the internal message queue.

Syntax

async sshdaemon.doEvents(): Promise<void>

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.

SSHDaemon.exchangeKeys Method

Causes the class to exchange a new set of session keys on the specified connection.

Syntax

async sshdaemon.exchangeKeys(connectionId : string): Promise<void>

Remarks

SSH key renegotiation can be initiated by either end of an established SSH connection. ExchangeKeys allows the server to start such a renegotiation with the client. During this process, SSHStatus events will fire containing updates regarding the key negotiation process.

The SSH 2.0 specification recommends that key renegotiation be done once for 2 gigabytes (GB) of data processed by the connection, or once every day. This makes it more difficult to break the security of data-intensive or long-lived connections.

SSHDaemon.getSSHParam Method

Used to read a field from an SSH packet's payload.

Syntax

sshdaemon.getSSHParam(payload : Uint8Array, field : string): string

Remarks

This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as SSHChannelRequest. Field is the name of a field to be read out of the packet.

The following is a list of the names of well-known channel request field names and their encodings:

The remaining fields that are available in the payload are dependent upon the value of RequestType.

pty-req

Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:

x11-req

X11-req is a request to forward x11 sessions over a channel. The following fields are available:

env

Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:

exec

Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:

subsystem

Subsystem is a request to start a subsystem on the specified channel. The following field is available:

xon-xoff

Instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:

signal

Sends a signal to the remote process/service. The following field is available:

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".

Note: the return value is a string encoded the same way as the FieldValue param in SetSSHParam.

SSHDaemon.getSSHParamBytes Method

Used to read a field from an SSH packet's payload.

Syntax

async sshdaemon.getSSHParamBytes(payload : Uint8Array, field : string): Promise<Uint8Array>

Remarks

This method is the same as calling GetSSHParam, but returns raw bytes instead of strings.

SSHDaemon.openChannel Method

Opens a new SSHChannel .

Syntax

async sshdaemon.openChannel(connectionId : string, channelType : string): Promise<string>

Remarks

The SSH 2.0 specification allows for multiple channels to be opened over a single TCP/IP connection. The Channels property represents the channels that are currently open. A new SSHChannel can be opened with OpenChannel.

ChannelType represents the type of SSH channel to be opened. The most common type of channel is "session".

If the call to OpenChannel succeeds, an SSHChannel will be created and added to the Channels collection.

SSHDaemon.reset Method

Reset the class.

Syntax

async sshdaemon.reset(): Promise<void>

Remarks

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

SSHDaemon.sendBytes Method

Sends binary data to the specified channel.

Syntax

async sshdaemon.sendBytes(channelId : string, data : Uint8Array): Promise<void>

Remarks

This method sends binary data to the channel identified by ChannelId. To send text use the SendText method instead.

SSHDaemon.sendChannelData Method

Used to send data over an SSH channel.

Syntax

async sshdaemon.sendChannelData(channelId : string, data : Uint8Array): Promise<void>

Remarks

This method can be used to send arbitrary data to the channel with the specified ChannelId.

SSHDaemon.sendSSHPacket Method

Used to send an encoded SSH packet to the server.

Syntax

async sshdaemon.sendSSHPacket(channelId : string, packetType : number, payload : Uint8Array): Promise<void>

Remarks

This method can be used to send a previously built SSH payload to the server. ChannelId identifies the channel that will receive the packet.

PacketType identifies what kind of packet is to be sent. Payload should contain the payload of the packet, which can be built by successive calls to SetSSHParam.

When SendSSHPacket is called, the class will finish building the packet, encrypt it for transport, and send it to the server.

SSHDaemon.sendText Method

Sends text to the specified channel.

Syntax

async sshdaemon.sendText(channelId : string, text : string): Promise<void>

Remarks

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

SSHDaemon.setSSHParam Method

Used to write a field to the end of a payload.

Syntax

sshdaemon.setSSHParam(payload : Uint8Array, fieldType : string, fieldValue : string): Uint8Array

Remarks

This method is used to build the payload portion of an SSH packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

The following is a list of supported field types and a description of how FieldValue should be encoded:

Note: integer values may be encoded in hexadecimal by prefixing "0x" to the beginning of the string, otherwise the value is assumed to be base-10.

SSHDaemon.shutdown Method

Shuts down the server.

Syntax

async sshdaemon.shutdown(): Promise<void>

Remarks

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

SSHDaemon.startListening Method

Starts listening for incoming connections.

Syntax

async sshdaemon.startListening(): Promise<void>

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 is transferred.

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

SSHDaemon.stopListening Method

Stops listening for new connections.

Syntax

async sshdaemon.stopListening(): Promise<void>

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 disconnect all existing clients call Shutdown instead.

SSHDaemon.Connected Event

Fired immediately after a connection completes (or fails).

Syntax

sshdaemon.on('Connected', listener: (e: {readonly connectionId: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

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

Please refer to the Error Codes section for more information.

SSHDaemon.ConnectionRequest Event

Fired when a request for connection comes from a remote host.

Syntax

sshdaemon.on('ConnectionRequest', listener: (e: {readonly address: string, readonly port: number, accept: boolean}) => void )

Remarks

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

SSHDaemon.Disconnected Event

Fired when a connection is closed.

Syntax

sshdaemon.on('Disconnected', listener: (e: {readonly connectionId: string, readonly statusCode: number, readonly description: string}) => void )

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

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

Please refer to the Error Codes section for more information.

SSHDaemon.Error Event

Information about errors during data delivery.

Syntax

sshdaemon.on('Error', listener: (e: {readonly connectionId: string, readonly errorCode: number, readonly description: string}) => void )

Remarks

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

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

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

SSHDaemon.Log Event

Fires once for each log message.

Syntax

sshdaemon.on('Log', listener: (e: {readonly connectionId: string, readonly logLevel: number, readonly message: string, readonly logType: string}) => void )

Remarks

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

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType is reserved for future use.

ConnectionId specifies the connection to which the log message is applicable.

SSHDaemon.SSHChannelClosed Event

Fired when a channel is closed.

Syntax

sshdaemon.on('SSHChannelClosed', listener: (e: {readonly connectionId: string, readonly channelId: string}) => void )

Remarks

The SSHChannelClosed event is fired when a channel is closed on an SSH connection.

ConnectionId identifies the connection. ChannelId identifies the channel.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHDaemon.SSHChannelDataIn Event

Fired when data is received on an SSH channel.

Syntax

sshdaemon.on('SSHChannelDataIn', listener: (e: {readonly connectionId: string, readonly channelId: string, readonly data: string, readonly dataB: Uint8Array}) => void )

Remarks

Whenever a client sends data to an SSH channel, the SSHChannelDataIn event will fire. ChannelId will identify the channel receiving data. Data will contain the raw data being received.

ConnectionId identifies the connection. ChannelId identifies the channel.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHDaemon.SSHChannelEOF Event

Fired when the remote peer signals the end of the data stream for the channel.

Syntax

sshdaemon.on('SSHChannelEOF', listener: (e: {readonly connectionId: string, readonly channelId: string}) => void )

Remarks

The SSHChannelEOF event is fired when the end of the data stream for a channel on an SSH connection is reached.

ConnectionId identifies the connection. ChannelId identifies the channel.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHDaemon.SSHChannelOpened Event

Fired when a channel is successfully opened.

Syntax

sshdaemon.on('SSHChannelOpened', listener: (e: {readonly connectionId: string, readonly channelId: string}) => void )

Remarks

The SSHChannelOpened event is fired when a channel is successfully opened on an SSH connection.

ConnectionId identifies the connection. ChannelId identifies the channel.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHDaemon.SSHChannelOpenRequest Event

Fired when a client attempts to open a new channel.

Syntax

sshdaemon.on('SSHChannelOpenRequest', listener: (e: {readonly connectionId: string, readonly channelId: string, readonly service: string, readonly parameters: string, readonly parametersB: Uint8Array, accept: boolean}) => void )

Remarks

This event is fired whenever a client attempts to open a new channel for a given connection. ChannelId will contain the id of the channel to be created. Service will identify the type of channel that is being requested (e.g.: "session"). Set Accept to true to accept the channel open request.

ConnectionId identifies the connection. ChannelId identifies the channel.

If the channel open request contains extra information, it will be contained in Parameters; you can extract data from it using GetSSHParam and GetSSHParamBytes. The most common example of a request with parameters would be a request with Service set to "direct-tcpip" (for SSH tunneling); in that case Parameters will contain the host to connect (string), the port to connect (int), the originator IP address (string) and the originator TCP port (int).

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHDaemon.SSHChannelReadyToSend Event

Fired when the class is ready to send data.

Syntax

sshdaemon.on('SSHChannelReadyToSend', listener: (e: {readonly connectionId: string, readonly channelId: string}) => void )

Remarks

This event fires when data can be sent over the SSH Channel specified by ChannelId for the connection specified by ConnectionId.

When a channel is opened this event will fire once the channel is ready and data can be sent.

When Timeout is set to 0 (asynchronous) sending data may result in an error if the channel or underlying socket cannot accept more data to send. Monitor SSHChannelReadyToSend or ChannelsReadyToSend to determine when data can be sent again.

When Timeout is set to a positive value the class will block when sending data until the data can be successfully sent and SSHChannelReadyToSend and ChannelsReadyToSend do not need to be monitored.

SSHDaemon.SSHChannelRequest Event

Fired when the SSHHost sends a channel request to the client.

Syntax

sshdaemon.on('SSHChannelRequest', listener: (e: {readonly connectionId: string, readonly channelId: string, readonly requestType: string, readonly packet: string, readonly packetB: Uint8Array, success: boolean}) => void )

Remarks

The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. However, others may need the attention of the user to be dealt with properly within the scope of the application.

ConnectionId identifies the connection.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types are dependent upon the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original SSH packet. If the request type has specific parameters, they can be parsed out of this data.

Success should be used to instruct the class to respond to the request with either a success or failure notification. If the request is successful, SSHChannelRequested will fire with the same information in case the request requires further processing.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHDaemon.SSHChannelRequested Event

Fired if the SSHChannelRequest was successful, any further processing for the channel request should be done here.

Syntax

sshdaemon.on('SSHChannelRequested', listener: (e: {readonly connectionId: string, readonly channelId: string, readonly requestType: string, readonly packet: string, readonly packetB: Uint8Array}) => void )

Remarks

The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the class. However, others may need the attention of the user to be dealt with properly within the scope of the application.

ConnectionId identifies the connection.

ChannelId identifies the channel receiving the request.

Type will contain the type of the request. These types are dependent upon the type of the channel. For example, a "session" channel executing a command on the remote shell may receive an "exit-status" request containing the return code of that command.

RequestData contains the remainder of the original SSH packet. If the request type has specific parameters, they can be parsed out of this data.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHDaemon.SSHServiceRequest Event

Fired when a client requests a service to be started.

Syntax

sshdaemon.on('SSHServiceRequest', listener: (e: {readonly connectionId: string, readonly service: string, accept: boolean}) => void )

Remarks

The SSHServiceRequest event is fired when a client requests that a service be started for a particular connection, identified by ConnectionId. Service will be the name of the service the client wishes to start. If the connection is authenticated and the user has access to the service, set Accept to true to allow the SSHDaemon to accept the request.

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHDaemon.SSHStatus Event

Shows the progress of the secure connection.

Syntax

sshdaemon.on('SSHStatus', listener: (e: {readonly connectionId: string, readonly message: string}) => void )

Remarks

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

SSHDaemon.SSHUserAuthRequest Event

Fires when a client attempts to authenticate a connection.

Syntax

sshdaemon.on('SSHUserAuthRequest', listener: (e: {readonly connectionId: string, readonly user: string, readonly service: string, readonly authMethod: string, readonly authParam: string, accept: boolean, partialSuccess: boolean, availableMethods: string, readonly keyAlgorithm: string}) => void )

Remarks

The SSHUserAuthRequest event fires when an SSH client attempts to authenticate itself on a particular connection. ConnectionId will identify the connection being authenticated. User will be the name of the account requesting authentication, and Service will contain the name of the service the client is wishing to access.

AuthMethod will denote which method the client is attempting to use to authenticate itself. AuthParam will contain the value of the authentication token used by the client. If the token is acceptable, you may set Accept to true to allow the class to authenticate the client. If it is not, set Accept to false.

Connecting clients will initially attempt authentication with an AuthMethod of "none". This is done with the expectation that the request will fail and the server will send a list of supported methods back to the client. In your implementation check the AuthMethod parameter, if it is "none" you should set AvailableMethods and reject the request. The client will select one of the available methods and re-authenticate.

You may set AvailableMethods to a comma-delimited string of authentication methods that are available for the user. This list will be sent back to the client so that it may perform further authentication attempts.

The following is a list of methods implemented by the class:

The PartialSuccess parameter is only used when multi-factor authentication is needed. To implement multi-factor authentication when this event fires first verify the AuthParam for the given AuthMethod. If accepted, set PartialSuccess to true and Accept to false. The client should then send the authentication request for a different form of authentication specified in AvailableMethods. You may continue to set PartialSuccess to true until all authentication requirements are satisfied. Once all requirements are satisfied set Accept to true.

KeyAlgorithm hold the signing algorithm used when the client attempts public key authentication. Possible values are:

• ssh-rsa
• rsa-sha2-256
• rsa-sha2-512
• ssh-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• x509v3-sign-rsa
• x509v3-sign-dss

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing SSH data until the event returns. In order to prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

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.

Fields

Constructors

public Certificate();

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

public Certificate(String certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(int certStoreType, String store, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType 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 class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, String store, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType 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 class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, String subject, String configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(int certStoreType, byte[] storeBlob, String storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

SSHChannel Type

A currently open SSH channel.

Remarks

This type describes the SSH client's currently open channels. You may use the different fields of this type to manage the channel.

Fields

SSHConnection Type

A currently connected client.

Remarks

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

Fields

Constructors

public SSHConnection();

SSHPrompt Type

A prompt to provide to the client during keyboard-interactive authentication.

Remarks

This type describes a prompt the SSH daemon will send to the client when requesting keyboard-interactive authentication.

Fields

Constructors

public SSHPrompt();

public SSHPrompt(String prompt, boolean echo);

Configuration Settings (class ipworksssh.sshdaemon)

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*

Trappable Errors (class ipworksssh.sshdaemon)

SSHDaemon Errors

	1201   Could not forward connection. A detailed message follows.
	1202   Could not forward connection/channel data. A detailed message follows.
	1300   Could not authenticate client.
	1301   No server certificate was specified or no private key found.

IPDaemon 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   IPDaemon is already listening.
	106   Cannot change LocalPort when IPDaemon is Listening.
	107   Cannot change LocalHost when IPDaemon is Listening.
	108   Cannot change MaxConnections when IPDaemon 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.

TCP/IP Errors

	10004   [10004] Interrupted system call.
	10009   [10009] Bad file number.
	10013   [10013] Access denied.
	10014   [10014] Bad address.
	10022   [10022] Invalid argument.
	10024   [10024] Too many open files.
	10035   [10035] Operation would block.
	10036   [10036] Operation now in progress.
	10037   [10037] Operation already in progress.
	10038   [10038] Socket operation on non-socket.
	10039   [10039] Destination address required.
	10040   [10040] Message too long.
	10041   [10041] Protocol wrong type for socket.
	10042   [10042] Bad protocol option.
	10043   [10043] Protocol not supported.
	10044   [10044] Socket type not supported.
	10045   [10045] Operation not supported on socket.
	10046   [10046] Protocol family not supported.
	10047   [10047] Address family not supported by protocol family.
	10048   [10048] Address already in use.
	10049   [10049] Can't assign requested address.
	10050   [10050] Network is down.
	10051   [10051] Network is unreachable.
	10052   [10052] Net dropped connection or reset.
	10053   [10053] Software caused connection abort.
	10054   [10054] Connection reset by peer.
	10055   [10055] No buffer space available.
	10056   [10056] Socket is already connected.
	10057   [10057] Socket is not connected.
	10058   [10058] Can't send after socket shutdown.
	10059   [10059] Too many references, can't splice.
	10060   [10060] Connection timed out.
	10061   [10061] Connection refused.
	10062   [10062] Too many levels of symbolic links.
	10063   [10063] File name too long.
	10064   [10064] Host is down.
	10065   [10065] No route to host.
	10066   [10066] Directory not empty
	10067   [10067] Too many processes.
	10068   [10068] Too many users.
	10069   [10069] Disc Quota Exceeded.
	10070   [10070] Stale NFS file handle.
	10071   [10071] Too many levels of remote in path.
	10091   [10091] Network subsystem is unavailable.
	10092   [10092] WINSOCK DLL Version out of range.
	10093   [10093] Winsock not loaded yet.
	11001   [11001] Host not found.
	11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	11004   [11004] Valid name, no data record (check DNS setup).