SFTPClient Class

Properties Methods Events Configuration Settings Errors

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

Syntax

SFTPClient

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


AuthAttempts	Specifies the number of SSH authentication attempts.
AutoAdjustTransferBlock	Specifies whether to adjust the send and receive buffer sizes automatically.
Connected	Indicates if the client is connected to the SFTP server.
ConnInfoClientKeyAlgorithm	Specifies the client's key algorithm.
ConnInfoClientKeyBits	Specifies the length of the client's key.
ConnInfoClientKeyFingerprint	The fingerprint (hash value) of the client's public key.
ConnInfoCloseReason	Contains the line sent by the server just before closing the connection.
ConnInfoCompressionAlgorithmInbound	Compression algorithm for the incoming traffic.
ConnInfoCompressionAlgorithmOutbound	Compression algorithm for the outgoing traffic.
ConnInfoEncryptionAlgorithmInbound	Encryption algorithm for the incoming traffic.
ConnInfoEncryptionAlgorithmOutbound	Encryption algorithm for the outgoing traffic.
ConnInfoInboundEncryptionKeyBits	Specifies the length of the key used to encrypt the incoming traffic.
ConnInfoKexAlgorithm	The key exchange algorithm used during the SSH handshake.
ConnInfoKexBits	The number of bits used by the key exchange algorithm.
ConnInfoKexLines	The contents of the received KexInit packet.
ConnInfoMacAlgorithmInbound	MAC algorithm used for the incoming connection.
ConnInfoMacAlgorithmOutbound	MAC algorithm used for outbound connection.
ConnInfoOutboundEncryptionKeyBits	Specifies the length of the key used to encrypt the outgoing traffic.
ConnInfoPublicKeyAlgorithm	Specifies the public key algorithm which was used during the SSH handshake.
ConnInfoServerKeyBits	Specifies the number of bits in the server's key.
ConnInfoServerKeyFingerprint	The fingerprint (hash value) of the server's public key.
ConnInfoServerSoftwareName	Returns the name of the SSH software running on the server side.
ConnInfoTotalBytesReceived	Returns the total number of bytes received over this connection.
ConnInfoTotalBytesSent	Returns the total number of bytes sent over this connection.
ConnInfoVersion	Specifies SSH protocol version.
CurrListEntryATime	Contains the last access time for this file, in UTC.
CurrListEntryCTime	Contains this file's creation time, in UTC.
CurrListEntryDirectory	Specifies whether this entry is a directory.
CurrListEntryFileType	Specifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 .
CurrListEntryGroupExecute	Controls file execution permission for the group users.
CurrListEntryGroupRead	Controls file read permission for the group users.
CurrListEntryGroupWrite	Controls file write permission for the group users.
CurrListEntryHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
CurrListEntryLongName	Contains the long name of the file (human-readable, ftp-like).
CurrListEntryMTime	Specifies the last modification time, in UTC.
CurrListEntryName	Specifies the file name.
CurrListEntryOtherExecute	Controls file execution permission for other users (users that are neither owners, nor belong to the same group).
CurrListEntryOtherRead	Controls file read permission for other users (users that are neither owners, nor belong to the same group).
CurrListEntryOtherWrite	Controls file write permission for other users (users that are neither owners, nor belong to the same group).
CurrListEntryOwner	Specifies the owner of the file/directory.
CurrListEntryPath	Contains the full path to the file.
CurrListEntrySize	The size of the file in bytes.
CurrListEntryUserExecute	Controls file execution permission for the file owner.
CurrListEntryUserRead	Controls file read permission for the file owner.
CurrListEntryUserWrite	Controls file write permission for the file owner.
DownloadBlockSize	The download block size in bytes.
ExternalCryptoAsyncDocumentID	Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.
ExternalCryptoCustomParams	Custom parameters to be passed to the signing service (uninterpreted).
ExternalCryptoData	Additional data to be included in the async state and mirrored back by the requestor.
ExternalCryptoExternalHashCalculation	Specifies whether the message hash is to be calculated at the external endpoint.
ExternalCryptoHashAlgorithm	Specifies the request's signature hash algorithm.
ExternalCryptoKeyID	The ID of the pre-shared key used for DC request authentication.
ExternalCryptoKeySecret	The pre-shared key used for DC request authentication.
ExternalCryptoMethod	Specifies the asynchronous signing method.
ExternalCryptoMode	Specifies the external cryptography mode.
ExternalCryptoPublicKeyAlgorithm	Provide public key algorithm here if the certificate is not available on the pre-signing stage.
FIPSMode	Reserved.
ForceCompression	Enforces compression for the SSH layer.
KeyFingerprintSHA1	Contains the SHA-1 fingerprint (hash) of the key.
KeyFingerprintSHA256	Contains the SHA-256 fingerprint (hash) of the key.
KeyHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
MaxSFTPVersion	Higher SFTP version to support.
MinSFTPVersion	Lower SFTP version to support.
Password	Specifies user's authentication password.
PipelineLength	The number of parallelized transfer requests.
ProxyAddress	The IP address of the proxy server.
ProxyAuthentication	The authentication type used by the proxy server.
ProxyPassword	The password to authenticate to the proxy server.
ProxyPort	The port on the proxy server to connect to.
ProxyProxyType	The type of the proxy server.
ProxyRequestHeaders	Contains HTTP request headers for WebTunnel and HTTP proxy.
ProxyResponseBody	Contains the HTTP or HTTPS (WebTunnel) proxy response body.
ProxyResponseHeaders	Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.
ProxyUseIPv6	Specifies whether IPv6 should be used when connecting through the proxy.
ProxyUseProxy	Enables or disables proxy-driven connection.
ProxyUsername	Specifies the username credential for proxy authentication.
ServerKeyAlgorithm	Specifies the key algorithm.
ServerKeyBits	The number of bits in the key: the more the better, 2048 or 4096 are typical values.
ServerKeyComment	The comment for the public key.
ServerKeyCurve	Specifies the elliptical curve when EC cryptography is used.
ServerKeyDSSG	The G (Generator) parameter of the DSS signature key.
ServerKeyDSSP	The P (Prime) parameter of the DSS signature key.
ServerKeyDSSQ	The Q (Prime Factor) parameter of the DSS signature key.
ServerKeyDSSX	The X (Private key) parameter of the DSS signature key.
ServerKeyDSSY	The Y (Public key) parameter of the DSS signature key.
ServerKeyECCD	The value of the secret key (the order of the public key, D) if elliptic curve (EC) cryptography is used.
ServerKeyECCQX	The value of the X coordinate of the public key if elliptic curve (EC) cryptography is used.
ServerKeyECCQY	The value of the Y coordinate of the public key if elliptic curve (EC) cryptography is used.
ServerKeyEdPrivate	The value of the private key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
ServerKeyEdPublic	The value of the public key if EdDSA (Edwards-curve Digital Signature Algorithm) algorithm is used.
ServerKeyFingerprintMD5	Contains the MD5 fingerprint (hash) of the key.
ServerKeyFingerprintSHA1	Contains the SHA-1 fingerprint (hash) of the key.
ServerKeyFingerprintSHA256	Contains the SHA-256 fingerprint (hash) of the key.
ServerKeyHandle	Allows to get or set a 'handle', a unique identifier of the underlying property object.
ServerKeyIsExtractable	Whether the key is extractable (e.
ServerKeyIsPrivate	Whether this key is a private key or not.
ServerKeyIsPublic	Whether this key is a public key or not.
ServerKeyKDFRounds	Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.
ServerKeyKDFSalt	The salt value used by the Key Derivation Function (KDF) to generate this key.
ServerKeyKeyFormat	Specifies the format in which the key is stored.
ServerKeyKeyProtectionAlgorithm	Specifies the key protection algorithm.
ServerKeyRSAExponent	Returns the e parameter (public exponent) of the RSA key.
ServerKeyRSAIQMP	Returns the iqmp parameter of the RSA key.
ServerKeyRSAModulus	Returns the m parameter (public modulus) of the RSA key.
ServerKeyRSAP	Returns the p parameter (first factor of the common modulus n) of the RSA key.
ServerKeyRSAPrivateExponent	Returns the d parameter (private exponent) of the RSA key.
ServerKeyRSAQ	Returns the q parameter (second factor of the common modulus n) of the RSA key.
ServerKeySubject	Specifies the public key owner (subject).
SocketDNSMode	Selects the DNS resolver to use: the class's (secure) built-in one, or the one provided by the system.
SocketDNSPort	Specifies the port number to be used for sending queries to the DNS server.
SocketDNSQueryTimeout	The timeout (in milliseconds) for each DNS query.
SocketDNSServers	The addresses of DNS servers to use for address resolution, separated by commas or semicolons.
SocketDNSTotalTimeout	The timeout (in milliseconds) for the whole resolution process.
SocketIncomingSpeedLimit	The maximum number of bytes to read from the socket, per second.
SocketLocalAddress	The local network interface to bind the socket to.
SocketLocalPort	The local port number to bind the socket to.
SocketOutgoingSpeedLimit	The maximum number of bytes to write to the socket, per second.
SocketTimeout	The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.
SocketUseIPv6	Enables or disables IP protocol version 6.
SSHSettingsAutoAdjustCiphers	Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to.
SSHSettingsBaseConfiguration	Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility.
SSHSettingsCompressionAlgorithms	A list of session compression algorithms separated with commas or semicolons.
SSHSettingsCompressionLevel	Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression).
SSHSettingsDefaultWindowSize	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.
SSHSettingsEncryptionAlgorithms	A list of session encryption algorithms separated with commas or semicolons.
SSHSettingsForceCompression	Whether the SSH client should explicitly request compression.
SSHSettingsGSSAuthTypes	A comma-separated list of authentication types.
SSHSettingsGSSDelegateCreds	Switches credential delegation on or off.
SSHSettingsGSSHostname	The GSS host name, in form of a FQDN (e.
SSHSettingsGSSLib	A path to the GSS-API library (DLL or SO).
SSHSettingsGSSMechanisms	A comma-separated list of GSS mechanisms to use.
SSHSettingsGSSProtocols	A comma-separated list of SSPI protocols.
SSHSettingsHandshakeTimeout	Specifies the maximal time for the SSH handshake to proceed, in seconds.
SSHSettingsKexAlgorithms	A list of key exchange algorithms separated with commas or semicolons.
SSHSettingsMacAlgorithms	A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.
SSHSettingsMaxSSHPacketSize	Specifies the maximum length of one SSH packet in bytes.
SSHSettingsMinWindowSize	Specifies the minimal internal window size.
SSHSettingsObfuscateHandshake	Enables or disables handshake obfuscation.
SSHSettingsObfuscationPassword	Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.
SSHSettingsPublicKeyAlgorithms	A list of public key algorithms separated with commas or semicolons.
SSHSettingsRequestPasswordChange	Whether to request a password change when connecting.
SSHSettingsSoftwareName	The name to be used by the class to identify itself.
SSHSettingsTrustAllKeys	Enables or disables explicit trust to all server keys.
SSHSettingsUseAuthAgent	Enables or disables the use of external key agent, such as Putty key agent.
SSHSettingsVersions	Specifies enabled SSH protocol versions (1 or 2).
TrustedKeysFile	A file containing the keys of authorized servers.
UploadBlockSize	The upload block size in bytes.
Username	The client's username to authenticate to the server.
UseUTF8	Enables UTF8 for all string content.
Version	The SFTP version negotiated.

Method List

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


AbsolutePath	Requests the absolute path for a relative path.
ChangeDir	Changes current working directory on the server.
Config	Sets or retrieves a configuration setting.
Connect	Connects to an SFTP server.
CreateLink	Creates a symbolic or hard link to a remote file.
DeleteDir	Removes directory from the SFTP server.
DeleteFile	Deletes a file from the SFTP server.
DeleteFiles	Deletes a group of files from the SFTP server.
DirExists	Checks if a directory exists on the SFTP server.
Disconnect	Disconnects from the SFTP server.
DoAction	Performs an additional action.
DownloadBytes	Downloads a file from the server into an array of bytes.
DownloadFile	Downloads a file from the SFTP server.
DownloadFiles	Downloads multiple files from the SFTP server.
ExecuteSSHCommand	Sends an SSH command to the server in the middle of SFTP session.
ExtensionCmd	Sends an extension command to the server.
FileExists	Checks whether a file exists on the server.
GetCurrentDir	Returns the current directory on the SFTP server.
GetFileSize	Checks the size of a remote file.
ListDir	Lists the content of the current remote directory.
MakeDir	Creates a new directory on the server.
RenameFile	Renames a file.
RequestAttributes	Requests attributes of the remote file.
SetAttributes	Sets the attributes upon a remote file.
UploadBytes	Uploads a byte array to the server.
UploadFile	Uploads a file to the server.
UploadFiles	Uploads multiple files to the server.

Event List

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


AuthAttempt	Fires when an authentication attempt is performed.
AuthFailed	Fires if an authentication attempt fails.
AuthSucceeded	Reports a successful authentication.
Banner	Reports the receipt of the Welcome message from the server.
Disconnect	Reports SFTP connection closure.
Error	Information about errors during SFTP connection.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
FileOperation	Signifies the start of a file transfer operation.
FileOperationResult	Signifies the completion of a file transfer operation.
KnownKeyReceived	Signals that the server has introduced itself with a known key.
ListEntry	Reports a directory listing entry to the application.
Notification	This event notifies the application about an underlying control flow event.
PasswordChangeRequest	Signals that the server requests a password change.
PrivateKeyNeeded	Asks the application for the client's private key.
Progress	Fires periodically during the data transfer.
UnknownKeyReceived	Signals that the server has introduced itself with an unknown key.

Configuration Settings

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


AdjustFileTimes	Whether file times should be adjusted after upload/download.
ASCIIMode	Whether ASCII transfer mode is used.
CaseConversion	Whether case conversion must be applied to file names as they are downloaded.
CaseSensitive	Specifies if file paths are case-sensitive.
CopyMode	Defines what to do with each successfully copied file.
DefOutboundBlockSize	The default outbound block size.
DisablePacketFragmentation	Enables or disables SSH packet fragmentation.
ErrorOrigin	Specifies whether the error is local or remote.
ErrorSeverity	Specifies whether the error is fatal.
IncomingSpeedLimit	Specifies incoming speed limit.
KeepAlivePeriod	The inactivity period after which a keep-alive signal will be sent.
LocalCharset	Charset used on the client machine.
LocalNewLineConvention	A character string for the end of line (EOL) indication on the local machine.
Mode	The file open mode to use.
NewLineConvention	A character string for the end of line (EOL) indication on the server.
OutgoingSpeedLimit	Specifies incoming speed limit.
PreserveExistingFileTimes	Whether original file times should be restored upon transfer.
Recursive	Whether subdirectories should also be scanned for matching files.
RedirectStdErr	Whether to redirect output to StdErr.
RemoteCharset	Charset used on the server.
SFTPBufferSize	The size of internal buffer used for data transfer.
SFTPServerExecutableLocations	Location of the SFTP server executable.
StdErrData	The buffer for writing StdErr data.
TempPath	Location where the temporary files are stored.
TreatZeroSizeAsUndefined	Whether zero size returned by STAT should be considered as undefined.
UseTruncateFlagOnUpload	whether to use the 'truncate' flag on file upload.
UseUTF8OnV3	Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
Tag	Allows to store any custom data.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.

AuthAttempts Property (SFTPClient Class)

Specifies the number of SSH authentication attempts.

Syntax

int GetAuthAttempts();
int SetAuthAttempts(int iAuthAttempts);

Default Value

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

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

Syntax

bool GetAutoAdjustTransferBlock();
int SetAutoAdjustTransferBlock(bool bAutoAdjustTransferBlock);

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

Connected Property (SFTPClient Class)

Indicates if the client is connected to the SFTP server.

Syntax

bool GetConnected();

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

Specifies the client's key algorithm.

Syntax

QString GetConnInfoClientKeyAlgorithm();

Default Value

Remarks

Specifies the client's key algorithm.

This property is read-only.

Data Type

String

ConnInfoClientKeyBits Property (SFTPClient Class)

Specifies the length of the client's key.

Syntax

int GetConnInfoClientKeyBits();

Default Value

Remarks

Specifies the length of the client's key.

This property is read-only.

Data Type

Integer

ConnInfoClientKeyFingerprint Property (SFTPClient Class)

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

Syntax

QString GetConnInfoClientKeyFingerprint();

Default Value

Remarks

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

This property is read-only.

Data Type

String

ConnInfoCloseReason Property (SFTPClient Class)

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

Syntax

QString GetConnInfoCloseReason();

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

Compression algorithm for the incoming traffic.

Syntax

QString GetConnInfoCompressionAlgorithmInbound();

Default Value

Remarks

Compression algorithm for the incoming traffic.

This property is read-only.

Data Type

String

ConnInfoCompressionAlgorithmOutbound Property (SFTPClient Class)

Compression algorithm for the outgoing traffic.

Syntax

QString GetConnInfoCompressionAlgorithmOutbound();

Default Value

Remarks

Compression algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

ConnInfoEncryptionAlgorithmInbound Property (SFTPClient Class)

Encryption algorithm for the incoming traffic.

Syntax

QString GetConnInfoEncryptionAlgorithmInbound();

Default Value

Remarks

Encryption algorithm for the incoming traffic.

This property is read-only.

Data Type

String

ConnInfoEncryptionAlgorithmOutbound Property (SFTPClient Class)

Encryption algorithm for the outgoing traffic.

Syntax

QString GetConnInfoEncryptionAlgorithmOutbound();

Default Value

Remarks

Encryption algorithm for the outgoing traffic.

This property is read-only.

Data Type

String

ConnInfoInboundEncryptionKeyBits Property (SFTPClient Class)

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

Syntax

int GetConnInfoInboundEncryptionKeyBits();

Default Value

Remarks

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

This property is read-only.

Data Type

Integer

ConnInfoKexAlgorithm Property (SFTPClient Class)

The key exchange algorithm used during the SSH handshake.

Syntax

QString GetConnInfoKexAlgorithm();

Default Value

Remarks

The key exchange algorithm used during the SSH handshake.

This property is read-only.

Data Type

String

ConnInfoKexBits Property (SFTPClient Class)

The number of bits used by the key exchange algorithm.

Syntax

int GetConnInfoKexBits();

Default Value

Remarks

The number of bits used by the key exchange algorithm.

This property is read-only.

Data Type

Integer

ConnInfoKexLines Property (SFTPClient Class)

The contents of the received KexInit packet.

Syntax

QString GetConnInfoKexLines();

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

MAC algorithm used for the incoming connection.

Syntax

QString GetConnInfoMacAlgorithmInbound();

Default Value

Remarks

MAC algorithm used for the incoming connection.

This property is read-only.

Data Type

String

ConnInfoMacAlgorithmOutbound Property (SFTPClient Class)

MAC algorithm used for outbound connection.

Syntax

QString GetConnInfoMacAlgorithmOutbound();

Default Value

Remarks

MAC algorithm used for outbound connection.

This property is read-only.

Data Type

String

ConnInfoOutboundEncryptionKeyBits Property (SFTPClient Class)

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

Syntax

int GetConnInfoOutboundEncryptionKeyBits();

Default Value

Remarks

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

This property is read-only.

Data Type

Integer

ConnInfoPublicKeyAlgorithm Property (SFTPClient Class)

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

Syntax

QString GetConnInfoPublicKeyAlgorithm();

Default Value

Remarks

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

This property is read-only.

Data Type

String

ConnInfoServerKeyBits Property (SFTPClient Class)

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

Syntax

int GetConnInfoServerKeyBits();

Default Value

Remarks

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

This property is read-only.

Data Type

Integer

ConnInfoServerKeyFingerprint Property (SFTPClient Class)

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

Syntax

QString GetConnInfoServerKeyFingerprint();

Default Value

Remarks

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

This property is read-only.

Data Type

String

ConnInfoServerSoftwareName Property (SFTPClient Class)

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

Syntax

QString GetConnInfoServerSoftwareName();

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

Returns the total number of bytes received over this connection.

Syntax

qint64 GetConnInfoTotalBytesReceived();

Default Value

Remarks

Returns the total number of bytes received over this connection.

This property is read-only.

Data Type

Long64

ConnInfoTotalBytesSent Property (SFTPClient Class)

Returns the total number of bytes sent over this connection.

Syntax

qint64 GetConnInfoTotalBytesSent();

Default Value

Remarks

Returns the total number of bytes sent over this connection.

This property is read-only.

Data Type

Long64

ConnInfoVersion Property (SFTPClient Class)

Specifies SSH protocol version.

Syntax

int GetConnInfoVersion();

Default Value

Remarks

Specifies SSH protocol version.

This property is read-only.

Data Type

Integer

CurrListEntryATime Property (SFTPClient Class)

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

Syntax

QString GetCurrListEntryATime();

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

CurrListEntryCTime Property (SFTPClient Class)

Contains this file's creation time, in UTC.

Syntax

QString GetCurrListEntryCTime();

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

CurrListEntryDirectory Property (SFTPClient Class)

Specifies whether this entry is a directory.

Syntax

bool GetCurrListEntryDirectory();

Default Value

false

Remarks

Specifies whether this entry is a directory.

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

Data Type

Boolean

CurrListEntryFileType Property (SFTPClient Class)

Specifies the type of this entry, one of the following: cftFile 0 cftDirectory 1 cftSymblink 2 cftSpecial 3 cftUnknown 4 cftSocket 5 cftCharDevice 6 cftBlockDevice 7 cftFIFO 8 .

Syntax

int GetCurrListEntryFileType();

Possible Values

CFT_FILE(0), 
CFT_DIRECTORY(1), 
CFT_SYMBLINK(2), 
CFT_SPECIAL(3), 
CFT_UNKNOWN(4), 
CFT_SOCKET(5), 
CFT_CHAR_DEVICE(6), 
CFT_BLOCK_DEVICE(7), 
CFT_FIFO(8)

Default Value

Remarks

Specifies the type of this entry, one of the following:


cftFile	`0`
cftDirectory	`1`
cftSymblink	`2`
cftSpecial	`3`
cftUnknown	`4`
cftSocket	`5`
cftCharDevice	`6`
cftBlockDevice	`7`
cftFIFO	`8`

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

Data Type

Integer

CurrListEntryGroupExecute Property (SFTPClient Class)

Controls file execution permission for the group users.

Syntax

bool GetCurrListEntryGroupExecute();

Default Value

false

Remarks

Controls file execution permission for the group users.

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

Data Type

Boolean

CurrListEntryGroupRead Property (SFTPClient Class)

Controls file read permission for the group users.

Syntax

bool GetCurrListEntryGroupRead();

Default Value

false

Remarks

Controls file read permission for the group users.

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

Data Type

Boolean

CurrListEntryGroupWrite Property (SFTPClient Class)

Controls file write permission for the group users.

Syntax

bool GetCurrListEntryGroupWrite();

Default Value

false

Remarks

Controls file write permission for the group users.

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

Data Type

Boolean

CurrListEntryHandle Property (SFTPClient Class)

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

Syntax

qint64 GetCurrListEntryHandle();

Default Value

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

CurrListEntryLongName Property (SFTPClient Class)

Contains the long name of the file (human-readable, ftp-like).

Syntax

QString GetCurrListEntryLongName();

Default Value

Remarks

Contains the long name of the file (human-readable, ftp-like).

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

Data Type

String

CurrListEntryMTime Property (SFTPClient Class)

Specifies the last modification time, in UTC.

Syntax

QString GetCurrListEntryMTime();

Default Value

Remarks

Specifies the last modification time, in UTC.

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

Data Type

String

CurrListEntryName Property (SFTPClient Class)

Specifies the file name.

Syntax

QString GetCurrListEntryName();

Default Value

Remarks

Specifies the file name.

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

Data Type

String

CurrListEntryOtherExecute Property (SFTPClient Class)

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

Syntax

bool GetCurrListEntryOtherExecute();

Default Value

false

Remarks

Controls file execution permission for other users (users that are neither owners, nor belong to the same group).

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

Data Type

Boolean

CurrListEntryOtherRead Property (SFTPClient Class)

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

Syntax

bool GetCurrListEntryOtherRead();

Default Value

false

Remarks

Controls file read permission for other users (users that are neither owners, nor belong to the same group).

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

Data Type

Boolean

CurrListEntryOtherWrite Property (SFTPClient Class)

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

Syntax

bool GetCurrListEntryOtherWrite();

Default Value

false

Remarks

Controls file write permission for other users (users that are neither owners, nor belong to the same group).

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

Data Type

Boolean

CurrListEntryOwner Property (SFTPClient Class)

Specifies the owner of the file/directory.

Syntax

QString GetCurrListEntryOwner();

Default Value

Remarks

Specifies the owner of the file/directory.

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

Data Type

String

CurrListEntryPath Property (SFTPClient Class)

Contains the full path to the file.

Syntax

QString GetCurrListEntryPath();

Default Value

Remarks

Contains the full path to the file.

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

Data Type

String

CurrListEntrySize Property (SFTPClient Class)

The size of the file in bytes.

Syntax

qint64 GetCurrListEntrySize();

Default Value

Remarks

The size of the file in bytes.

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

Data Type

Long64

CurrListEntryUserExecute Property (SFTPClient Class)

Controls file execution permission for the file owner.

Syntax

bool GetCurrListEntryUserExecute();

Default Value

false

Remarks

Controls file execution permission for the file owner.

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

Data Type

Boolean

CurrListEntryUserRead Property (SFTPClient Class)

Controls file read permission for the file owner.

Syntax

bool GetCurrListEntryUserRead();

Default Value

false

Remarks

Controls file read permission for the file owner.

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

Data Type

Boolean

CurrListEntryUserWrite Property (SFTPClient Class)

Controls file write permission for the file owner.

Syntax

bool GetCurrListEntryUserWrite();

Default Value

false

Remarks

Controls file write permission for the file owner.

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

Data Type

Boolean

DownloadBlockSize Property (SFTPClient Class)

The download block size in bytes.

Syntax

int GetDownloadBlockSize();
int SetDownloadBlockSize(int iDownloadBlockSize);

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

Specifies the document ID for SignAsyncEnd() call Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch.

Syntax

QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);

