SSHClient Component

Properties   Methods   Events   Config Settings   Errors  

The SSHClient component provides client-side SSH protocol functionality.

Syntax

TsbxSSHClient

Remarks

Use SSHClient to establish terminal-like connections to remote systems and run commands remotely. The component supports most of third-party implementations out there, and is capable of working in "shell" and "command" modes.

Start with assigning your sign-in credentials to Username and Password properties. Where public key authentication is to be used, assign your private authentication key to Key property (remember to set Username in this case too). Subscribe to events to be notified of the session progress. AuthFailed, AuthSucceeded, and Connect are among those particularly useful.

Special attention should be paid to setting up the server key trust. Component only allows connections to servers whose public keys are recognized as trusted, much like any other SSH clients do. Assign a path to the file containing the list of trusted keys to TrustedKeysFile property. If you don't have such file, or if you would like to make trust decisions on the fly, subscribe to KnownKeyReceived and UnknownKeyReceived events. These are fired whenever a trusted or untrusted key is received from the server. For unknown/untrusted keys, you need to set the Action parameter in your UnknownKeyReceived event handler to catAcceptOnce (1) or catAcceptPermanently (2) for the connection to proceed.

Once you are all set up, you can go ahead by calling the Connect method. This launches the SSH handshake and, if everything has been set up right, establishes a connection to the server. You can now use Send and Receive methods to exchange information with the server. You can exchange data in synchronous or asynchronous way; see the description in AsyncMode topic to learn more about each mode.

When you are done with the session, call Disconnect to shut the connection down.

Hint: If you are only interested in a quick-and-dirty execution of a simple, non-interactive command, SSHClient offers a handy shortcut. ConnectAndExec method is a self-contained mechanism which sets up a connection, performs the data exchange internally, and returns the command output. Please keep in mind that you still need to set up the server trust settings as described above for this method to work.

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.

AsyncMode Property (SSHClient Component)

Controls the SSH clients mode of work.

Syntax

__property bool AsyncMode = { read=FAsyncMode, write=FSetAsyncMode };

Default Value

false

Remarks

This property defines the way in which the component communicates with the application/user code. AsyncMode set to false makes the component use synchronous single-thread approach. Synchronous mode is generally simpler to integrate and use, but please keep in mind that the calls like Connect, Receive or SendBytes may block until their execution completes. In asyncronous mode all operations return immediately, but more care should be taken about handling them in your code properly.

Here are a few highlights of each mode.

Synchronous mode:

• All operations are performed within the caller thread context
• Operations like Connect or SendBytes may block
• Use Poll to check for the availability of data before reading it out with Receive or ReceiveBytes
• Return of a call guarantees completion of the operation
• Connection errors are reported straight from the methods via exceptions

Asynchronous mode:

• All operations are performed in a separate thread (and so are the event calls!)
• Methods like Send return immediately
• Use DataSent and DataReceived events to be notified about actual data transmissions
• Return of call only marks the beginning of the operation and does not guarantee its successful completion
• Connection errors are reported via Error event, often followed by Disconnect.

Please note that this is a very important and sensitive property, which has a wide-scale effect on the way the SSH client works and co-operates with the application. Depending on the value assigned to this setting you may need to work with the component very differently.

When setting this property to true, please make sure that your code is prepared to handle events coming from the context of a different thread.

Data Type

Boolean

AuthAttempts Property (SSHClient Component)

Specifies the number of SSH password authentication attempts.

Syntax

__property int AuthAttempts = { read=FAuthAttempts, write=FSetAuthAttempts };

Default Value

1

Remarks

In case of password authentication failure provide new password inside the AuthFailed event handler.

Data Type

Integer

Commands Property (SSHClient Component)

Specifies the list of commands to execute.

Syntax

__property String Commands = { read=FCommands, write=FSetCommands };

Default Value

""

Remarks

Use this property to provide a list of commands to execute remotely. Separate different commands with EOL characters.

When this property is set, the component works in the command mode, meaning each command is executed in its own virtual terminal session. No shell connection is established.

If no commands are provided via this property, the component will establish a shell session.

Data Type

String

Connected Property (SSHClient Component)

Specifies whether the client is connected to the SFTP server.

Syntax

__property bool Connected = { read=FConnected };

Default Value

false

Remarks

Use this read-only property to check whether the client is connected to the server.

This property is read-only.

Data Type

Boolean

ConnInfoClientKeyAlgorithm Property (SSHClient Component)

Specifies the client's key algorithm.

Syntax

__property String ConnInfoClientKeyAlgorithm = { read=FConnInfoClientKeyAlgorithm };

Default Value

""

Remarks

Specifies the client's key algorithm.

This property is read-only.

Data Type

String

ConnInfoClientKeyBits Property (SSHClient Component)

Specifies the length of the client's key.

Syntax

__property int ConnInfoClientKeyBits = { read=FConnInfoClientKeyBits };

Default Value

0

Remarks

Specifies the length of the client's key.

This property is read-only.

Data Type

Integer

ConnInfoClientKeyFingerprint Property (SSHClient Component)

The fingerprint (hash value) of the client's public key.

Syntax

__property String ConnInfoClientKeyFingerprint = { read=FConnInfoClientKeyFingerprint };

Default Value

""

Remarks

The fingerprint (hash value) of the client's public key.

This property is read-only.

Data Type

String

ConnInfoCloseReason Property (SSHClient Component)

Contains the line sent by the server just before closing the connection.

Syntax

__property String ConnInfoCloseReason = { read=FConnInfoCloseReason };

Default Value

""

Remarks

Contains the line sent by the server just before closing the connection. It might contain the error description if the connection was not closed gracefully.

This property is read-only.

Data Type

String

ConnInfoCompressionAlgorithmInbound Property (SSHClient Component)

Compression algorithm for the incoming traffic.

Syntax

__property String ConnInfoCompressionAlgorithmInbound = { read=FConnInfoCompressionAlgorithmInbound };

Default Value

""

Remarks

Compression algorithm for the incoming traffic.

This property is read-only.

Data Type

String

ConnInfoCompressionAlgorithmOutbound Property (SSHClient Component)

Compression algorithm for the outgoing traffic.

Syntax

__property String ConnInfoCompressionAlgorithmOutbound = { read=FConnInfoCompressionAlgorithmOutbound };

Default Value

""

Remarks

Compression algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

ConnInfoEncryptionAlgorithmInbound Property (SSHClient Component)

Encryption algorithm for the incoming traffic.

Syntax

__property String ConnInfoEncryptionAlgorithmInbound = { read=FConnInfoEncryptionAlgorithmInbound };

Default Value

""

Remarks

Encryption algorithm for the incoming traffic.

This property is read-only.

Data Type

String

ConnInfoEncryptionAlgorithmOutbound Property (SSHClient Component)

Encryption algorithm for the outgoing traffic.

Syntax

__property String ConnInfoEncryptionAlgorithmOutbound = { read=FConnInfoEncryptionAlgorithmOutbound };

Default Value

""

Remarks

Encryption algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

ConnInfoInboundEncryptionKeyBits Property (SSHClient Component)

Specifies the length of the key used to encrypt the incoming traffic.

Syntax

__property int ConnInfoInboundEncryptionKeyBits = { read=FConnInfoInboundEncryptionKeyBits };

Default Value

0

Remarks

Specifies the length of the key used to encrypt the incoming traffic.

This property is read-only.

Data Type

Integer

ConnInfoKexAlgorithm Property (SSHClient Component)

The key exchange algorithm used during the SSH handshake.

Syntax

__property String ConnInfoKexAlgorithm = { read=FConnInfoKexAlgorithm };

Default Value

""

Remarks

The key exchange algorithm used during the SSH handshake.

This property is read-only.

Data Type

String

ConnInfoKexBits Property (SSHClient Component)

The number of bits used by the key exchange algorithm.

Syntax

