SSHServer Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

TiphSSHServer

Remarks

The SSHServer component is the Secure Shell (SSH)-enabled equivalent of the IPWorks TCPServer component, 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 (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 SSHServer 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 contain one or more multiplexed channels, which are identified by a ChannelId. Channel-level events will specify the ChannelId to which they relate.

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

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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

SSHChannelCount Property (SSHServer Component)

The number of records in the arrays.

Syntax

__property int SSHChannelCount = { read=FSSHChannelCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• BytesSent
• ChannelEOL
• ChannelId
• KeyboardInteractivePromptEcho
• KeyboardInteractivePromptPrompt
• MaxChannelLength
• ReadyToSend
• RecordLength
• Service
• SSHCertEffectiveDate
• SSHCertEncoded
• SSHCertExpirationDate
• SSHCertExtendedKeyUsage
• SSHCertFingerprint
• SSHCertFingerprintSHA1
• SSHCertFingerprintSHA256
• SSHCertIssuer
• SSHCertPrivateKey
• SSHCertPrivateKeyAvailable
• SSHCertPrivateKeyContainer
• SSHCertPublicKey
• SSHCertPublicKeyAlgorithm
• SSHCertPublicKeyLength
• SSHCertSerialNumber
• SSHCertSignatureAlgorithm
• SSHCertStore
• SSHCertStorePassword
• SSHCertStoreType
• SSHCertSubject
• SSHCertSubjectAltNames
• SSHCertThumbprintMD5
• SSHCertThumbprintSHA1
• SSHCertThumbprintSHA256
• SSHCertUsage
• SSHCertUsageFlags
• SSHCertVersion
• SSHConnectionConnected
• SSHConnectionLocalAddress
• SSHConnectionRemoteHost
• SSHConnectionRemotePort
• SSHConnectionTimeout

The array indices start at 0 and end at SSHChannelCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

BytesSent Property (SSHServer Component)

This property specifies the number of bytes actually sent after a sending channel data.

Syntax

__property int BytesSent[int SSHChannelId] = { read=FBytesSent };

Default Value

0

Remarks

This property specifies the number of bytes actually sent after a sending channel data.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only and not available at design time.

Data Type

Integer

ChannelEOL Property (SSHServer Component)

Breaks the incoming data stream into chunks separated by EOL .

Syntax

__property String ChannelEOL[int SSHChannelId] = { read=FChannelEOL, write=FSetChannelEOL };

Default Value

""

Remarks

Breaks the incoming data stream into chunks separated by EOL.

This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.

ChannelEOL and MaxChannelLength must be set together or unexpected behavior could occur.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is not available at design time.

Data Type

String

ChannelId Property (SSHServer Component)

This property provides an Id generated by the component to identify the current Secure Shell (SSH) channel.

Syntax

__property String ChannelId[int SSHChannelId] = { read=FChannelId };

Default Value

""

Remarks

This property provides an Id generated by the component to identify the current Secure Shell (SSH) channel.

This Id is unique to this channel.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only and not available at design time.

Data Type

String

MaxChannelLength Property (SSHServer Component)

This property specifies the maximum amount of data to accumulate when no EOL is found.

Syntax

__property int MaxChannelLength[int SSHChannelId] = { read=FMaxChannelLength, write=FSetMaxChannelLength };

Default Value

0

Remarks

This property specifies the maximum amount of data to accumulate when no EOL is found.

MaxChannelLength is the size of an internal buffer, which holds received data while waiting for a ChannelEOL string.

If the ChannelEOL string is found in the input stream before MaxChannelLength bytes are received, the SSHChannelData event is fired with the ChannelDataEOLFound parameter set to True, and the buffer is reset.

If no ChannelEOL is found, and MaxChannelLength bytes are accumulated in the buffer, the SSHChannelData event is fired with the ChannelDataEOLFound parameter set to False, and the buffer is reset.

ChannelEOL and MaxChannelLength must be set together or unexpected behavior could occur.

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is not available at design time.

Data Type

Integer

ReadyToSend Property (SSHServer Component)

This property is True when data can be sent over the Secure Shell (SSH) channel.

Syntax

__property bool ReadyToSend[int SSHChannelId] = { read=FReadyToSend };

Default Value

false

Remarks

This property is True when data can be sent over the Secure Shell (SSH) channel.

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 ReadyToSend to determine when data can be sent again.

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

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only and not available at design time.

Data Type

Boolean

RecordLength Property (SSHServer Component)

This property holds the current record length set by ChangeRecordLength .

Syntax

__property int RecordLength[int SSHChannelId] = { read=FRecordLength };

Default Value

0

Remarks

This property holds the current record length set by ChangeRecordLength. When this value is a positive number, the component will accumulate data until RecordLength is reached and only then will it fire the SSHChannelDataIn event with the data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time by calling ChangeRecordLength, including within the SSHChannelDataIn event.

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

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only and not available at design time.

Data Type

Integer

Service Property (SSHServer Component)

This property holds the channel type that was requested when opening the channel.

Syntax

__property String Service[int SSHChannelId] = { read=FService };

Default Value

""

Remarks

This property holds the channel type that was requested when opening the channel. For instance "session" or "forwarded-tcpip".

The SSHChannelId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHChannelCount property.

This property is read-only and not available at design time.

Data Type

String

ConnectionBacklog Property (SSHServer Component)

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

Syntax

__property int ConnectionBacklog = { read=FConnectionBacklog, write=FSetConnectionBacklog };

Default Value

5

Remarks

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

This property is not available at design time.

Data Type

Integer

SSHConnectionCount Property (SSHServer Component)

The number of records in the SSHConnection arrays.

Syntax

__property int SSHConnectionCount = { read=FSSHConnectionCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• SSHConnectionConnected
• SSHConnectionLocalAddress
• SSHConnectionRemoteHost
• SSHConnectionRemotePort
• SSHConnectionTimeout

The array indices start at 0 and end at SSHConnectionCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

SSHConnectionConnected Property (SSHServer Component)

This property indicates the status of individual connections.

Syntax

__property bool SSHConnectionConnected[int ConnectionId] = { read=FSSHConnectionConnected };

Default Value

False

Remarks

This property indicates the status of individual connections.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is read-only and not available at design time.

Data Type

Boolean

SSHConnectionLocalAddress Property (SSHServer Component)

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

Syntax

__property String SSHConnectionLocalAddress[int ConnectionId] = { read=FSSHConnectionLocalAddress };

Default Value

""

Remarks

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

LocalAddress is important for multihomed hosts in cases in which it can be used to identify the particular network interface an individual connection is going through.

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

SSHConnectionRemoteHost Property (SSHServer Component)

The RemoteHost shows the IP address of the remote host through which the connection is coming.

Syntax

__property String SSHConnectionRemoteHost[int ConnectionId] = { read=FSSHConnectionRemoteHost };

Default Value

""

Remarks

The RemoteHost shows the IP address of the remote host through which the connection is coming.

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

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is read-only and not available at design time.

Data Type

String

SSHConnectionRemotePort Property (SSHServer Component)

The RemotePort shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Syntax

__property int SSHConnectionRemotePort[int ConnectionId] = { read=FSSHConnectionRemotePort };

Default Value

0

Remarks

The RemotePort shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is read-only and not available at design time.

Data Type

Integer

SSHConnectionTimeout Property (SSHServer Component)

This property contains a timeout for the component.

Syntax

__property int SSHConnectionTimeout[int ConnectionId] = { read=FSSHConnectionTimeout, write=FSetSSHConnectionTimeout };

Default Value

0

Remarks

This property contains a timeout for the component.

If the Timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data cannot be sent or received immediately.

If Timeout is set to a positive value, the component will automatically retry each operation that otherwise would result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

The component 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 component raises an exception.

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

The ConnectionId parameter specifies the index of the item in the array. The size of the array is controlled by the SSHConnectionCount property.

This property is not available at design time.

Data Type

Integer

DefaultAuthMethods Property (SSHServer Component)

The supported authentication methods.

Syntax

__property String DefaultAuthMethods = { read=FDefaultAuthMethods, write=FSetDefaultAuthMethods };

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

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

Data Type

String

DefaultIdleTimeout Property (SSHServer Component)

This property includes the default idle timeout for inactive clients.

Syntax

__property int DefaultIdleTimeout = { read=FDefaultIdleTimeout, write=FSetDefaultIdleTimeout };

Default Value

0

Remarks

This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the component will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent or received data within DefaultIdleTimeout seconds.

If set to 0 (default), no idle timeout is applied.

Note: DoEvents must be called for the component to check existing connections.

Data Type

Integer

DefaultTimeout Property (SSHServer Component)

An initial timeout value to be used by incoming connections.

Syntax

__property int DefaultTimeout = { read=FDefaultTimeout, write=FSetDefaultTimeout };

Default Value

60

Remarks

This property is used by the component 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 component will behave synchronously.

Data Type

Integer

KeyboardInteractiveMessage Property (SSHServer Component)

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

Syntax

__property String KeyboardInteractiveMessage = { read=FKeyboardInteractiveMessage, write=FSetKeyboardInteractiveMessage };

Default Value

""

Remarks

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

Data Type

String

KeyboardInteractivePromptCount Property (SSHServer Component)

The number of records in the KeyboardInteractivePrompt arrays.

Syntax

__property int KeyboardInteractivePromptCount = { read=FKeyboardInteractivePromptCount, write=FSetKeyboardInteractivePromptCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyboardInteractivePromptEcho
• KeyboardInteractivePromptPrompt

The array indices start at 0 and end at KeyboardInteractivePromptCount - 1.

This property is not available at design time.

Data Type

Integer

KeyboardInteractivePromptEcho Property (SSHServer Component)

This property specifies whether or not the client should echo the value entered by the user.

Syntax

__property bool KeyboardInteractivePromptEcho[int PromptIndex] = { read=FKeyboardInteractivePromptEcho, write=FSetKeyboardInteractivePromptEcho };

Default Value

false

Remarks

This property specifies whether or not the client should echo the value entered by the user.

The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.

This property is not available at design time.

Data Type

Boolean

KeyboardInteractivePromptPrompt Property (SSHServer Component)

This property contains the prompt label or text the client should present to the user.

Syntax

__property String KeyboardInteractivePromptPrompt[int PromptIndex] = { read=FKeyboardInteractivePromptPrompt, write=FSetKeyboardInteractivePromptPrompt };

Default Value

""

Remarks

This property contains the prompt label or text the client should present to the user.

The PromptIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.

This property is not available at design time.

Data Type

String

Listening Property (SSHServer Component)

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

Syntax

__property bool Listening = { read=FListening };

Default Value

False

Remarks

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

This property is read-only and not available at design time.

Data Type

Boolean

LocalHost Property (SSHServer Component)

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

Syntax

__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };

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

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

Data Type

String

LocalPort Property (SSHServer Component)

The Transmission Control Protocol (TCP) port in the local host where the component listens.

Syntax

__property int LocalPort = { read=FLocalPort, write=FSetLocalPort };

Default Value

22

Remarks

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

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

Data Type

Integer

SSHCertEffectiveDate Property (SSHServer Component)

The date on which this certificate becomes valid.

Syntax

__property String SSHCertEffectiveDate = { read=FSSHCertEffectiveDate };

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSHCertExpirationDate Property (SSHServer Component)

The date on which the certificate expires.

Syntax

__property String SSHCertExpirationDate = { read=FSSHCertExpirationDate };

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSHCertExtendedKeyUsage Property (SSHServer Component)

A comma-delimited list of extended key usage identifiers.

Syntax

__property String SSHCertExtendedKeyUsage = { read=FSSHCertExtendedKeyUsage };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSHCertFingerprint Property (SSHServer Component)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

__property String SSHCertFingerprint = { read=FSSHCertFingerprint };

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSHCertFingerprintSHA1 Property (SSHServer Component)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

__property String SSHCertFingerprintSHA1 = { read=FSSHCertFingerprintSHA1 };

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSHCertFingerprintSHA256 Property (SSHServer Component)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

__property String SSHCertFingerprintSHA256 = { read=FSSHCertFingerprintSHA256 };

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSHCertIssuer Property (SSHServer Component)

The issuer of the certificate.

Syntax

__property String SSHCertIssuer = { read=FSSHCertIssuer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSHCertPrivateKey Property (SSHServer Component)

The private key of the certificate (if available).

Syntax

__property String SSHCertPrivateKey = { read=FSSHCertPrivateKey };

Default Value

""

Remarks

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

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

This property is read-only.

Data Type

String

SSHCertPrivateKeyAvailable Property (SSHServer Component)

Whether a PrivateKey is available for the selected certificate.

Syntax

__property bool SSHCertPrivateKeyAvailable = { read=FSSHCertPrivateKeyAvailable };

Default Value

false

Remarks

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

This property is read-only.

Data Type

Boolean

SSHCertPrivateKeyContainer Property (SSHServer Component)

The name of the PrivateKey container for the certificate (if available).

Syntax

__property String SSHCertPrivateKeyContainer = { read=FSSHCertPrivateKeyContainer };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSHCertPublicKey Property (SSHServer Component)

The public key of the certificate.

Syntax

__property String SSHCertPublicKey = { read=FSSHCertPublicKey };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSHCertPublicKeyAlgorithm Property (SSHServer Component)

The textual description of the certificate's public key algorithm.

Syntax

__property String SSHCertPublicKeyAlgorithm = { read=FSSHCertPublicKeyAlgorithm };

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHCertPublicKeyLength Property (SSHServer Component)

The length of the certificate's public key (in bits).

Syntax

__property int SSHCertPublicKeyLength = { read=FSSHCertPublicKeyLength };

Default Value

0

Remarks

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

This property is read-only.

Data Type

Integer

SSHCertSerialNumber Property (SSHServer Component)

The serial number of the certificate encoded as a string.

Syntax

__property String SSHCertSerialNumber = { read=FSSHCertSerialNumber };

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSHCertSignatureAlgorithm Property (SSHServer Component)

The text description of the certificate's signature algorithm.

Syntax

__property String SSHCertSignatureAlgorithm = { read=FSSHCertSignatureAlgorithm };

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHCertStore Property (SSHServer Component)

The name of the certificate store for the client certificate.

Syntax

__property String SSHCertStore = { read=FSSHCertStore, write=FSetSSHCertStore };
__property DynamicArray<Byte> SSHCertStoreB = { read=FSSHCertStoreB, write=FSetSSHCertStoreB };

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Byte Array

SSHCertStorePassword Property (SSHServer Component)

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

Syntax

__property String SSHCertStorePassword = { read=FSSHCertStorePassword, write=FSetSSHCertStorePassword };

Default Value

""

Remarks

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

Data Type

String

SSHCertStoreType Property (SSHServer Component)

The type of certificate store for this certificate.

Syntax

__property TiphSSHServerSSHCertStoreTypes SSHCertStoreType = { read=FSSHCertStoreType, write=FSetSSHCertStoreType };

enum TiphSSHServerSSHCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

SSHCertSubjectAltNames Property (SSHServer Component)

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

Syntax

__property String SSHCertSubjectAltNames = { read=FSSHCertSubjectAltNames };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSHCertThumbprintMD5 Property (SSHServer Component)

The MD5 hash of the certificate.

Syntax

__property String SSHCertThumbprintMD5 = { read=FSSHCertThumbprintMD5 };

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertThumbprintSHA1 Property (SSHServer Component)

The SHA-1 hash of the certificate.

Syntax

__property String SSHCertThumbprintSHA1 = { read=FSSHCertThumbprintSHA1 };

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertThumbprintSHA256 Property (SSHServer Component)

The SHA-256 hash of the certificate.

Syntax

__property String SSHCertThumbprintSHA256 = { read=FSSHCertThumbprintSHA256 };

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertUsage Property (SSHServer Component)

The text description of UsageFlags .

Syntax

__property String SSHCertUsage = { read=FSSHCertUsage };

Default Value

""

Remarks

The text description of UsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSHCertUsageFlags Property (SSHServer Component)

The flags that show intended use for the certificate.

Syntax

__property int SSHCertUsageFlags = { read=FSSHCertUsageFlags };

Default Value

0

Remarks

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

Please see the Usage property for a text representation of UsageFlags.

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

This property is read-only.

Data Type

Integer

SSHCertVersion Property (SSHServer Component)

The certificate's version number.

Syntax

__property String SSHCertVersion = { read=FSSHCertVersion };

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SSHCertSubject Property (SSHServer Component)

The subject of the certificate used for client authentication.

Syntax

__property String SSHCertSubject = { read=FSSHCertSubject, write=FSetSSHCertSubject };

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

Data Type

String

SSHCertEncoded Property (SSHServer Component)

The certificate (PEM/Base64 encoded).

Syntax

__property String SSHCertEncoded = { read=FSSHCertEncoded, write=FSetSSHCertEncoded };
__property DynamicArray<Byte> SSHCertEncodedB = { read=FSSHCertEncodedB, write=FSetSSHCertEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSHCompressionAlgorithms Property (SSHServer Component)

The comma-separated list containing all allowable compression algorithms.

Syntax

__property String SSHCompressionAlgorithms = { read=FSSHCompressionAlgorithms, write=FSetSSHCompressionAlgorithms };

Default Value

"none,zlib"

Remarks

During the Secure Shell (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. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the component 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 component:

• zlib
• zlib@openssh.com
• none

Data Type

String

SSHEncryptionAlgorithms Property (SSHServer Component)

The comma-separated list containing all allowable encryption algorithms.

Syntax

__property String SSHEncryptionAlgorithms = { read=FSSHEncryptionAlgorithms, write=FSetSSHEncryptionAlgorithms };

Default Value

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

Remarks

During the Secure Shell (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. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the component 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 component:

Data Type

String

ChangeRecordLength Method (SSHServer Component)

Changes the length of received data records.

Syntax

void __fastcall ChangeRecordLength(int ChannelId, int RecordLength);

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 component will accumulate data until RecordLength bytes of data is received and only then will it 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.

CloseChannel Method (SSHServer Component)

Closes an existing SSHChannel .

Syntax

void __fastcall CloseChannel(int ChannelId);

Remarks

ChannelId is the identifier for the Secure Shell (SSH) channel to be closed.

Config Method (SSHServer Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 (SSHServer Component)

This method disconnects the specified client.

Syntax

void __fastcall Disconnect(int ConnectionId);

Remarks

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

DoEvents Method (SSHServer Component)

This method processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

ExchangeKeys Method (SSHServer Component)

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

Syntax

void __fastcall ExchangeKeys(int ConnectionId);

Remarks

Secure Shell (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.

GetSSHParam Method (SSHServer Component)

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

String __fastcall GetSSHParam(DynamicArray<Byte> Payload, String Field);

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

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.

GetSSHParamBytes Method (SSHServer Component)

Reads a field from a Secure Shell (SSH) packet's payload.

Syntax

DynamicArray<Byte> __fastcall GetSSHParamBytes(DynamicArray<Byte> Payload, String Field);

Remarks

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

OpenChannel Method (SSHServer Component)

Opens a new SSHChannel .

Syntax

String __fastcall OpenChannel(int ConnectionId, String ChannelType);

Remarks

The Secure Shell (SSH) 2.0 specification allows for multiple channels to be opened over a single Transmission Control Protocol (TCP)/IP connection. The Channels property represents the channels that are currently open. A new SSHChannel can be opened with OpenChannel, and data can be sent over it with SendChannelData.

ChannelType represents the type of Secure Shell (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.

Reset Method (SSHServer Component)

This method will reset the component.

Syntax

void __fastcall Reset();

Remarks

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

SendBytes Method (SSHServer Component)

Sends binary data to the specified channel.

Syntax

void __fastcall SendBytes(int ChannelId, DynamicArray<Byte> Data);

Remarks

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

SendChannelData Method (SSHServer Component)

Sends data over a Secure Shell (SSH) channel.

Syntax

void __fastcall SendChannelData(int ChannelId, DynamicArray<Byte> Data);

Remarks

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

SendSSHPacket Method (SSHServer Component)

Sends an encoded Secure Shell (SSH) packet to the server.

Syntax

void __fastcall SendSSHPacket(int ChannelId, int PacketType, DynamicArray<Byte> Payload);

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 component will finish building the packet, encrypt it for transport, and send it to the server.

SendText Method (SSHServer Component)

Sends text to the specified channel.

Syntax

void __fastcall SendText(int ChannelId, String Text);

Remarks

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

SetSSHParam Method (SSHServer Component)

Writes a field to the end of a payload.

Syntax

DynamicArray<Byte> __fastcall SetSSHParam(DynamicArray<Byte> Payload, String FieldType, String FieldValue);

Remarks

This method is used to build the payload portion of a Secure Shell (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 hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10.

Shutdown Method (SSHServer Component)

This method shuts down the server.

Syntax

void __fastcall 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 (SSHServer Component)

This method starts listening for incoming connections.

Syntax

void __fastcall 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 (SSHServer Component)

This method stops listening for new connections.

Syntax

void __fastcall 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 (SSHServer Component)

Fired immediately after a connection completes (or fails).

Syntax

typedef struct {
  int ConnectionId;
  int StatusCode;
  String Description;
  int CertStoreType;
  String CertStore;
  String CertPassword;
  String CertSubject;
} TiphSSHServerConnectedEventParams;
typedef void __fastcall (__closure *TiphSSHServerConnectedEvent)(System::TObject* Sender, TiphSSHServerConnectedEventParams *e);
__property TiphSSHServerConnectedEvent OnConnected = { read=FOnConnected, write=FOnConnected };

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.

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

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

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:

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:

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

ConnectionRequest Event (SSHServer Component)

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

Syntax

typedef struct {
  String Address;
  int Port;
  bool Accept;
} TiphSSHServerConnectionRequestEventParams;
typedef void __fastcall (__closure *TiphSSHServerConnectionRequestEvent)(System::TObject* Sender, TiphSSHServerConnectionRequestEventParams *e);
__property TiphSSHServerConnectionRequestEvent OnConnectionRequest = { read=FOnConnectionRequest, write=FOnConnectionRequest };

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.

Disconnected Event (SSHServer Component)

This event is fired when a connection is closed.

Syntax

typedef struct {
  int ConnectionId;
  int StatusCode;
  String Description;
} TiphSSHServerDisconnectedEventParams;
typedef void __fastcall (__closure *TiphSSHServerDisconnectedEvent)(System::TObject* Sender, TiphSSHServerDisconnectedEventParams *e);
__property TiphSSHServerDisconnectedEvent OnDisconnected = { read=FOnDisconnected, write=FOnDisconnected };

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.

Error Event (SSHServer Component)

Fired when errors occur during data delivery.

Syntax

typedef struct {
  int ConnectionId;
  int ErrorCode;
  String Description;
} TiphSSHServerErrorEventParams;
typedef void __fastcall (__closure *TiphSSHServerErrorEvent)(System::TObject* Sender, TiphSSHServerErrorEventParams *e);
__property TiphSSHServerErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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 (SSHServer Component)

Fired once for each log message.

Syntax

typedef struct {
  int ConnectionId;
  int LogLevel;
  String Message;
  String LogType;
} TiphSSHServerLogEventParams;
typedef void __fastcall (__closure *TiphSSHServerLogEvent)(System::TObject* Sender, TiphSSHServerLogEventParams *e);
__property TiphSSHServerLogEvent OnLog = { read=FOnLog, write=FOnLog };

Remarks

Fired once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

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

Message is the log message.

LogType is reserved for future use.

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

SSHChannelClosed Event (SSHServer Component)

Fired when a channel is closed.

Syntax

typedef struct {
  int ConnectionId;
  int ChannelId;
} TiphSSHServerSSHChannelClosedEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHChannelClosedEvent)(System::TObject* Sender, TiphSSHServerSSHChannelClosedEventParams *e);
__property TiphSSHServerSSHChannelClosedEvent OnSSHChannelClosed = { read=FOnSSHChannelClosed, write=FOnSSHChannelClosed };

Remarks

The SSHChannelClosed event is fired when a channel is closed on a Secure Shell (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 Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelDataIn Event (SSHServer Component)

Fired when data are received on a Secure Shell (SSH) channel.

Syntax

typedef struct {
  int ConnectionId;
  int ChannelId;
  String Data;
  DynamicArray<Byte> DataB;
} TiphSSHServerSSHChannelDataInEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHChannelDataInEvent)(System::TObject* Sender, TiphSSHServerSSHChannelDataInEventParams *e);
__property TiphSSHServerSSHChannelDataInEvent OnSSHChannelDataIn = { read=FOnSSHChannelDataIn, write=FOnSSHChannelDataIn };

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 Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelEOF Event (SSHServer Component)

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

Syntax

typedef struct {
  int ConnectionId;
  int ChannelId;
} TiphSSHServerSSHChannelEOFEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHChannelEOFEvent)(System::TObject* Sender, TiphSSHServerSSHChannelEOFEventParams *e);
__property TiphSSHServerSSHChannelEOFEvent OnSSHChannelEOF = { read=FOnSSHChannelEOF, write=FOnSSHChannelEOF };

Remarks

The SSHChannelEOF event is fired when the end of the data stream for a channel on a Sescure Shell (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 Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelOpened Event (SSHServer Component)

Fired when a channel is successfully opened.

Syntax

typedef struct {
  int ConnectionId;
  int ChannelId;
} TiphSSHServerSSHChannelOpenedEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHChannelOpenedEvent)(System::TObject* Sender, TiphSSHServerSSHChannelOpenedEventParams *e);
__property TiphSSHServerSSHChannelOpenedEvent OnSSHChannelOpened = { read=FOnSSHChannelOpened, write=FOnSSHChannelOpened };

Remarks

The SSHChannelOpened event is fired when a channel is successfully opened on a Secure Shell (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 Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelOpenRequest Event (SSHServer Component)

Fired when a client attempts to open a new channel.

Syntax

typedef struct {
  int ConnectionId;
  int ChannelId;
  String Service;
  String Parameters;
  DynamicArray<Byte> ParametersB;
  bool Accept;
} TiphSSHServerSSHChannelOpenRequestEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHChannelOpenRequestEvent)(System::TObject* Sender, TiphSSHServerSSHChannelOpenRequestEventParams *e);
__property TiphSSHServerSSHChannelOpenRequestEvent OnSSHChannelOpenRequest = { read=FOnSSHChannelOpenRequest, write=FOnSSHChannelOpenRequest };

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 Secure Shell (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 Transmission Control Protocol (TCP) port (int).

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

SSHChannelReadyToSend Event (SSHServer Component)

Fired when the component is ready to send data.

Syntax

typedef struct {
  int ConnectionId;
  int ChannelId;
} TiphSSHServerSSHChannelReadyToSendEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHChannelReadyToSendEvent)(System::TObject* Sender, TiphSSHServerSSHChannelReadyToSendEventParams *e);
__property TiphSSHServerSSHChannelReadyToSendEvent OnSSHChannelReadyToSend = { read=FOnSSHChannelReadyToSend, write=FOnSSHChannelReadyToSend };

Remarks

This event fires when data can be sent over the Secure Shell (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 ReadyToSend to determine when data can be sent again.

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

SSHChannelRequest Event (SSHServer Component)

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

Syntax

typedef struct {
  int ConnectionId;
  int ChannelId;
  String RequestType;
  String Packet;
  DynamicArray<Byte> PacketB;
  bool Success;
} TiphSSHServerSSHChannelRequestEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHChannelRequestEvent)(System::TObject* Sender, TiphSSHServerSSHChannelRequestEventParams *e);
__property TiphSSHServerSSHChannelRequestEvent OnSSHChannelRequest = { read=FOnSSHChannelRequest, write=FOnSSHChannelRequest };

Remarks

The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the component. Others, however, 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 depend on 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 Secure Shell (SSH) packet. If the request type has specific parameters, they can be parsed out of this data.

Success should be used to instruct the component 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 Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHChannelRequested Event (SSHServer Component)

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

Syntax

typedef struct {
  int ConnectionId;
  int ChannelId;
  String RequestType;
  String Packet;
  DynamicArray<Byte> PacketB;
} TiphSSHServerSSHChannelRequestedEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHChannelRequestedEvent)(System::TObject* Sender, TiphSSHServerSSHChannelRequestedEventParams *e);
__property TiphSSHServerSSHChannelRequestedEvent OnSSHChannelRequested = { read=FOnSSHChannelRequested, write=FOnSSHChannelRequested };

Remarks

The SSHHost may send requests that affect the status of a particular SSHChannel. Some requests will be automatically handled by the component. Others, however, 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 depend on 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 Secure Shell (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 Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

SSHServiceRequest Event (SSHServer Component)

Fired when a client requests a service to be started.

Syntax

typedef struct {
  int ConnectionId;
  String Service;
  bool Accept;
} TiphSSHServerSSHServiceRequestEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHServiceRequestEvent)(System::TObject* Sender, TiphSSHServerSSHServiceRequestEventParams *e);
__property TiphSSHServerSSHServiceRequestEvent OnSSHServiceRequest = { read=FOnSSHServiceRequest, write=FOnSSHServiceRequest };

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 SSHServer to accept the request.

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

SSHStatus Event (SSHServer Component)

Fired to show the progress of the secure connection.

Syntax

typedef struct {
  int ConnectionId;
  String Message;
} TiphSSHServerSSHStatusEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHStatusEvent)(System::TObject* Sender, TiphSSHServerSSHStatusEventParams *e);
__property TiphSSHServerSSHStatusEvent OnSSHStatus = { read=FOnSSHStatus, write=FOnSSHStatus };

Remarks

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

SSHTunnelClosed Event (SSHServer Component)

Fired when a connected client attempts to close a tunnel.

Syntax

typedef struct {
  int ConnectionId;
  String Address;
  int Port;
} TiphSSHServerSSHTunnelClosedEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHTunnelClosedEvent)(System::TObject* Sender, TiphSSHServerSSHTunnelClosedEventParams *e);
__property TiphSSHServerSSHTunnelClosedEvent OnSSHTunnelClosed = { read=FOnSSHTunnelClosed, write=FOnSSHTunnelClosed };

Remarks

SSHTunnelRequested Event (SSHServer Component)

Fired when a connected client attempts to establish a forward or reverse tunnel.

Syntax

typedef struct {
  int ConnectionId;
  int Direction;
  String Address;
  int Port;
  bool Accept;
} TiphSSHServerSSHTunnelRequestedEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHTunnelRequestedEvent)(System::TObject* Sender, TiphSSHServerSSHTunnelRequestedEventParams *e);
__property TiphSSHServerSSHTunnelRequestedEvent OnSSHTunnelRequested = { read=FOnSSHTunnelRequested, write=FOnSSHTunnelRequested };

Remarks

SSHUserAuthRequest Event (SSHServer Component)

Fired when a client attempts to authenticate a connection.

Syntax

typedef struct {
  int ConnectionId;
  String User;
  String Service;
  String AuthMethod;
  String AuthParam;
  bool Accept;
  bool PartialSuccess;
  String AvailableMethods;
  String KeyAlgorithm;
} TiphSSHServerSSHUserAuthRequestEventParams;
typedef void __fastcall (__closure *TiphSSHServerSSHUserAuthRequestEvent)(System::TObject* Sender, TiphSSHServerSSHUserAuthRequestEventParams *e);
__property TiphSSHServerSSHUserAuthRequestEvent OnSSHUserAuthRequest = { read=FOnSSHUserAuthRequest, write=FOnSSHUserAuthRequest };

Remarks

The SSHUserAuthRequest event fires when a Secure Shell (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 component 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 reauthenticate.

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

The PartialSuccess parameter is used only when multifactor authentication is needed. To implement multifactor 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 holds the signing algorithm used when the client attempts public key authentication. Possible values are as follows:

• 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 Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

Config Settings (SSHServer Component)

SSHServer Config Settings

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

TCPServer Config Settings

Base Config Settings

Trappable Errors (SSHServer Component)

SSHServer Errors

TCPServer Errors

TCP/IP Errors