Default Value

Remarks

Specifies the document ID for SignAsyncEnd() call

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. This value helps ASiCSigner 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 pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (SFTPClient Class)

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

Syntax

QString GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(QString qsExternalCryptoCustomParams);

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

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

Syntax

QString GetExternalCryptoData();
int SetExternalCryptoData(QString qsExternalCryptoData);

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

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

Syntax

bool GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(bool bExternalCryptoExternalHashCalculation);

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 all components. In particular, components operating with larger objects (PDFSigner, CAdESSigner, XAdESSigner) do not support it.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (SFTPClient Class)

Specifies the request's signature hash algorithm.

Syntax

QString GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(QString qsExternalCryptoHashAlgorithm);

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.


SB_HASH_ALGORITHM_SHA1	`SHA1`
SB_HASH_ALGORITHM_SHA224	`SHA224`
SB_HASH_ALGORITHM_SHA256	`SHA256`
SB_HASH_ALGORITHM_SHA384	`SHA384`
SB_HASH_ALGORITHM_SHA512	`SHA512`
SB_HASH_ALGORITHM_MD2	`MD2`
SB_HASH_ALGORITHM_MD4	`MD4`
SB_HASH_ALGORITHM_MD5	`MD5`
SB_HASH_ALGORITHM_RIPEMD160	`RIPEMD160`
SB_HASH_ALGORITHM_CRC32	`CRC32`
SB_HASH_ALGORITHM_SSL3	`SSL3`
SB_HASH_ALGORITHM_GOST_R3411_1994	`GOST1994`
SB_HASH_ALGORITHM_WHIRLPOOL	`WHIRLPOOL`
SB_HASH_ALGORITHM_POLY1305	`POLY1305`
SB_HASH_ALGORITHM_SHA3_224	`SHA3_224`
SB_HASH_ALGORITHM_SHA3_256	`SHA3_256`
SB_HASH_ALGORITHM_SHA3_384	`SHA3_384`
SB_HASH_ALGORITHM_SHA3_512	`SHA3_512`
SB_HASH_ALGORITHM_BLAKE2S_128	`BLAKE2S_128`
SB_HASH_ALGORITHM_BLAKE2S_160	`BLAKE2S_160`
SB_HASH_ALGORITHM_BLAKE2S_224	`BLAKE2S_224`
SB_HASH_ALGORITHM_BLAKE2S_256	`BLAKE2S_256`
SB_HASH_ALGORITHM_BLAKE2B_160	`BLAKE2B_160`
SB_HASH_ALGORITHM_BLAKE2B_256	`BLAKE2B_256`
SB_HASH_ALGORITHM_BLAKE2B_384	`BLAKE2B_384`
SB_HASH_ALGORITHM_BLAKE2B_512	`BLAKE2B_512`
SB_HASH_ALGORITHM_SHAKE_128	`SHAKE_128`
SB_HASH_ALGORITHM_SHAKE_256	`SHAKE_256`
SB_HASH_ALGORITHM_SHAKE_128_LEN	`SHAKE_128_LEN`
SB_HASH_ALGORITHM_SHAKE_256_LEN	`SHAKE_256_LEN`

