SExec Component

Properties   Methods   Events   Config Settings   Errors  

The SExec component is used to remotely execute a command on an SSH server.

Syntax

TiphSExec

Remarks

The SExec component establishes a Secure Shell (SSH) connection to a server and starts up the user's default shell. Using the component is very simple. The destination is specified by the SSHHost property, and the login information is given by the SSHUser and SSHPassword properties. To execute the command, simply call the Execute command or set the Command property with the command you wish to execute as the parameter. Further input can be supplied to the Text parameter of the Send method or via the Stdin property.

The output of the command is returned through the Stdout event. If an error happens on the protocol level, the error message can be found in the ErrorMessage property. Errors during command execution (the stderr stream) are given by the Stderr event. Once the remote command or application terminates, the component will disconnect from the server. If the application's exit status is non-zero (success), the component will throw an exception.

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.

Command Property (SExec Component)

The command to be sent to the remote host.

Syntax

__property String Command = { read=FCommand, write=FSetCommand };

Default Value

""

Remarks

Assigning a command to this property makes the component attempt to connect to the SSHHost and execute the command under the user's shell. There is no need to append an end-of-line character to the command. All output from the remote application will be returned through the Stdout event.

Note: the component will terminate the connection once the remote application has finished executing. If the exit status of the application is non-zero (failure), the component will raise an exception.

Data Type

String

Connected Property (SExec Component)

This shows whether the component is connected.

Syntax

__property bool Connected = { read=FConnected, write=FSetConnected };

Default Value

False

Remarks

This property is used to determine whether or not the component is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

ErrorMessage Property (SExec Component)

The error message returned by the server along with the ExitStatus .

Syntax

__property String ErrorMessage = { read=FErrorMessage };

Default Value

""

Remarks

After executing a command through Execute or by setting Command, the server will send a notification containing the ExitStatus of the command. The server may also send a textual representation of that code, which will be stored in ErrorMessage.

This property is read-only.

Data Type

String

ExitStatus Property (SExec Component)

The exit code for the last executed command.

Syntax

__property int ExitStatus = { read=FExitStatus };

Default Value

0

Remarks

After executing a command through Execute or by setting Command, the server will send a notification containing the ExitStatus of the command. The server may also send a textual representation of that code, which will be stored in ErrorMessage.

This property is read-only.

Data Type

Integer

