Ssh DataFlex Reference Documentation

Ssh

Current Version: 9.5.0.73

A client-side SSH2 implementation for executing commands and shell sessions on Unix/Windows SSH servers.

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoSsh
Get Create(RefClass(cComChilkatSsh)) to hoSsh

Properties

AbortCurrent
Function ComAbortCurrent Returns Boolean
Procedure Set ComAbortCurrent Boolean value
Introduced in version 9.5.0.58

When set to True, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to False when the next method is called. When the abort occurs, this property is reset to False. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
AuthFailReason
Function ComAuthFailReason Returns Integer
Introduced in version 9.5.0.52

Set to one of the following values if a call to AuthenticatePw, AuthenticatePk, or AuthenticatePwPk returns a failed status.

  • 1: Transport failure. This is a failure to communicate with the server (i.e. the connection was lost, or a read or write failed or timed out).
  • 2: Invalid key for public key authentication. The key was not a valid format, not a valid key, not a private key, or not the right type of key.
  • 3: No matching authentication methods were available.
  • 4: SSH authentication protocol error - an unexpected or invalid message was received.
  • 5: The incorrect password or private key was provided.
  • 6: Already authenticated. The SSH session is already authenticated.
  • 7: Password change request: The server requires the password to be changed.

top
CaretControl
Function ComCaretControl Returns Boolean
Procedure Set ComCaretControl Boolean value
Introduced in version 9.5.0.49

Controls whether the caret character '^' is interpreted as indicating a control character. The default value of this property is False. If set to True, then the following sequences are interpreted as control characters in any string passed to SendReqExec or ChannelSendString.

^@ 	00 	00 	NUL  	Null
^A 	01 	01 	SOH  	Start of Heading
^B 	02 	02 	STX  	Start of Text
^C 	03 	03 	ETX  	End of Text
^D 	04 	04 	EOT  	End of Transmission
^E 	05 	05 	ENQ  	Enquiry
^F 	06 	06 	ACK  	Acknowledge
^G 	07 	07 	BEL  	Bell
^H 	08 	08 	BS  	Backspace
^I 	09 	09 	HT  	Character Tabulation, Horizontal Tabulation
^J 	10 	0A 	LF  	Line Feed
^K 	11 	0B 	VT  	Line Tabulation, Vertical Tabulation
^L 	12 	0C 	FF  	Form Feed
^M 	13 	0D 	CR  	Carriage Return
^N 	14 	0E 	SO  	Shift Out
^O 	15 	0F 	SI  	Shift In
^P 	16 	10 	DLE  	Data Link Escape
^Q 	17 	11 	DC1  	Device Control One (XON)
^R 	18 	12 	DC2  	Device Control Two
^S 	19 	13 	DC3  	Device Control Three (XOFF)
^T 	20 	14 	DC4  	Device Control Four
^U 	21 	15 	NAK  	Negative Acknowledge
^V 	22 	16 	SYN  	Synchronous Idle
^W 	23 	17 	ETB  	End of Transmission Block
^X 	24 	18 	CAN  	Cancel
^Y 	25 	19 	EM  	End of medium
^Z 	26 	1A 	SUB  	Substitute
^[ 	27 	1B 	ESC  	Escape
^\ 	28 	1C 	FS  	File Separator
^] 	29 	1D 	GS  	Group Separator
^^ 	30 	1E 	RS  	Record Separator
^_ 	31 	1F 	US  	Unit Separator
^? 	127 	7F 	DEL  	Delete

top
ChannelOpenFailCode
Function ComChannelOpenFailCode Returns Integer

If a request to open a channel fails, this property contains a code that identifies the reason for failure. The reason codes are defined in RFC 4254 and are reproduced here:

             Symbolic name                           reason code
             -------------                           -----------
            SSH_OPEN_ADMINISTRATIVELY_PROHIBITED          1
            SSH_OPEN_CONNECT_FAILED                       2
            SSH_OPEN_UNKNOWN_CHANNEL_TYPE                 3
            SSH_OPEN_RESOURCE_SHORTAGE                    4

top
ChannelOpenFailReason
Function ComChannelOpenFailReason Returns String

The descriptive text corresponding to the ChannelOpenFailCode property.

top
ClientIdentifier
Function ComClientIdentifier Returns String
Procedure Set ComClientIdentifier String value

The client-identifier string to be used when connecting to an SSH/SFTP server. Defaults to "SSH-2.0-PuTTY_Release_0.63". (This string is used to mimic PuTTY because some servers are known to disconnect from clients with unknown client identifiers.)

top
ClientIpAddress
Function ComClientIpAddress Returns String
Procedure Set ComClientIpAddress String value

The IP address to use for computers with multiple network interfaces or IP addresses. For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.

The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124".

top
ConnectTimeoutMs
Function ComConnectTimeoutMs Returns Integer
Procedure Set ComConnectTimeoutMs Integer value

Maximum number of milliseconds to wait when connecting to an SSH server.

top
DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DisconnectCode
Function ComDisconnectCode Returns Integer

If the SSH server sent a DISCONNECT message when closing the connection, this property contains the "reason code" as specified in RFC 4253:

           Symbolic name                                reason code
           -------------                                -----------
      SSH_DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT             1
      SSH_DISCONNECT_PROTOCOL_ERROR                          2
      SSH_DISCONNECT_KEY_EXCHANGE_FAILED                     3
      SSH_DISCONNECT_RESERVED                                4
      SSH_DISCONNECT_MAC_ERROR                               5
      SSH_DISCONNECT_COMPRESSION_ERROR                       6
      SSH_DISCONNECT_SERVICE_NOT_AVAILABLE                   7
      SSH_DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED          8
      SSH_DISCONNECT_HOST_KEY_NOT_VERIFIABLE                 9
      SSH_DISCONNECT_CONNECTION_LOST                        10
      SSH_DISCONNECT_BY_APPLICATION                         11
      SSH_DISCONNECT_TOO_MANY_CONNECTIONS                   12
      SSH_DISCONNECT_AUTH_CANCELLED_BY_USER                 13
      SSH_DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE         14
      SSH_DISCONNECT_ILLEGAL_USER_NAME                      15

top
DisconnectReason
Function ComDisconnectReason Returns String

If the SSH/ server sent a DISCONNECT message when closing the connection, this property contains a descriptive string for the "reason code" as specified in RFC 4253.

top
EnableCompression
Function ComEnableCompression Returns Boolean
Procedure Set ComEnableCompression Boolean value
Introduced in version 9.5.0.56

Enables or disables the use of compression w/ the SSH connection. The default value is True, meaning that compression is used if the server supports it.

