SFTPClient Component

Properties   Methods   Events   Config Settings   Errors  

The SFTPClient component provides client-side functionality for SFTP (Secure File Transfer Protocol).

Syntax

TsbxSFTPClient

Remarks

SFTP is a file transfer subsystem that runs on top of secure shell (SSH) connection. This means that SFTP uses the whole strength of security provided by the SSH protocol, at the same time providing strong file transfer capabilities.

Please do keep in mind that there exist two protocols that offer similar secure file transfer features. SFTP works on top of SSH and normally uses port 22. FTPS works on top of TLS (or SSL) and normally uses ports 21 and 990. The protocols are very different, so please make sure you are after the right component. This component works with SFTP. Use the FTPClient component to connect to FTPS servers.

Below are the typical steps that let you integrate SFTPClient to your project:

• Set up your Username and Password. SSH uses mandatory client-side authentication, so in most cases you need to provide your username, your password, or, sometimes, your private key. Use Key property to provide your key, if needed.
• Be ready to handle server authentication, which is also mandatory in SSH. SSH operates a concept of a trusted keys file, where keys of known servers are stored. You can assign a path to your own trusted keys file to the TrustedKeysFile property. When a client receives a server key, it reports it to your code via its KnownKeyReceived or UnknownKeyReceived event, depending on whether the key was found in the trusted list. If you leave TrustedKeysFile empty, SFTPClient will only be able to fire the UnknownKeyReceived event, since there will be no known keys to report.
• If needed, customize Proxy parameters and SSHSettings.
• Consider interacting more with SFTPClient by subscribing to AuthAttempt, AuthFailed, and AuthSucceeded events to be notified about the client authentication progress.
• When you are ready to connect, call Connect, passing the details of the server as parameters. During the initial handshake, the following events will fire: UnknownKeyReceived (or KnownKeyReceived), and then one or more AuthAttempt, AuthFailed and AuthSucceeded.
• Upon completion of the Connect method, the component is ready for file operations. Use DownloadFile, UploadFile, ListDir, DeleteFile and other file transfer methods to work with the server file system.
• When you are done with your work, call Disconnect to close the connection.

Some SFTP servers, primarily older ones, may expose various transfer issues. If you come across a weird issue that you believe should not be happening (such as repeated connection closures in the middle of the transfer), please try adjusting the following properties:

• AutoAdjustTransferBlock to false,
• PipelineLength to 1,
• UploadBlockSize to 16384,
• DownloadBlockSize to 16384.

These adjustments will put SFTPClient in very conservative transfer setup. While this setup may be quite sluggish with modern servers, it should make SFTPClient interoperable with most older servers.

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.

AuthAttempts Property (SFTPClient Component)

Specifies the number of SSH authentication attempts.

Syntax

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

Default Value

1

Remarks

Use this property to specify the number of authentication attempts to try. The AuthFailed event is fired for every failed attempt.

Data Type

Integer

AutoAdjustTransferBlock Property (SFTPClient Component)

Specifies whether to adjust the send and receive buffer sizes automatically.

Syntax

__property bool AutoAdjustTransferBlock = { read=FAutoAdjustTransferBlock, write=FSetAutoAdjustTransferBlock };

Default Value

true

Remarks

Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds.

Use DownloadBlockSize, UploadBlockSize, and PipelineLength properties to adjust the transfer settings manually.

Data Type

Boolean

ConflictResolutionMode Property (SFTPClient Component)

Defines the approach that should be used to resolve various conflicts during batch processing.

Syntax

__property TsbxSFTPClientConflictResolutionModes ConflictResolutionMode = { read=FConflictResolutionMode, write=FSetConflictResolutionMode };

enum TsbxSFTPClientConflictResolutionModes {
  cftmOverwrite=0,
  cftmSkip=1,
  cftmAppendToEnd=2,
  cftmResume=3,
  cftmOverwriteIfDiffSize=4,
  cftmSaveWithNewName=5,
  cftmRenameExistingTarget=6
};

Default Value

cftmOverwrite

Remarks

Use this property to specify the approach to use when landing in conflicting transfer situations.

Data Type

Integer

Connected Property (SFTPClient Component)

Indicates if 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 and not available at design time.

Data Type

Boolean