Data Type

String

ExternalCryptoKeyID Property (SFTPClient Class)

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

Syntax

QString GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(QString qsExternalCryptoKeyID);

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 extra protection layer for the protocol and diminishes the risk of 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 Class)

The pre-shared key used for DC request authentication.

Syntax

QString GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(QString qsExternalCryptoKeySecret);

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

Specifies the asynchronous signing method.

Syntax

int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);

Possible Values

ASMD_PKCS1(0), 
ASMD_PKCS7(1)

Default Value

Remarks

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

Available options:


asmdPKCS1	`0`
asmdPKCS7	`1`

Data Type

Integer

ExternalCryptoMode Property (SFTPClient Class)

Specifies the external cryptography mode.

Syntax

int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);

Possible Values

ECM_DEFAULT(0), 
ECM_DISABLED(1), 
ECM_GENERIC(2), 
ECM_DCAUTH(3), 
ECM_DCAUTH_JSON(4)

Default Value

Remarks

Specifies the external cryptography mode.

Available options:


ecmDefault	The default value (`0`)
ecmDisabled	Do not use DC or external signing (`1`)
ecmGeneric	Generic external signing with OnExternalSign event (`2`)
ecmDCAuth	DCAuth signing (`3`)
ecmDCAuthJSON	DCAuth signing in JSON format (`4`)

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (SFTPClient Class)

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