Some older SSH servers have been found that claim to support compression, but actually fail when compression is used. PuTTY does not enable compression by default. If trouble is encountered where the SSH server disconnects immediately after the connection is seemingly established (i.e. during authentication), then check to see if disabling compression resolves the problem.

top
ForceCipher
Function ComForceCipher Returns String
Procedure Set ComForceCipher String value

Set to one of the following encryption algorithms to force that cipher to be used. By default, the component will automatically choose the first cipher supported by the server in the order listed here: "aes256-ctr", "aes128-ctr", "aes256-cbc", "aes128-cbc", "twofish256-cbc", "twofish128-cbc", "blowfish-cbc", "3des-cbc", "arcfour128", "arcfour256". (If blowfish is chosen, the encryption strength is 128 bits.)

Important: If this is property is set and the server does NOT support then encryption algorithm, then the Connect will fail.

top
HostKeyAlg
Function ComHostKeyAlg Returns String
Procedure Set ComHostKeyAlg String value

Indicates the preferred host key algorithm to be used in establishing the SSH secure connection. The default is "DSS". It may be changed to "RSA" if needed. Chilkat recommends not changing this unless a problem warrants the change.

top
HostKeyFingerprint
Function ComHostKeyFingerprint Returns String

Set after connecting to an SSH server. The format of the fingerprint looks like this: "ssh-rsa 1024 68:ff:d1:4e:6c:ff:d7:b0:d6:58:73:85:07:bc:2e:d5"

top
HttpProxyAuthMethod
Function ComHttpProxyAuthMethod Returns String
Procedure Set ComHttpProxyAuthMethod String value

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy authentication method name. Valid choices are "Basic" or "NTLM".

top
HttpProxyDomain
Function ComHttpProxyDomain Returns String
Procedure Set ComHttpProxyDomain String value

The NTLM authentication domain (optional) if NTLM authentication is used w/ the HTTP proxy.

top
HttpProxyHostname
Function ComHttpProxyHostname Returns String
Procedure Set ComHttpProxyHostname String value

If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).

More Information and Examples
top
HttpProxyPassword
Function ComHttpProxyPassword Returns String
Procedure Set ComHttpProxyPassword String value

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.

top
HttpProxyPort
Function ComHttpProxyPort Returns Integer
Procedure Set ComHttpProxyPort Integer value

If an HTTP proxy is to be used, set this property to the HTTP proxy port number. (Two commonly used HTTP proxy ports are 8080 and 3128.)

top
HttpProxyUsername
Function ComHttpProxyUsername Returns String
Procedure Set ComHttpProxyUsername String value

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.

More Information and Examples
top
IdleTimeoutMs
Function ComIdleTimeoutMs Returns Integer
Procedure Set ComIdleTimeoutMs Integer value

Causes SSH operations to fail when progress for sending or receiving data halts for more than this number of milliseconds. Setting IdleTimeoutMs = 0 (the default) allows the application to wait indefinitely.

top
IsConnected
Function ComIsConnected Returns Boolean

Returns True if the component is connected to an SSH server.

Note: The IsConnected property is set to True after successfully completing the Connect method call. The IsConnected property will only be set to False by calling Disconnect, or by the failure of another method call such that the disconnection is detected.

More Information and Examples
top
KeepSessionLog
Function ComKeepSessionLog Returns Boolean
Procedure Set ComKeepSessionLog Boolean value

Controls whether communications to/from the SSH server are saved to the SessionLog property. The default value is False. If this property is set to True, the contents of the SessionLog property will continuously grow as SSH activity transpires. The purpose of the KeepSessionLog / SessionLog properties is to help in debugging any future problems that may arise.

top
LastBinaryResult
Function ComLastBinaryResult Returns Variant
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
Function ComLastErrorHtml Returns String

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
Function ComLastErrorText Returns String

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
Function ComLastErrorXml Returns String

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
Function ComLastStringResult Returns String
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
MaxPacketSize
Function ComMaxPacketSize Returns Integer
Procedure Set ComMaxPacketSize Integer value

The maximum packet length to be used in the SSH transport protocol. The default value is 8192.

Note: If a large amount of data is to be flowing to/from the SSH server, then setting the MaxPacketSize equal to 32768 may improve performance. For those familiar with the inner workings of the SSH protocol, this is the "maximum packet size" value that is sent in the SSH_MSG_CHANNEL_OPEN message as defined in RFC 4254.

top
NumOpenChannels
Function ComNumOpenChannels Returns Integer

The number of currently open channels.

top
PasswordChangeRequested
Function ComPasswordChangeRequested Returns Boolean

Set by the AuthenticatePw and AuthenticatePwPk methods. If the authenticate method returns a failed status, and this property is set to True, then it indicates the server requested a password change. In this case, re-call the authenticate method, but provide both the old and new passwords in the following format, where vertical bar characters encapsulate the old and new passwords:

|oldPassword|newPassword|

top
PreferIpv6
Function ComPreferIpv6 Returns Boolean
Procedure Set ComPreferIpv6 Boolean value

If True, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is False, which will choose IPv4 over IPv6.

top
ReadTimeoutMs
Function ComReadTimeoutMs Returns Integer
Procedure Set ComReadTimeoutMs Integer value

The maximum amount of time to allow for reading messages/data from the SSH server. This is different from the IdleTimeoutMs property. The IdleTimeoutMs is the maximum amount of time to wait while no incoming data is arriving. The ReadTimeoutMs is the maximum amount of time to allow for reading data even if data is continuing to arrive. The default value of 0 indicates an infinite timeout value.

top
ReqExecCharset
Function ComReqExecCharset Returns String
Procedure Set ComReqExecCharset String value
Introduced in version 9.5.0.47

Indicates the charset to be used for the command sent via the SendReqExec method. The default is "ANSI". A likely alternate value would be "utf-8".

top
ServerIdentifier
Function ComServerIdentifier Returns String
Introduced in version 9.5.0.71

The server-identifier string received from the server during connection establishment. For example, a typical value would be similar to "SSH-2.0-OpenSSH_7.2p2 Ubuntu-4ubuntu2.2".

top
SessionLog
Function ComSessionLog Returns String

Contains a log of the messages sent to/from the SSH server. To enable session logging, set the KeepSessionLog property = True. Note: This property is not a filename -- it is a string property that contains the session log data.

top
SocksHostname
Function ComSocksHostname Returns String
Procedure Set ComSocksHostname String value

The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).

top
SocksPassword
Function ComSocksPassword Returns String
Procedure Set ComSocksPassword String value

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