ConnInfoClientKeyAlgorithm Property (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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

CurrListEntryAccessTime Property (SFTPClient Component)

Contains the last access time for this file, in UTC.

Syntax

__property String CurrListEntryAccessTime = { read=FCurrListEntryAccessTime };

Default Value

""

Remarks

Contains the last access time for this file, in UTC.

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

Data Type

String

CurrListEntryCreationTime Property (SFTPClient Component)

Contains this file's creation time, in UTC.

Syntax

__property String CurrListEntryCreationTime = { read=FCurrListEntryCreationTime };

Default Value

""

Remarks

Contains this file's creation time, in UTC.

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

Data Type

String

CurrListEntryEntryFormat Property (SFTPClient Component)

The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 .

Syntax

__property TsbxSFTPClientCurrListEntryEntryFormats CurrListEntryEntryFormat = { read=FCurrListEntryEntryFormat };

enum TsbxSFTPClientCurrListEntryEntryFormats {
  cfefUnknown=0,
  cfefUnix=1,
  cfefWindows=2,
  cfefMLSD=3
};

Default Value

cfefUnknown

Remarks

The file listing format:

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

Data Type

Integer

CurrListEntryFileType Property (SFTPClient Component)

The type of the entry: fetUnknown 0 fetDirectory 1 fetFile 2 fetSymlink 3 fetSpecial 4 fetCurrentDirectory 5 fetParentDirectory 6 fetSocket 7 fetCharDevice 8 fetBlockDevice 9 fetFIFO 10 .

Syntax

__property TsbxSFTPClientCurrListEntryFileTypes CurrListEntryFileType = { read=FCurrListEntryFileType };

enum TsbxSFTPClientCurrListEntryFileTypes {
  fetUnknown=0,
  fetDirectory=1,
  fetFile=2,
  fetSymlink=3,
  fetSpecial=4,
  fetCurrentDirectory=5,
  fetParentDirectory=6,
  fetSocket=7,
  fetCharDevice=8,
  fetBlockDevice=9,
  fetFIFO=10
};

Default Value

fetUnknown

Remarks

The type of the entry:

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

Data Type

Integer

CurrListEntryHandle Property (SFTPClient Component)

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

Syntax

__property __int64 CurrListEntryHandle = { read=FCurrListEntryHandle };

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

CurrListEntryModificationTime Property (SFTPClient Component)

File last modification date/time.

Syntax

__property String CurrListEntryModificationTime = { read=FCurrListEntryModificationTime };

Default Value

""

Remarks

File last modification date/time.

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

Data Type

String

CurrListEntryName Property (SFTPClient Component)

The file or directory name.

Syntax

__property String CurrListEntryName = { read=FCurrListEntryName };

Default Value

""

Remarks

The file or directory name.

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

Data Type

String

CurrListEntryPath Property (SFTPClient Component)

The full path to the file or directory.

Syntax

__property String CurrListEntryPath = { read=FCurrListEntryPath };

Default Value

""

Remarks

The full path to the file or directory.

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

Data Type

String

CurrListEntryPrincipal Property (SFTPClient Component)

Specifies the owner of the file/directory.

Syntax

__property String CurrListEntryPrincipal = { read=FCurrListEntryPrincipal };

Default Value

""

Remarks

Specifies the owner of the file/directory.

Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings.

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

Data Type

String

CurrListEntrySize Property (SFTPClient Component)

File size in bytes.

Syntax

__property __int64 CurrListEntrySize = { read=FCurrListEntrySize };

Default Value

0

Remarks

File size in bytes.

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

Data Type

Long64

CurrListEntryUnixPerms Property (SFTPClient Component)

The file Unix permissions bit mask (e.

Syntax

__property int CurrListEntryUnixPerms = { read=FCurrListEntryUnixPerms };

Default Value

511

Remarks

The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)).

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

Data Type

Integer

CurrListEntryUnparsedName Property (SFTPClient Component)

The unparsed entry as returned by the server.

Syntax

__property String CurrListEntryUnparsedName = { read=FCurrListEntryUnparsedName };

Default Value

""

Remarks

The unparsed entry as returned by the server. Sometimes this is also known as "long name".

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

Data Type

String

DownloadBlockSize Property (SFTPClient Component)