Syntax

QString GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(QString qsExternalCryptoPublicKeyAlgorithm);

Default Value

Remarks

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


SB_CERT_ALGORITHM_ID_RSA_ENCRYPTION	`rsaEncryption`
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTION	`md2withRSAEncryption`
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTION	`md5withRSAEncryption`
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTION	`sha1withRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA	`id-dsa`
SB_CERT_ALGORITHM_ID_DSA_SHA1	`id-dsa-with-sha1`
SB_CERT_ALGORITHM_DH_PUBLIC	`dhpublicnumber`
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTION	`sha224WithRSAEncryption`
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTION	`sha256WithRSAEncryption`
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTION	`sha384WithRSAEncryption`
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTION	`sha512WithRSAEncryption`
SB_CERT_ALGORITHM_ID_RSAPSS	`id-RSASSA-PSS`
SB_CERT_ALGORITHM_ID_RSAOAEP	`id-RSAES-OAEP`
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160	`ripemd160withRSA`
SB_CERT_ALGORITHM_ID_ELGAMAL	`elGamal`
SB_CERT_ALGORITHM_SHA1_ECDSA	`ecdsa-with-SHA1`
SB_CERT_ALGORITHM_RECOMMENDED_ECDSA	`ecdsa-recommended`
SB_CERT_ALGORITHM_SHA224_ECDSA	`ecdsa-with-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA	`ecdsa-with-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA	`ecdsa-with-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA	`ecdsa-with-SHA512`
SB_CERT_ALGORITHM_EC	`id-ecPublicKey`
SB_CERT_ALGORITHM_SPECIFIED_ECDSA	`ecdsa-specified`
SB_CERT_ALGORITHM_GOST_R3410_1994	`id-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3410_2001	`id-GostR3410-2001`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994	`id-GostR3411-94-with-GostR3410-94`
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001	`id-GostR3411-94-with-GostR3410-2001`
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAIN	`ecdsa-plain-SHA1`
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAIN	`ecdsa-plain-SHA224`
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAIN	`ecdsa-plain-SHA256`
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAIN	`ecdsa-plain-SHA384`
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAIN	`ecdsa-plain-SHA512`
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAIN	`ecdsa-plain-RIPEMD160`
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTION	`whirlpoolWithRSAEncryption`
SB_CERT_ALGORITHM_ID_DSA_SHA224	`id-dsa-with-sha224`
SB_CERT_ALGORITHM_ID_DSA_SHA256	`id-dsa-with-sha256`
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA	`id-ecdsa-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA	`id-ecdsa-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA	`id-ecdsa-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA	`id-ecdsa-with-sha3-512`
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-224`
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-256`
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-384`
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAIN	`id-ecdsa-plain-with-sha3-512`
SB_CERT_ALGORITHM_ID_DSA_SHA3_224	`id-dsa-with-sha3-224`
SB_CERT_ALGORITHM_ID_DSA_SHA3_256	`id-dsa-with-sha3-256`
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTION	`id-rsassa-pkcs1-v1_5-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA	`id-ecdsa-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA	`id-ecdsa-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA	`id-ecdsa-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA	`id-ecdsa-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA	`id-ecdsa-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA	`id-ecdsa-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA	`id-ecdsa-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA	`id-ecdsa-with-blake2b512`
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s128`
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s160`
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s224`
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2s256`
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b160`
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b256`
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b384`
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAIN	`id-ecdsa-plain-with-blake2b512`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224	`id-dsa-with-blake2s224`
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256	`id-dsa-with-blake2s256`
SB_CERT_ALGORITHM_EDDSA_ED25519	`id-Ed25519`
SB_CERT_ALGORITHM_EDDSA_ED448	`id-Ed448`
SB_CERT_ALGORITHM_EDDSA_ED25519_PH	`id-Ed25519ph`
SB_CERT_ALGORITHM_EDDSA_ED448_PH	`id-Ed448ph`
SB_CERT_ALGORITHM_EDDSA	`id-EdDSA`
SB_CERT_ALGORITHM_EDDSA_SIGNATURE	`id-EdDSA-sig`

Data Type

String

FIPSMode Property (SFTPClient Class)