__property int ConnInfoKexBits = { read=FConnInfoKexBits };

Default Value

0

Remarks

The number of bits used by the key exchange algorithm.

This property is read-only.

Data Type

Integer

ConnInfoKexLines Property (SSHClient Component)

The contents of the received KexInit packet.

Syntax

__property String ConnInfoKexLines = { read=FConnInfoKexLines };

Default Value

""

Remarks

The contents of the received KexInit packet.

KexInit packet contains the list of algorithms supported by the remote party.

This property is read-only.

Data Type

String

ConnInfoMacAlgorithmInbound Property (SSHClient Component)

MAC algorithm used for the incoming connection.

Syntax

__property String ConnInfoMacAlgorithmInbound = { read=FConnInfoMacAlgorithmInbound };

Default Value

""

Remarks

MAC algorithm used for the incoming connection.

This property is read-only.

Data Type

String

ConnInfoMacAlgorithmOutbound Property (SSHClient Component)

MAC algorithm used for outbound connection.

Syntax

__property String ConnInfoMacAlgorithmOutbound = { read=FConnInfoMacAlgorithmOutbound };

Default Value

""

Remarks

MAC algorithm used for outbound connection.

This property is read-only.

Data Type

String

ConnInfoOutboundEncryptionKeyBits Property (SSHClient Component)

Specifies the length of the key used to encrypt the outgoing traffic.

Syntax

__property int ConnInfoOutboundEncryptionKeyBits = { read=FConnInfoOutboundEncryptionKeyBits };

Default Value

0

Remarks

Specifies the length of the key used to encrypt the outgoing traffic.

This property is read-only.

Data Type

Integer

ConnInfoPublicKeyAlgorithm Property (SSHClient Component)

Specifies the public key algorithm which was used during the SSH handshake.

Syntax

__property String ConnInfoPublicKeyAlgorithm = { read=FConnInfoPublicKeyAlgorithm };

Default Value

""

Remarks

Specifies the public key algorithm which was used during the SSH handshake.

This property is read-only.

Data Type

String

ConnInfoRemoteAddress Property (SSHClient Component)

The client's IP address.

Syntax

__property String ConnInfoRemoteAddress = { read=FConnInfoRemoteAddress };

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

ConnInfoRemotePort Property (SSHClient Component)

The remote port of the client connection.

Syntax

__property int ConnInfoRemotePort = { read=FConnInfoRemotePort };

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

Integer

ConnInfoServerKeyAlgorithm Property (SSHClient Component)

Specifies the server's key algorithm.

Syntax

__property String ConnInfoServerKeyAlgorithm = { read=FConnInfoServerKeyAlgorithm };

Default Value

""

Remarks

Specifies the server's key algorithm.

This property is read-only.

Data Type

String

ConnInfoServerKeyBits Property (SSHClient Component)

Specifies the number of bits in the server's key.

Syntax

__property int ConnInfoServerKeyBits = { read=FConnInfoServerKeyBits };

Default Value

0

Remarks

Specifies the number of bits in the server's key.

This property is read-only.

Data Type

Integer

ConnInfoServerKeyFingerprint Property (SSHClient Component)

The fingerprint (hash value) of the server's public key.

Syntax

__property String ConnInfoServerKeyFingerprint = { read=FConnInfoServerKeyFingerprint };

Default Value

""

Remarks

The fingerprint (hash value) of the server's public key.

This property is read-only.

Data Type

String

ConnInfoServerSoftwareName Property (SSHClient Component)

Returns the name of the SSH software running on the server side.

Syntax

__property String ConnInfoServerSoftwareName = { read=FConnInfoServerSoftwareName };

Default Value

""

Remarks

Returns the name of the SSH software running on the server side.

This property is read-only.

Data Type

String

ConnInfoTotalBytesReceived Property (SSHClient Component)

Returns the total number of bytes received over this connection.

Syntax

__property __int64 ConnInfoTotalBytesReceived = { read=FConnInfoTotalBytesReceived };

Default Value

0

Remarks

Returns the total number of bytes received over this connection.

This property is read-only.

Data Type

Long64

ConnInfoTotalBytesSent Property (SSHClient Component)

Returns the total number of bytes sent over this connection.

Syntax

__property __int64 ConnInfoTotalBytesSent = { read=FConnInfoTotalBytesSent };

Default Value

0

Remarks

Returns the total number of bytes sent over this connection.

This property is read-only.

Data Type

Long64

ConnInfoVersion Property (SSHClient Component)

Specifies SSH protocol version.

Syntax

__property int ConnInfoVersion = { read=FConnInfoVersion };

Default Value

2

Remarks

Specifies SSH protocol version.

This property is read-only.

Data Type

Integer

ExitMessage Property (SSHClient Component)

Contains the last commands exit message.

Syntax

__property String ExitMessage = { read=FExitMessage };

Default Value

""

Remarks

Use this property to access the exit message of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error.

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

Data Type

String

ExitSignal Property (SSHClient Component)

Contains the last commands exit signal.

Syntax

__property String ExitSignal = { read=FExitSignal };

Default Value

""

Remarks

Use this property to access the exit signal of the last command or shell session. This property normally gets assigned if the command or shell was closed due to an error.

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

Data Type

String

ExitStatus Property (SSHClient Component)

Contains the last commands exit status.

Syntax

__property int ExitStatus = { read=FExitStatus };

Default Value

0

Remarks