top
SocksPort
Function ComSocksPort Returns Integer
Procedure Set ComSocksPort Integer value

The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).

top
SocksUsername
Function ComSocksUsername Returns String
Procedure Set ComSocksUsername String value

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

top
SocksVersion
Function ComSocksVersion Returns Integer
Procedure Set ComSocksVersion Integer value

SocksVersion May be set to one of the following integer values:

0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.

top
SoRcvBuf
Function ComSoRcvBuf Returns Integer
Procedure Set ComSoRcvBuf Integer value

Sets the receive buffer size socket option. Normally, this property should be left unchanged. The default value is 4194304.

This property can be increased if download performance seems slow. It is recommended to be a multiple of 4096.

top
SoSndBuf
Function ComSoSndBuf Returns Integer
Procedure Set ComSoSndBuf Integer value

Sets the send buffer size socket option. Normally, this property should be left unchanged. The default value is 262144.

This property can be increased if upload performance seems slow. It is recommended to be a multiple of 4096. Testing with sizes such as 512K and 1MB is reasonable.

top
StderrToStdout
Function ComStderrToStdout Returns Boolean
Procedure Set ComStderrToStdout Boolean value

If True, then stderr is redirected to stdout. In this case, channel output for both stdout and stderr is combined and retrievable via the following methods: GetReceivedData, GetReceivedDataN, GetReceivedText, GetReceivedTextS. If this property is False, then stderr is available separately via the GetReceivedStderr method.

The default value of this property is True.

Note: Most SSH servers do not send stderr output as "extended data" packets as specified in RFC 4254. The SessionLog may be examined to see if any CHANNEL_EXTENDED_DATA messages exist. If not, then all of the output (stdout + stderr) was sent via CHANNEL_DATA messages, and therefore it is not possible to differentiate stderr output from stdout. In summary: This feature will not work for most SSH servers.

top
StripColorCodes
Function ComStripColorCodes Returns Boolean
Procedure Set ComStripColorCodes Boolean value
Introduced in version 9.5.0.67

If True, then terminal color codes are stripped from the received text. The default value of this property is True. (Color codes are non-printable escape sequences that provide information about color for text in a terminal.)

top
TcpNoDelay
Function ComTcpNoDelay Returns Boolean
Procedure Set ComTcpNoDelay Boolean value

Controls whether the TCP_NODELAY socket option is used for the underlying TCP/IP socket. The default value is True. This disables the Nagle algorithm and allows for better performance when small amounts of data are sent to/from the SSH server.

top
UncommonOptions
Function ComUncommonOptions Returns String
Procedure Set ComUncommonOptions String value
Introduced in version 9.5.0.73

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty.

As of v9.5.0.73, the only possible value is:

  • "KEX_DH_GEX_REQUEST_OLD" - Force the old Group Exchange message to be used. This would be used for very old SSH server implementations that do not use the RFC standard for diffie-hellman-group-exchange.

top
UserAuthBanner
Function ComUserAuthBanner Returns String
Procedure Set ComUserAuthBanner String value
Introduced in version 9.5.0.46

If a user authentication banner message is received during authentication, it will be made available here. An application can check to see if this property contains a banner string after calling StartKeyboardAuth. It is only possible for an application to display this message if it is doing keyboard-interactive authentication via the StartKeyboardAuth and ContinueKeyboardAuth methods.

top
VerboseLogging
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Function ComVersion Returns String

Version of the component/library, such as "9.5.0.63"

top

Methods

AuthenticatePk
Function ComAuthenticatePk String username cComChilkatSshKey privateKey Returns Boolean

Authenticates with the SSH server using public-key authentication. The corresponding public key must have been installed on the SSH server for the username. Authentication will succeed if the matching privateKey is provided.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Returns True for success, False for failure.

top
AuthenticatePkAsync (1)
Function ComAuthenticatePkAsync String username cComChilkatSshKey privateKey Returns cComChilkatTask

Creates an asynchronous task to call the AuthenticatePk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
AuthenticatePw
Function ComAuthenticatePw String login String password Returns Boolean

Authenticates with the SSH server using a login and password.

An SSH session always begins by first calling Connect to connect to the SSH server, and then calling either AuthenticatePw or AuthenticatePk to login.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.
Note: To learn about how to handle password change requests, see the PasswordChangeRequested property (above).

Returns True for success, False for failure.

top
AuthenticatePwAsync (1)
Function ComAuthenticatePwAsync String login String password Returns cComChilkatTask

Creates an asynchronous task to call the AuthenticatePw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
AuthenticatePwPk
Function ComAuthenticatePwPk String username String password cComChilkatSshKey privateKey Returns Boolean

Authentication for SSH servers that require both a password and private key. (Most SSH servers are configured to require one or the other, but not both.)

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Returns True for success, False for failure.

top
AuthenticatePwPkAsync (1)
Function ComAuthenticatePwPkAsync String username String password cComChilkatSshKey privateKey Returns cComChilkatTask

Creates an asynchronous task to call the AuthenticatePwPk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
AuthenticateSecPw
Function ComAuthenticateSecPw cComChilkatSecureString login cComChilkatSecureString password Returns Boolean
Introduced in version 9.5.0.71

The same as AuthenticatePw, except the login and passwords strings are passed in secure string objects.

Returns True for success, False for failure.

More Information and Examples
top
AuthenticateSecPwAsync (1)
Function ComAuthenticateSecPwAsync cComChilkatSecureString login cComChilkatSecureString password Returns cComChilkatTask
Introduced in version 9.5.0.71

Creates an asynchronous task to call the AuthenticateSecPw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
AuthenticateSecPwPk
Function ComAuthenticateSecPwPk cComChilkatSecureString username cComChilkatSecureString password cComChilkatSshKey privateKey Returns Boolean
Introduced in version 9.5.0.71

The same as AuthenticatePwPk, except the login and passwords strings are passed in secure string objects.

Returns True for success, False for failure.

top
AuthenticateSecPwPkAsync (1)
Function ComAuthenticateSecPwPkAsync cComChilkatSecureString username cComChilkatSecureString password cComChilkatSshKey privateKey Returns cComChilkatTask
Introduced in version 9.5.0.71

Creates an asynchronous task to call the AuthenticateSecPwPk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelIsOpen
Function ComChannelIsOpen Integer channelNum Returns Boolean

Returns True if the channel indicated by channelNum is open. Otherwise returns False.

top
ChannelPoll
Function ComChannelPoll Integer channelNum Integer pollTimeoutMs Returns Integer

Polls for incoming data on an open channel. This method will read a channel, waiting at most pollTimeoutMs milliseconds for data to arrive. Return values are as follows:

-1 -- Error. Check the IsConnected property to see if the connection to the SSH server is still valid. Also, call ChannelIsOpen to see if the channel remains open. The LastErrorText property will contain more detailed information regarding the error.

-2 -- No additional data was received prior to the poll timeout.

>0 -- Additional data was received and the return value indicates how many bytes are available to be "picked up". Methods that read data on a channel do not return the received data directly. Instead, they return an integer to indicate how many bytes are available to be "picked up". An application picks up the available data by calling GetReceivedData or GetReceivedText.

=0 -- A zero can be returned if the channel EOF has already been received, or if the channel had already been closed.

top
ChannelPollAsync (1)
Function ComChannelPollAsync Integer channelNum Integer pollTimeoutMs Returns cComChilkatTask

Creates an asynchronous task to call the ChannelPoll method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelRead
Function ComChannelRead Integer channelNum Returns Integer

Reads incoming data on an open channel. This method will read a channel, waiting at most IdleTimeoutMs milliseconds for data to arrive. Return values are as follows:

-1 -- Error. Check the IsConnected property to see if the connection to the SSH server is still valid. Also, call ChannelIsOpen to see if the channel remains open. The LastErrorText property will contain more detailed information regarding the error.

-2 -- No additional data was received prior to the IdleTimeoutMs timeout.

>0 -- Additional data was received and the return value indicates how many bytes are available to be "picked up". Methods that read data on a channel do not return the received data directly. Instead, they return an integer to indicate how many bytes are available to be "picked up". An application picks up the available data by calling GetReceivedData or GetReceivedText.

=0 -- A zero can be returned if the channel EOF has already been received, or if the channel had already been closed.

top
ChannelReadAsync (1)
Function ComChannelReadAsync Integer channelNum Returns cComChilkatTask

Creates an asynchronous task to call the ChannelRead method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelReadAndPoll
Function ComChannelReadAndPoll Integer channelNum Integer pollTimeoutMs Returns Integer

Reads incoming data on an open channel and continues reading until no data arrives for pollTimeoutMs milliseconds. The first read will wait a max of IdleTimeoutMs milliseconds before timing out. Subsequent reads wait a max of pollTimeoutMs milliseconds before timing out.