Reserved.

Syntax

bool GetFIPSMode();
int SetFIPSMode(bool bFIPSMode);

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

ForceCompression Property (SFTPClient Class)

Enforces compression for the SSH layer.

Syntax

bool GetForceCompression();
int SetForceCompression(bool bForceCompression);

Default Value

false

Remarks

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

Data Type

Boolean

KeyFingerprintSHA1 Property (SFTPClient Class)

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

Syntax

QString GetKeyFingerprintSHA1();

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

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

Syntax

QString GetKeyFingerprintSHA256();

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

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

Syntax

qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);

Default Value

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.

This property is not available at design time.

Data Type

Long64

MaxSFTPVersion Property (SFTPClient Class)

Higher SFTP version to support.

Syntax

int GetMaxSFTPVersion();
int SetMaxSFTPVersion(int iMaxSFTPVersion);

Default Value

Remarks

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

Data Type

Integer

MinSFTPVersion Property (SFTPClient Class)

Lower SFTP version to support.

Syntax

int GetMinSFTPVersion();
int SetMinSFTPVersion(int iMinSFTPVersion);

Default Value

Remarks

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

Data Type

Integer

Password Property (SFTPClient Class)

Specifies user's authentication password.

Syntax

QString GetPassword();
int SetPassword(QString qsPassword);

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

The number of parallelized transfer requests.

Syntax

int GetPipelineLength();
int SetPipelineLength(int iPipelineLength);

Default Value

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

The IP address of the proxy server.

Syntax

QString GetProxyAddress();
int SetProxyAddress(QString qsProxyAddress);

Default Value

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (SFTPClient Class)

The authentication type used by the proxy server.

Syntax

int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);

Possible Values

PAT_NO_AUTHENTICATION(0), 
PAT_BASIC(1), 
PAT_DIGEST(2), 
PAT_NTLM(3)

Default Value

Remarks

The authentication type used by the proxy server.


patNoAuthentication	`0`
patBasic	`1`
patDigest	`2`
patNTLM	`3`

Data Type

Integer

ProxyPassword Property (SFTPClient Class)

The password to authenticate to the proxy server.

Syntax

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

Default Value

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (SFTPClient Class)

The port on the proxy server to connect to.

Syntax

int GetProxyPort();
int SetProxyPort(int iProxyPort);

Default Value

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (SFTPClient Class)

The type of the proxy server.

Syntax

int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);

Possible Values

CPT_NONE(0), 
CPT_SOCKS_4(1), 
CPT_SOCKS_5(2), 
CPT_WEB_TUNNEL(3), 
CPT_HTTP(4)

Default Value

Remarks

The type of the proxy server.

The WebTunnel proxy is also known as HTTPS proxy. Unlike HTTP proxy, HTTPS proxy (WebTunnel) provides end-to-end security.


cptNone	`0`
cptSocks4	`1`
cptSocks5	`2`
cptWebTunnel	`3`
cptHTTP	`4`

Data Type

Integer

ProxyRequestHeaders Property (SFTPClient Class)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

QString GetProxyRequestHeaders();
int SetProxyRequestHeaders(QString qsProxyRequestHeaders);

Default Value

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (SFTPClient Class)

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

Syntax

QString GetProxyResponseBody();
int SetProxyResponseBody(QString qsProxyResponseBody);

Default Value

Remarks

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

Data Type

String

ProxyResponseHeaders Property (SFTPClient Class)

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

Syntax

QString GetProxyResponseHeaders();
int SetProxyResponseHeaders(QString qsProxyResponseHeaders);

Default Value

Remarks

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

Data Type

String

ProxyUseIPv6 Property (SFTPClient Class)

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

Syntax

bool GetProxyUseIPv6();
int SetProxyUseIPv6(bool bProxyUseIPv6);

Default Value

false

Remarks

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

Data Type

Boolean

ProxyUseProxy Property (SFTPClient Class)

Enables or disables proxy-driven connection.

Syntax

bool GetProxyUseProxy();
int SetProxyUseProxy(bool bProxyUseProxy);

Default Value

false

Remarks

Enables or disables proxy-driven connection.

Data Type

Boolean

ProxyUsername Property (SFTPClient Class)

Specifies the username credential for proxy authentication.

Syntax

QString GetProxyUsername();
int SetProxyUsername(QString qsProxyUsername);

Default Value

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

ServerKeyAlgorithm Property (SFTPClient Class)

Specifies the key algorithm.

Syntax

QString GetServerKeyAlgorithm();

Default Value

Remarks

Specifies the key algorithm.

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

Data Type

String

ServerKeyBits Property (SFTPClient Class)

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

Syntax

int GetServerKeyBits();

Default Value

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

The comment for the public key.

Syntax

QString GetServerKeyComment();

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

Specifies the elliptical curve when EC cryptography is used.

Syntax

QString GetServerKeyCurve();

QByteArray GetServerKeyDSSX();

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

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

Syntax

QByteArray GetServerKeyDSSY();

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

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

Syntax

QByteArray GetServerKeyECCD();

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

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

Syntax

QByteArray GetServerKeyECCQX();

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

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

Syntax

QByteArray GetServerKeyECCQY();

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

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

Syntax

QByteArray GetServerKeyEdPrivate();

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

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

Syntax

QByteArray GetServerKeyEdPublic();

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

Contains the MD5 fingerprint (hash) of the key.

Syntax

QString GetServerKeyFingerprintMD5();

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

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

Syntax

QString GetServerKeyFingerprintSHA1();

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

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

Syntax

QString GetServerKeyFingerprintSHA256();

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

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

Syntax

qint64 GetServerKeyHandle();

Default Value

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.

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

Data Type

Long64

ServerKeyIsExtractable Property (SFTPClient Class)

Whether the key is extractable (e.

Syntax

bool GetServerKeyIsExtractable();

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

Whether this key is a private key or not.

Syntax

bool GetServerKeyIsPrivate();

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

Whether this key is a public key or not.

Syntax

bool GetServerKeyIsPublic();

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

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

Syntax

int GetServerKeyKDFRounds();

Default Value

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

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

Syntax

QByteArray GetServerKeyKDFSalt();

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

Specifies the format in which the key is stored.

Syntax

int GetServerKeyKeyFormat();

Possible Values

CKF_OPEN_SSH(0), 
CKF_OPEN_SSH2(1), 
CKF_IETF(2), 
CKF_PU_TTY(3), 
CKF_X509(4), 
CKF_BINARY(5), 
CKF_SSH1(6), 
CKF_PGP(7), 
CKF_PKCS8(8)

Default Value

Remarks

Specifies the format in which the key is stored.


ckfOpenSSH	`0`
ckfOpenSSH2	`1`
ckfIETF	`2`
ckfPuTTY	`3`
ckfX509	`4`
ckfBinary	`5`
ckfSSH1	`6`
ckfPGP	`7`
ckfPKCS8	`8`

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

Data Type

Integer

ServerKeyKeyProtectionAlgorithm Property (SFTPClient Class)

Specifies the key protection algorithm.

Syntax

QString GetServerKeyKeyProtectionAlgorithm();

QString GetServerKeySubject();

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

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

Syntax

int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);

Possible Values

DM_AUTO(0), 
DM_PLATFORM(1), 
DM_OWN(2), 
DM_OWN_SECURE(3)

Default Value

Remarks

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


dmAuto	`0`
dmPlatform	`1`
dmOwn	`2`
dmOwnSecure	`3`

Data Type

Integer

SocketDNSPort Property (SFTPClient Class)

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

Syntax

int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);

Default Value

Remarks

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

Data Type

Integer

SocketDNSQueryTimeout Property (SFTPClient Class)

The timeout (in milliseconds) for each DNS query.

Syntax

int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);

Default Value

Remarks

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

Data Type

Integer

SocketDNSServers Property (SFTPClient Class)

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

Syntax

QString GetSocketDNSServers();
int SetSocketDNSServers(QString qsSocketDNSServers);

Default Value

Remarks

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

Data Type

String

SocketDNSTotalTimeout Property (SFTPClient Class)

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

Syntax

int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);

Default Value

Remarks

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

Data Type

Integer

SocketIncomingSpeedLimit Property (SFTPClient Class)

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

Syntax

int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);

Default Value

Remarks

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

Data Type

Integer

SocketLocalAddress Property (SFTPClient Class)

The local network interface to bind the socket to.

Syntax

QString GetSocketLocalAddress();
int SetSocketLocalAddress(QString qsSocketLocalAddress);

Default Value

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (SFTPClient Class)

The local port number to bind the socket to.

Syntax

int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);

Default Value

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (SFTPClient Class)

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

Syntax

int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);

Default Value

Remarks

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

Data Type

Integer

SocketTimeout Property (SFTPClient Class)

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

Syntax

int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout);

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