The download block size in bytes.

Syntax

__property int DownloadBlockSize = { read=FDownloadBlockSize, write=FSetDownloadBlockSize };

Default Value

65536

Remarks

Use this property to manually control the size of download blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

ExternalCryptoAsyncDocumentID Property (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient Component)

Specifies the asynchronous signing method.

Syntax

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

enum TsbxSFTPClientExternalCryptoMethods {
  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 (SFTPClient Component)

Specifies the external cryptography mode.

Syntax

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

enum TsbxSFTPClientExternalCryptoModes {
  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 (SFTPClient 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 (SFTPClient Component)

Reserved.

Syntax

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

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

ForceCompression Property (SFTPClient Component)

Enforces compression for the SSH layer.

Syntax

__property bool ForceCompression = { read=FForceCompression, write=FSetForceCompression };

Default Value

false

Remarks

Set this property before opening a connection to enforce compression of the SSH packets.

Data Type

Boolean

KeyFingerprintSHA1 Property (SFTPClient 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 and not available at design time.

Data Type

String

KeyFingerprintSHA256 Property (SFTPClient 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 and not available at design time.

Data Type

String

KeyHandle Property (SFTPClient 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

MaxSFTPVersion Property (SFTPClient Component)

Higher SFTP version to support.

Syntax

__property int MaxSFTPVersion = { read=FMaxSFTPVersion, write=FSetMaxSFTPVersion };

Default Value

6

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this client.

Data Type

Integer

MinSFTPVersion Property (SFTPClient Component)

Lower SFTP version to support.

Syntax

__property int MinSFTPVersion = { read=FMinSFTPVersion, write=FSetMinSFTPVersion };

Default Value

0

Remarks

MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions to be supported by this client.

Data Type

Integer

Password Property (SFTPClient Component)

Specifies user's authentication password.

Syntax

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

Default Value

""

Remarks

Use this property to provide an authentication password. This property is only applicable for password-based and keyboard-interactive authentication types.

Data Type

String

PipelineLength Property (SFTPClient Component)

The number of parallelized transfer requests.

Syntax

__property int PipelineLength = { read=FPipelineLength, write=FSetPipelineLength };

Default Value

32

Remarks

This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.

Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

ProxyAddress Property (SFTPClient Component)

The IP address of the proxy server.

Syntax

__property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress };

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SFTPClient Component)

The authentication type used by the proxy server.

Syntax

__property TsbxSFTPClientProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication };

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

Default Value

patNoAuthentication

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (SFTPClient Component)

The password to authenticate to the proxy server.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SFTPClient Component)

The port on the proxy server to connect to.

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SFTPClient Component)

The type of the proxy server.

Syntax

__property TsbxSFTPClientProxyProxyTypes ProxyProxyType = { read=FProxyProxyType, write=FSetProxyProxyType };

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

Default Value

cptNone

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (SFTPClient Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

__property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders };

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SFTPClient Component)

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

Syntax

__property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody };

Default Value

""

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SFTPClient Component)

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

Syntax

__property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders };

Default Value

""

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SFTPClient Component)

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

Syntax

__property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 };

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUsername Property (SFTPClient Component)

Specifies the username credential for proxy authentication.

Syntax

__property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername };

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerKeyAlgorithm Property (SFTPClient Component)

Specifies the key algorithm.

Syntax

__property String ServerKeyAlgorithm = { read=FServerKeyAlgorithm };

Default Value

""

Remarks

Specifies the key algorithm.

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

Data Type

String