Check this property to obtain the exit status (also sometimes referred to as errorlevel) of the last command or shell session.

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

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SSHClient Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SSHClient Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (SSHClient Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (SSHClient Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component.

If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SSHClient Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (SSHClient Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (SSHClient Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (SSHClient Component)

Specifies the asynchronous signing method.

Syntax

__property TsbxSSHClientExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxSSHClientExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (SSHClient Component)

Specifies the external cryptography mode.

Syntax

__property TsbxSSHClientExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxSSHClientExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SSHClient Component)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (SSHClient Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KeyFingerprintSHA1 Property (SSHClient Component)

Contains the SHA-1 fingerprint (hash) of the key.

Syntax

__property String KeyFingerprintSHA1 = { read=FKeyFingerprintSHA1 };

Default Value

""

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

KeyFingerprintSHA256 Property (SSHClient Component)

Contains the SHA-256 fingerprint (hash) of the key.

Syntax

__property String KeyFingerprintSHA256 = { read=FKeyFingerprintSHA256 };

Default Value

""

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

KeyHandle Property (SSHClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KeyHandle = { read=FKeyHandle, write=FSetKeyHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

Password Property (SSHClient Component)

Specifies user's password on the server.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

Invalid password fires the AuthFailed event.

Data Type

String

ProxySettingsAddress Property (SSHClient Component)

The IP address of the proxy server.

Syntax

__property String ProxySettingsAddress = { read=FProxySettingsAddress, write=FSetProxySettingsAddress };

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxySettingsAuthentication Property (SSHClient Component)

The authentication type used by the proxy server.

Syntax

__property TsbxSSHClientProxySettingsAuthentications ProxySettingsAuthentication = { read=FProxySettingsAuthentication, write=FSetProxySettingsAuthentication };

enum TsbxSSHClientProxySettingsAuthentications {
  patNoAuthentication=0,
  patBasic=1,
  patDigest=2,
  patNTLM=3
};

Default Value

patNoAuthentication

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxySettingsPassword Property (SSHClient Component)

The password to authenticate to the proxy server.

Syntax

__property String ProxySettingsPassword = { read=FProxySettingsPassword, write=FSetProxySettingsPassword };

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxySettingsPort Property (SSHClient Component)

The port on the proxy server to connect to.

Syntax

__property int ProxySettingsPort = { read=FProxySettingsPort, write=FSetProxySettingsPort };

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxySettingsProxyType Property (SSHClient Component)

The type of the proxy server.

Syntax

__property TsbxSSHClientProxySettingsProxyTypes ProxySettingsProxyType = { read=FProxySettingsProxyType, write=FSetProxySettingsProxyType };

enum TsbxSSHClientProxySettingsProxyTypes {
  cptNone=0,
  cptSocks4=1,
  cptSocks5=2,
  cptWebTunnel=3,
  cptHTTP=4
};

Default Value

cptNone

Remarks

The type of the proxy server.

Data Type

Integer

ProxySettingsRequestHeaders Property (SSHClient Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

__property String ProxySettingsRequestHeaders = { read=FProxySettingsRequestHeaders, write=FSetProxySettingsRequestHeaders };

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxySettingsResponseBody Property (SSHClient Component)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

__property String ProxySettingsResponseBody = { read=FProxySettingsResponseBody, write=FSetProxySettingsResponseBody };

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxySettingsResponseHeaders Property (SSHClient Component)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

__property String ProxySettingsResponseHeaders = { read=FProxySettingsResponseHeaders, write=FSetProxySettingsResponseHeaders };

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxySettingsUseIPv6 Property (SSHClient Component)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

__property bool ProxySettingsUseIPv6 = { read=FProxySettingsUseIPv6, write=FSetProxySettingsUseIPv6 };

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxySettingsUsername Property (SSHClient Component)

Specifies the username credential for proxy authentication.

Syntax

__property String ProxySettingsUsername = { read=FProxySettingsUsername, write=FSetProxySettingsUsername };

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerKeyAlgorithm Property (SSHClient Component)

Specifies the key algorithm.

Syntax

__property String ServerKeyAlgorithm = { read=FServerKeyAlgorithm };

Default Value

""

Remarks

Specifies the key algorithm.

The following algorithms are currently supported:

• RSA
• DSS
• ECDSA
• EDDSA

This property is read-only.

Data Type

String

ServerKeyBits Property (SSHClient Component)

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

Syntax

__property int ServerKeyBits = { read=FServerKeyBits };

Default Value

0

Remarks

The number of bits in the key: the more the better, 2048 or 4096 are typical values.

This property is read-only.

Data Type

Integer

ServerKeyComment Property (SSHClient Component)

The comment for the public key.

Syntax

__property String ServerKeyComment = { read=FServerKeyComment };

Default Value

""

Remarks

The comment for the public key.

This property is read-only.

Data Type

String

ServerKeyCurve Property (SSHClient Component)

Specifies the elliptical curve when EC cryptography is used.

Syntax

__property String ServerKeyCurve = { read=FServerKeyCurve };

Default Value

""

Remarks

Specifies the elliptical curve when EC cryptography is used.

The following curves are currently supported:

• NISTP256
• NISTP384
• NISTP521
• NISTK163
• NISTP192
• NISTP224
• NISTK233
• NISTB233
• NISTK283
• NISTK409
• NISTB409
• NISTK571
• CURVE25519 (EdDSA curve)
• CURVE448 (EdDSA curve)

This property is read-only.

Data Type

String

ServerKeyDSSG Property (SSHClient Component)

The G (Generator) parameter of the DSS signature key.

Syntax

__property DynamicArray ServerKeyDSSG = { read=FServerKeyDSSG };

Remarks

The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.

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

Data Type

Byte Array

ServerKeyDSSP Property (SSHClient Component)

The P (Prime) parameter of the DSS signature key.

Syntax

__property DynamicArray ServerKeyDSSP = { read=FServerKeyDSSP };

Remarks

The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.

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

Data Type

Byte Array

ServerKeyDSSQ Property (SSHClient Component)

The Q (Prime Factor) parameter of the DSS signature key.

Syntax

__property DynamicArray ServerKeyDSSQ = { read=FServerKeyDSSQ };

Remarks

The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.

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

Data Type

Byte Array

ServerKeyDSSX Property (SSHClient Component)

The X (Private key) parameter of the DSS signature key.

Syntax

__property DynamicArray ServerKeyDSSX = { read=FServerKeyDSSX };

Remarks

The X (Private key) parameter of the DSS signature key. The string should contain the binary data of X.

This parameter may be empty if there's no need to sign data with this key (e.g. if the key is a server public key needed only to authenticate the server).

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

Data Type

Byte Array

ServerKeyDSSY Property (SSHClient Component)

The Y (Public key) parameter of the DSS signature key.

Syntax

__property DynamicArray ServerKeyDSSY = { read=FServerKeyDSSY };

Remarks

The Y (Public key) parameter of the DSS signature key. The string should contain the binary data of Y.

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

Data Type

Byte Array

ServerKeyECCD Property (SSHClient Component)

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.

Syntax

__property DynamicArray ServerKeyECCD = { read=FServerKeyECCD };

Remarks

The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used. The string should contain the binary data of D.

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

Data Type

Byte Array

ServerKeyECCQX Property (SSHClient Component)

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.

Syntax

__property DynamicArray ServerKeyECCQX = { read=FServerKeyECCQX };

Remarks

The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of X.

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

Data Type

Byte Array

ServerKeyECCQY Property (SSHClient Component)

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.

Syntax

__property DynamicArray ServerKeyECCQY = { read=FServerKeyECCQY };

Remarks

The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used. The string should contain the binary data of Y.

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

Data Type

Byte Array

ServerKeyEdPrivate Property (SSHClient Component)

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Syntax

__property DynamicArray ServerKeyEdPrivate = { read=FServerKeyEdPrivate };

Remarks

The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

ServerKeyEdPublic Property (SSHClient Component)

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

Syntax

__property DynamicArray ServerKeyEdPublic = { read=FServerKeyEdPublic };

Remarks

The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.

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

Data Type

Byte Array

ServerKeyFingerprintMD5 Property (SSHClient Component)

Contains the MD5 fingerprint (hash) of the key.

Syntax

__property String ServerKeyFingerprintMD5 = { read=FServerKeyFingerprintMD5 };

Default Value

""

Remarks

Contains the MD5 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

ServerKeyFingerprintSHA1 Property (SSHClient Component)

Contains the SHA-1 fingerprint (hash) of the key.

Syntax

__property String ServerKeyFingerprintSHA1 = { read=FServerKeyFingerprintSHA1 };

Default Value

""

Remarks

Contains the SHA-1 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

ServerKeyFingerprintSHA256 Property (SSHClient Component)

Contains the SHA-256 fingerprint (hash) of the key.

Syntax

__property String ServerKeyFingerprintSHA256 = { read=FServerKeyFingerprintSHA256 };

Default Value

""

Remarks

Contains the SHA-256 fingerprint (hash) of the key.

This property is read-only.

Data Type

String

ServerKeyHandle Property (SSHClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 ServerKeyHandle = { read=FServerKeyHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

Data Type

Long64

ServerKeyIsExtractable Property (SSHClient Component)

Whether the key is extractable (e.

Syntax

__property bool ServerKeyIsExtractable = { read=FServerKeyIsExtractable };

Default Value

false

Remarks

Whether the key is extractable (e.g., from a security token), or not.

This property is read-only.

Data Type

Boolean

ServerKeyIsPrivate Property (SSHClient Component)

Whether this key is a private key or not.

Syntax

__property bool ServerKeyIsPrivate = { read=FServerKeyIsPrivate };

Default Value

false

Remarks

Whether this key is a private key or not.

This property is read-only.

Data Type

Boolean

ServerKeyIsPublic Property (SSHClient Component)

Whether this key is a public key or not.

Syntax

__property bool ServerKeyIsPublic = { read=FServerKeyIsPublic };

Default Value

false

Remarks

Whether this key is a public key or not.

This property is read-only.

Data Type

Boolean

ServerKeyKDFRounds Property (SSHClient Component)

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

Syntax

__property int ServerKeyKDFRounds = { read=FServerKeyKDFRounds };

Default Value

0

Remarks

Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.

This property is read-only.

Data Type

Integer

ServerKeyKDFSalt Property (SSHClient Component)

The salt value used by the Key Derivation Function (KDF) to generate this key.

Syntax

__property DynamicArray ServerKeyKDFSalt = { read=FServerKeyKDFSalt };

Remarks

The salt value used by the Key Derivation Function (KDF) to generate this key.

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

Data Type

Byte Array

ServerKeyKeyFormat Property (SSHClient Component)

Specifies the format in which the key is stored.

Syntax

__property TsbxSSHClientServerKeyKeyFormats ServerKeyKeyFormat = { read=FServerKeyKeyFormat };

enum TsbxSSHClientServerKeyKeyFormats {
  ckfOpenSSH=0,
  ckfOpenSSH2=1,
  ckfIETF=2,
  ckfPuTTY=3,
  ckfX509=4,
  ckfBinary=5,
  ckfSSH1=6,
  ckfPGP=7,
  ckfPKCS8=8,
  ckfPuTTY3=9
};

Default Value

ckfOpenSSH

Remarks

Specifies the format in which the key is stored.

This property is read-only.

Data Type

Integer

ServerKeyKeyProtectionAlgorithm Property (SSHClient Component)

Specifies the key protection algorithm.

Syntax

__property String ServerKeyKeyProtectionAlgorithm = { read=FServerKeyKeyProtectionAlgorithm };

Default Value

""

Remarks

Specifies the key protection algorithm.

This property is read-only.

Data Type

String

ServerKeyRSAExponent Property (SSHClient Component)

Returns the e parameter (public exponent) of the RSA key.

Syntax

__property DynamicArray ServerKeyRSAExponent = { read=FServerKeyRSAExponent };

Remarks

Returns the e parameter (public exponent) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAIQMP Property (SSHClient Component)

Returns the iqmp parameter of the RSA key.

Syntax

__property DynamicArray ServerKeyRSAIQMP = { read=FServerKeyRSAIQMP };

Remarks

Returns the iqmp parameter of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAModulus Property (SSHClient Component)

Returns the m parameter (public modulus) of the RSA key.

Syntax

__property DynamicArray ServerKeyRSAModulus = { read=FServerKeyRSAModulus };

Remarks

Returns the m parameter (public modulus) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAP Property (SSHClient Component)

Returns the p parameter (first factor of the common modulus n) of the RSA key.

Syntax

__property DynamicArray ServerKeyRSAP = { read=FServerKeyRSAP };

Remarks

Returns the p parameter (first factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAPrivateExponent Property (SSHClient Component)

Returns the d parameter (private exponent) of the RSA key.

Syntax

__property DynamicArray ServerKeyRSAPrivateExponent = { read=FServerKeyRSAPrivateExponent };

Remarks

Returns the d parameter (private exponent) of the RSA key.

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

Data Type

Byte Array

ServerKeyRSAQ Property (SSHClient Component)

Returns the q parameter (second factor of the common modulus n) of the RSA key.

Syntax

__property DynamicArray ServerKeyRSAQ = { read=FServerKeyRSAQ };

Remarks

Returns the q parameter (second factor of the common modulus n) of the RSA key.

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

Data Type

Byte Array

ServerKeySubject Property (SSHClient Component)

Specifies the public key owner (subject).

Syntax

__property String ServerKeySubject = { read=FServerKeySubject };

Default Value

""

Remarks

Specifies the public key owner (subject). This property is used only for IETF-keys.

This property is read-only.

Data Type

String

SocketDNSMode Property (SSHClient Component)

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Syntax

__property TsbxSSHClientSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode };

enum TsbxSSHClientSocketDNSModes {
  dmAuto=0,
  dmPlatform=1,
  dmOwn=2,
  dmOwnSecure=3
};

Default Value

dmAuto

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (SSHClient Component)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

__property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort };

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (SSHClient Component)

The timeout (in milliseconds) for each DNS query.

Syntax

__property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout };

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketDNSServers Property (SSHClient Component)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

__property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers };

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (SSHClient Component)

The timeout (in milliseconds) for the whole resolution process.

Syntax

__property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout };

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (SSHClient Component)

The maximum number of bytes to read from the socket, per second.

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (SSHClient Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SSHClient Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SSHClient Component)

The maximum number of bytes to write to the socket, per second.

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (SSHClient Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (SSHClient Component)

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SSHSettingsAutoAdjustCiphers Property (SSHClient Component)

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

Syntax

__property bool SSHSettingsAutoAdjustCiphers = { read=FSSHSettingsAutoAdjustCiphers, write=FSetSSHSettingsAutoAdjustCiphers };

Default Value

true

Remarks

Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.

Data Type

Boolean

SSHSettingsBaseConfiguration Property (SSHClient Component)

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

Syntax

__property TsbxSSHClientSSHSettingsBaseConfigurations SSHSettingsBaseConfiguration = { read=FSSHSettingsBaseConfiguration, write=FSetSSHSettingsBaseConfiguration };

enum TsbxSSHClientSSHSettingsBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

Remarks

Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.

Data Type

Integer

SSHSettingsCompressionAlgorithms Property (SSHClient Component)

A list of session compression algorithms separated with commas or semicolons.

Syntax

__property String SSHSettingsCompressionAlgorithms = { read=FSSHSettingsCompressionAlgorithms, write=FSetSSHSettingsCompressionAlgorithms };

Default Value

""

Remarks

A list of session compression algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all compression algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of compression algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported compression algorithms is provided below:

• none
• zlib
• zlib@openssh.com

Data Type

String

SSHSettingsCompressionLevel Property (SSHClient Component)

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).

Syntax

__property int SSHSettingsCompressionLevel = { read=FSSHSettingsCompressionLevel, write=FSetSSHSettingsCompressionLevel };

Default Value

6

Remarks

Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.

Data Type

Integer

SSHSettingsDefaultWindowSize Property (SSHClient Component)

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

Syntax

__property int SSHSettingsDefaultWindowSize = { read=FSSHSettingsDefaultWindowSize, write=FSetSSHSettingsDefaultWindowSize };

Default Value

2048000

Remarks

The SSH window size specifies how many bytes the client can send to the server in the command channel without obtaining pre-authorization for the further send from the server.

Data Type

Integer

SSHSettingsEncryptionAlgorithms Property (SSHClient Component)

A list of session encryption algorithms separated with commas or semicolons.

Syntax

__property String SSHSettingsEncryptionAlgorithms = { read=FSSHSettingsEncryptionAlgorithms, write=FSetSSHSettingsEncryptionAlgorithms };

Default Value

""

Remarks

A list of session encryption algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all encryption algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of encryption algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported encryption algorithms is provided below:

• 3des-cbc
• blowfish-cbc
• twofish256-cbc
• twofish192-cbc
• twofish128-cbc
• aes256-cbc
• aes192-cbc
• aes128-cbc
• serpent256-cbc
• serpent192-cbc
• serpent128-cbc
• arcfour
• idea-cbc
• cast128-cbc
• none
• des-cbc
• aes128-ctr
• aes192-ctr
• aes256-ctr
• 3des-ctr
• blowfish-ctr
• twofish128-ctr
• twofish192-ctr
• twofish256-ctr
• serpent128-ctr
• serpent192-ctr
• serpent256-ctr
• idea-ctr
• cast128-ctr
• arcfour128
• arcfour256
• aes128-gcm
• aes256-gcm
• aes128-gcm@openssh.com
• aes256-gcm@openssh.com
• chacha20-poly1305
• chacha20-poly1305@openssh.com

Data Type

String

SSHSettingsForceCompression Property (SSHClient Component)

Whether the SSH client should explicitly request compression.

Syntax

__property bool SSHSettingsForceCompression = { read=FSSHSettingsForceCompression, write=FSetSSHSettingsForceCompression };

Default Value

false

Remarks

Whether the SSH client should explicitly request compression.

If ForceCompression is False, compression will be used only if the server doesn't support algorithms without compression.

Data Type

Boolean

SSHSettingsForwardAuthAgent Property (SSHClient Component)

Enables or disables auth agent forwarding.

Syntax

__property bool SSHSettingsForwardAuthAgent = { read=FSSHSettingsForwardAuthAgent, write=FSetSSHSettingsForwardAuthAgent };

Default Value

false

Remarks

Enables or disables auth agent forwarding. This allows the component to connect to the second and subsequent servers in the chain with the key agent available on the client computer.

Data Type

Boolean

SSHSettingsGSSAuthTypes Property (SSHClient Component)

A comma-separated list of authentication types.

Syntax

__property String SSHSettingsGSSAuthTypes = { read=FSSHSettingsGSSAuthTypes, write=FSetSSHSettingsGSSAuthTypes };

Default Value

""

Remarks

A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex.

Data Type

String

SSHSettingsGSSDelegateCreds Property (SSHClient Component)

Switches credential delegation on or off.

Syntax

__property bool SSHSettingsGSSDelegateCreds = { read=FSSHSettingsGSSDelegateCreds, write=FSetSSHSettingsGSSDelegateCreds };

Default Value

false

Remarks

Switches credential delegation on or off.

Data Type

Boolean

SSHSettingsGSSHostname Property (SSHClient Component)

The GSS host name, in form of a FQDN (e.

Syntax

__property String SSHSettingsGSSHostname = { read=FSSHSettingsGSSHostname, write=FSetSSHSettingsGSSHostname };

Default Value

""

Remarks

The GSS host name, in form of a FQDN (e.g. hostname.com), a principal name (e.g. 'host@hostname.com), or a cross-real ticket-granting ticket (e.g. krbtgt/test.com@example.com).

Data Type

String

SSHSettingsGSSLib Property (SSHClient Component)

A path to the GSS-API library (DLL or SO).

Syntax

__property String SSHSettingsGSSLib = { read=FSSHSettingsGSSLib, write=FSetSSHSettingsGSSLib };

Default Value

""

Remarks

A path to the GSS-API library (DLL or SO).

Data Type

String

SSHSettingsGSSMechanisms Property (SSHClient Component)

A comma-separated list of GSS mechanisms to use.

Syntax

__property String SSHSettingsGSSMechanisms = { read=FSSHSettingsGSSMechanisms, write=FSetSSHSettingsGSSMechanisms };

Default Value

""

Remarks

A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI.

Data Type

String

SSHSettingsGSSProtocols Property (SSHClient Component)

A comma-separated list of SSPI protocols.

Syntax

__property String SSHSettingsGSSProtocols = { read=FSSHSettingsGSSProtocols, write=FSetSSHSettingsGSSProtocols };

Default Value

""

Remarks

A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM.

Data Type

String

SSHSettingsHandshakeTimeout Property (SSHClient Component)

Specifies the maximal time for the SSH handshake to proceed, in seconds.

Syntax

__property int SSHSettingsHandshakeTimeout = { read=FSSHSettingsHandshakeTimeout, write=FSetSSHSettingsHandshakeTimeout };

Default Value

45

Remarks

Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.

Data Type

Integer

SSHSettingsKexAlgorithms Property (SSHClient Component)

A list of key exchange algorithms separated with commas or semicolons.

Syntax

__property String SSHSettingsKexAlgorithms = { read=FSSHSettingsKexAlgorithms, write=FSetSSHSettingsKexAlgorithms };

Default Value

""

Remarks

A list of key exchange algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all key exchange algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of key exchange algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported kex algorithms is provided below:

• diffie-hellman-group-exchange-sha1
• diffie-hellman-group1-sha1
• diffie-hellman-group14-sha1
• diffie-hellman-group-exchange-sha256
• rsa1024-sha1
• rsa2048-sha256
• ecdh-sha2-nistp256
• ecdh-sha2-nistp384
• ecdh-sha2-nistp521
• ecdh-sha2-nistk163
• ecdh-sha2-nistp192
• ecdh-sha2-nistp224
• ecdh-sha2-nistk233
• ecdh-sha2-nistb233
• ecdh-sha2-nistk283
• ecdh-sha2-nistk409
• ecdh-sha2-nistb409
• ecdh-sha2-nistt571
• ecdh-sha2-curve25519
• curve25519-sha256@libssh.org
• curve448-sha512@libssh.org
• diffie-hellman-group14-sha256
• diffie-hellman-group15-sha512
• diffie-hellman-group16-sha512
• diffie-hellman-group17-sha512
• diffie-hellman-group18-sha512

Data Type

String

SSHSettingsMacAlgorithms Property (SSHClient Component)

A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.

Syntax

__property String SSHSettingsMacAlgorithms = { read=FSSHSettingsMacAlgorithms, write=FSetSSHSettingsMacAlgorithms };

Default Value

""

Remarks

A list of MAC (for message authentication code) algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all MAC algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of MAC algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported MAC algorithms is provided below:

• hmac-sha1
• hmac-sha1-96
• hmac-md5
• hmac-md5-96
• none
• hmac-ripemd160
• hmac-ripemd
• hmac-ripemd160@openssh.com
• hmac-sha256@ssh.com
• hmac-sha256-96@ssh.com
• umac-32@openssh.com
• umac-64@openssh.com
• umac-96@openssh.com
• umac-128@openssh.com
• hmac-sha2-256
• hmac-sha2-512
• aes128-gcm
• aes256-gcm
• chacha20-poly1305@openssh.com
• hmac-sha2-256-etm@openssh.com
• hmac-sha2-512-etm@openssh.com

Data Type

String

SSHSettingsMaxSSHPacketSize Property (SSHClient Component)

Specifies the maximum length of one SSH packet in bytes.

Syntax

__property int SSHSettingsMaxSSHPacketSize = { read=FSSHSettingsMaxSSHPacketSize, write=FSetSSHSettingsMaxSSHPacketSize };

Default Value

262144

Remarks

Specifies the maximum length of one SSH packet in bytes.

Data Type

Integer

SSHSettingsMinWindowSize Property (SSHClient Component)

Specifies the minimal internal window size.

Syntax

__property int SSHSettingsMinWindowSize = { read=FSSHSettingsMinWindowSize, write=FSetSSHSettingsMinWindowSize };

Default Value

2048

Remarks

Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data.

Data Type

Integer

SSHSettingsObfuscateHandshake Property (SSHClient Component)

Enables or disables handshake obfuscation.

Syntax

__property bool SSHSettingsObfuscateHandshake = { read=FSSHSettingsObfuscateHandshake, write=FSetSSHSettingsObfuscateHandshake };

Default Value

false

Remarks

Enables or disables handshake obfuscation.

Data Type

Boolean

SSHSettingsObfuscationPassword Property (SSHClient Component)

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

Syntax

__property String SSHSettingsObfuscationPassword = { read=FSSHSettingsObfuscationPassword, write=FSetSSHSettingsObfuscationPassword };

Default Value

""

Remarks

Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.

Data Type

String

SSHSettingsPublicKeyAlgorithms Property (SSHClient Component)

A list of public key algorithms separated with commas or semicolons.

Syntax

__property String SSHSettingsPublicKeyAlgorithms = { read=FSSHSettingsPublicKeyAlgorithms, write=FSetSSHSettingsPublicKeyAlgorithms };

Default Value

""

Remarks

A list of public key algorithms separated with commas or semicolons. Each algorithm in the list may be prefixed with a minus sign (-) to indicate that the algorithm should be disabled rather than enabled. Besides the specific algorithm names, this property supports the all (and -all) aliases that allow to blanketly enable or disable all public key algorithms at once.

Note: the list of algorithms provided to this property alters the baseline list of public key algorithms pre-configured for this component. Remember to start your algorithm string with -all; if you need to only enable a specific fixed set of algorithms. The list of supported public key algorithms is provided below:

• ssh-dss
• ssh-rsa
• x509v3-sign-rsa
• x509v3-sign-dss
• spki-sign-rsa,
• spki-sign-dss
• pgp-sign-rsa
• pgp-sign-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• ecdsa-sha2-nistk163
• ecdsa-sha2-nistp192
• ecdsa-sha2-nistp224
• ecdsa-sha2-nistk233
• ecdsa-sha2-nistb233
• ecdsa-sha2-nistk283
• ecdsa-sha2-nistk409
• ecdsa-sha2-nistb409
• ecdsa-sha2-nistt571,
• ecdsa-sha2-curve25519
• x509v3-ssh-rsa
• x509v3-ssh-dss
• x509v3-rsa2048-sha256
• x509v3-ecdsa-sha2-nistp256
• x509v3-ecdsa-sha2-nistp384
• x509v3-ecdsa-sha2-nistp521
• x509v3-ecdsa-sha2-nistk163
• x509v3-ecdsa-sha2-nistp192
• x509v3-ecdsa-sha2-nistp224
• x509v3-ecdsa-sha2-nistk233
• x509v3-ecdsa-sha2-nistb233
• x509v3-ecdsa-sha2-nistk283
• x509v3-ecdsa-sha2-nistk409
• x509v3-ecdsa-sha2-nistb409
• x509v3-ecdsa-sha2-nistt571
• x509v3-ecdsa-sha2-curve25519
• ssh-ed25519
• ssh-ed448
• rsa-sha2-256
• rsa-sha2-512

Data Type

String

SSHSettingsRequestPasswordChange Property (SSHClient Component)

Whether to request a password change when connecting.

Syntax

__property bool SSHSettingsRequestPasswordChange = { read=FSSHSettingsRequestPasswordChange, write=FSetSSHSettingsRequestPasswordChange };

Default Value

false

Remarks

Whether to request a password change when connecting.

Data Type

Boolean

SSHSettingsSoftwareName Property (SSHClient Component)

The name to be used by the component to identify itself.

Syntax

__property String SSHSettingsSoftwareName = { read=FSSHSettingsSoftwareName, write=FSetSSHSettingsSoftwareName };

Default Value

"SecureBlackbox"

Remarks

The name to be used by the component to identify itself.

Data Type

String

SSHSettingsTrustAllKeys Property (SSHClient Component)

Enables or disables explicit trust to all server keys.

Syntax

__property bool SSHSettingsTrustAllKeys = { read=FSSHSettingsTrustAllKeys, write=FSetSSHSettingsTrustAllKeys };

Default Value

false

Remarks

Enables or disables explicit trust to all server keys. Use with care.

Data Type

Boolean

SSHSettingsUseAuthAgent Property (SSHClient Component)

Enables or disables the use of external key agent, such as Putty key agent.

Syntax

__property bool SSHSettingsUseAuthAgent = { read=FSSHSettingsUseAuthAgent, write=FSetSSHSettingsUseAuthAgent };

Default Value

false

Remarks

Enables or disables the use of external key agent, such as Putty key agent.

Data Type

Boolean

SSHSettingsVersions Property (SSHClient Component)

Specifies enabled SSH protocol versions (1 or 2).

Syntax

__property int SSHSettingsVersions = { read=FSSHSettingsVersions, write=FSetSSHSettingsVersions };

Default Value

1

Remarks

Specifies enabled SSH protocol versions (1 or 2).

Data Type

Integer

Subsystem Property (SSHClient Component)

Specifies the subsystem to request from the server.

Syntax

__property String Subsystem = { read=FSubsystem, write=FSetSubsystem };

Default Value

""

Remarks

Subsystem is a special form of an SSH channel. It is typically used to transfer third-party protocol data, with SFTP being the most widely known.

You can tell component to set up a subsystem connection (rather than a shell or command) by assigning the subsystem name to this property.

Data Type

String

TerminalCols Property (SSHClient Component)

Specifies the width of the pseudoterminal, in characters.

Syntax

__property int TerminalCols = { read=FTerminalCols, write=FSetTerminalCols };

Default Value

80

Remarks

Specifies the width of the pseudoterminal, in characters.

Data Type

Integer

TerminalEnvironment Property (SSHClient Component)

Specifies the list of environment variables.

Syntax

__property String TerminalEnvironment = { read=FTerminalEnvironment, write=FSetTerminalEnvironment };

Default Value

""

Remarks

Specifies the list of environment variables.

Data Type

String

TerminalEOLChar Property (SSHClient Component)

Specifies the End-of-Line character or sequence.

Syntax

__property DynamicArray TerminalEOLChar = { read=FTerminalEOLChar, write=FSetTerminalEOLChar };

Remarks

Specifies the End-of-Line character or sequence.

This property is not available at design time.

Data Type

Byte Array

TerminalHeight Property (SSHClient Component)

Specifies the height of the pseudoterminal, in pixels.

Syntax

__property int TerminalHeight = { read=FTerminalHeight, write=FSetTerminalHeight };

Default Value

0

Remarks

Specifies the height of the pseudoterminal, in pixels.

Data Type

Integer

TerminalOpcodes Property (SSHClient Component)

Specifies the operation codes specific for the terminal.

Syntax

__property String TerminalOpcodes = { read=FTerminalOpcodes, write=FSetTerminalOpcodes };

Default Value

""

Remarks

Specifies the operation codes specific for the terminal.

Data Type

String

TerminalProtocol Property (SSHClient Component)

The terminal protocol name.

Syntax

__property String TerminalProtocol = { read=FTerminalProtocol, write=FSetTerminalProtocol };

Default Value

"vt100"

Remarks

The terminal protocol name.

Data Type

String

TerminalRequestPty Property (SSHClient Component)

Specifies whether to request a pseudoterminal for the session.

Syntax

__property bool TerminalRequestPty = { read=FTerminalRequestPty, write=FSetTerminalRequestPty };

Default Value

true

Remarks

Specifies whether to request a pseudoterminal for the session.

Data Type

Boolean

TerminalRows Property (SSHClient Component)

Specifies the height of the pseudoterminal, in lines.

Syntax

__property int TerminalRows = { read=FTerminalRows, write=FSetTerminalRows };

Default Value

25

Remarks

Specifies the height of the pseudoterminal, in lines.

Data Type

Integer

TerminalWidth Property (SSHClient Component)

Specifies the width of the pseudoterminal, in pixels.

Syntax

__property int TerminalWidth = { read=FTerminalWidth, write=FSetTerminalWidth };

Default Value

0

Remarks

Specifies the width of the pseudoterminal, in pixels.

Data Type

Integer

TrustedKeysFile Property (SSHClient Component)

Path to the file containing public keys of authorized servers.

Syntax

__property String TrustedKeysFile = { read=FTrustedKeysFile, write=FSetTrustedKeysFile };

Default Value

""

Remarks

Path to the file containing public keys of authorized servers.

Data Type

String

Username Property (SSHClient Component)

Specifies client's username on the server.

Syntax

__property String Username = { read=FUsername, write=FSetUsername };

Default Value

""

Remarks

Client's password is set by Password property. ;

Data Type

String

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

Connect Method (SSHClient Component)

Establishes connection to an SSH server.

Syntax

void __fastcall Connect(String Address, int Port);

Remarks

Use this method to connect to the SSH server by providing its Address and Port.

Before connecting to the server you might want to set up your credentials using Username and Password properties. You might also need to configure the server key validation routine. You can do this by subscribing to KnownKeyReceived and UnknownKeyReceived events and implementing the event handlers as required.

Adjust AsyncMode before connecting to switch the component to either synchronous or asynchronous mode. In synchronous mode, all the calls to the component, such as Connect or SendBytes, are executed within the context of the caller thread, and block until the action completes. In asynchronous mode, the component runs the SSH session in a background thread, which makes all such calls return immediately. Find out more about the modes in the AsyncMode topic.

ConnectAndExec Method (SSHClient Component)

Connects to an SSH server and executes a command in one go.

Syntax

DynamicArray<Byte> __fastcall ConnectAndExec(String Address, int Port, String Command, bool WantStdout, bool WantStdErr);

Remarks

Use this method to connect to an SSH server at Address and Port and execute a command. The method returns the output of the executed command.

This method is a handy shortcut for running non-interactive commands. It encapsulates calls to Connect, Receive, Disconnect internally to save you time and space.

Please note that ConnectAndExec always runs synchronously, thus ignoring the AsyncMode setting.

Disconnect Method (SSHClient Component)

Closes connection to the SSH server.

Syntax

void __fastcall Disconnect();

Remarks

Call this method to terminate the active SSH connection.

Please note that in some cases the component may still have some inbound data cached internally even after the connection is closed. You can read that data out using Receive and/or ReceiveBytes methods.

DoAction Method (SSHClient Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

Ping Method (SSHClient Component)

Sends a keep-alive request to the SSH server.

Syntax

void __fastcall Ping();

Remarks

Use this method to send a keep-alive message to the SSH server. Keep-alive messages are empty data packets which carry no useful information but are a handy way of checking if the connection is still alive.

Poll Method (SSHClient Component)

Checks whether there is any inbound data readily available.

Syntax

bool __fastcall Poll(int Milliseconds);

Remarks

Use this method to check whether there is any incoming data available in the connection. If this method returns true, you can read the data with Receive or ReceiveBytes calls.

Use the Milliseconds parameter to tell the component how long it can wait for the data to arrive.

Receive Method (SSHClient Component)

Reads a portion of received data into a string.

Syntax

String __fastcall Receive();

Remarks

Use this method to read out a piece of data received from the server into a string.

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use Poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use ReceiveFrom to read stderr data.

ReceiveBytes Method (SSHClient Component)

Reads a portion of received data into a byte array.

Syntax

DynamicArray<Byte> __fastcall ReceiveBytes(int MaxLen);

Remarks

Use this method to read out a piece of data received from the server into a byte array. Control the maximum length of the data chunk with the MaxLen parameter.

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use Poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.

This method only returns data that arrives via the stdout channel. Use ReceiveBytesFrom to read stderr data.

ReceiveBytesFrom Method (SSHClient Component)

Reads a portion of data received via a specific channel into a byte array.

Syntax

DynamicArray<Byte> __fastcall ReceiveBytesFrom(int Channel, int MaxLen);

Remarks

Use this method to read out a piece of data received from the server into a byte array. Specify the channel that you are interested in reading from (0 for stdout, 1 for stderr) via the Channel parameter, and control the maximum length of the data chunk with the MaxLen parameter.

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use Poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.

Please also note that stdout and stderr channels are fully independent, which implies that data arriving via each channel should be read out separately.

ReceiveFrom Method (SSHClient Component)

Reads a portion of data received via a specific channel into a string.

Syntax

String __fastcall ReceiveFrom(int Channel);

Remarks

Use this method to read out a piece of data received from the server into a string. Use the Channel parameter to specify the channel that you would like to read from (0 for stdout, 1 for stderr).

Note that in synchronous mode this method may block in the absence of any inbound data until the next piece of data is received from the server. Use Poll to check if there is any data in the connection that is immediately available for reading.

In asynchronous mode a good time to call this method is upon receiving a read notification in DataReceived event handler. When working in asynchronous mode, this call returns immediately.

Reset Method (SSHClient Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

Send Method (SSHClient Component)

Sends a string to the server.

Syntax

void __fastcall Send(String DataStr, bool AddEOL);

Remarks

Use this method to send DataStr to the remote command's stdin channel. Set the AddEOL parameter to true to append the end-of-line character to the string automatically.

Note that in synchronous mode this method may block until the whole string is commited to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the DataSent event.

SendBytes Method (SSHClient Component)

Sends an array of bytes to the server.

Syntax

void __fastcall SendBytes(DynamicArray<Byte> Data);

Remarks

Use this method to send Data to the remote command's stdin channel.

Note that in synchronous mode this method may block until the whole byte array is commited to the network connection. In asynchronous mode this method returns immediately; the application is eventually notified that the data has been sent via the DataSent event.

SendSpecial Method (SSHClient Component)

Sends a special character to the server or remote command.

Syntax

void __fastcall SendSpecial(String SpecialChar);

Remarks

Use this method to send a special or control character to the SSH server or the command being executed. Specify the character id via the SpecialChar parameter.

Currently the only supported special character is "eof", which is sometimes used as a way to close the stdin channel gracefully.

AuthAttempt Event (SSHClient Component)

Fires when a single authentication attempt is performed.

Syntax

typedef struct {
  int AuthType;
} TsbxSSHClientAuthAttemptEventParams;
typedef void __fastcall (__closure *TsbxSSHClientAuthAttemptEvent)(System::TObject* Sender, TsbxSSHClientAuthAttemptEventParams *e);
__property TsbxSSHClientAuthAttemptEvent OnAuthAttempt = { read=FOnAuthAttempt, write=FOnAuthAttempt };

Remarks

This event is fired each time a single authentication attempt is performed. AuthType parameter specifies the type of authentication. Note, this event could be fired more than once if the client tries different authentication methods one after another.

AuthFailed Event (SSHClient Component)

Fires when a single authentication attempt is failed.

Syntax

typedef struct {
  int AuthenticationType;
} TsbxSSHClientAuthFailedEventParams;
typedef void __fastcall (__closure *TsbxSSHClientAuthFailedEvent)(System::TObject* Sender, TsbxSSHClientAuthFailedEventParams *e);
__property TsbxSSHClientAuthFailedEvent OnAuthFailed = { read=FOnAuthFailed, write=FOnAuthFailed };

Remarks

This event is fired each time a single authentication attempt fails. AuthType parameter specifies the type of authentication.

As SSH may try a number of authentication attempts of different types or with different parameters (such as public keys) during one session, this event may be fired more than once. It is not critical and may not lead to closing of the connection.

AuthSucceeded Event (SSHClient Component)

Reports a successful authentication.

Syntax

typedef struct {
} TsbxSSHClientAuthSucceededEventParams;
typedef void __fastcall (__closure *TsbxSSHClientAuthSucceededEvent)(System::TObject* Sender, TsbxSSHClientAuthSucceededEventParams *e);
__property TsbxSSHClientAuthSucceededEvent OnAuthSucceeded = { read=FOnAuthSucceeded, write=FOnAuthSucceeded };

Remarks

This event may be preceded by some AuthFailed events if the client tries different authentication methods one after another.

Banner Event (SSHClient Component)

Reports the receipt of the Hello message from the server.

Syntax

typedef struct {
  DynamicArray Text;
  DynamicArray Language;
} TsbxSSHClientBannerEventParams;
typedef void __fastcall (__closure *TsbxSSHClientBannerEvent)(System::TObject* Sender, TsbxSSHClientBannerEventParams *e);
__property TsbxSSHClientBannerEvent OnBanner = { read=FOnBanner, write=FOnBanner };

Remarks

SFPTClient fires this event when it receives hello message from the server.

CommandCompleted Event (SSHClient Component)

Signifies completion of the command execution.

Syntax

typedef struct {
  String Command;
  int ExitStatus;
  String ExitMessage;
  String ExitSignal;
} TsbxSSHClientCommandCompletedEventParams;
typedef void __fastcall (__closure *TsbxSSHClientCommandCompletedEvent)(System::TObject* Sender, TsbxSSHClientCommandCompletedEventParams *e);
__property TsbxSSHClientCommandCompletedEvent OnCommandCompleted = { read=FOnCommandCompleted, write=FOnCommandCompleted };

Remarks

Subscribe to this event to be notified about completion of the remote command execution. This event fires for every command in the Commands list. The Command parameter indicates the command being completed.

ExitStatus specifies the command's return code. ExitMessage or ExitSignal parameters provide error details if the command execution was terminated forcefully,

CommandStart Event (SSHClient Component)

Marks the commencement of a command execution.

Syntax

typedef struct {
  String Command;
} TsbxSSHClientCommandStartEventParams;
typedef void __fastcall (__closure *TsbxSSHClientCommandStartEvent)(System::TObject* Sender, TsbxSSHClientCommandStartEventParams *e);
__property TsbxSSHClientCommandStartEvent OnCommandStart = { read=FOnCommandStart, write=FOnCommandStart };

Remarks

Subscribe to this event to be notified about the start of execution of a remote command. The Command parameter indicates the command being started.

This event is fired for all commands in the Commands list, in order. The completion of the command is reported via the CommandCompleted event.

Connect Event (SSHClient Component)

This event is fired when an SSH session has been established.

Syntax

typedef struct {
} TsbxSSHClientConnectEventParams;
typedef void __fastcall (__closure *TsbxSSHClientConnectEvent)(System::TObject* Sender, TsbxSSHClientConnectEventParams *e);
__property TsbxSSHClientConnectEvent OnConnect = { read=FOnConnect, write=FOnConnect };

Remarks

Use this event to track the moment when SSH session has been set up.

DataReceived Event (SSHClient Component)

Reports receipt of another chunk of data from the server.

Syntax

typedef struct {
  int Channel;
  int BytesReceived;
  int TotalBytesPending;
} TsbxSSHClientDataReceivedEventParams;
typedef void __fastcall (__closure *TsbxSSHClientDataReceivedEvent)(System::TObject* Sender, TsbxSSHClientDataReceivedEventParams *e);
__property TsbxSSHClientDataReceivedEvent OnDataReceived = { read=FOnDataReceived, write=FOnDataReceived };

Remarks

This event fires in asynchronous mode to report the receipt of another chunk of data from the server. Use Receive or ReceiveBytes methods to read out the received data.

The Channel parameter indicates the channel on which the data was received: stdout (0) or stderr (1). BytesReceived specify the size of the newly received chunk, and TotalBytesPending contain the total number of bytes available for reading.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.

DataSent Event (SSHClient Component)

Notifies the application that a piece of data has been sent to the server.

Syntax

typedef struct {
  int BytesSent;
  int BytesPending;
} TsbxSSHClientDataSentEventParams;
typedef void __fastcall (__closure *TsbxSSHClientDataSentEvent)(System::TObject* Sender, TsbxSSHClientDataSentEventParams *e);
__property TsbxSSHClientDataSentEvent OnDataSent = { read=FOnDataSent, write=FOnDataSent };

Remarks

Subscribe to this event to be notified about the outbound data flow. This event fires following a call to Send or SendBytes methods to notify the application that the data provided has been sent to the server. This event may fire more than once for each Send or SendBytes call, subject to the volume of data being sent and the settings of the server.

The BytesSent parameter specifies the number of bytes that has just been sent to the server. The BytesPending indicate the number of bytes that remain cached in the internal buffer. Any bytes cached in such way will be sent again on the next available opportunity and reported via a separate DataSent event invocation.

Please note that just like other asynchronous mode events this event may fire from a secondary thread. Please make sure your code is prepared for that by using appropriate synchronization facilities.

This event does not fire in synchronous mode.

Disconnect Event (SSHClient Component)

This event is fired when the SFTP subsystem connection is closed.

Syntax

typedef struct {
  int CloseReason;
} TsbxSSHClientDisconnectEventParams;
typedef void __fastcall (__closure *TsbxSSHClientDisconnectEvent)(System::TObject* Sender, TsbxSSHClientDisconnectEventParams *e);
__property TsbxSSHClientDisconnectEvent OnDisconnect = { read=FOnDisconnect, write=FOnDisconnect };

Remarks

Do not perform any file operations after this event has been fired.

Error Event (SSHClient Component)

Information about errors during SFTP connection.

Syntax

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

Remarks

The event is fired in case of exceptional conditions during data transfer.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of error codes please refer to SFTP.

ExternalSign Event (SSHClient Component)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

typedef struct {
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxSSHClientExternalSignEventParams;
typedef void __fastcall (__closure *TsbxSSHClientExternalSignEvent)(System::TObject* Sender, TsbxSSHClientExternalSignEventParams *e);
__property TsbxSSHClientExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign };

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The component uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

KnownKeyReceived Event (SSHClient Component)

Signals that the server has introduced itself with a known key.

Syntax

typedef struct {
  String Algorithm;
  int Bits;
  String FingerprintSHA256;
} TsbxSSHClientKnownKeyReceivedEventParams;
typedef void __fastcall (__closure *TsbxSSHClientKnownKeyReceivedEvent)(System::TObject* Sender, TsbxSSHClientKnownKeyReceivedEventParams *e);
__property TsbxSSHClientKnownKeyReceivedEvent OnKnownKeyReceived = { read=FOnKnownKeyReceived, write=FOnKnownKeyReceived };

Remarks

The component fires this event to tell the application that the server has introduced itself with a known key from TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

Use ServerKey to access more key details.

Notification Event (SSHClient Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxSSHClientNotificationEventParams;
typedef void __fastcall (__closure *TsbxSSHClientNotificationEvent)(System::TObject* Sender, TsbxSSHClientNotificationEventParams *e);
__property TsbxSSHClientNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PasswordChangeRequest Event (SSHClient Component)

This event is fired when a password change is requested.

Syntax

typedef struct {
  String Prompt;
  String NewPassword;
  bool Cancel;
} TsbxSSHClientPasswordChangeRequestEventParams;
typedef void __fastcall (__closure *TsbxSSHClientPasswordChangeRequestEvent)(System::TObject* Sender, TsbxSSHClientPasswordChangeRequestEventParams *e);
__property TsbxSSHClientPasswordChangeRequestEvent OnPasswordChangeRequest = { read=FOnPasswordChangeRequest, write=FOnPasswordChangeRequest };

Remarks

This event is fired by the component when a password change is requested by the server. Prompt contains the password prompt message. Handler should either provide the new password via NewPassword, or deny the request by setting Cancel to true.

PrivateKeyNeeded Event (SSHClient Component)

This event is fired when client's public key was accepted by the server, but the corresponding secret key is not available.

Syntax

typedef struct {
  bool Skip;
} TsbxSSHClientPrivateKeyNeededEventParams;
typedef void __fastcall (__closure *TsbxSSHClientPrivateKeyNeededEvent)(System::TObject* Sender, TsbxSSHClientPrivateKeyNeededEventParams *e);
__property TsbxSSHClientPrivateKeyNeededEvent OnPrivateKeyNeeded = { read=FOnPrivateKeyNeeded, write=FOnPrivateKeyNeeded };

Remarks

Set Skip to true when it is not possible to load the missing key for some reason.

UnknownKeyReceived Event (SSHClient Component)

Signals that the server has introduced itself with an unknown key.

Syntax

typedef struct {
  String Algorithm;
  int Bits;
  String FingerprintSHA256;
  int Action;
} TsbxSSHClientUnknownKeyReceivedEventParams;
typedef void __fastcall (__closure *TsbxSSHClientUnknownKeyReceivedEvent)(System::TObject* Sender, TsbxSSHClientUnknownKeyReceivedEventParams *e);
__property TsbxSSHClientUnknownKeyReceivedEvent OnUnknownKeyReceived = { read=FOnUnknownKeyReceived, write=FOnUnknownKeyReceived };

Remarks

The component fires this event to tell the application that the server has introduced itself with a key not present in TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

In this event handler, you need to make a decision whether to proceed with the connection. Use Action to tell the component what it should do with the key:

Note that accepting an unknown and unchecked key may be risky.

Config Settings (SSHClient Component)

The component accepts one or more of the following configuration settings. Configuration 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.

SSHClient Config Settings

Base Config Settings

Trappable Errors (SSHClient Component)