Enables or disables IP protocol version 6.

Syntax

bool GetSocketUseIPv6();
int SetSocketUseIPv6(bool bSocketUseIPv6);

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

SSHSettingsAutoAdjustCiphers Property (SFTPClient Class)

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

bool GetSSHSettingsAutoAdjustCiphers();
int SetSSHSettingsAutoAdjustCiphers(bool bSSHSettingsAutoAdjustCiphers);

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

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

Syntax

int GetSSHSettingsBaseConfiguration();
int SetSSHSettingsBaseConfiguration(int iSSHSettingsBaseConfiguration);

Possible Values

STPC_DEFAULT(0), 
STPC_COMPATIBLE(1), 
STPC_COMPREHENSIVE_INSECURE(2), 
STPC_HIGHLY_SECURE(3)

Default Value

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

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

Syntax

QString GetSSHSettingsCompressionAlgorithms();
int SetSSHSettingsCompressionAlgorithms(QString qsSSHSettingsCompressionAlgorithms);

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

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

Syntax

int GetSSHSettingsCompressionLevel();
int SetSSHSettingsCompressionLevel(int iSSHSettingsCompressionLevel);

Default Value

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

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

int GetSSHSettingsDefaultWindowSize();
int SetSSHSettingsDefaultWindowSize(int iSSHSettingsDefaultWindowSize);

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

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

Syntax

QString GetSSHSettingsEncryptionAlgorithms();
int SetSSHSettingsEncryptionAlgorithms(QString qsSSHSettingsEncryptionAlgorithms);

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

Whether the SSH client should explicitly request compression.

Syntax

bool GetSSHSettingsForceCompression();
int SetSSHSettingsForceCompression(bool bSSHSettingsForceCompression);

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

SSHSettingsGSSAuthTypes Property (SFTPClient Class)

A comma-separated list of authentication types.

Syntax

QString GetSSHSettingsGSSAuthTypes();
int SetSSHSettingsGSSAuthTypes(QString qsSSHSettingsGSSAuthTypes);

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

Switches credential delegation on or off.

Syntax

bool GetSSHSettingsGSSDelegateCreds();
int SetSSHSettingsGSSDelegateCreds(bool bSSHSettingsGSSDelegateCreds);

Default Value

false

Remarks

Switches credential delegation on or off.

Data Type

Boolean

SSHSettingsGSSHostname Property (SFTPClient Class)

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

Syntax

QString GetSSHSettingsGSSHostname();
int SetSSHSettingsGSSHostname(QString qsSSHSettingsGSSHostname);

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

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

Syntax

QString GetSSHSettingsGSSLib();
int SetSSHSettingsGSSLib(QString qsSSHSettingsGSSLib);

Default Value

Remarks

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

Data Type

String

SSHSettingsGSSMechanisms Property (SFTPClient Class)

A comma-separated list of GSS mechanisms to use.

Syntax

QString GetSSHSettingsGSSMechanisms();
int SetSSHSettingsGSSMechanisms(QString qsSSHSettingsGSSMechanisms);

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

A comma-separated list of SSPI protocols.

Syntax

QString GetSSHSettingsGSSProtocols();
int SetSSHSettingsGSSProtocols(QString qsSSHSettingsGSSProtocols);

Default Value

Remarks

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

Data Type

String

SSHSettingsHandshakeTimeout Property (SFTPClient Class)

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

Syntax

int GetSSHSettingsHandshakeTimeout();
int SetSSHSettingsHandshakeTimeout(int iSSHSettingsHandshakeTimeout);

Default Value

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

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

Syntax

QString GetSSHSettingsKexAlgorithms();
int SetSSHSettingsKexAlgorithms(QString qsSSHSettingsKexAlgorithms);

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

Data Type

String

SSHSettingsMacAlgorithms Property (SFTPClient Class)

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

Syntax

QString GetSSHSettingsMacAlgorithms();
int SetSSHSettingsMacAlgorithms(QString qsSSHSettingsMacAlgorithms);

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

Specifies the maximum length of one SSH packet in bytes.

Syntax

int GetSSHSettingsMaxSSHPacketSize();
int SetSSHSettingsMaxSSHPacketSize(int iSSHSettingsMaxSSHPacketSize);

Data Type

Boolean

SSHSettingsObfuscationPassword Property (SFTPClient Class)

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

Syntax

QString GetSSHSettingsObfuscationPassword();
int SetSSHSettingsObfuscationPassword(QString qsSSHSettingsObfuscationPassword);

Default Value

Remarks

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

Data Type

String

SSHSettingsPublicKeyAlgorithms Property (SFTPClient Class)

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

Syntax

QString GetSSHSettingsPublicKeyAlgorithms();
int SetSSHSettingsPublicKeyAlgorithms(QString qsSSHSettingsPublicKeyAlgorithms);

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

Data Type

String

SSHSettingsRequestPasswordChange Property (SFTPClient Class)

Whether to request a password change when connecting.

Syntax

bool GetSSHSettingsRequestPasswordChange();
int SetSSHSettingsRequestPasswordChange(bool bSSHSettingsRequestPasswordChange);

Default Value

Remarks

Specifies enabled SSH protocol versions (1 or 2).

Data Type

Integer

TrustedKeysFile Property (SFTPClient Class)

A file containing the keys of authorized servers.

Syntax

QString GetTrustedKeysFile();
int SetTrustedKeysFile(QString qsTrustedKeysFile);

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

The upload block size in bytes.

Syntax

int GetUploadBlockSize();
int SetUploadBlockSize(int iUploadBlockSize);

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

The client's username to authenticate to the server.

Syntax

QString GetUsername();
int SetUsername(QString qsUsername);

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

Enables UTF8 for all string content.

Syntax

bool GetUseUTF8();
int SetUseUTF8(bool bUseUTF8);

Default Value

false

Remarks

If UseUTF8 is true, the class 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 Class)

The SFTP version negotiated.

Syntax

int GetVersion();

Default Value

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

Data Type

Integer

AbsolutePath Method (SFTPClient Class)

Requests the absolute path for a relative path.

Syntax

QString AbsolutePath(const QString& qsRemotePath);

Remarks

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

Error Handling

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ChangeDir Method (SFTPClient Class)

Changes current working directory on the server.

Syntax

int ChangeDir(const QString& qsRemoteDir);

Remarks

Changes current working directory on the server to RemoteDir.

Error Handling

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (SFTPClient Class)

Sets or retrieves a configuration setting.

Syntax

QString Config(const QString& qsConfigurationString);

Remarks

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

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

Error Handling

Connect Method (SFTPClient Class)

Connects to an SFTP server.

Syntax

int Connect(const QString& qsAddress, int iPort);

Remarks

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

Error Handling

CreateLink Method (SFTPClient Class)

Creates a symbolic or hard link to a remote file.

Syntax

int CreateLink(const QString& qsLinkPath, const QString& qsTargetPath, bool bHardLink);

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

Error Handling

DeleteDir Method (SFTPClient Class)

Removes directory from the SFTP server.

Syntax

int DeleteDir(const QString& qsRemoteDir);

Remarks

Use RemoteDir to provide a path to the directory to be deleted.

Error Handling

DeleteFile Method (SFTPClient Class)

Deletes a file from the SFTP server.

Syntax

int DeleteFile(const QString& qsRemoteFile);

Remarks

Use the RemoteFile parameter to specify the name of the file to delete.

Error Handling

DeleteFiles Method (SFTPClient Class)

Deletes a group of files from the SFTP server.

Syntax

int DeleteFiles(const QString& qsRemotePath, const QString& qsMask, bool bCaseSensitive, bool bRecursive);

Remarks

Use this method to delete a group of files from the SFTP server. Specify the files to be deleted via RemotePath and Mask parameters. Use CaseSensitive and Recursive parameters to tune up the operation.

This method is a more efficient way to delete a group of files than deleting them one by one.

Error Handling

DirExists Method (SFTPClient Class)

Checks if a directory exists on the SFTP server.

Syntax

bool DirExists(const QString& qsRemoteDir);

Remarks

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

Error Handling

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Disconnect Method (SFTPClient Class)

Disconnects from the SFTP server.

Syntax

int Disconnect();

Remarks

Call this method to disconnect from the SFTP server.

Error Handling

DoAction Method (SFTPClient Class)

Performs an additional action.

Syntax

QString DoAction(const QString& qsActionID, const QString& qsActionParams);

Remarks

DoAction is a generic method available in every class. 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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Error Handling

DownloadBytes Method (SFTPClient Class)

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

Syntax

QByteArray DownloadBytes(const QString& qsRemoteFile);

Remarks

Use this method to download RemoteFile into a byte array.

Error Handling

This method returns a Binary String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DownloadFile Method (SFTPClient Class)

Downloads a file from the SFTP server.

Syntax