ServerKeyBits Property (SFTPClient 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 and not available at design time.

Data Type

Integer

ServerKeyComment Property (SFTPClient 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 and not available at design time.

Data Type

String

ServerKeyCurve Property (SFTPClient 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.

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

Data Type

String

ServerKeyDSSG Property (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 and not available at design time.

Data Type

String

ServerKeyFingerprintSHA1 Property (SFTPClient 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 and not available at design time.

Data Type

String

ServerKeyFingerprintSHA256 Property (SFTPClient 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 and not available at design time.

Data Type

String

ServerKeyHandle Property (SFTPClient 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 (SFTPClient 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 and not available at design time.

Data Type

Boolean

ServerKeyIsPrivate Property (SFTPClient 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 and not available at design time.

Data Type

Boolean

ServerKeyIsPublic Property (SFTPClient 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 and not available at design time.

Data Type

Boolean

ServerKeyKDFRounds Property (SFTPClient 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 and not available at design time.

Data Type

Integer

ServerKeyKDFSalt Property (SFTPClient 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 (SFTPClient Component)

Specifies the format in which the key is stored.

Syntax

__property TsbxSFTPClientServerKeyKeyFormats ServerKeyKeyFormat = { read=FServerKeyKeyFormat };

enum TsbxSFTPClientServerKeyKeyFormats {
  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 and not available at design time.

Data Type

Integer

ServerKeyKeyProtectionAlgorithm Property (SFTPClient 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 and not available at design time.

Data Type

String

ServerKeyRSAExponent Property (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 and not available at design time.

Data Type

String

SocketDNSMode Property (SFTPClient Component)

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

Syntax

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

enum TsbxSFTPClientSocketDNSModes {
  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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient Component)

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

Syntax

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

enum TsbxSFTPClientSSHSettingsBaseConfigurations {
  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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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 (SFTPClient 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

TrustedKeysFile Property (SFTPClient Component)

A file containing the keys of authorized servers.

Syntax

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

Default Value

""

Remarks

Use this property to provide a path to the 'authorized_keys' file to be used by the client.

Data Type

String

UploadBlockSize Property (SFTPClient Component)

The upload block size in bytes.

Syntax

__property int UploadBlockSize = { read=FUploadBlockSize, write=FSetUploadBlockSize };

Default Value

32256

Remarks

Use this property to manually control the size of upload blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Data Type

Integer

Username Property (SFTPClient Component)

The client's username to authenticate to the server.

Syntax

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

Default Value

""

Remarks

Use this property to provide an authentication username (login). This property is only applicable for password-based and keyboard-interactive authentication types.

Data Type

String

UseUTF8 Property (SFTPClient Component)

Enables UTF8 for all string content.

Syntax

__property bool UseUTF8 = { read=FUseUTF8, write=FSetUseUTF8 };

Default Value

false

Remarks

If UseUTF8 is true, the component expects all downloaded filenames to be encoded in UTF-8. Set UseUTF8 to false if you connect to a server that does not support UTF8 (e.g., OpenSSH). In this case the file names will be interpreted in the default character set.

Data Type

Boolean

Version Property (SFTPClient Component)

The SFTP version negotiated.

Syntax

__property int Version = { read=FVersion };

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

Data Type

Integer

AbsolutePath Method (SFTPClient Component)

Requests the absolute path for a relative path.

Syntax

String __fastcall AbsolutePath(String RemotePath);

Remarks

Use this method to ask the SFTP server to convert a relative path to an absolute.

ChangeDir Method (SFTPClient Component)

Changes current working directory on the server.

Syntax

void __fastcall ChangeDir(String RemoteDir);

Remarks

Changes current working directory on the server to RemoteDir.

Config Method (SFTPClient 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 (SFTPClient Component)

Connects to an SFTP server.

Syntax

void __fastcall Connect(String Address, int Port);

Remarks

Use this method to connect to the SFTP server identified via its Address and Port.

CreateLink Method (SFTPClient Component)

Creates a symbolic or hard link to a remote file.

Syntax

void __fastcall CreateLink(String LinkPath, String TargetPath, bool HardLink);

Remarks

Use this method to create a symbolic or hard link on the server. Provide the name of the new link object via the LinkPath parameter, and the destinating file or directory path via the TargetPath parameter. HardLink specifies whether the new link should be hard (true) or symbolic (false).

DelDir Method (SFTPClient Component)

Removes directory from the SFTP server.

Syntax

void __fastcall DelDir(String RemoteDir);

Remarks

DelFile Method (SFTPClient Component)

Deletes a file from the SFTP server.

Syntax

void __fastcall DelFile(String RemoteFile);

Remarks

DelFiles Method (SFTPClient Component)

Deletes a group of files from the SFTP server.

Syntax

void __fastcall DelFiles(String RemotePath, String Mask, bool CaseSensitive, bool Recursive, int ErrorHandling);

Remarks

DirExists Method (SFTPClient Component)

Checks if a directory exists on the SFTP server.

Syntax

bool __fastcall DirExists(String RemoteDir);

Remarks

RemoteDir specifies the name of the remote directory to check for existence.

Disconnect Method (SFTPClient Component)

Disconnects from the SFTP server.

Syntax

void __fastcall Disconnect();

Remarks

Call this method to disconnect from the SFTP server.

DoAction Method (SFTPClient 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;....

DownloadBytes Method (SFTPClient Component)

Downloads a file from the server into an array of bytes.

Syntax

DynamicArray<Byte> __fastcall DownloadBytes(String RemoteFile);

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (SFTPClient Component)

Downloads a file from the SFTP server.

Syntax

void __fastcall DownloadFile(String RemoteFile, String LocalFile);

Remarks

Use this method to download RemoteFile into the location specified by LocalFile.

DownloadFiles Method (SFTPClient Component)

Downloads multiple files from the SFTP server.

Syntax

void __fastcall DownloadFiles(String RemotePath, String LocalDir, bool Recursive, int ErrorHandling);

Remarks

RemotePath contains a file mask or regular expression by which the files are selected for download.

LocalDir specifies the local folder where the files should be saved. The Recursive parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual RemotePath, but not its subdirectories, will be downloaded.

The ErrorHandling parameter specifies the error handling tactics.

ExecuteSSHCommand Method (SFTPClient Component)

Sends an SSH command to the server in the middle of SFTP session.

Syntax

DynamicArray<Byte> __fastcall ExecuteSSHCommand(String Command);

Remarks

Use this command to send an SSH command to the server in the middle of an SFTP session. The command is executed in a secondary channel, so the SFTP connection is not affected.

This method is suitable for simple commands that do not require interaction with the user. The call returns the command output.

ExtensionCmd Method (SFTPClient Component)

Sends an extension command to the server.

Syntax

DynamicArray<Byte> __fastcall ExtensionCmd(String Extn, DynamicArray<Byte> DataBuffer);

Remarks

Use this method to send an extension command to the SFTP server. Provide the extension type via the Extn parameter, and the request body via the DataBuffer parameter.

Upon completion of the command, the method returns the response as received from the server.

FileExists Method (SFTPClient Component)

Checks whether a file exists on the server.

Syntax

bool __fastcall FileExists(String RemoteFile);

Remarks

Use this method to check if a RemoteFile exists on the server.

GetCurrentDir Method (SFTPClient Component)

Returns the current directory on the SFTP server.

Syntax

String __fastcall GetCurrentDir();

Remarks

Use this method to retrieve the current directory as stored by the component. This is a virtualized current directory, as SFTP protocol does not maintain a concept of the current directory.

GetFileSize Method (SFTPClient Component)

Checks the size of a remote file.

Syntax

__int64 __fastcall GetFileSize(String RemoteFile);

Remarks

Returns the size of the RemoteFile.

ListDir Method (SFTPClient Component)

Lists the content of the current remote directory.

Syntax

String __fastcall ListDir(bool IncludeFiles, bool IncludeDirectories);

Remarks

IncludeFiles specifies whether file names and symlinks should be included in the results. IncludeDirectories specifies whether directory names should be included in the result.

Upon receiving the listing, the component will report each entry in it via ListEntry event.

MakeDir Method (SFTPClient Component)

Creates a new directory on the server.

Syntax

void __fastcall MakeDir(String RemoteDir);

Remarks

RemoteDir specifies the name of the new directory.

RenameFile Method (SFTPClient Component)

Renames a file.

Syntax

void __fastcall RenameFile(String SourceFile, String DestFile);

Remarks

Use this method to rename a remote file. Provide the old and the new name via SourceFile and DestFile parameters.

RequestAttributes Method (SFTPClient Component)

Requests attributes of the remote file.

Syntax

String __fastcall RequestAttributes(String RemotePath, bool FollowSymLinks);

Remarks

Use this method to request attributes of a remote file. Pass the name of the file via the RemotePath parameter, and use FollowSymLinks to specify whether symbolic links should be resolved.

The method returns the list of attributes as a line of semicolon-separated entries: Size=78220;Owner=user@system;Group=none@system;Permissions=432;ATime=2020-04-28 08:21:00.295;MTime=2020-04-28 08:21:00.302;CTime=2020-04-28 08:21:00.295;AttribBits=24;LinkCount=1.

Reset Method (SFTPClient Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

SetAttributes Method (SFTPClient Component)

Sets the attributes upon a remote file.

Syntax

void __fastcall SetAttributes(String RemotePath, String Attributes);

Remarks

Use this method to set the attributes of a remote file.

UploadBytes Method (SFTPClient Component)

Uploads a byte array to the server.

Syntax

void __fastcall UploadBytes(DynamicArray<Byte> Bytes, String RemoteFile);

Remarks

Use this method to upload Bytes or its part to RemoteFile on the server.

UploadFile Method (SFTPClient Component)

Uploads a file to the server.

Syntax

void __fastcall UploadFile(String LocalFile, String RemoteFile);

Remarks

Use this method to upload LocalFile to the RemoteFile location on the server.

UploadFiles Method (SFTPClient Component)

Uploads multiple files to the server.

Syntax

void __fastcall UploadFiles(String LocalPath, String RemoteDir, bool Recursive, int ErrorHandling);

Remarks

Use this property to upload a batch of files to the server.

LocalPath specifies a wildcard or regular expression by which the local files are picked for uploading. RemoteDir specifies the location on the server where these files should be saved. The Recursive parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual LocalPath, but not its subdirectories, will be uploaded.

The ErrorHandling parameter specifies one of the pre-defined error handling tactics:

AuthAttempt Event (SFTPClient Component)

Fires when an authentication attempt is performed.

Syntax

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

Remarks

This event signals the start of an authentication attempt. The AuthType parameter specifies the authentication type. This event may be fired more than once if the client tries different authentication methods one after another.

Supported authentication types:

AuthFailed Event (SFTPClient Component)

Fires if an authentication attempt fails.

Syntax

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

Remarks

This event fires if an authentication attempt fails (for example, if a bad password had been provided). AuthType parameter indicates the authentication type.

AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the AuthAttempts property.

This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method.

Supported authentication types:

AuthSucceeded Event (SFTPClient Component)

Reports a successful authentication.

Syntax

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

Remarks

This event marks the completion of the authentication procedure, and signifies transition to the SSH connection subprotocol.

Banner Event (SFTPClient Component)

Reports the receipt of the Welcome message from the server.

Syntax

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

Remarks

The component fires this event when it receives a welcome message from the server. Use the Text parameter to access the encoded message.

Disconnect Event (SFTPClient Component)

Reports SFTP connection closure.

Syntax

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

Remarks

The component fires this event to report connection closure. No more SFTP activity could be done after the disconnect.

Error Event (SFTPClient Component)

Information about errors during SFTP connection.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxSFTPClientErrorEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientErrorEvent)(System::TObject* Sender, TsbxSFTPClientErrorEventParams *e);
__property TsbxSFTPClientErrorEvent 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 (SFTPClient 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;
} TsbxSFTPClientExternalSignEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientExternalSignEvent)(System::TObject* Sender, TsbxSFTPClientExternalSignEventParams *e);
__property TsbxSFTPClientExternalSignEvent 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(); };

FileNameChangeNeeded Event (SFTPClient Component)

Asks the application for a new file name.

Syntax

typedef struct {
  String FileName;
  bool Force;
} TsbxSFTPClientFileNameChangeNeededEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientFileNameChangeNeededEvent)(System::TObject* Sender, TsbxSFTPClientFileNameChangeNeededEventParams *e);
__property TsbxSFTPClientFileNameChangeNeededEvent OnFileNameChangeNeeded = { read=FOnFileNameChangeNeeded, write=FOnFileNameChangeNeeded };

Remarks

The component uses this event to ask the application for a new file name in the case of a name conflict. Adjust the FileName as required to avoid the conflict, or set Force to true to go ahead with the current name (possibly overwriting an existing file).

FileOperation Event (SFTPClient Component)

Signifies the start of a file transfer operation.

Syntax

typedef struct {
  int Operation;
  String RemotePath;
  String LocalPath;
  bool Skip;
  bool Cancel;
} TsbxSFTPClientFileOperationEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientFileOperationEvent)(System::TObject* Sender, TsbxSFTPClientFileOperationEventParams *e);
__property TsbxSFTPClientFileOperationEvent OnFileOperation = { read=FOnFileOperation, write=FOnFileOperation };

Remarks

This event is fired each time the component starts an upload or download operation within a multi-file call. Operation defines the operation about to start, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

If needed, set Skip to true to ignore the current file, or Cancel to abort the whole batch.

Supported operations:

FileOperationResult Event (SFTPClient Component)

Signifies the completion of a file transfer operation.

Syntax

typedef struct {
  int Operation;
  String RemotePath;
  String LocalPath;
  int ErrorCode;
  String Comment;
  bool Cancel;
} TsbxSFTPClientFileOperationResultEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientFileOperationResultEvent)(System::TObject* Sender, TsbxSFTPClientFileOperationResultEventParams *e);
__property TsbxSFTPClientFileOperationResultEvent OnFileOperationResult = { read=FOnFileOperationResult, write=FOnFileOperationResult };

Remarks

This event is fired each time the component completes a file transfer within a multi-file call. Operation defines the operation performed on the file, RemotePath specifies the name and path to the remote file, and LocalPath specifies the name and path to the local file.

ErrorCode and Comment return the code and textual description of the error, if it was encountered.

Set Cancel to True to cancel the multi-file operation.

Supported operations:

KnownKeyReceived Event (SFTPClient Component)

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

Syntax

typedef struct {
  String Algorithm;
  int Bits;
  String FingerprintSHA256;
} TsbxSFTPClientKnownKeyReceivedEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientKnownKeyReceivedEvent)(System::TObject* Sender, TsbxSFTPClientKnownKeyReceivedEventParams *e);
__property TsbxSFTPClientKnownKeyReceivedEvent 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.

ListEntry Event (SFTPClient Component)

Reports a directory listing entry to the application.

Syntax

typedef struct {
  String FileName;
} TsbxSFTPClientListEntryEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientListEntryEvent)(System::TObject* Sender, TsbxSFTPClientListEntryEventParams *e);
__property TsbxSFTPClientListEntryEvent OnListEntry = { read=FOnListEntry, write=FOnListEntry };

Remarks

The component fires this event to report a directory listing entry to the application. FileName contains the entry name.

Use CurrentListEntry to access the details of the entry.

Notification Event (SFTPClient Component)

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

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxSFTPClientNotificationEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientNotificationEvent)(System::TObject* Sender, TsbxSFTPClientNotificationEventParams *e);
__property TsbxSFTPClientNotificationEvent 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 (SFTPClient Component)

Signals that the server requests a password change.

Syntax

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

Remarks

The component fires this event to pass the password change request from the server to the application. This event is fired during the SSH handshake.

PrivateKeyNeeded Event (SFTPClient Component)

Asks the application for the client's private key.

Syntax

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

Remarks

The component fires this event if the public key provided in Key was accepted by the server, but no private key is available for it.

Use this event handler to attach the private key to your Key. The component will pick the key up and continue the authentication.

Progress Event (SFTPClient Component)

Fires periodically during the data transfer.

Syntax

typedef struct {
  __int64 Total;
  __int64 Current;
  bool Cancel;
} TsbxSFTPClientProgressEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientProgressEvent)(System::TObject* Sender, TsbxSFTPClientProgressEventParams *e);
__property TsbxSFTPClientProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

Use this event to check the progress of an upload or download operation. Total indicates the total number of bytes to be transferred; Current specifies how much data has been transferred so far, and Cancel gives you a chance to cancel the operation.

UnknownKeyReceived Event (SFTPClient Component)

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

Syntax

typedef struct {
  String Algorithm;
  int Bits;
  String FingerprintSHA256;
  int Action;
} TsbxSFTPClientUnknownKeyReceivedEventParams;
typedef void __fastcall (__closure *TsbxSFTPClientUnknownKeyReceivedEvent)(System::TObject* Sender, TsbxSFTPClientUnknownKeyReceivedEventParams *e);
__property TsbxSFTPClientUnknownKeyReceivedEvent 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 (SFTPClient 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.

SFTPClient Config Settings

Base Config Settings

Trappable Errors (SFTPClient Component)

SFTPClient Errors