The idea behind ChannelReadAndPoll is to capture the output of a shell command. One might imagine the typical sequence of events when executing a shell command to be like this: (1) client sends command to server, (2) server executes the command (i.e. it's computing...), potentially taking some amount of time, (3) output is streamed back to the client. It makes sense for the client to wait a longer period of time for the first data to arrive, but once it begins arriving, the timeout can be shortened. This is exactly what ChannelReadAndPoll does -- the first timeout is controlled by the IdleTimeoutMs property, while the subsequent reads (once output starts flowing) is controlled by pollTimeoutMs.

Return values are as follows:
-1 -- Error. Check the IsConnected property to see if the connection to the SSH server is still valid. Also, call ChannelIsOpen to see if the channel remains open. The LastErrorText property will contain more detailed information regarding the error.

-2 -- No additional data was received prior to the IdleTimeoutMs timeout.

>0 -- Additional data was received and the return value indicates how many bytes are available to be "picked up". Methods that read data on a channel do not return the received data directly. Instead, they return an integer to indicate how many bytes are available to be "picked up". An application picks up the available data by calling GetReceivedData or GetReceivedText.

=0 -- A zero can be returned if the channel EOF has already been received, or if the channel had already been closed.

top
ChannelReadAndPollAsync (1)
Function ComChannelReadAndPollAsync Integer channelNum Integer pollTimeoutMs Returns cComChilkatTask

Creates an asynchronous task to call the ChannelReadAndPoll method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelReadAndPoll2
Function ComChannelReadAndPoll2 Integer channelNum Integer pollTimeoutMs Integer maxNumBytes Returns Integer

The same as ChannelReadAndPoll, except this method will return as soon as maxNumBytes is exceeded, which may be as large as the MaxPacketSize property setting.

top
ChannelReadAndPoll2Async (1)
Function ComChannelReadAndPoll2Async Integer channelNum Integer pollTimeoutMs Integer maxNumBytes Returns cComChilkatTask

Creates an asynchronous task to call the ChannelReadAndPoll2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelReceivedClose
Function ComChannelReceivedClose Integer channelNum Returns Boolean

True if a CLOSE message has been received on the channel indicated by channelNum. When a CLOSE is received, no subsequent data should be sent in either direction -- the channel is closed in both directions.

top
ChannelReceivedEof
Function ComChannelReceivedEof Integer channelNum Returns Boolean

True if an EOF message has been received on the channel indicated by channelNum. When an EOF is received, no more data will be forthcoming on the channel. However, data may still be sent in the opposite direction.

top
ChannelReceivedExitStatus
Function ComChannelReceivedExitStatus Integer channelNum Returns Boolean

True if an exit status code was received on the channel. Otherwise False.

top
ChannelReceiveToClose
Function ComChannelReceiveToClose Integer channelNum Returns Boolean

Reads incoming data on an open channel until the channel is closed by the server. If successful, the number of bytes available to be "picked up" can be determined by calling GetReceivedNumBytes. The received data may be retrieved by calling GetReceivedData or GetReceivedText.

Returns True for success, False for failure.

top
ChannelReceiveToCloseAsync (1)
Function ComChannelReceiveToCloseAsync Integer channelNum Returns cComChilkatTask

Creates an asynchronous task to call the ChannelReceiveToClose method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelReceiveUntilMatch
Function ComChannelReceiveUntilMatch Integer channelNum String matchPattern String charset Boolean caseSensitive Returns Boolean

Reads incoming text data on an open channel until the received data matches the matchPattern. For example, to receive data until the string "Hello World" arrives, set matchPattern equal to "*Hello World*". charset indicates the character encoding of the text being received ("iso-8859-1" for example). caseSensitive may be set to True for case sensitive matching, or False for case insensitive matching.

Returns True if text data matching matchPattern was received and is available to be picked up by calling GetReceivedText (or GetReceivedTextS). IMPORTANT: This method may read beyond the matching text. Call GetReceivedTextS to extract only the data up-to and including the matching text.

Important Notes:

  • It's wise to set the ReadTimeoutMs property to a non-zero value to prevent an infinite wait if the matchPattern never arrives.
  • If using a shell session and SendReqPty was called, set the termType = "dumb". If terminal control codes get mixed into the output stream, it could disrupt matching.
  • Be aware of the StderrToStdout property setting. The default value is true, which means that stderr is mixed with stdout in the output stream. This could disrupt matching. Set StderrToStdout to false to prevent this possibility.

Returns True for success, False for failure.

top
ChannelReceiveUntilMatchAsync (1)
Function ComChannelReceiveUntilMatchAsync Integer channelNum String matchPattern String charset Boolean caseSensitive Returns cComChilkatTask

Creates an asynchronous task to call the ChannelReceiveUntilMatch method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelReceiveUntilMatchN
Function ComChannelReceiveUntilMatchN Integer channelNum cComCkStringArray matchPatterns String charset Boolean caseSensitive Returns Boolean

The same as ChannelReceiveUntilMatch except that the method returns when any one of the match patterns specified in matchPatterns are received on the channel.

Important: It's wise to set the ReadTimeoutMs property to a non-zero value to prevent an infinite wait if of the matchPatterns ever arrives.

Returns True for success, False for failure.

More Information and Examples
top
ChannelReceiveUntilMatchNAsync (1)
Function ComChannelReceiveUntilMatchNAsync Integer channelNum cComCkStringArray matchPatterns String charset Boolean caseSensitive Returns cComChilkatTask

Creates an asynchronous task to call the ChannelReceiveUntilMatchN method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelRelease
Procedure ComChannelRelease Integer channelNum
Introduced in version 9.5.0.44

Releases the internal memory resources for a channel previously opened by OpenSessionChannel, OpenCustomChannel, or OpenDirectTcpIpChannel. It is not absolutely necessary to call this method because the internal memory resources for all channels are automatically released when the SSH object instance is deleted/disposed. This method becomes necessary only when an extremely large number of channels within the same SSH object instance are opened, used, and closed over a long period of time.

top
ChannelSendClose
Function ComChannelSendClose Integer channelNum Returns Boolean

Sends a CLOSE message to the server for the channel indicated by channelNum. This closes both directions of the bidirectional channel.

Returns True for success, False for failure.

top
ChannelSendCloseAsync (1)
Function ComChannelSendCloseAsync Integer channelNum Returns cComChilkatTask

Creates an asynchronous task to call the ChannelSendClose method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelSendData
Function ComChannelSendData Integer channelNum Variant byteData Returns Boolean

Sends byte data on the channel indicated by channelNum.

Returns True for success, False for failure.

top
ChannelSendDataAsync (1)
Function ComChannelSendDataAsync Integer channelNum Variant byteData Returns cComChilkatTask

Creates an asynchronous task to call the ChannelSendData method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelSendEof
Function ComChannelSendEof Integer channelNum Returns Boolean

Sends an EOF for the channel indicated by channelNum. Once an EOF is sent, no additional data may be sent on the channel. However, the channel remains open and additional data may still be received from the server.

Returns True for success, False for failure.

top
ChannelSendEofAsync (1)
Function ComChannelSendEofAsync Integer channelNum Returns cComChilkatTask

Creates an asynchronous task to call the ChannelSendEof method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ChannelSendString
Function ComChannelSendString Integer channelNum String textData String charset Returns Boolean

Sends character data on the channel indicated by channelNum. The text is converted to the charset indicated by charset prior to being sent. A list of supported charset values may be found on this page: Supported Charsets.

Returns True for success, False for failure.

top
ChannelSendStringAsync (1)
Function ComChannelSendStringAsync Integer channelNum String textData String charset Returns cComChilkatTask

Creates an asynchronous task to call the ChannelSendString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
CheckConnection
Function ComCheckConnection Returns Boolean
Introduced in version 9.5.0.46

Returns True if the underlying TCP socket is connected to the SSH server.

top
ClearTtyModes
Procedure ComClearTtyModes

Clears the collection of TTY modes that are sent with the SendReqPty method.

top
Connect
Function ComConnect String domainName Integer port Returns Boolean

Connects to the SSH server at domainName:port

The domainName may be a domain name or an IPv4 or IPv6 address in string format.

Internally, the following SSH connection protocol algorithms are supported:

  • Hostkey Types: ssh-rsa, ssh-dsa, ecdsa-sha2-nistp256, rsa-sha2-256, rsa-sha2-512, ssh-ed25519
  • Key Exchange Methods: curve25519-sha256@libssh.org, ecdh-sha2-nistp256, ecdh-sha2-nistp384, ecdh-sha2-nistp521, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group14-sha1, diffie-hellman-group1-sha1
  • Ciphers: chacha20-poly1305@openssh.com, aes256-ctr, aes192-ctr, aes128-ctr, aes256-cbc, aes192-cbc, aes128-cbc, twofish256-cbc, twofish128-cbc, blowfish-cbc, 3des-cbc, arcfour128, arcfour256
  • MAC Algorithms: hmac-sha2-256, hmac-sha2-512, hmac-sha1, hmac-md5, hmac-ripemd160, hmac-sha1-96
  • Compression: none, zlib, zlib@openssh.com

Important: All TCP-based Internet communications, regardless of the protocol (such as HTTP, FTP, SSH, IMAP, POP3, SMTP, etc.), and regardless of SSL/TLS, begin with establishing a TCP connection to a remote host:port. External security-related infrastructure such as software firewalls (Windows Firewall), hardware firewalls, anti-virus, at either source or destination (or both) can block the connection. If the connection fails, make sure to check all potential external causes of blockage.

Returns True for success, False for failure.

top
ConnectAsync (1)
Function ComConnectAsync String domainName Integer port Returns cComChilkatTask

Creates an asynchronous task to call the Connect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ConnectThroughSsh
Function ComConnectThroughSsh cComChilkatSsh ssh String hostname Integer port Returns Boolean
Introduced in version 9.5.0.55

Connects to an SSH server through an existing SSH connection. The ssh is an existing connected and authenticated SSH object. The connection to hostname:port is made through the existing SSH connection via port-forwarding. If successful, the connection is as follows: application => ServerSSH1 => ServerSSH2. (where ServerSSH1 is the ssh and ServerSSH2 is the SSH server at hostname:port) Once connected in this way, all communications are routed through ServerSSH1 to ServerSSH2. This includes authentication -- which means the application must still call one of the Authenticate* methods to authenticate with ServerSSH2.

Returns True for success, False for failure.

More Information and Examples
top
ConnectThroughSshAsync (1)
Function ComConnectThroughSshAsync cComChilkatSsh ssh String hostname Integer port Returns cComChilkatTask
Introduced in version 9.5.0.55

Creates an asynchronous task to call the ConnectThroughSsh method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ContinueKeyboardAuth
Function ComContinueKeyboardAuth String response Returns String
Introduced in version 9.5.0.46

Continues keyboard-interactive authentication with the SSH server. The response is typically the password. If multiple responses are required (because there were multiple prompts in the infoRequest XML returned by StartKeyboardAuth), then the response should be formatted as XML (as shown below) otherwise the response simply contains the single response string.

<response>
    <response1>response to first prompt</response1>
    <response2>response to second prompt</response2>
    ...
    <responseN>response to Nth prompt</responseN>
</response>

If the interactive authentication completed with success or failure, the XML response will be:

<success>success_message</success>

or

<error>error_message</error>
If additional steps are required to complete the interactive authentication, then an XML string that provides the name, instruction, and prompts is returned. The XML has the following format:
 	<infoRequest numPrompts="N">
	    <name>name_string</name>
	    <instruction>instruction_string</instruction>
	    <prompt1 echo="1_or_0">prompt_string</prompt1>
	    ...
	    <promptN echo="1_or_0">prompt_string</promptN>
	</infoRequest>

Returns null on failure

More Information and Examples
top
ContinueKeyboardAuthAsync (1)
Function ComContinueKeyboardAuthAsync String response Returns cComChilkatTask
Introduced in version 9.5.0.46

Creates an asynchronous task to call the ContinueKeyboardAuth method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
Disconnect
Procedure ComDisconnect

Disconnects from the SSH server.

top
GetChannelExitStatus
Function ComGetChannelExitStatus Integer channelNum Returns Integer

Returns the exit status code for a channel. This method should only be called if an exit status has been received. You may check to see if the exit status was received by calling ChannelReceivedExitStatus.

top
GetChannelNumber
Function ComGetChannelNumber Integer index Returns Integer

Returns the channel number for the Nth open channel. Indexing begins at 0, and the number of currently open channels is indicated by the NumOpenChannels property. Returns -1 if the index is out of range.

top
GetChannelType
Function ComGetChannelType Integer index Returns String

Returns a string describing the channel type for the Nth open channel. Channel types are: "session", "x11", "forwarded-tcpip", and "direct-tcpip".

Returns null on failure

top
GetReceivedData
Function ComGetReceivedData Integer channelNum Returns Variant

Returns the accumulated data received on the channel indicated by channelNum and clears the channel's internal receive buffer.

Returns null on failure

top
GetReceivedDataN
Function ComGetReceivedDataN Integer channelNum Integer maxNumBytes Returns Variant

Same as GetReceivedData, but a maximum of maxNumBytes bytes is returned.

Returns null on failure

top
GetReceivedNumBytes
Function ComGetReceivedNumBytes Integer channelNum Returns Integer

Returns the number of bytes available in the internal receive buffer for the specified channelNum. The received data may be retrieved by calling GetReceivedData or GetReceivedText.

top
GetReceivedStderr
Function ComGetReceivedStderr Integer channelNum Returns Variant
Introduced in version 9.5.0.48

Returns the accumulated stderr bytes received on the channel indicated by channelNum and clears the channel's internal stderr receive buffer.

Note: If the StderrToStdout property is set to True, then stderr is automatically redirected to stdout. This is the default behavior. The following methods can be called to retrieve the channel's stdout: GetReceivedData, GetReceivedDataN, GetReceivedText, and GetReceivedTextS.

Returns null on failure

top
GetReceivedStderrText
Function ComGetReceivedStderrText Integer channelNum String charset Returns String

Returns the accumulated stderr text received on the channel indicated by channelNum and clears the channel's internal receive buffer. The charset indicates the charset of the character data in the internal receive buffer. A list of supported charset values may be found on this page: Supported Charsets.

Returns null on failure

top
GetReceivedText
Function ComGetReceivedText Integer channelNum String charset Returns String

Returns the accumulated text received on the channel indicated by channelNum and clears the channel's internal receive buffer. The charset indicates the charset of the character data in the internal receive buffer. A list of supported charset values may be found on this page: Supported Charsets.

Returns null on failure

top
GetReceivedTextS
Function ComGetReceivedTextS Integer channelNum String substr String charset Returns String

The same as GetReceivedText, except only the text up to and including substr is returned. The text returned is removed from the internal receive buffer. If the substr was not found in the internal receive buffer, an empty string is returned and the internal receive buffer is not modified.

Returns null on failure

top
OpenCustomChannel
Function ComOpenCustomChannel String channelType Returns Integer

Opens a custom channel with a custom server that uses the SSH protocol. The channelType is application-defined.

If successful, the channel number is returned. This is the number that should be passed to any method requiring a channel number. A -1 is returned upon failure.

top
OpenCustomChannelAsync (1)
Function ComOpenCustomChannelAsync String channelType Returns cComChilkatTask

Creates an asynchronous task to call the OpenCustomChannel method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
OpenDirectTcpIpChannel
Function ComOpenDirectTcpIpChannel String targetHostname Integer targetPort Returns Integer

Open a direct-tcpip channel for port forwarding. Data sent on the channel via ChannelSend* methods is sent to the SSH server and then forwarded to targetHostname:targetPort. The SSH server automatically forwards data received from targetHostname:targetPort to the SSH client. Therefore, calling ChannelRead* and ChannelReceive* methods is equivalent to reading directly from targetHostname:targetPort.

If successful, the channel number is returned. This is the number that should be passed to any method requiring a channel number. A -1 is returned upon failure.

top
OpenDirectTcpIpChannelAsync (1)
Function ComOpenDirectTcpIpChannelAsync String targetHostname Integer targetPort Returns cComChilkatTask

Creates an asynchronous task to call the OpenDirectTcpIpChannel method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
OpenSessionChannel
Function ComOpenSessionChannel Returns Integer

Opens a new session channel. Almost everything you will do with the Chilkat SSH component will involve opening a session channel. The normal sequence of operation is typically this: 1) Connect to the SSH server. 2) Authenticate. 3) Open a session channel. 4) do something on the channel such as opening a shell, execute a command, etc.