int DownloadFile(const QString& qsRemoteFile, const QString& qsLocalFile);

Remarks

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

Error Handling

DownloadFiles Method (SFTPClient Class)

Downloads multiple files from the SFTP server.

Syntax

int DownloadFiles(const QString& qsRemotePath, const QString& qsLocalDir);

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.

Error Handling

ExecuteSSHCommand Method (SFTPClient Class)

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

Syntax

QByteArray ExecuteSSHCommand(const QString& qsCommand);

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.

Error Handling

This method returns a Byte Array value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ExtensionCmd Method (SFTPClient Class)

Sends an extension command to the server.

Syntax

QByteArray ExtensionCmd(const QString& qsExtn, QByteArray qbaDataBuffer);

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.

Error Handling

FileExists Method (SFTPClient Class)

Checks whether a file exists on the server.

Syntax

bool FileExists(const QString& qsRemoteFile);

Remarks

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

Error Handling

GetCurrentDir Method (SFTPClient Class)

Returns the current directory on the SFTP server.

Syntax

QString GetCurrentDir();

Remarks

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

Error Handling

GetFileSize Method (SFTPClient Class)

Checks the size of a remote file.

Syntax

qint64 GetFileSize(const QString& qsRemoteFile);

Remarks

Returns the size of the RemoteFile.

Error Handling

This method returns a Long64 value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListDir Method (SFTPClient Class)

Lists the content of the current remote directory.

Syntax

QString ListDir(bool bIncludeFiles, bool bIncludeDirectories);

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.

Error Handling

MakeDir Method (SFTPClient Class)

Creates a new directory on the server.

Syntax

int MakeDir(const QString& qsRemoteDir);

Remarks

RemoteDir specifies the name of the new directory.

Error Handling

RenameFile Method (SFTPClient Class)

Renames a file.

Syntax

int RenameFile(const QString& qsSourceFile, const QString& qsDestFile);

Remarks

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

Error Handling

RequestAttributes Method (SFTPClient Class)

Requests attributes of the remote file.

Syntax

QString RequestAttributes(const QString& qsRemotePath, bool bFollowSymLinks);

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.

Error Handling

SetAttributes Method (SFTPClient Class)

Sets the attributes upon a remote file.

Syntax

int SetAttributes(const QString& qsRemotePath, const QString& qsAttributes);

Remarks

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

Error Handling

UploadBytes Method (SFTPClient Class)

Uploads a byte array to the server.

Syntax

int UploadBytes(QByteArray qbaBytes, const QString& qsRemoteFile);

Remarks

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

Error Handling

UploadFile Method (SFTPClient Class)

Uploads a file to the server.

Syntax

int UploadFile(const QString& qsLocalFile, const QString& qsRemoteFile);

Remarks

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

Error Handling

UploadFiles Method (SFTPClient Class)

Uploads multiple files to the server.

Syntax

int UploadFiles(const QString& qsLocalPath, const QString& qsRemoteDir);

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.

Error Handling

AuthAttempt Event (SFTPClient Class)

Fires when an authentication attempt is performed.

Syntax

