IP*Works! SSH V9 - Online Help
IP*Works! SSH V9
Questions / Feedback?

SSHDaemon Control

Properties   Methods   Events   Configuration Settings   Errors  

The SSHDaemon component is used to create Secure Shell (SSH) servers. The component 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

SSHDaemon

Remarks

The SSHDaemon control is the SSH-enabled equivalent of the IP*Works! IPDaemon control, 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 ClientRemoteHost and ClientRemotePort properties.

Property List


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

SSHChannelCountThe number of records in the arrays.
BytesSentThe number of bytes actually sent after a sending channel data.
ChannelIdAn id generated by the component to identify the current SSH channel.
DataToSendA string of data to be sent to the remote host.
ConnectionBacklogThe maximum number of pending connections maintained by the TCP/IP subsystem.
SSHConnectionCountThe number of records in the SSHConnection arrays.
SSHConnectionConnectedUsed to disconnect individual connections and/or show their status.
SSHConnectionLocalAddressThis property shows the IP address of the interface through which the connection is passing.
SSHConnectionRemoteHostThe RemoteHost shows the IP address of the remote host through which the connection is coming.
SSHConnectionRemotePortThe RemotePort shows the TCP port on the remote host through which the connection is coming.
SSHConnectionTimeoutA timeout for the component.
DefaultAuthMethodsSpecifies the supported authentication methods.
DefaultTimeoutAn initial timeout value to be used by incoming connections.
KeyboardInteractiveMessageThe instructions to send to the client during keyboard-interactive authentication.
KeyboardInteractivePromptCountThe number of records in the KeyboardInteractivePrompt arrays.
KeyboardInteractivePromptEchoSpecifies if the client should echo the value entered by the user or not.
KeyboardInteractivePromptPromptThe prompt label/text the client should present to the user.
ListeningIf True, the component accepts incoming connections on LocalPort.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component listens.
SSHCertEncodedThe certificate (PEM/base64 encoded).
SSHCertStoreThe name of the certificate store for the client certificate.
SSHCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSHCertStoreTypeThe type of certificate store for this certificate.
SSHCertSubjectThe subject of the certificate used for client authentication.
SSHCompressionAlgorithmsA comma-separated list containing all allowable compression algorithms.
SSHEncryptionAlgorithmsA comma-separated list containing all allowable compression algorithms.

Method List


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

CloseChannelCloses a existing SSHChannel .
ConfigSets or retrieves a configuration setting .
DisconnectDisconnect the specified client.
DoEventsProcesses events from the internal message queue.
ExchangeKeysCauses the component to exchange a new set of session keys on the specified connection.
GetSSHParamUsed to read a field from an SSH packet's payload.
GetSSHParamBytesUsed to read a field from an SSH packet's payload.
OpenChannelOpens a new SSHChannel .
SendChannelDataUsed to send regular data over an SSH channel.
SendSSHPacketUsed to send an encoded SSH packet to a connected client.
SetSSHParamUsed to write a field to the end of a payload.
ShutdownShuts down the server.

Event List


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

ConnectedFired immediately after a connection completes (or fails).
ConnectionRequestFired when a request for connection comes from a remote host.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
SSHChannelClosedFired when a channel is closed.
SSHChannelDataInFired when data is received on an SSH channel.
SSHChannelEOFFired when the remote peer signals the end of the data stream for the channel.
SSHChannelOpenedFired when a channel is successfully opened.
SSHChannelOpenRequestFired when a client attempts to open a new channel.
SSHChannelReadyToSendFired when the component is ready to send data.
SSHChannelRequestFired when the SSHHost sends a channel request to the client.
SSHChannelRequestedFired if the SSHChannelRequest was successful, any further processing for the channel request should be done here.
SSHServiceRequestFired when a client requests a service to be started.
SSHStatusShows the progress of the secure connection.
SSHUserAuthRequestFires when a client attempts to authenticate a connection.

Configuration Settings


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

MaxAuthAttemptsThe maximum authentication attempts allowed before forcing a disconnect.
ServerSSHVersionStringThe SSH version string sent to connecting clients.
UserAuthBanner[ConnectionId]A custom user authentication banner.
KeyRenegotiationThresholdSets the threshold for the SSH Key Renegotiation.
SSHKeyExchangeAlgorithmsSpecifies the supported key exchange algorithms.
SSHMacAlgorithmsSpecifies the supported Mac algorithms.
BindExclusivelyWhether or not the component considers a local port reserved for exclusive use.
InBufferSizeThe size in bytes of the incoming queue of the socket.
MaxConnectionsThe maximum number of connections available.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
RecordLength[ConnectionId]The length of received data records.
TcpNoDelayWhether or not to delay when sending packets.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 9.0.6240.0