If successful, the channel number is returned. This is the number that should be passed to any method requiring a channel number. A -1 is returned upon failure.

top
OpenSessionChannelAsync (1)
Function ComOpenSessionChannelAsync Returns cComChilkatTask

Creates an asynchronous task to call the OpenSessionChannel method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
PeekReceivedText
Function ComPeekReceivedText Integer channelNum String charset Returns String

This is the same as GetReceivedText, except the internal receive buffer is not cleared.

Returns null on failure

top
QuickCmdCheck
Function ComQuickCmdCheck Integer pollTimeoutMs Returns Integer
Introduced in version 9.5.0.65

Returns a channel number for a completed command that was previously sent via QuickCmdSend. Returns -1 if no commands have yet completed. The pollTimeoutMs indicates how long to wait (in milliseconds) for any command in progress (on any channel) to complete before returning -1.

Returns -2 if an error occurred (for example, if the connection to the SSH server was lost while checking for responses).

top
QuickCmdCheckAsync (1)
Function ComQuickCmdCheckAsync Integer pollTimeoutMs Returns cComChilkatTask
Introduced in version 9.5.0.65

Creates an asynchronous task to call the QuickCmdCheck method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
QuickCmdSend
Function ComQuickCmdSend String command Returns Integer
Introduced in version 9.5.0.65