FirewallAutoDetect Property (SExec Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (SExec Component)

This property determines the type of firewall to connect through.

Syntax

__property TiphSExecFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TiphSExecFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (SExec Component)

This property contains the name or IP address of firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (SExec Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (SExec Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (SExec Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

LocalHost Property (SExec 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

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 component initiate connections (or accept in the case of server components) only through that interface.

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

Data Type

String

LocalPort Property (SExec Component)

The TCP port in the local host where the component binds.

Syntax

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

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the component to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

SSHAcceptServerHostKeyEncoded Property (SExec Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSHAcceptServerHostKeyEncoded = { read=FSSHAcceptServerHostKeyEncoded, write=FSetSSHAcceptServerHostKeyEncoded };
__property DynamicArray<Byte> SSHAcceptServerHostKeyEncodedB = { read=FSSHAcceptServerHostKeyEncodedB, write=FSetSSHAcceptServerHostKeyEncodedB };

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSHAuthMode Property (SExec Component)

The authentication method to be used the component when calling SSHLogon .

Syntax

__property TiphSExecSSHAuthModes SSHAuthMode = { read=FSSHAuthMode, write=FSetSSHAuthMode };

enum TiphSExecSSHAuthModes {
  amNone=0,
  amMultiFactor=1,
  amPassword=2,
  amPublicKey=3,
  amKeyboardInteractive=4,
  amGSSAPIWithMic=5,
  amCustom=6,
  amGSSAPIKeyex=7
};

Default Value

amPassword

Remarks

The SSH Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the component will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.

The component will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the component supports the following authentication methods:

Example (User/Password Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example (Public Key Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

Integer

SSHCertEncoded Property (SExec Component)

This is the certificate (PEM/Base64 encoded).

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

SSHCertStore Property (SExec Component)

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

This is the name of the certificate store for the client certificate.

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

SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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 (SExec 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 (SExec Component)

This is the type of certificate store for this certificate.

Syntax

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

enum TiphSExecSSHCertStoreTypes {
  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

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

SSHCertSubject Property (SExec Component)

This is the subject of the certificate used for client authentication.

Syntax

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

Default Value

""

Remarks

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

SSHCompressionAlgorithms Property (SExec Component)

A comma-separated list containing all allowable compression algorithms.

Syntax

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

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

A comma-separated list containing all allowable encryption algorithms.

Syntax

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

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

SSHHost Property (SExec Component)

The address of the SSH host.

Syntax

__property String SSHHost = { read=FSSHHost, write=FSetSSHHost };

Default Value

""

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the SSHHost property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.

Data Type

String

SSHPassword Property (SExec Component)

The password for SSH password-based authentication.

Syntax

__property String SSHPassword = { read=FSSHPassword, write=FSetSSHPassword };

Default Value

""

Remarks

SSHPassword specifies the password which is used to authenticate the client to the SSH server.

Data Type

String

SSHPort Property (SExec Component)

The port on the SSH server where the SSH service is running; by default, 22.

Syntax

__property int SSHPort = { read=FSSHPort, write=FSetSSHPort };

Default Value

22

Remarks

The SSHPort specifies a service port on the SSH host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

SSHUser Property (SExec Component)

The username for SSH authentication.

Syntax

__property String SSHUser = { read=FSSHUser, write=FSetSSHUser };

Default Value

""

Remarks

SSHUser specifies the username which is used to authenticate the client to the SSH server. This property is required.

Example (User/Password Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example (Public Key Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

String

Stdin Property (SExec Component)

This property includes a string of data to be sent to the remote host while connected.

Syntax

__property String Stdin = { write=FSetStdin };
__property DynamicArray<Byte> StdinB = { write=FSetStdinB };

Default Value

""

Remarks

This property is used to provide input for the process in the remote host.

If you are sending data to the remote host faster than it can process it, or faster than the network bandwidth allows, the outgoing queue might fill up. When this happens, Stdin raises the exception with errorcode 10035 and message "[10035] Operation would block" (WSAEWOULDBLOCK). You can handle this exception, and then try to send the data again. .

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

Data Type

Byte Array

Timeout Property (SExec Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

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

If Timeout is set to a positive value, data is sent in a blocking manner and the component will wait for the operation to complete before returning control. The component will handle any potential WOULDBLOCK errors internally and automatically retry the operation 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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 60 seconds.

Data Type

Integer

Config Method (SExec 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.

DecodePacket Method (SExec Component)

Decodes a hex-encoded SSH packet.

Syntax

DynamicArray<Byte> __fastcall DecodePacket(String EncodedPacket);

Remarks

This method is used to decode an SSH packet created by EncodePacket.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

DoEvents Method (SExec Component)

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.

EncodePacket Method (SExec Component)

Hex encodes an SSH packet.

Syntax

String __fastcall EncodePacket(DynamicArray<Byte> Packet);

Remarks

This method is used to encode a raw SSH packet created by SetSSHParam.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

Execute Method (SExec Component)

Execute a Command on the remote host.

Syntax

void __fastcall Execute(String Command);

Remarks

Calling this method is equivalent to setting the Command property to Command.

GetSSHParam Method (SExec Component)

Used to read a field from an 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 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.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

GetSSHParamBytes Method (SExec Component)

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

Syntax

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

Remarks

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

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

Interrupt Method (SExec Component)

Interrupt the current method.

Syntax

void __fastcall Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Reset Method (SExec Component)

Reset the component.

Syntax

void __fastcall Reset();

Remarks

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

Send Method (SExec Component)

Send standard input to the program executing on the remote host.

Syntax

void __fastcall Send(DynamicArray<Byte> Text);

Remarks

Calling this method is equivalent to setting the Stdin property to Text.

SendStdinBytes Method (SExec Component)

This method sends binary data to the remote host.

Syntax

void __fastcall SendStdinBytes(DynamicArray<Byte> Data);

Remarks

This method sends the specified binary data to the remote host. The data provided are used as input for the process on the remote host. To send text, use the SendStdinText method instead.

If you are sending data to the remote host faster than it can process it, or faster than the network bandwidth allows, the outgoing queue might fill up. When this happens the component raises the exception with errorcode 10035 and message "[10035] Operation would block" (WSAEWOULDBLOCK). You can handle this exception, and then try to send the data again. .

SendStdinText Method (SExec Component)

This method sends text to the remote host.

Syntax

void __fastcall SendStdinText(String Text);

Remarks

This method sends the specified text to the remote host. The text provided is used as an input for the process on the remote host. To send binary data, use the SendStdinBytes method instead.

If you are sending data to the remote host faster than it can process it, or faster than the network bandwidth allows, the outgoing queue might fill up. When this happens the component raises the exception with errorcode 10035 and message "[10035] Operation would block" (WSAEWOULDBLOCK). You can handle this exception, and then try to send the data again. .

SetSSHParam Method (SExec Component)

Used to write 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 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.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

SSHLogoff Method (SExec Component)

Logoff from the SSH server.

Syntax

void __fastcall SSHLogoff();

Remarks

Logoff from the SSH server. If that fails, the connection is terminated by the local host.

SSHLogon Method (SExec Component)

Logon to the SSHHost using the current SSHUser and SSHPassword .

Syntax

void __fastcall SSHLogon(String SSHHost, int SSHPort);

Remarks

Logon to the SSH server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example (Logging On)

SSHClient.SSHUser = "username" SSHClient.SSHPassword = "password" SSHClient.SSHLogon("sshHost", sshPort)

Connected Event (SExec Component)

This event is fired immediately after a connection completes (or fails).

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TiphSExecConnectedEventParams;
typedef void __fastcall (__closure *TiphSExecConnectedEvent)(System::TObject* Sender, TiphSExecConnectedEventParams *e);
__property TiphSExecConnectedEvent 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 Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (SExec Component)

This event is fired to indicate changes in the connection state.

Syntax

typedef struct {
  String ConnectionEvent;
  int StatusCode;
  String Description;
} TiphSExecConnectionStatusEventParams;
typedef void __fastcall (__closure *TiphSExecConnectionStatusEvent)(System::TObject* Sender, TiphSExecConnectionStatusEventParams *e);
__property TiphSExecConnectionStatusEvent OnConnectionStatus = { read=FOnConnectionStatus, write=FOnConnectionStatus };

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (SExec Component)

This event is fired when a connection is closed.

Syntax

typedef struct {
  int StatusCode;
  String Description;
} TiphSExecDisconnectedEventParams;
typedef void __fastcall (__closure *TiphSExecDisconnectedEvent)(System::TObject* Sender, TiphSExecDisconnectedEventParams *e);
__property TiphSExecDisconnectedEvent 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 Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

Error Event (SExec Component)

Fired when information is available about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TiphSExecErrorEventParams;
typedef void __fastcall (__closure *TiphSExecErrorEvent)(System::TObject* Sender, TiphSExecErrorEventParams *e);
__property TiphSExecErrorEvent 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.

The ErrorCode parameter contains an error code, and the Description parameter 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 (SExec Component)

Fires once for each log message.

Syntax

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

Remarks

This event fires once for each log messages generated by the component. 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.

SSHCustomAuth Event (SExec Component)

Fired when the component is doing custom authentication.

Syntax

typedef struct {
  String Packet;
} TiphSExecSSHCustomAuthEventParams;
typedef void __fastcall (__closure *TiphSExecSSHCustomAuthEvent)(System::TObject* Sender, TiphSExecSSHCustomAuthEventParams *e);
__property TiphSExecSSHCustomAuthEvent OnSSHCustomAuth = { read=FOnSSHCustomAuth, write=FOnSSHCustomAuth };

Remarks

SSHCustomAuth is fired during the user authentication stage of the SSH logon process if SSHAuthMode is set to amCustom. Packet contains the raw last SSH packet sent by the server, in HEX-encoded format.

The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.

In all cases, Packet will start with the message type field.

To read the incoming packet call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (SExec Component)

Fired when the component receives a request for user input from the server.

Syntax

typedef struct {
  String Name;
  String Instructions;
  String Prompt;
  String Response;
  bool EchoResponse;
} TiphSExecSSHKeyboardInteractiveEventParams;
typedef void __fastcall (__closure *TiphSExecSSHKeyboardInteractiveEvent)(System::TObject* Sender, TiphSExecSSHKeyboardInteractiveEventParams *e);
__property TiphSExecSSHKeyboardInteractiveEvent OnSSHKeyboardInteractive = { read=FOnSSHKeyboardInteractive, write=FOnSSHKeyboardInteractive };

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the SSH logon process. During authentication, the component will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the component will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

Note: the server may send several prompts in a single packet. The component will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (SExec Component)

Fired after the server presents its public key to the client.

Syntax

typedef struct {
  String HostKey;
  DynamicArray<Byte> HostKeyB;
  String Fingerprint;
  String KeyAlgorithm;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TiphSExecSSHServerAuthenticationEventParams;
typedef void __fastcall (__closure *TiphSExecSSHServerAuthenticationEvent)(System::TObject* Sender, TiphSExecSSHServerAuthenticationEventParams *e);
__property TiphSExecSSHServerAuthenticationEvent OnSSHServerAuthentication = { read=FOnSSHServerAuthentication, write=FOnSSHServerAuthentication };

Remarks

This event is where the client can decide whether to continue with the connection process or not. If the public key is known to be a valid key for the SSH server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.

Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.

Accept may be set to True manually to accept the server host key.

Note that SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to true is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.

Host Key contains the full binary text of the key, in the same format used internally by SSH.

Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value see SSHFingerprintHashAlgorithm.

KeyAlgorithm identifies the host key algorithm. Supported values are:

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

CertSubject is the subject of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

SSHStatus Event (SExec Component)

Shows the progress of the secure connection.

Syntax

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

Remarks

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

Stderr Event (SExec Component)

Fired when data (complete lines) come in through stderr.

Syntax

typedef struct {
  String Text;
  DynamicArray<Byte> TextB;
} TiphSExecStderrEventParams;
typedef void __fastcall (__closure *TiphSExecStderrEvent)(System::TObject* Sender, TiphSExecStderrEventParams *e);
__property TiphSExecStderrEvent OnStderr = { read=FOnStderr, write=FOnStderr };

Remarks

The Stderr event is fired every time the process on the remote host outputs a line in its error output. The incoming data is provided through the Text parameter.

Stdout Event (SExec Component)

Fired when data (complete lines) come in through stdout.

Syntax

typedef struct {
  String Text;
  DynamicArray<Byte> TextB;
} TiphSExecStdoutEventParams;
typedef void __fastcall (__closure *TiphSExecStdoutEvent)(System::TObject* Sender, TiphSExecStdoutEventParams *e);
__property TiphSExecStdoutEvent OnStdout = { read=FOnStdout, write=FOnStdout };

Remarks

The Stdout event is fired every time the process on the remote host outputs a line in its standard output. The incoming data is provided through the Text parameter.

Config Settings (SExec Component)

SExec Config Settings

SSHClient Config Settings

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

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SExec Component)

SExec Errors

SSHClient Errors

The component may also return one of the following error codes, which are inherited from other components.

TCPClient Errors

TCP/IP Errors