class SFTPClientAuthAttemptEventParams {
public:
  int AuthType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthAttempt(SFTPClientAuthAttemptEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireAuthAttempt(SFTPClientAuthAttemptEventParams *e) {...}

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:


atRhosts	`0x01`	RHOSTS file authentication. Rarely used today.
atPublicKey	`0x02`	Public key (sometimes called private key) authentication
atPassword	`0x04`	Password-based authentication
atHostbased	`0x08`	Hostbased authentication
atKeyboard	`0x10`	Keyboard-interactive authentication. This is often used in place of generic password authentication.
atGssWithMic	`0x20`	GSS authentication
atGssKeyex	`0x40`	GSS authentication with key exchange
atPublicKeyAgent	`0x80`	Public key agent authentication

AuthFailed Event (SFTPClient Class)

Fires if an authentication attempt fails.

Syntax

class SFTPClientAuthFailedEventParams {
public:
  int AuthType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthFailed(SFTPClientAuthFailedEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireAuthFailed(SFTPClientAuthFailedEventParams *e) {...}

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:


atRhosts	`0x01`	RHOSTS file authentication. Rarely used today.
atPublicKey	`0x02`	Public key (sometimes called private key) authentication
atPassword	`0x04`	Password-based authentication
atHostbased	`0x08`	Hostbased authentication
atKeyboard	`0x10`	Keyboard-interactive authentication. This is often used in place of generic password authentication.
atGssWithMic	`0x20`	GSS authentication
atGssKeyex	`0x40`	GSS authentication with key exchange
atPublicKeyAgent	`0x80`	Public key agent authentication

AuthSucceeded Event (SFTPClient Class)

Reports a successful authentication.

Syntax

class SFTPClientAuthSucceededEventParams {
public:
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void AuthSucceeded(SFTPClientAuthSucceededEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireAuthSucceeded(SFTPClientAuthSucceededEventParams *e) {...}

Remarks

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

Banner Event (SFTPClient Class)

Reports the receipt of the Welcome message from the server.

Syntax

class SFTPClientBannerEventParams {
public:
  const QByteArray &Text();

  const QByteArray &Language();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Banner(SFTPClientBannerEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireBanner(SFTPClientBannerEventParams *e) {...}

Remarks

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

Disconnect Event (SFTPClient Class)

Reports SFTP connection closure.

Syntax

class SFTPClientDisconnectEventParams {
public:
  int CloseReason();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnect(SFTPClientDisconnectEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireDisconnect(SFTPClientDisconnectEventParams *e) {...}

Remarks

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

Error Event (SFTPClient Class)

Information about errors during SFTP connection.

Syntax

class SFTPClientErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SFTPClientErrorEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireError(SFTPClientErrorEventParams *e) {...}

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

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

Syntax

class SFTPClientExternalSignEventParams {
public:
  const QString &OperationId();

  const QString &HashAlgorithm();

  const QString &Pars();

  const QString &Data();

  const QString &SignedData();
  void SetSignedData(const QString &qsSignedData);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ExternalSign(SFTPClientExternalSignEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireExternalSign(SFTPClientExternalSignEventParams *e) {...}

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 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 contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for 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 a .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(); };

FileOperation Event (SFTPClient Class)

Signifies the start of a file transfer operation.

Syntax

class SFTPClientFileOperationEventParams {
public:
  int Operation();

  const QString &RemotePath();

  const QString &LocalPath();

  bool Skip();
  void SetSkip(bool bSkip);

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileOperation(SFTPClientFileOperationEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireFileOperation(SFTPClientFileOperationEventParams *e) {...}

Remarks

This event is fired each time the class 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:


csfoDownloadFile	`0`	Download file
csfoUploadFile	`1`	Upload file
csfoDeleteFile	`2`	Delete file
csfoMakeDir	`3`	Make directory

FileOperationResult Event (SFTPClient Class)

Signifies the completion of a file transfer operation.

Syntax

class SFTPClientFileOperationResultEventParams {
public:
  int Operation();

  const QString &RemotePath();

  const QString &LocalPath();

  int ErrorCode();

  const QString &Comment();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileOperationResult(SFTPClientFileOperationResultEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireFileOperationResult(SFTPClientFileOperationResultEventParams *e) {...}

Remarks

This event is fired each time the class 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:


csfoDownloadFile	`0`	Download file
csfoUploadFile	`1`	Upload file
csfoDeleteFile	`2`	Delete file
csfoMakeDir	`3`	Make directory

KnownKeyReceived Event (SFTPClient Class)

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

Syntax

class SFTPClientKnownKeyReceivedEventParams {
public:
  const QString &Algorithm();

  int Bits();

  const QString &FingerprintSHA256();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void KnownKeyReceived(SFTPClientKnownKeyReceivedEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireKnownKeyReceived(SFTPClientKnownKeyReceivedEventParams *e) {...}

Remarks

The class 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 Class)

Reports a directory listing entry to the application.

Syntax

class SFTPClientListEntryEventParams {
public:
  const QString &Filename();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ListEntry(SFTPClientListEntryEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireListEntry(SFTPClientListEntryEventParams *e) {...}

Remarks

The class 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 Class)

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

Syntax

class SFTPClientNotificationEventParams {
public:
  const QString &EventID();

  const QString &EventParam();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(SFTPClientNotificationEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireNotification(SFTPClientNotificationEventParams *e) {...}

Remarks

The class 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 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 Class)

Signals that the server requests a password change.

Syntax

class SFTPClientPasswordChangeRequestEventParams {
public:
  const QString &Prompt();

  const QString &NewPassword();
  void SetNewPassword(const QString &qsNewPassword);

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PasswordChangeRequest(SFTPClientPasswordChangeRequestEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FirePasswordChangeRequest(SFTPClientPasswordChangeRequestEventParams *e) {...}

Remarks

The class 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 Class)

Asks the application for the client's private key.

Syntax

class SFTPClientPrivateKeyNeededEventParams {
public:
  bool Skip();
  void SetSkip(bool bSkip);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PrivateKeyNeeded(SFTPClientPrivateKeyNeededEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FirePrivateKeyNeeded(SFTPClientPrivateKeyNeededEventParams *e) {...}

Remarks

The class 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 Class)

Fires periodically during the data transfer.

Syntax

class SFTPClientProgressEventParams {
public:
  qint64 Total();

  qint64 Current();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(SFTPClientProgressEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireProgress(SFTPClientProgressEventParams *e) {...}

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

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

Syntax

class SFTPClientUnknownKeyReceivedEventParams {
public:
  const QString &Algorithm();

  int Bits();

  const QString &FingerprintSHA256();

  int Action();
  void SetAction(int iAction);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void UnknownKeyReceived(SFTPClientUnknownKeyReceivedEventParams *e);

// Or, subclass SFTPClient and override this emitter function.
virtual int FireUnknownKeyReceived(SFTPClientUnknownKeyReceivedEventParams *e) {...}

Remarks

The class 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 class what it should do with the key:


catAcceptOnce	`1`	Accept the key for the current session only.
catAcceptPermanently	`2`	Accept the key for the current session and store the key to the trusted keys list.
catReject	`3`	Reject the key and close the connection.

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

Configuration Settings (SFTPClient Class)

The class 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 class, access to these internal properties is provided through the Config method.

SFTPClient Configuration Settings

AdjustFileTimes: Whether file times should be adjusted after upload/download.

If this property value is True, file times (creation, access and last modification times) will be adjusted after upload/download operation.

ASCIIMode: Whether ASCII transfer mode is used.

When this property is True, ASCII (text) transfer mode is used, otherwise the transfer is performed in binary mode.

CaseConversion: Whether case conversion must be applied to file names as they are downloaded.

You can choose to: convert file names to upper case, convert file names to lower case, or to keep them as they are.

CaseSensitive: Specifies if file paths are case-sensitive.

Set this property to True if all file names, paths and file masks should be case-sensitive.

CopyMode: Defines what to do with each successfully copied file.

You could choose to: simply copy the file, delete each file's origin right after that file has been copied, or delete all original files only after all files have been copied.

DefOutboundBlockSize: The default outbound block size.

Use this property to configure the outbound data block size.

DisablePacketFragmentation: Enables or disables SSH packet fragmentation.

Use this property to enable or disable SSH packet fragmentation. This is one of the settings that is worth a look if encountering unexplained transfer issues.

ErrorOrigin: Specifies whether the error is local or remote.

Use this property to check where the error took place.

ErrorSeverity: Specifies whether the error is fatal.

Use this property to check whether the error is fatal or not.

IncomingSpeedLimit: Specifies incoming speed limit.

Use this property to limit the maximum number of bytes per second that client may receive. The value of 0 (zero) means "no limitation".

KeepAlivePeriod: The inactivity period after which a keep-alive signal will be sent.

Use this property to specify tunnel inactivity period (in milliseconds) after which a keep-alive signal will be sent. The default value is 0 (no keep-alive signals).

LocalCharset: Charset used on the client machine.

This property specifies the charset used on the local client computer.

LocalNewLineConvention: A character string for the end of line (EOL) indication on the local machine.

This property contains a character string for the end of line (EOL) indication on the local machine.

Mode: The file open mode to use.

This property allows to provide a custom file upload mode.

NewLineConvention: A character string for the end of line (EOL) indication on the server.

This property contains a character string for the end of line (EOL) indication used by the server. Usually its value is one of: 0x0d, 0x0d0x0a, 0x0a0x0d, or 0x0a, but it can differ for some servers.

OutgoingSpeedLimit: Specifies incoming speed limit.

Use this property to limit the maximum number of bytes per second that client may send. The value of 0 (zero) means "no limitation".

PreserveExistingFileTimes: Whether original file times should be restored upon transfer.

If the destination file exists and PreserveExistingFileTimes option is enabled, the class will remember the file's times before transfer, and restore them after the file has been transferred. The default value is False.

Recursive: Whether subdirectories should also be scanned for matching files.

Set this property to True to indicate that subdirectories should also be scanned for matching files

RedirectStdErr: Whether to redirect output to StdErr.

If this property is True, all output will be redirected to StdErr.

RemoteCharset: Charset used on the server.

This property specifies the charset used on the server.

SFTPBufferSize: The size of internal buffer used for data transfer.

Use this property to control the size of the internal buffers used for data transfer.

SFTPServerExecutableLocations: Location of the SFTP server executable.

Specifies the location of the SFTP server executable.

StdErrData: The buffer for writing StdErr data.

This property represents a buffer where StdErr data is written by the class.

TempPath: Location where the temporary files are stored.

This setting specifies an absolute path to the location on disk where temporary files are stored.

TreatZeroSizeAsUndefined: Whether zero size returned by STAT should be considered as undefined.

This property specifies if the size of zero returned by the STAT command for a particular file should be considered as undefined. It makes sense to set this property to True, because some operating systems (e.g. Unix-based) return zero size for the files of certain type. For instance, most of the files contained in the /proc directory are reported as 0-sized, while actually not being empty.

UseTruncateFlagOnUpload: whether to use the 'truncate' flag on file upload.

If this property is True, the existing files are opened truncated on upload, otherwise new files are created. The default value is True.

UseUTF8OnV3: Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.

If this property is True, UTF-8 encoding will be applied to file names for SFTP protocol versions 3 and lower.

Base Configuration Settings

CheckKeyIntegrityBeforeUse: Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching: Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:


off		No caching (default)
local		Local caching (supported for HTTPClient, RESTClient and SOAPClient only)
global		Global caching

Cookies: Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations: Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE: Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies: Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent: Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination: Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:


file		File
console		Console
systemlog		System Log (supported for Android only)
debugger		Debugger (supported for VCL for Windows and .Net)

LogDetails: Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:


time		Current time
level		Level
package		Package name
module		Module name
class		Class name
method		Method name
threadid		Thread Id
contenttype		Content type
content		Content
all		All details

LogFile: Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters: Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:


exclude-package		Exclude a package specified in the value
exclude-module		Exclude a module specified in the value
exclude-class		Exclude a class specified in the value
exclude-method		Exclude a method specified in the value
include-package		Include a package specified in the value
include-module		Include a module specified in the value
include-class		Include a class specified in the value
include-method		Include a method specified in the value

LogFlushMode: Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:


none		No flush (caching only)
immediate		Immediate flush (real-time logging)
maxcount		Flush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel: Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:


none		None (by default)
fatal		Severe errors that cause premature termination.
error		Other runtime errors or unexpected conditions.
warning		Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
info		Interesting runtime events (startup/shutdown).
debug		Detailed information on flow of through the system.
trace		More detailed information.

LogMaxEventCount: Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode: Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:


none		No rotation
deleteolder		Delete older entries from the cache upon reaching LogMaxEventCount
keepolder		Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength: Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth: Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm: Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

Tag: Allows to store any custom data.

Use this config property to store any custom data.

UseSharedSystemStorages: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS: Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom: Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (SFTPClient Class)

SFTPClient Errors

1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER)
31457281   Unsupported file operation (SB_ERROR_SFTP_UNSUPPORTED_FILEOPERATION)


	1048577 Invalid parameter value (`SB_ERROR_INVALID_PARAMETER`)
	1048578 Class is configured incorrectly (`SB_ERROR_INVALID_SETUP`)
	1048579 Operation cannot be executed in the current state (`SB_ERROR_INVALID_STATE`)
	1048580 Attempt to set an invalid value to a property (`SB_ERROR_INVALID_VALUE`)
	1048581 Certificate does not have its private key loaded (`SB_ERROR_NO_PRIVATE_KEY`)
	1048581 Cancelled by the user (`SB_ERROR_CANCELLED_BY_USER`)
	31457281 Unsupported file operation (`SB_ERROR_SFTP_UNSUPPORTED_FILEOPERATION`)

SecureBlackbox 2022 Qt Edition

SFTPClient Class

Syntax

Remarks

Property List

Method List

Event List

Configuration Settings

AuthAttempts Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

AutoAdjustTransferBlock Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

Connected Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoClientKeyAlgorithm Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoClientKeyBits Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoClientKeyFingerprint Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoCloseReason Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoCompressionAlgorithmInbound Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoCompressionAlgorithmOutbound Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoEncryptionAlgorithmInbound Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoEncryptionAlgorithmOutbound Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoInboundEncryptionKeyBits Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoKexAlgorithm Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoKexBits Property (SFTPClient Class)

Syntax

Default Value

Remarks

Data Type

ConnInfoKexLines Property (SFTPClient Class)

Syntax