Sends a command and returns the channel number for the command that has started. This is the equivalent of calling OpenSessionChannel, followed by SendReqExec. A value of -1 is returned on failure.

The ReqExecCharset property controls the charset used for the command that is sent.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

top
QuickCmdSendAsync (1)
Function ComQuickCmdSendAsync String command Returns cComChilkatTask
Introduced in version 9.5.0.65

Creates an asynchronous task to call the QuickCmdSend method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
QuickCommand
Function ComQuickCommand String command String charset Returns String
Introduced in version 9.5.0.65

Simplified method for executing a remote command and getting the complete output. This is the equivalent of calling OpenSessionChannel, followed by SendReqExec, then ChannelReceiveToClose, and finally GetReceivedText.

The charset indicates the charset of the command's output (such as "utf-8" or "ansi"). A list of supported charset values may be found on this page: Supported Charsets.

The ReqExecCharset property controls the charset used for the command that is sent.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Returns null on failure

More Information and Examples
top
QuickCommandAsync (1)
Function ComQuickCommandAsync String command String charset Returns cComChilkatTask
Introduced in version 9.5.0.65

Creates an asynchronous task to call the QuickCommand method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
QuickShell
Function ComQuickShell Returns Integer
Introduced in version 9.5.0.65

Simplified method for starting a remote shell session. It is the equivalent of calling OpenSessionChannel, followed by SendReqPty, and finally SendReqShell.

Returns the SSH channel number for the session, or -1 if not successful.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

More Information and Examples
top
QuickShellAsync (1)
Function ComQuickShellAsync Returns cComChilkatTask
Introduced in version 9.5.0.65

Creates an asynchronous task to call the QuickShell method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
ReKey
Function ComReKey Returns Boolean

Initiates a re-key with the SSH server. The ReKey method does not return until the key re-exchange is complete.

RFC 4253 (the SSH Transport Layer Protocol) recommends that keys be changed after each gigabyte of transmitted data or after each hour of connection time, whichever comes sooner. Key re-exchange is a public-key operation and requires a fair amount of processing power and should not be performed too often. Either side (client or server) may initiate a key re-exchange at any time.

In most cases, a server will automatically initiate key re-exchange whenever it deems necessary, and the Chilkat SSH component handles these transparently. For example, if the Chilkat SSH component receives a re-key message from the server while in the process of receiving data on a channel, it will automatically handle the key re-exchange and the application will not even realize that an underlying key re-exchange occurred.

Returns True for success, False for failure.

top
ReKeyAsync (1)
Function ComReKeyAsync Returns cComChilkatTask

Creates an asynchronous task to call the ReKey method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendIgnore
Function ComSendIgnore Returns Boolean

Sends an IGNORE message to the SSH server. This is one way of verifying that the connection to the SSH server is open and valid. The SSH server does not respond to an IGNORE message. It simply ignores it. IGNORE messages are not associated with a channel (in other words, you do not need to first open a channel prior to sending an IGNORE message).

Returns True for success, False for failure.

top
SendIgnoreAsync (1)
Function ComSendIgnoreAsync Returns cComChilkatTask

Creates an asynchronous task to call the SendIgnore method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqExec
Function ComSendReqExec Integer channelNum String commandLine Returns Boolean

Initiates execution of a command on the channel specified by channelNum. The commandLine contains the full command line including any command-line parameters (just as you would type the command at a shell prompt).

The user's default shell (typically defined in /etc/password in UNIX systems) is started on the SSH server to execute the command.

Important: A channel only exists for a single request. You may not call SendReqExec multiple times on the same open channel. The reason is that the SSH server automatically closes the channel at the end of the exec. The solution is to call OpenSessionChannel to get a new channel, and then call SendReqExec using the new channel. It is OK to have more than one channel open simultaneously.

Charset: The ReqExecCharset property has been added in version 9.5.0.47. This can be set to control the character encoding of the command sent to the server. The default is ANSI. A likely alternative value is "utf-8".

Returns True for success, False for failure.

top
SendReqExecAsync (1)
Function ComSendReqExecAsync Integer channelNum String commandLine Returns cComChilkatTask

Creates an asynchronous task to call the SendReqExec method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqPty
Function ComSendReqPty Integer channelNum String termType Integer widthInChars Integer heightInChars Integer widthInPixels Integer heightInPixels Returns Boolean

Requests a pseudo-terminal for a session channel. If the termType is a character oriented terminal ("vt100" for example), then widthInChars and heightInChars would be set to non-zero values, while widthInPixels and heightInPixels may be set to 0. If termType is pixel-oriented, such as "xterm", the reverse is true (i.e. set widthInPixels and heightInPixels, but set widthInChars and heightInChars equal to 0).

In most cases, you probably don't even want terminal emulation. In that case, try setting termType = "dumb". Terminal emulation causes terminal escape sequences to be included with shell command output. A "dumb" terminal should have no escape sequences.

Some SSH servers allow a shell to be started (via the SendReqShell method) without the need to first request a pseudo-terminal. The normal sequence for starting a remote shell is as follows:

1) Connect
2) Authenticate
3) OpenSessionChannel
4) Request a PTY via this method if necessary.
5) Start a shell by calling SendReqShell

Returns True for success, False for failure.

More Information and Examples
top
SendReqPtyAsync (1)
Function ComSendReqPtyAsync Integer channelNum String termType Integer widthInChars Integer heightInChars Integer widthInPixels Integer heightInPixels Returns cComChilkatTask

Creates an asynchronous task to call the SendReqPty method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqSetEnv
Function ComSendReqSetEnv Integer channelNum String name String value Returns Boolean

Sets an environment variable in the remote shell.

Returns True for success, False for failure.

top
SendReqSetEnvAsync (1)
Function ComSendReqSetEnvAsync Integer channelNum String name String value Returns cComChilkatTask

Creates an asynchronous task to call the SendReqSetEnv method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqShell
Function ComSendReqShell Integer channelNum Returns Boolean

Starts a shell on an open session channel. Some SSH servers require that a PTY (pseudo-terminal) first be requested prior to starting a shell. In that case, call SendReqPty prior to calling this method. Once a shell is started, commands may be sent by calling ChannelSendString. (Don't forget to terminate commands with a CRLF).

Returns True for success, False for failure.

More Information and Examples
top
SendReqShellAsync (1)
Function ComSendReqShellAsync Integer channelNum Returns cComChilkatTask

Creates an asynchronous task to call the SendReqShell method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqSignal
Function ComSendReqSignal Integer channelNum String signalName Returns Boolean

Delivers a signal to the remote process/service. signalName is one of the following: ABRT, ALRM, FPE, HUP, ILL, INT, KILL, PIPE, QUIT, SEGV, TERM, USR1, USR2. (Obviously, these are UNIX signals, so the remote SSH server would need to be a Unix/Linux system.)

Returns True for success, False for failure.

top
SendReqSignalAsync (1)
Function ComSendReqSignalAsync Integer channelNum String signalName Returns cComChilkatTask

Creates an asynchronous task to call the SendReqSignal method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqSubsystem
Function ComSendReqSubsystem Integer channelNum String subsystemName Returns Boolean

Executes a pre-defined subsystem. The SFTP protocol (Secure File Transfer Protocol) is started by the Chilkat SFTP component by starting the "sftp" subsystem.

Returns True for success, False for failure.

top
SendReqSubsystemAsync (1)
Function ComSendReqSubsystemAsync Integer channelNum String subsystemName Returns cComChilkatTask

Creates an asynchronous task to call the SendReqSubsystem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqWindowChange
Function ComSendReqWindowChange Integer channelNum Integer widthInChars Integer heightInRows Integer pixWidth Integer pixHeight Returns Boolean

When the client-side window (terminal) size changes, this message may be sent to the server to inform it of the new size.

top
SendReqWindowChangeAsync (1)
Function ComSendReqWindowChangeAsync Integer channelNum Integer widthInChars Integer heightInRows Integer pixWidth Integer pixHeight Returns cComChilkatTask

Creates an asynchronous task to call the SendReqWindowChange method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqX11Forwarding
Function ComSendReqX11Forwarding Integer channelNum Boolean singleConnection String authProt String authCookie Integer screenNum Returns Boolean

Allows the client to send an X11 forwarding request to the server. Chilkat only provides this functionality because it is a message defined in the SSH connection protocol. Chilkat has no advice for when or why it would be needed.

top
SendReqX11ForwardingAsync (1)
Function ComSendReqX11ForwardingAsync Integer channelNum Boolean singleConnection String authProt String authCookie Integer screenNum Returns cComChilkatTask

Creates an asynchronous task to call the SendReqX11Forwarding method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SendReqXonXoff
Function ComSendReqXonXoff Integer channelNum Boolean clientCanDo Returns Boolean

This method should be ignored and not used.

top
SendReqXonXoffAsync (1)
Function ComSendReqXonXoffAsync Integer channelNum Boolean clientCanDo Returns cComChilkatTask

Creates an asynchronous task to call the SendReqXonXoff method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
SetTtyMode
Function ComSetTtyMode String ttyName Integer ttyValue Returns Boolean

Sets a TTY mode that is included in the SendReqPty method call. Most commonly, it is not necessary to call this method at all. Chilkat has no recommendations or expertise as to why or when a particular mode might be useful. This capability is provided because it is defined in the SSH connection protocol specification.

This method can be called multiple times to set many terminal mode flags (one per call).

The ttyValue is an integer, typically 0 or 1. Valid ttyName flag names include: VINTR, VQUIT, VERASE, VKILL, VEOF, VEOL, VEOL2, VSTART, VSTOP, VSUSP, VDSUSP, VREPRINT, VWERASE, VLNEXT, VFLUSH, VSWTCH, VSTATUS, VDISCARD, IGNPAR, PARMRK, INPCK, ISTRIP, INLCR, IGNCR, ICRNL, IUCLC, IXON, IXANY, IXOFF, IMAXBEL, ISIG, ICANON, XCASE, ECHO, ECHOE, ECHOK, ECHONL, NOFLSH, TOSTOP, IEXTEN, ECHOCTL, ECHOKE, PENDIN, OPOST, OLCUC, ONLCR, OCRNL, ONOCR, ONLRET, CS7, CS8, PARENB, PARODD, TTY_OP_ISPEED, TTY_OP_OSPEED

top
StartKeyboardAuth
Function ComStartKeyboardAuth String login Returns String
Introduced in version 9.5.0.46

Begins keyboard-interactive authentication with the SSH server. Returns an XML string providing the name, instruction, and prompts. The XML has the following format:

 	<infoRequest numPrompts="N">
	    <name>name_string</name>
	    <instruction>instruction_string</instruction>
	    <prompt1 echo="1_or_0">prompt_string</prompt1>
	    ...
	    <promptN echo="1_or_0">prompt_string</promptN>
	</infoRequest>

If the authentication immediately succeeds because no password is required, or immediately fails, the XML response can be:

<success>success_message</success>

or

<error>error_message</error>

Returns null on failure

More Information and Examples
top
StartKeyboardAuthAsync (1)
Function ComStartKeyboardAuthAsync String login Returns cComChilkatTask
Introduced in version 9.5.0.46

Creates an asynchronous task to call the StartKeyboardAuth method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top
UnlockComponent
Function ComUnlockComponent String unlockCode Returns Boolean

Unlocks the component. This must be called once prior to calling any other method. A fully-functional 30-day trial is automatically started when an arbitrary string is passed to this method. For example, passing "Hello", or "abc123" will unlock the component for the 1st thirty days after the initial install.

Returns True for success, False for failure.

top
WaitForChannelMessage
Function ComWaitForChannelMessage Integer pollTimeoutMs Returns Integer
Introduced in version 9.5.0.48

The pollTimeoutMs is the number of milliseconds to wait. To poll, pass a value of 0 in pollTimeoutMs. Waits for an incoming message on any channel. This includes data, EOF, CLOSE, etc. If a message arrives in the alotted time, the channel number is returned. A value of -1 is returned for a timeout, and -2 for any other errors such as if the connection is lost.

Note: If a channel number is returned, the message must still be read by calling a method such as ChannelRead, ChannelReceiveUntilMatch, etc. Once the message is actually received, it may be collected by calling GetReceivedText, GetReceivedData, etc.

top
WaitForChannelMessageAsync (1)
Function ComWaitForChannelMessageAsync Integer pollTimeoutMs Returns cComChilkatTask
Introduced in version 9.5.0.48

Creates an asynchronous task to call the WaitForChannelMessage method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns null on failure

top