SFTPClient Class
Properties Methods Events Config 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.
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 an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. |
| 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. |
| DownloadStream | Downloads a file 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. |
| UploadStream | Uploads a file 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. |
Config Settings
The following is a list of config 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. |
| AvailableSpace | Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work. |
| 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. |
| FileHash | Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work. |
| HashAlgorithm | The hash algorithm to use for the protocol operations. |
| HomeDir | Returns a user's home directory. This protocol extension must be supported by the server for this request to work. |
| 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. |
| StatVFS | Returns VFS details. This protocol extension must be supported by the server for this request to work. |
| StdErrData | The buffer for writing StdErr data. |
| TempFolder | Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work. |
| TempPath | Location where the temporary files are stored. |
| TreatZeroSizeAsUndefined | Whether zero size returned by STAT should be considered as undefined. |
| UseStrictKeyExchange | Specifies how strict key exchange is supported. |
| 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. |
| 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. |
| StaticDNS | Specifies whether static DNS rules should be used. |
| StaticIPAddress[domain] | Gets or sets an IP address for the specified domain name. |
| StaticIPAddresses | Gets or sets all the static DNS rules. |
| Tag | Allows to store any custom data. |
| TLSSessionGroup | Specifies the group name of TLS sessions to be used for session resumption. |
| TLSSessionLifetime | Specifies lifetime in seconds of the cached TLS session. |
| TLSSessionPurgeInterval | Specifies how often the session cache should remove the expired TLS sessions. |
| UseOwnDNSResolver | Specifies whether the client classes should use own DNS resolver. |
| 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
ANSI (Cross Platform) int GetAuthAttempts();
int SetAuthAttempts(int iAuthAttempts); Unicode (Windows) INT GetAuthAttempts();
INT SetAuthAttempts(INT iAuthAttempts);
int secureblackbox_sftpclient_getauthattempts(void* lpObj);
int secureblackbox_sftpclient_setauthattempts(void* lpObj, int iAuthAttempts);
int GetAuthAttempts();
int SetAuthAttempts(int iAuthAttempts);
Default Value
1
Remarks
Use this property to specify the number of authentication attempts to try. The AuthFailed event is fired for every failed attempt.
Data Type
Integer
AutoAdjustTransferBlock Property (SFTPClient Class)
Specifies whether to adjust the send and receive buffer sizes automatically.
Syntax
ANSI (Cross Platform) int GetAutoAdjustTransferBlock();
int SetAutoAdjustTransferBlock(int bAutoAdjustTransferBlock); Unicode (Windows) BOOL GetAutoAdjustTransferBlock();
INT SetAutoAdjustTransferBlock(BOOL bAutoAdjustTransferBlock);
int secureblackbox_sftpclient_getautoadjusttransferblock(void* lpObj);
int secureblackbox_sftpclient_setautoadjusttransferblock(void* lpObj, int bAutoAdjustTransferBlock);
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
ANSI (Cross Platform) int GetConnected(); Unicode (Windows) BOOL GetConnected();
int secureblackbox_sftpclient_getconnected(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoClientKeyAlgorithm(); Unicode (Windows) LPWSTR GetConnInfoClientKeyAlgorithm();
char* secureblackbox_sftpclient_getconninfoclientkeyalgorithm(void* lpObj);
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
ANSI (Cross Platform) int GetConnInfoClientKeyBits(); Unicode (Windows) INT GetConnInfoClientKeyBits();
int secureblackbox_sftpclient_getconninfoclientkeybits(void* lpObj);
int GetConnInfoClientKeyBits();
Default Value
0
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
ANSI (Cross Platform) char* GetConnInfoClientKeyFingerprint(); Unicode (Windows) LPWSTR GetConnInfoClientKeyFingerprint();
char* secureblackbox_sftpclient_getconninfoclientkeyfingerprint(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoCloseReason(); Unicode (Windows) LPWSTR GetConnInfoCloseReason();
char* secureblackbox_sftpclient_getconninfoclosereason(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoCompressionAlgorithmInbound(); Unicode (Windows) LPWSTR GetConnInfoCompressionAlgorithmInbound();
char* secureblackbox_sftpclient_getconninfocompressionalgorithminbound(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoCompressionAlgorithmOutbound(); Unicode (Windows) LPWSTR GetConnInfoCompressionAlgorithmOutbound();
char* secureblackbox_sftpclient_getconninfocompressionalgorithmoutbound(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoEncryptionAlgorithmInbound(); Unicode (Windows) LPWSTR GetConnInfoEncryptionAlgorithmInbound();
char* secureblackbox_sftpclient_getconninfoencryptionalgorithminbound(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoEncryptionAlgorithmOutbound(); Unicode (Windows) LPWSTR GetConnInfoEncryptionAlgorithmOutbound();
char* secureblackbox_sftpclient_getconninfoencryptionalgorithmoutbound(void* lpObj);
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
ANSI (Cross Platform) int GetConnInfoInboundEncryptionKeyBits(); Unicode (Windows) INT GetConnInfoInboundEncryptionKeyBits();
int secureblackbox_sftpclient_getconninfoinboundencryptionkeybits(void* lpObj);
int GetConnInfoInboundEncryptionKeyBits();
Default Value
0
Remarks
Specifies the length of the key used to encrypt the incoming traffic.
This property is read-only.
Data Type
Integer
ConnInfoKexAlgorithm Property (SFTPClient Class)
The key exchange algorithm used during the SSH handshake.
Syntax
ANSI (Cross Platform) char* GetConnInfoKexAlgorithm(); Unicode (Windows) LPWSTR GetConnInfoKexAlgorithm();
char* secureblackbox_sftpclient_getconninfokexalgorithm(void* lpObj);
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
ANSI (Cross Platform) int GetConnInfoKexBits(); Unicode (Windows) INT GetConnInfoKexBits();
int secureblackbox_sftpclient_getconninfokexbits(void* lpObj);
int GetConnInfoKexBits();
Default Value
0
Remarks
The number of bits used by the key exchange algorithm.
This property is read-only.
Data Type
Integer
ConnInfoKexLines Property (SFTPClient Class)
The contents of the received KexInit packet.
Syntax
ANSI (Cross Platform) char* GetConnInfoKexLines(); Unicode (Windows) LPWSTR GetConnInfoKexLines();
char* secureblackbox_sftpclient_getconninfokexlines(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoMacAlgorithmInbound(); Unicode (Windows) LPWSTR GetConnInfoMacAlgorithmInbound();
char* secureblackbox_sftpclient_getconninfomacalgorithminbound(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoMacAlgorithmOutbound(); Unicode (Windows) LPWSTR GetConnInfoMacAlgorithmOutbound();
char* secureblackbox_sftpclient_getconninfomacalgorithmoutbound(void* lpObj);
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
ANSI (Cross Platform) int GetConnInfoOutboundEncryptionKeyBits(); Unicode (Windows) INT GetConnInfoOutboundEncryptionKeyBits();
int secureblackbox_sftpclient_getconninfooutboundencryptionkeybits(void* lpObj);
int GetConnInfoOutboundEncryptionKeyBits();
Default Value
0
Remarks
Specifies the length of the key used to encrypt the outgoing traffic.
This property is read-only.
Data Type
Integer
ConnInfoPublicKeyAlgorithm Property (SFTPClient Class)
Specifies the public key algorithm which was used during the SSH handshake.
Syntax
ANSI (Cross Platform) char* GetConnInfoPublicKeyAlgorithm(); Unicode (Windows) LPWSTR GetConnInfoPublicKeyAlgorithm();
char* secureblackbox_sftpclient_getconninfopublickeyalgorithm(void* lpObj);
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
ANSI (Cross Platform) int GetConnInfoServerKeyBits(); Unicode (Windows) INT GetConnInfoServerKeyBits();
int secureblackbox_sftpclient_getconninfoserverkeybits(void* lpObj);
int GetConnInfoServerKeyBits();
Default Value
0
Remarks
Specifies the number of bits in the server's key.
This property is read-only.
Data Type
Integer
ConnInfoServerKeyFingerprint Property (SFTPClient Class)
The fingerprint (hash value) of the server's public key.
Syntax
ANSI (Cross Platform) char* GetConnInfoServerKeyFingerprint(); Unicode (Windows) LPWSTR GetConnInfoServerKeyFingerprint();
char* secureblackbox_sftpclient_getconninfoserverkeyfingerprint(void* lpObj);
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
ANSI (Cross Platform) char* GetConnInfoServerSoftwareName(); Unicode (Windows) LPWSTR GetConnInfoServerSoftwareName();
char* secureblackbox_sftpclient_getconninfoserversoftwarename(void* lpObj);
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
ANSI (Cross Platform) int64 GetConnInfoTotalBytesReceived(); Unicode (Windows) LONG64 GetConnInfoTotalBytesReceived();
int64 secureblackbox_sftpclient_getconninfototalbytesreceived(void* lpObj);
qint64 GetConnInfoTotalBytesReceived();
Default Value
0
Remarks
Returns the total number of bytes received over this connection.
This property is read-only.
Data Type
Long64
ConnInfoTotalBytesSent Property (SFTPClient Class)
Returns the total number of bytes sent over this connection.
Syntax
ANSI (Cross Platform) int64 GetConnInfoTotalBytesSent(); Unicode (Windows) LONG64 GetConnInfoTotalBytesSent();
int64 secureblackbox_sftpclient_getconninfototalbytessent(void* lpObj);
qint64 GetConnInfoTotalBytesSent();
Default Value
0
Remarks
Returns the total number of bytes sent over this connection.
This property is read-only.
Data Type
Long64
ConnInfoVersion Property (SFTPClient Class)
Specifies SSH protocol version.
Syntax
ANSI (Cross Platform) int GetConnInfoVersion(); Unicode (Windows) INT GetConnInfoVersion();
int secureblackbox_sftpclient_getconninfoversion(void* lpObj);
int GetConnInfoVersion();
Default Value
2
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
ANSI (Cross Platform) char* GetCurrListEntryATime(); Unicode (Windows) LPWSTR GetCurrListEntryATime();
char* secureblackbox_sftpclient_getcurrlistentryatime(void* lpObj);
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
ANSI (Cross Platform) char* GetCurrListEntryCTime(); Unicode (Windows) LPWSTR GetCurrListEntryCTime();
char* secureblackbox_sftpclient_getcurrlistentryctime(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryDirectory(); Unicode (Windows) BOOL GetCurrListEntryDirectory();
int secureblackbox_sftpclient_getcurrlistentrydirectory(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryFileType(); Unicode (Windows) 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)
int secureblackbox_sftpclient_getcurrlistentryfiletype(void* lpObj);
int GetCurrListEntryFileType();
Default Value
4
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
ANSI (Cross Platform) int GetCurrListEntryGroupExecute(); Unicode (Windows) BOOL GetCurrListEntryGroupExecute();
int secureblackbox_sftpclient_getcurrlistentrygroupexecute(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryGroupRead(); Unicode (Windows) BOOL GetCurrListEntryGroupRead();
int secureblackbox_sftpclient_getcurrlistentrygroupread(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryGroupWrite(); Unicode (Windows) BOOL GetCurrListEntryGroupWrite();
int secureblackbox_sftpclient_getcurrlistentrygroupwrite(void* lpObj);
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
ANSI (Cross Platform) int64 GetCurrListEntryHandle(); Unicode (Windows) LONG64 GetCurrListEntryHandle();
int64 secureblackbox_sftpclient_getcurrlistentryhandle(void* lpObj);
qint64 GetCurrListEntryHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
CurrListEntryLongName Property (SFTPClient Class)
Contains the long name of the file (human-readable, ftp-like).
Syntax
ANSI (Cross Platform) char* GetCurrListEntryLongName(); Unicode (Windows) LPWSTR GetCurrListEntryLongName();
char* secureblackbox_sftpclient_getcurrlistentrylongname(void* lpObj);
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
ANSI (Cross Platform) char* GetCurrListEntryMTime(); Unicode (Windows) LPWSTR GetCurrListEntryMTime();
char* secureblackbox_sftpclient_getcurrlistentrymtime(void* lpObj);
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
ANSI (Cross Platform) char* GetCurrListEntryName(); Unicode (Windows) LPWSTR GetCurrListEntryName();
char* secureblackbox_sftpclient_getcurrlistentryname(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryOtherExecute(); Unicode (Windows) BOOL GetCurrListEntryOtherExecute();
int secureblackbox_sftpclient_getcurrlistentryotherexecute(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryOtherRead(); Unicode (Windows) BOOL GetCurrListEntryOtherRead();
int secureblackbox_sftpclient_getcurrlistentryotherread(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryOtherWrite(); Unicode (Windows) BOOL GetCurrListEntryOtherWrite();
int secureblackbox_sftpclient_getcurrlistentryotherwrite(void* lpObj);
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
ANSI (Cross Platform) char* GetCurrListEntryOwner(); Unicode (Windows) LPWSTR GetCurrListEntryOwner();
char* secureblackbox_sftpclient_getcurrlistentryowner(void* lpObj);
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
ANSI (Cross Platform) char* GetCurrListEntryPath(); Unicode (Windows) LPWSTR GetCurrListEntryPath();
char* secureblackbox_sftpclient_getcurrlistentrypath(void* lpObj);
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
ANSI (Cross Platform) int64 GetCurrListEntrySize(); Unicode (Windows) LONG64 GetCurrListEntrySize();
int64 secureblackbox_sftpclient_getcurrlistentrysize(void* lpObj);
qint64 GetCurrListEntrySize();
Default Value
0
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
ANSI (Cross Platform) int GetCurrListEntryUserExecute(); Unicode (Windows) BOOL GetCurrListEntryUserExecute();
int secureblackbox_sftpclient_getcurrlistentryuserexecute(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryUserRead(); Unicode (Windows) BOOL GetCurrListEntryUserRead();
int secureblackbox_sftpclient_getcurrlistentryuserread(void* lpObj);
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
ANSI (Cross Platform) int GetCurrListEntryUserWrite(); Unicode (Windows) BOOL GetCurrListEntryUserWrite();
int secureblackbox_sftpclient_getcurrlistentryuserwrite(void* lpObj);
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
ANSI (Cross Platform) int GetDownloadBlockSize();
int SetDownloadBlockSize(int iDownloadBlockSize); Unicode (Windows) INT GetDownloadBlockSize();
INT SetDownloadBlockSize(INT iDownloadBlockSize);
int secureblackbox_sftpclient_getdownloadblocksize(void* lpObj);
int secureblackbox_sftpclient_setdownloadblocksize(void* lpObj, int iDownloadBlockSize);
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 an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Syntax
ANSI (Cross Platform) char* GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(const char* lpszExternalCryptoAsyncDocumentID); Unicode (Windows) LPWSTR GetExternalCryptoAsyncDocumentID();
INT SetExternalCryptoAsyncDocumentID(LPCWSTR lpszExternalCryptoAsyncDocumentID);
char* secureblackbox_sftpclient_getexternalcryptoasyncdocumentid(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptoasyncdocumentid(void* lpObj, const char* lpszExternalCryptoAsyncDocumentID);
QString GetExternalCryptoAsyncDocumentID();
int SetExternalCryptoAsyncDocumentID(QString qsExternalCryptoAsyncDocumentID);
Default Value
""
Remarks
Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.
Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.
If using batched requests, make sure to set this property to the same value on both 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
ANSI (Cross Platform) char* GetExternalCryptoCustomParams();
int SetExternalCryptoCustomParams(const char* lpszExternalCryptoCustomParams); Unicode (Windows) LPWSTR GetExternalCryptoCustomParams();
INT SetExternalCryptoCustomParams(LPCWSTR lpszExternalCryptoCustomParams);
char* secureblackbox_sftpclient_getexternalcryptocustomparams(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptocustomparams(void* lpObj, const char* lpszExternalCryptoCustomParams);
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
ANSI (Cross Platform) char* GetExternalCryptoData();
int SetExternalCryptoData(const char* lpszExternalCryptoData); Unicode (Windows) LPWSTR GetExternalCryptoData();
INT SetExternalCryptoData(LPCWSTR lpszExternalCryptoData);
char* secureblackbox_sftpclient_getexternalcryptodata(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptodata(void* lpObj, const char* lpszExternalCryptoData);
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
ANSI (Cross Platform) int GetExternalCryptoExternalHashCalculation();
int SetExternalCryptoExternalHashCalculation(int bExternalCryptoExternalHashCalculation); Unicode (Windows) BOOL GetExternalCryptoExternalHashCalculation();
INT SetExternalCryptoExternalHashCalculation(BOOL bExternalCryptoExternalHashCalculation);
int secureblackbox_sftpclient_getexternalcryptoexternalhashcalculation(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptoexternalhashcalculation(void* lpObj, int bExternalCryptoExternalHashCalculation);
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
ANSI (Cross Platform) char* GetExternalCryptoHashAlgorithm();
int SetExternalCryptoHashAlgorithm(const char* lpszExternalCryptoHashAlgorithm); Unicode (Windows) LPWSTR GetExternalCryptoHashAlgorithm();
INT SetExternalCryptoHashAlgorithm(LPCWSTR lpszExternalCryptoHashAlgorithm);
char* secureblackbox_sftpclient_getexternalcryptohashalgorithm(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptohashalgorithm(void* lpObj, const char* lpszExternalCryptoHashAlgorithm);
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
ANSI (Cross Platform) char* GetExternalCryptoKeyID();
int SetExternalCryptoKeyID(const char* lpszExternalCryptoKeyID); Unicode (Windows) LPWSTR GetExternalCryptoKeyID();
INT SetExternalCryptoKeyID(LPCWSTR lpszExternalCryptoKeyID);
char* secureblackbox_sftpclient_getexternalcryptokeyid(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptokeyid(void* lpObj, const char* lpszExternalCryptoKeyID);
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
ANSI (Cross Platform) char* GetExternalCryptoKeySecret();
int SetExternalCryptoKeySecret(const char* lpszExternalCryptoKeySecret); Unicode (Windows) LPWSTR GetExternalCryptoKeySecret();
INT SetExternalCryptoKeySecret(LPCWSTR lpszExternalCryptoKeySecret);
char* secureblackbox_sftpclient_getexternalcryptokeysecret(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptokeysecret(void* lpObj, const char* lpszExternalCryptoKeySecret);
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
ANSI (Cross Platform) int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod); Unicode (Windows) INT GetExternalCryptoMethod();
INT SetExternalCryptoMethod(INT iExternalCryptoMethod);
Possible Values
ASMD_PKCS1(0),
ASMD_PKCS7(1)
int secureblackbox_sftpclient_getexternalcryptomethod(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptomethod(void* lpObj, int iExternalCryptoMethod);
int GetExternalCryptoMethod();
int SetExternalCryptoMethod(int iExternalCryptoMethod);
Default Value
0
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
ANSI (Cross Platform) int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode); Unicode (Windows) INT GetExternalCryptoMode();
INT SetExternalCryptoMode(INT iExternalCryptoMode);
Possible Values
ECM_DEFAULT(0),
ECM_DISABLED(1),
ECM_GENERIC(2),
ECM_DCAUTH(3),
ECM_DCAUTH_JSON(4)
int secureblackbox_sftpclient_getexternalcryptomode(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptomode(void* lpObj, int iExternalCryptoMode);
int GetExternalCryptoMode();
int SetExternalCryptoMode(int iExternalCryptoMode);
Default Value
0
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
ANSI (Cross Platform) char* GetExternalCryptoPublicKeyAlgorithm();
int SetExternalCryptoPublicKeyAlgorithm(const char* lpszExternalCryptoPublicKeyAlgorithm); Unicode (Windows) LPWSTR GetExternalCryptoPublicKeyAlgorithm();
INT SetExternalCryptoPublicKeyAlgorithm(LPCWSTR lpszExternalCryptoPublicKeyAlgorithm);
char* secureblackbox_sftpclient_getexternalcryptopublickeyalgorithm(void* lpObj);
int secureblackbox_sftpclient_setexternalcryptopublickeyalgorithm(void* lpObj, const char* lpszExternalCryptoPublicKeyAlgorithm);
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
ANSI (Cross Platform) int GetFIPSMode();
int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();
INT SetFIPSMode(BOOL bFIPSMode);
int secureblackbox_sftpclient_getfipsmode(void* lpObj);
int secureblackbox_sftpclient_setfipsmode(void* lpObj, int bFIPSMode);
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
ANSI (Cross Platform) int GetForceCompression();
int SetForceCompression(int bForceCompression); Unicode (Windows) BOOL GetForceCompression();
INT SetForceCompression(BOOL bForceCompression);
int secureblackbox_sftpclient_getforcecompression(void* lpObj);
int secureblackbox_sftpclient_setforcecompression(void* lpObj, int bForceCompression);
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
ANSI (Cross Platform) char* GetKeyFingerprintSHA1(); Unicode (Windows) LPWSTR GetKeyFingerprintSHA1();
char* secureblackbox_sftpclient_getkeyfingerprintsha1(void* lpObj);
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
ANSI (Cross Platform) char* GetKeyFingerprintSHA256(); Unicode (Windows) LPWSTR GetKeyFingerprintSHA256();
char* secureblackbox_sftpclient_getkeyfingerprintsha256(void* lpObj);
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
ANSI (Cross Platform) int64 GetKeyHandle();
int SetKeyHandle(int64 lKeyHandle); Unicode (Windows) LONG64 GetKeyHandle();
INT SetKeyHandle(LONG64 lKeyHandle);
int64 secureblackbox_sftpclient_getkeyhandle(void* lpObj);
int secureblackbox_sftpclient_setkeyhandle(void* lpObj, int64 lKeyHandle);
qint64 GetKeyHandle();
int SetKeyHandle(qint64 lKeyHandle);
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is not available at design time.
Data Type
Long64
MaxSFTPVersion Property (SFTPClient Class)
Higher SFTP version to support.
Syntax
ANSI (Cross Platform) int GetMaxSFTPVersion();
int SetMaxSFTPVersion(int iMaxSFTPVersion); Unicode (Windows) INT GetMaxSFTPVersion();
INT SetMaxSFTPVersion(INT iMaxSFTPVersion);
int secureblackbox_sftpclient_getmaxsftpversion(void* lpObj);
int secureblackbox_sftpclient_setmaxsftpversion(void* lpObj, int iMaxSFTPVersion);
int GetMaxSFTPVersion();
int SetMaxSFTPVersion(int iMaxSFTPVersion);
Default Value
6
Remarks
MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions supported by this client.
Data Type
Integer
MinSFTPVersion Property (SFTPClient Class)
Lower SFTP version to support.
Syntax
ANSI (Cross Platform) int GetMinSFTPVersion();
int SetMinSFTPVersion(int iMinSFTPVersion); Unicode (Windows) INT GetMinSFTPVersion();
INT SetMinSFTPVersion(INT iMinSFTPVersion);
int secureblackbox_sftpclient_getminsftpversion(void* lpObj);
int secureblackbox_sftpclient_setminsftpversion(void* lpObj, int iMinSFTPVersion);
int GetMinSFTPVersion();
int SetMinSFTPVersion(int iMinSFTPVersion);
Default Value
0
Remarks
MaxSFTPVersion and MinSFTPVersion properties control the range of SFTP protocol versions to be supported by this client.
Data Type
Integer
Password Property (SFTPClient Class)
Specifies user's authentication password.
Syntax
ANSI (Cross Platform) char* GetPassword();
int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);
char* secureblackbox_sftpclient_getpassword(void* lpObj);
int secureblackbox_sftpclient_setpassword(void* lpObj, const char* lpszPassword);
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
ANSI (Cross Platform) int GetPipelineLength();
int SetPipelineLength(int iPipelineLength); Unicode (Windows) INT GetPipelineLength();
INT SetPipelineLength(INT iPipelineLength);
int secureblackbox_sftpclient_getpipelinelength(void* lpObj);
int secureblackbox_sftpclient_setpipelinelength(void* lpObj, int iPipelineLength);
int GetPipelineLength();
int SetPipelineLength(int iPipelineLength);
Default Value
32
Remarks
This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.
Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.
Data Type
Integer
ProxyAddress Property (SFTPClient Class)
The IP address of the proxy server.
Syntax
ANSI (Cross Platform) char* GetProxyAddress();
int SetProxyAddress(const char* lpszProxyAddress); Unicode (Windows) LPWSTR GetProxyAddress();
INT SetProxyAddress(LPCWSTR lpszProxyAddress);
char* secureblackbox_sftpclient_getproxyaddress(void* lpObj);
int secureblackbox_sftpclient_setproxyaddress(void* lpObj, const char* lpszProxyAddress);
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
ANSI (Cross Platform) int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication); Unicode (Windows) INT GetProxyAuthentication();
INT SetProxyAuthentication(INT iProxyAuthentication);
Possible Values
PAT_NO_AUTHENTICATION(0),
PAT_BASIC(1),
PAT_DIGEST(2),
PAT_NTLM(3)
int secureblackbox_sftpclient_getproxyauthentication(void* lpObj);
int secureblackbox_sftpclient_setproxyauthentication(void* lpObj, int iProxyAuthentication);
int GetProxyAuthentication();
int SetProxyAuthentication(int iProxyAuthentication);
Default Value
0
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
ANSI (Cross Platform) char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* secureblackbox_sftpclient_getproxypassword(void* lpObj);
int secureblackbox_sftpclient_setproxypassword(void* lpObj, const char* lpszProxyPassword);
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
ANSI (Cross Platform) int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int secureblackbox_sftpclient_getproxyport(void* lpObj);
int secureblackbox_sftpclient_setproxyport(void* lpObj, int iProxyPort);
int GetProxyPort();
int SetProxyPort(int iProxyPort);
Default Value
0
Remarks
The port on the proxy server to connect to.
Data Type
Integer
ProxyProxyType Property (SFTPClient Class)
The type of the proxy server.
Syntax
ANSI (Cross Platform) int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType); Unicode (Windows) 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)
int secureblackbox_sftpclient_getproxyproxytype(void* lpObj);
int secureblackbox_sftpclient_setproxyproxytype(void* lpObj, int iProxyProxyType);
int GetProxyProxyType();
int SetProxyProxyType(int iProxyProxyType);
Default Value
0
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
ANSI (Cross Platform) char* GetProxyRequestHeaders();
int SetProxyRequestHeaders(const char* lpszProxyRequestHeaders); Unicode (Windows) LPWSTR GetProxyRequestHeaders();
INT SetProxyRequestHeaders(LPCWSTR lpszProxyRequestHeaders);
char* secureblackbox_sftpclient_getproxyrequestheaders(void* lpObj);
int secureblackbox_sftpclient_setproxyrequestheaders(void* lpObj, const char* lpszProxyRequestHeaders);
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
ANSI (Cross Platform) char* GetProxyResponseBody();
int SetProxyResponseBody(const char* lpszProxyResponseBody); Unicode (Windows) LPWSTR GetProxyResponseBody();
INT SetProxyResponseBody(LPCWSTR lpszProxyResponseBody);
char* secureblackbox_sftpclient_getproxyresponsebody(void* lpObj);
int secureblackbox_sftpclient_setproxyresponsebody(void* lpObj, const char* lpszProxyResponseBody);
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
ANSI (Cross Platform) char* GetProxyResponseHeaders();
int SetProxyResponseHeaders(const char* lpszProxyResponseHeaders); Unicode (Windows) LPWSTR GetProxyResponseHeaders();
INT SetProxyResponseHeaders(LPCWSTR lpszProxyResponseHeaders);
char* secureblackbox_sftpclient_getproxyresponseheaders(void* lpObj);
int secureblackbox_sftpclient_setproxyresponseheaders(void* lpObj, const char* lpszProxyResponseHeaders);
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
ANSI (Cross Platform) int GetProxyUseIPv6();
int SetProxyUseIPv6(int bProxyUseIPv6); Unicode (Windows) BOOL GetProxyUseIPv6();
INT SetProxyUseIPv6(BOOL bProxyUseIPv6);
int secureblackbox_sftpclient_getproxyuseipv6(void* lpObj);
int secureblackbox_sftpclient_setproxyuseipv6(void* lpObj, int bProxyUseIPv6);
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
ANSI (Cross Platform) int GetProxyUseProxy();
int SetProxyUseProxy(int bProxyUseProxy); Unicode (Windows) BOOL GetProxyUseProxy();
INT SetProxyUseProxy(BOOL bProxyUseProxy);
int secureblackbox_sftpclient_getproxyuseproxy(void* lpObj);
int secureblackbox_sftpclient_setproxyuseproxy(void* lpObj, int bProxyUseProxy);
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
ANSI (Cross Platform) char* GetProxyUsername();
int SetProxyUsername(const char* lpszProxyUsername); Unicode (Windows) LPWSTR GetProxyUsername();
INT SetProxyUsername(LPCWSTR lpszProxyUsername);
char* secureblackbox_sftpclient_getproxyusername(void* lpObj);
int secureblackbox_sftpclient_setproxyusername(void* lpObj, const char* lpszProxyUsername);
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
ANSI (Cross Platform) char* GetServerKeyAlgorithm(); Unicode (Windows) LPWSTR GetServerKeyAlgorithm();
char* secureblackbox_sftpclient_getserverkeyalgorithm(void* lpObj);
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
ANSI (Cross Platform) int GetServerKeyBits(); Unicode (Windows) INT GetServerKeyBits();
int secureblackbox_sftpclient_getserverkeybits(void* lpObj);
int GetServerKeyBits();
Default Value
0
Remarks
The number of bits in the key: the more the better, 2048 or 4096 are typical values.
This property is read-only and not available at design time.
Data Type
Integer
ServerKeyComment Property (SFTPClient Class)
The comment for the public key.
Syntax
ANSI (Cross Platform) char* GetServerKeyComment(); Unicode (Windows) LPWSTR GetServerKeyComment();
char* secureblackbox_sftpclient_getserverkeycomment(void* lpObj);
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
ANSI (Cross Platform) char* GetServerKeyCurve(); Unicode (Windows) LPWSTR GetServerKeyCurve();
char* secureblackbox_sftpclient_getserverkeycurve(void* lpObj);
QString GetServerKeyCurve();
Default Value
""
Remarks
Specifies the elliptical curve when EC cryptography is used.
This property is read-only and not available at design time.
Data Type
String
ServerKeyDSSG Property (SFTPClient Class)
The G (Generator) parameter of the DSS signature key.
Syntax
ANSI (Cross Platform) int GetServerKeyDSSG(char* &lpServerKeyDSSG, int &lenServerKeyDSSG); Unicode (Windows) INT GetServerKeyDSSG(LPSTR &lpServerKeyDSSG, INT &lenServerKeyDSSG);
int secureblackbox_sftpclient_getserverkeydssg(void* lpObj, char** lpServerKeyDSSG, int* lenServerKeyDSSG);
QByteArray GetServerKeyDSSG();
Remarks
The G (Generator) parameter of the DSS signature key. The string should contain the binary data of G.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeyDSSP Property (SFTPClient Class)
The P (Prime) parameter of the DSS signature key.
Syntax
ANSI (Cross Platform) int GetServerKeyDSSP(char* &lpServerKeyDSSP, int &lenServerKeyDSSP); Unicode (Windows) INT GetServerKeyDSSP(LPSTR &lpServerKeyDSSP, INT &lenServerKeyDSSP);
int secureblackbox_sftpclient_getserverkeydssp(void* lpObj, char** lpServerKeyDSSP, int* lenServerKeyDSSP);
QByteArray GetServerKeyDSSP();
Remarks
The P (Prime) parameter of the DSS signature key. The string should contain the binary data of P.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeyDSSQ Property (SFTPClient Class)
The Q (Prime Factor) parameter of the DSS signature key.
Syntax
ANSI (Cross Platform) int GetServerKeyDSSQ(char* &lpServerKeyDSSQ, int &lenServerKeyDSSQ); Unicode (Windows) INT GetServerKeyDSSQ(LPSTR &lpServerKeyDSSQ, INT &lenServerKeyDSSQ);
int secureblackbox_sftpclient_getserverkeydssq(void* lpObj, char** lpServerKeyDSSQ, int* lenServerKeyDSSQ);
QByteArray GetServerKeyDSSQ();
Remarks
The Q (Prime Factor) parameter of the DSS signature key. The string should contain the binary data of Q.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeyDSSX Property (SFTPClient Class)
The X (Private key) parameter of the DSS signature key.
Syntax
ANSI (Cross Platform) int GetServerKeyDSSX(char* &lpServerKeyDSSX, int &lenServerKeyDSSX); Unicode (Windows) INT GetServerKeyDSSX(LPSTR &lpServerKeyDSSX, INT &lenServerKeyDSSX);
int secureblackbox_sftpclient_getserverkeydssx(void* lpObj, char** lpServerKeyDSSX, int* lenServerKeyDSSX);
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
ANSI (Cross Platform) int GetServerKeyDSSY(char* &lpServerKeyDSSY, int &lenServerKeyDSSY); Unicode (Windows) INT GetServerKeyDSSY(LPSTR &lpServerKeyDSSY, INT &lenServerKeyDSSY);
int secureblackbox_sftpclient_getserverkeydssy(void* lpObj, char** lpServerKeyDSSY, int* lenServerKeyDSSY);
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
ANSI (Cross Platform) int GetServerKeyECCD(char* &lpServerKeyECCD, int &lenServerKeyECCD); Unicode (Windows) INT GetServerKeyECCD(LPSTR &lpServerKeyECCD, INT &lenServerKeyECCD);
int secureblackbox_sftpclient_getserverkeyeccd(void* lpObj, char** lpServerKeyECCD, int* lenServerKeyECCD);
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
ANSI (Cross Platform) int GetServerKeyECCQX(char* &lpServerKeyECCQX, int &lenServerKeyECCQX); Unicode (Windows) INT GetServerKeyECCQX(LPSTR &lpServerKeyECCQX, INT &lenServerKeyECCQX);
int secureblackbox_sftpclient_getserverkeyeccqx(void* lpObj, char** lpServerKeyECCQX, int* lenServerKeyECCQX);
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
ANSI (Cross Platform) int GetServerKeyECCQY(char* &lpServerKeyECCQY, int &lenServerKeyECCQY); Unicode (Windows) INT GetServerKeyECCQY(LPSTR &lpServerKeyECCQY, INT &lenServerKeyECCQY);
int secureblackbox_sftpclient_getserverkeyeccqy(void* lpObj, char** lpServerKeyECCQY, int* lenServerKeyECCQY);
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
ANSI (Cross Platform) int GetServerKeyEdPrivate(char* &lpServerKeyEdPrivate, int &lenServerKeyEdPrivate); Unicode (Windows) INT GetServerKeyEdPrivate(LPSTR &lpServerKeyEdPrivate, INT &lenServerKeyEdPrivate);
int secureblackbox_sftpclient_getserverkeyedprivate(void* lpObj, char** lpServerKeyEdPrivate, int* lenServerKeyEdPrivate);
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
ANSI (Cross Platform) int GetServerKeyEdPublic(char* &lpServerKeyEdPublic, int &lenServerKeyEdPublic); Unicode (Windows) INT GetServerKeyEdPublic(LPSTR &lpServerKeyEdPublic, INT &lenServerKeyEdPublic);
int secureblackbox_sftpclient_getserverkeyedpublic(void* lpObj, char** lpServerKeyEdPublic, int* lenServerKeyEdPublic);
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
ANSI (Cross Platform) char* GetServerKeyFingerprintMD5(); Unicode (Windows) LPWSTR GetServerKeyFingerprintMD5();
char* secureblackbox_sftpclient_getserverkeyfingerprintmd5(void* lpObj);
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
ANSI (Cross Platform) char* GetServerKeyFingerprintSHA1(); Unicode (Windows) LPWSTR GetServerKeyFingerprintSHA1();
char* secureblackbox_sftpclient_getserverkeyfingerprintsha1(void* lpObj);
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
ANSI (Cross Platform) char* GetServerKeyFingerprintSHA256(); Unicode (Windows) LPWSTR GetServerKeyFingerprintSHA256();
char* secureblackbox_sftpclient_getserverkeyfingerprintsha256(void* lpObj);
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
ANSI (Cross Platform) int64 GetServerKeyHandle(); Unicode (Windows) LONG64 GetServerKeyHandle();
int64 secureblackbox_sftpclient_getserverkeyhandle(void* lpObj);
qint64 GetServerKeyHandle();
Default Value
0
Remarks
Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.
When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object
after such operation.
pdfSigner.setSigningCertHandle(certMgr.getCertHandle());
This property is read-only and not available at design time.
Data Type
Long64
ServerKeyIsExtractable Property (SFTPClient Class)
Whether the key is extractable (e.
Syntax
ANSI (Cross Platform) int GetServerKeyIsExtractable(); Unicode (Windows) BOOL GetServerKeyIsExtractable();
int secureblackbox_sftpclient_getserverkeyisextractable(void* lpObj);
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
ANSI (Cross Platform) int GetServerKeyIsPrivate(); Unicode (Windows) BOOL GetServerKeyIsPrivate();
int secureblackbox_sftpclient_getserverkeyisprivate(void* lpObj);
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
ANSI (Cross Platform) int GetServerKeyIsPublic(); Unicode (Windows) BOOL GetServerKeyIsPublic();
int secureblackbox_sftpclient_getserverkeyispublic(void* lpObj);
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
ANSI (Cross Platform) int GetServerKeyKDFRounds(); Unicode (Windows) INT GetServerKeyKDFRounds();
int secureblackbox_sftpclient_getserverkeykdfrounds(void* lpObj);
int GetServerKeyKDFRounds();
Default Value
0
Remarks
Returns the number of iterations of the Key Derivation Function (KDF) used to generate this key.
This property is read-only and not available at design time.
Data Type
Integer
ServerKeyKDFSalt Property (SFTPClient Class)
The salt value used by the Key Derivation Function (KDF) to generate this key.
Syntax
ANSI (Cross Platform) int GetServerKeyKDFSalt(char* &lpServerKeyKDFSalt, int &lenServerKeyKDFSalt); Unicode (Windows) INT GetServerKeyKDFSalt(LPSTR &lpServerKeyKDFSalt, INT &lenServerKeyKDFSalt);
int secureblackbox_sftpclient_getserverkeykdfsalt(void* lpObj, char** lpServerKeyKDFSalt, int* lenServerKeyKDFSalt);
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
ANSI (Cross Platform) int GetServerKeyKeyFormat(); Unicode (Windows) 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),
CKF_PU_TTY3(9)
int secureblackbox_sftpclient_getserverkeykeyformat(void* lpObj);
int GetServerKeyKeyFormat();
Default Value
0
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 | |
| ckfPuTTY3 | 9 |
This property is read-only and not available at design time.
Data Type
Integer
ServerKeyKeyProtectionAlgorithm Property (SFTPClient Class)
Specifies the key protection algorithm.
Syntax
ANSI (Cross Platform) char* GetServerKeyKeyProtectionAlgorithm(); Unicode (Windows) LPWSTR GetServerKeyKeyProtectionAlgorithm();
char* secureblackbox_sftpclient_getserverkeykeyprotectionalgorithm(void* lpObj);
QString GetServerKeyKeyProtectionAlgorithm();
Default Value
""
Remarks
Specifies the key protection algorithm.
This property is read-only and not available at design time.
Data Type
String
ServerKeyRSAExponent Property (SFTPClient Class)
Returns the e parameter (public exponent) of the RSA key.
Syntax
ANSI (Cross Platform) int GetServerKeyRSAExponent(char* &lpServerKeyRSAExponent, int &lenServerKeyRSAExponent); Unicode (Windows) INT GetServerKeyRSAExponent(LPSTR &lpServerKeyRSAExponent, INT &lenServerKeyRSAExponent);
int secureblackbox_sftpclient_getserverkeyrsaexponent(void* lpObj, char** lpServerKeyRSAExponent, int* lenServerKeyRSAExponent);
QByteArray GetServerKeyRSAExponent();
Remarks
Returns the e parameter (public exponent) of the RSA key.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeyRSAIQMP Property (SFTPClient Class)
Returns the iqmp parameter of the RSA key.
Syntax
ANSI (Cross Platform) int GetServerKeyRSAIQMP(char* &lpServerKeyRSAIQMP, int &lenServerKeyRSAIQMP); Unicode (Windows) INT GetServerKeyRSAIQMP(LPSTR &lpServerKeyRSAIQMP, INT &lenServerKeyRSAIQMP);
int secureblackbox_sftpclient_getserverkeyrsaiqmp(void* lpObj, char** lpServerKeyRSAIQMP, int* lenServerKeyRSAIQMP);
QByteArray GetServerKeyRSAIQMP();
Remarks
Returns the iqmp parameter of the RSA key.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeyRSAModulus Property (SFTPClient Class)
Returns the m parameter (public modulus) of the RSA key.
Syntax
ANSI (Cross Platform) int GetServerKeyRSAModulus(char* &lpServerKeyRSAModulus, int &lenServerKeyRSAModulus); Unicode (Windows) INT GetServerKeyRSAModulus(LPSTR &lpServerKeyRSAModulus, INT &lenServerKeyRSAModulus);
int secureblackbox_sftpclient_getserverkeyrsamodulus(void* lpObj, char** lpServerKeyRSAModulus, int* lenServerKeyRSAModulus);
QByteArray GetServerKeyRSAModulus();
Remarks
Returns the m parameter (public modulus) of the RSA key.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeyRSAP Property (SFTPClient Class)
Returns the p parameter (first factor of the common modulus n) of the RSA key.
Syntax
ANSI (Cross Platform) int GetServerKeyRSAP(char* &lpServerKeyRSAP, int &lenServerKeyRSAP); Unicode (Windows) INT GetServerKeyRSAP(LPSTR &lpServerKeyRSAP, INT &lenServerKeyRSAP);
int secureblackbox_sftpclient_getserverkeyrsap(void* lpObj, char** lpServerKeyRSAP, int* lenServerKeyRSAP);
QByteArray GetServerKeyRSAP();
Remarks
Returns the p parameter (first factor of the common modulus n) of the RSA key.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeyRSAPrivateExponent Property (SFTPClient Class)
Returns the d parameter (private exponent) of the RSA key.
Syntax
ANSI (Cross Platform) int GetServerKeyRSAPrivateExponent(char* &lpServerKeyRSAPrivateExponent, int &lenServerKeyRSAPrivateExponent); Unicode (Windows) INT GetServerKeyRSAPrivateExponent(LPSTR &lpServerKeyRSAPrivateExponent, INT &lenServerKeyRSAPrivateExponent);
int secureblackbox_sftpclient_getserverkeyrsaprivateexponent(void* lpObj, char** lpServerKeyRSAPrivateExponent, int* lenServerKeyRSAPrivateExponent);
QByteArray GetServerKeyRSAPrivateExponent();
Remarks
Returns the d parameter (private exponent) of the RSA key.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeyRSAQ Property (SFTPClient Class)
Returns the q parameter (second factor of the common modulus n) of the RSA key.
Syntax
ANSI (Cross Platform) int GetServerKeyRSAQ(char* &lpServerKeyRSAQ, int &lenServerKeyRSAQ); Unicode (Windows) INT GetServerKeyRSAQ(LPSTR &lpServerKeyRSAQ, INT &lenServerKeyRSAQ);
int secureblackbox_sftpclient_getserverkeyrsaq(void* lpObj, char** lpServerKeyRSAQ, int* lenServerKeyRSAQ);
QByteArray GetServerKeyRSAQ();
Remarks
Returns the q parameter (second factor of the common modulus n) of the RSA key.
This property is read-only and not available at design time.
Data Type
Byte Array
ServerKeySubject Property (SFTPClient Class)
Specifies the public key owner (subject).
Syntax
ANSI (Cross Platform) char* GetServerKeySubject(); Unicode (Windows) LPWSTR GetServerKeySubject();
char* secureblackbox_sftpclient_getserverkeysubject(void* lpObj);
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
ANSI (Cross Platform) int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode); Unicode (Windows) INT GetSocketDNSMode();
INT SetSocketDNSMode(INT iSocketDNSMode);
Possible Values
DM_AUTO(0),
DM_PLATFORM(1),
DM_OWN(2),
DM_OWN_SECURE(3)
int secureblackbox_sftpclient_getsocketdnsmode(void* lpObj);
int secureblackbox_sftpclient_setsocketdnsmode(void* lpObj, int iSocketDNSMode);
int GetSocketDNSMode();
int SetSocketDNSMode(int iSocketDNSMode);
Default Value
0
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
ANSI (Cross Platform) int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort); Unicode (Windows) INT GetSocketDNSPort();
INT SetSocketDNSPort(INT iSocketDNSPort);
int secureblackbox_sftpclient_getsocketdnsport(void* lpObj);
int secureblackbox_sftpclient_setsocketdnsport(void* lpObj, int iSocketDNSPort);
int GetSocketDNSPort();
int SetSocketDNSPort(int iSocketDNSPort);
Default Value
0
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
ANSI (Cross Platform) int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout); Unicode (Windows) INT GetSocketDNSQueryTimeout();
INT SetSocketDNSQueryTimeout(INT iSocketDNSQueryTimeout);
int secureblackbox_sftpclient_getsocketdnsquerytimeout(void* lpObj);
int secureblackbox_sftpclient_setsocketdnsquerytimeout(void* lpObj, int iSocketDNSQueryTimeout);
int GetSocketDNSQueryTimeout();
int SetSocketDNSQueryTimeout(int iSocketDNSQueryTimeout);
Default Value
0
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
ANSI (Cross Platform) char* GetSocketDNSServers();
int SetSocketDNSServers(const char* lpszSocketDNSServers); Unicode (Windows) LPWSTR GetSocketDNSServers();
INT SetSocketDNSServers(LPCWSTR lpszSocketDNSServers);
char* secureblackbox_sftpclient_getsocketdnsservers(void* lpObj);
int secureblackbox_sftpclient_setsocketdnsservers(void* lpObj, const char* lpszSocketDNSServers);
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
ANSI (Cross Platform) int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout); Unicode (Windows) INT GetSocketDNSTotalTimeout();
INT SetSocketDNSTotalTimeout(INT iSocketDNSTotalTimeout);
int secureblackbox_sftpclient_getsocketdnstotaltimeout(void* lpObj);
int secureblackbox_sftpclient_setsocketdnstotaltimeout(void* lpObj, int iSocketDNSTotalTimeout);
int GetSocketDNSTotalTimeout();
int SetSocketDNSTotalTimeout(int iSocketDNSTotalTimeout);
Default Value
0
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
ANSI (Cross Platform) int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit); Unicode (Windows) INT GetSocketIncomingSpeedLimit();
INT SetSocketIncomingSpeedLimit(INT iSocketIncomingSpeedLimit);
int secureblackbox_sftpclient_getsocketincomingspeedlimit(void* lpObj);
int secureblackbox_sftpclient_setsocketincomingspeedlimit(void* lpObj, int iSocketIncomingSpeedLimit);
int GetSocketIncomingSpeedLimit();
int SetSocketIncomingSpeedLimit(int iSocketIncomingSpeedLimit);
Default Value
0
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
ANSI (Cross Platform) char* GetSocketLocalAddress();
int SetSocketLocalAddress(const char* lpszSocketLocalAddress); Unicode (Windows) LPWSTR GetSocketLocalAddress();
INT SetSocketLocalAddress(LPCWSTR lpszSocketLocalAddress);
char* secureblackbox_sftpclient_getsocketlocaladdress(void* lpObj);
int secureblackbox_sftpclient_setsocketlocaladdress(void* lpObj, const char* lpszSocketLocalAddress);
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
ANSI (Cross Platform) int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort); Unicode (Windows) INT GetSocketLocalPort();
INT SetSocketLocalPort(INT iSocketLocalPort);
int secureblackbox_sftpclient_getsocketlocalport(void* lpObj);
int secureblackbox_sftpclient_setsocketlocalport(void* lpObj, int iSocketLocalPort);
int GetSocketLocalPort();
int SetSocketLocalPort(int iSocketLocalPort);
Default Value
0
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
ANSI (Cross Platform) int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit); Unicode (Windows) INT GetSocketOutgoingSpeedLimit();
INT SetSocketOutgoingSpeedLimit(INT iSocketOutgoingSpeedLimit);
int secureblackbox_sftpclient_getsocketoutgoingspeedlimit(void* lpObj);
int secureblackbox_sftpclient_setsocketoutgoingspeedlimit(void* lpObj, int iSocketOutgoingSpeedLimit);
int GetSocketOutgoingSpeedLimit();
int SetSocketOutgoingSpeedLimit(int iSocketOutgoingSpeedLimit);
Default Value
0
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
ANSI (Cross Platform) int GetSocketTimeout();
int SetSocketTimeout(int iSocketTimeout); Unicode (Windows) INT GetSocketTimeout();
INT SetSocketTimeout(INT iSocketTimeout);
int secureblackbox_sftpclient_getsockettimeout(void* lpObj);
int secureblackbox_sftpclient_setsockettimeout(void* lpObj, int iSocketTimeout);
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
ANSI (Cross Platform) int GetSocketUseIPv6();
int SetSocketUseIPv6(int bSocketUseIPv6); Unicode (Windows) BOOL GetSocketUseIPv6();
INT SetSocketUseIPv6(BOOL bSocketUseIPv6);
int secureblackbox_sftpclient_getsocketuseipv6(void* lpObj);
int secureblackbox_sftpclient_setsocketuseipv6(void* lpObj, int bSocketUseIPv6);
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
ANSI (Cross Platform) int GetSSHSettingsAutoAdjustCiphers();
int SetSSHSettingsAutoAdjustCiphers(int bSSHSettingsAutoAdjustCiphers); Unicode (Windows) BOOL GetSSHSettingsAutoAdjustCiphers();
INT SetSSHSettingsAutoAdjustCiphers(BOOL bSSHSettingsAutoAdjustCiphers);
int secureblackbox_sftpclient_getsshsettingsautoadjustciphers(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsautoadjustciphers(void* lpObj, int bSSHSettingsAutoAdjustCiphers);
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
ANSI (Cross Platform) int GetSSHSettingsBaseConfiguration();
int SetSSHSettingsBaseConfiguration(int iSSHSettingsBaseConfiguration); Unicode (Windows) INT GetSSHSettingsBaseConfiguration();
INT SetSSHSettingsBaseConfiguration(INT iSSHSettingsBaseConfiguration);
Possible Values
STPC_DEFAULT(0),
STPC_COMPATIBLE(1),
STPC_COMPREHENSIVE_INSECURE(2),
STPC_HIGHLY_SECURE(3)
int secureblackbox_sftpclient_getsshsettingsbaseconfiguration(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsbaseconfiguration(void* lpObj, int iSSHSettingsBaseConfiguration);
int GetSSHSettingsBaseConfiguration();
int SetSSHSettingsBaseConfiguration(int iSSHSettingsBaseConfiguration);
Default Value
0
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
ANSI (Cross Platform) char* GetSSHSettingsCompressionAlgorithms();
int SetSSHSettingsCompressionAlgorithms(const char* lpszSSHSettingsCompressionAlgorithms); Unicode (Windows) LPWSTR GetSSHSettingsCompressionAlgorithms();
INT SetSSHSettingsCompressionAlgorithms(LPCWSTR lpszSSHSettingsCompressionAlgorithms);
char* secureblackbox_sftpclient_getsshsettingscompressionalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingscompressionalgorithms(void* lpObj, const char* lpszSSHSettingsCompressionAlgorithms);
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
ANSI (Cross Platform) int GetSSHSettingsCompressionLevel();
int SetSSHSettingsCompressionLevel(int iSSHSettingsCompressionLevel); Unicode (Windows) INT GetSSHSettingsCompressionLevel();
INT SetSSHSettingsCompressionLevel(INT iSSHSettingsCompressionLevel);
int secureblackbox_sftpclient_getsshsettingscompressionlevel(void* lpObj);
int secureblackbox_sftpclient_setsshsettingscompressionlevel(void* lpObj, int iSSHSettingsCompressionLevel);
int GetSSHSettingsCompressionLevel();
int SetSSHSettingsCompressionLevel(int iSSHSettingsCompressionLevel);
Default Value
6
Remarks
Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted.
Data Type
Integer
SSHSettingsDefaultWindowSize Property (SFTPClient 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
ANSI (Cross Platform) int GetSSHSettingsDefaultWindowSize();
int SetSSHSettingsDefaultWindowSize(int iSSHSettingsDefaultWindowSize); Unicode (Windows) INT GetSSHSettingsDefaultWindowSize();
INT SetSSHSettingsDefaultWindowSize(INT iSSHSettingsDefaultWindowSize);
int secureblackbox_sftpclient_getsshsettingsdefaultwindowsize(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsdefaultwindowsize(void* lpObj, int iSSHSettingsDefaultWindowSize);
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
ANSI (Cross Platform) char* GetSSHSettingsEncryptionAlgorithms();
int SetSSHSettingsEncryptionAlgorithms(const char* lpszSSHSettingsEncryptionAlgorithms); Unicode (Windows) LPWSTR GetSSHSettingsEncryptionAlgorithms();
INT SetSSHSettingsEncryptionAlgorithms(LPCWSTR lpszSSHSettingsEncryptionAlgorithms);
char* secureblackbox_sftpclient_getsshsettingsencryptionalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsencryptionalgorithms(void* lpObj, const char* lpszSSHSettingsEncryptionAlgorithms);
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
ANSI (Cross Platform) int GetSSHSettingsForceCompression();
int SetSSHSettingsForceCompression(int bSSHSettingsForceCompression); Unicode (Windows) BOOL GetSSHSettingsForceCompression();
INT SetSSHSettingsForceCompression(BOOL bSSHSettingsForceCompression);
int secureblackbox_sftpclient_getsshsettingsforcecompression(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsforcecompression(void* lpObj, int bSSHSettingsForceCompression);
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
ANSI (Cross Platform) char* GetSSHSettingsGSSAuthTypes();
int SetSSHSettingsGSSAuthTypes(const char* lpszSSHSettingsGSSAuthTypes); Unicode (Windows) LPWSTR GetSSHSettingsGSSAuthTypes();
INT SetSSHSettingsGSSAuthTypes(LPCWSTR lpszSSHSettingsGSSAuthTypes);
char* secureblackbox_sftpclient_getsshsettingsgssauthtypes(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgssauthtypes(void* lpObj, const char* lpszSSHSettingsGSSAuthTypes);
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
ANSI (Cross Platform) int GetSSHSettingsGSSDelegateCreds();
int SetSSHSettingsGSSDelegateCreds(int bSSHSettingsGSSDelegateCreds); Unicode (Windows) BOOL GetSSHSettingsGSSDelegateCreds();
INT SetSSHSettingsGSSDelegateCreds(BOOL bSSHSettingsGSSDelegateCreds);
int secureblackbox_sftpclient_getsshsettingsgssdelegatecreds(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgssdelegatecreds(void* lpObj, int bSSHSettingsGSSDelegateCreds);
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
ANSI (Cross Platform) char* GetSSHSettingsGSSHostname();
int SetSSHSettingsGSSHostname(const char* lpszSSHSettingsGSSHostname); Unicode (Windows) LPWSTR GetSSHSettingsGSSHostname();
INT SetSSHSettingsGSSHostname(LPCWSTR lpszSSHSettingsGSSHostname);
char* secureblackbox_sftpclient_getsshsettingsgsshostname(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgsshostname(void* lpObj, const char* lpszSSHSettingsGSSHostname);
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
ANSI (Cross Platform) char* GetSSHSettingsGSSLib();
int SetSSHSettingsGSSLib(const char* lpszSSHSettingsGSSLib); Unicode (Windows) LPWSTR GetSSHSettingsGSSLib();
INT SetSSHSettingsGSSLib(LPCWSTR lpszSSHSettingsGSSLib);
char* secureblackbox_sftpclient_getsshsettingsgsslib(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgsslib(void* lpObj, const char* lpszSSHSettingsGSSLib);
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
ANSI (Cross Platform) char* GetSSHSettingsGSSMechanisms();
int SetSSHSettingsGSSMechanisms(const char* lpszSSHSettingsGSSMechanisms); Unicode (Windows) LPWSTR GetSSHSettingsGSSMechanisms();
INT SetSSHSettingsGSSMechanisms(LPCWSTR lpszSSHSettingsGSSMechanisms);
char* secureblackbox_sftpclient_getsshsettingsgssmechanisms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgssmechanisms(void* lpObj, const char* lpszSSHSettingsGSSMechanisms);
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
ANSI (Cross Platform) char* GetSSHSettingsGSSProtocols();
int SetSSHSettingsGSSProtocols(const char* lpszSSHSettingsGSSProtocols); Unicode (Windows) LPWSTR GetSSHSettingsGSSProtocols();
INT SetSSHSettingsGSSProtocols(LPCWSTR lpszSSHSettingsGSSProtocols);
char* secureblackbox_sftpclient_getsshsettingsgssprotocols(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsgssprotocols(void* lpObj, const char* lpszSSHSettingsGSSProtocols);
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
ANSI (Cross Platform) int GetSSHSettingsHandshakeTimeout();
int SetSSHSettingsHandshakeTimeout(int iSSHSettingsHandshakeTimeout); Unicode (Windows) INT GetSSHSettingsHandshakeTimeout();
INT SetSSHSettingsHandshakeTimeout(INT iSSHSettingsHandshakeTimeout);
int secureblackbox_sftpclient_getsshsettingshandshaketimeout(void* lpObj);
int secureblackbox_sftpclient_setsshsettingshandshaketimeout(void* lpObj, int iSSHSettingsHandshakeTimeout);
int GetSSHSettingsHandshakeTimeout();
int SetSSHSettingsHandshakeTimeout(int iSSHSettingsHandshakeTimeout);
Default Value
45
Remarks
Specifies the maximal time for the SSH handshake to proceed, in seconds. If the handshake is not completed within this period, the session is aborted.
Data Type
Integer
SSHSettingsKexAlgorithms Property (SFTPClient Class)
A list of key exchange algorithms separated with commas or semicolons.
Syntax
ANSI (Cross Platform) char* GetSSHSettingsKexAlgorithms();
int SetSSHSettingsKexAlgorithms(const char* lpszSSHSettingsKexAlgorithms); Unicode (Windows) LPWSTR GetSSHSettingsKexAlgorithms();
INT SetSSHSettingsKexAlgorithms(LPCWSTR lpszSSHSettingsKexAlgorithms);
char* secureblackbox_sftpclient_getsshsettingskexalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingskexalgorithms(void* lpObj, const char* lpszSSHSettingsKexAlgorithms);
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
- diffie-hellman-group14-sha256
- diffie-hellman-group15-sha512
- diffie-hellman-group16-sha512
- diffie-hellman-group17-sha512
- diffie-hellman-group18-sha512
Data Type
String
SSHSettingsMacAlgorithms Property (SFTPClient Class)
A list of MAC (for message authentication code ) algorithms separated with commas or semicolons.
Syntax
ANSI (Cross Platform) char* GetSSHSettingsMacAlgorithms();
int SetSSHSettingsMacAlgorithms(const char* lpszSSHSettingsMacAlgorithms); Unicode (Windows) LPWSTR GetSSHSettingsMacAlgorithms();
INT SetSSHSettingsMacAlgorithms(LPCWSTR lpszSSHSettingsMacAlgorithms);
char* secureblackbox_sftpclient_getsshsettingsmacalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsmacalgorithms(void* lpObj, const char* lpszSSHSettingsMacAlgorithms);
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
ANSI (Cross Platform) int GetSSHSettingsMaxSSHPacketSize();
int SetSSHSettingsMaxSSHPacketSize(int iSSHSettingsMaxSSHPacketSize); Unicode (Windows) INT GetSSHSettingsMaxSSHPacketSize();
INT SetSSHSettingsMaxSSHPacketSize(INT iSSHSettingsMaxSSHPacketSize);
int secureblackbox_sftpclient_getsshsettingsmaxsshpacketsize(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsmaxsshpacketsize(void* lpObj, int iSSHSettingsMaxSSHPacketSize);
int GetSSHSettingsMaxSSHPacketSize();
int SetSSHSettingsMaxSSHPacketSize(int iSSHSettingsMaxSSHPacketSize);
Default Value
262144
Remarks
Specifies the maximum length of one SSH packet in bytes.
Data Type
Integer
SSHSettingsMinWindowSize Property (SFTPClient Class)
Specifies the minimal internal window size.
Syntax
ANSI (Cross Platform) int GetSSHSettingsMinWindowSize();
int SetSSHSettingsMinWindowSize(int iSSHSettingsMinWindowSize); Unicode (Windows) INT GetSSHSettingsMinWindowSize();
INT SetSSHSettingsMinWindowSize(INT iSSHSettingsMinWindowSize);
int secureblackbox_sftpclient_getsshsettingsminwindowsize(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsminwindowsize(void* lpObj, int iSSHSettingsMinWindowSize);
int GetSSHSettingsMinWindowSize();
int SetSSHSettingsMinWindowSize(int iSSHSettingsMinWindowSize);
Default Value
2048
Remarks
Specifies the minimal internal window size. When the minimal window size is reached, the 'window extension' request is sent to the server. This request notifies the server that the window was extended, and it can send more data.
Data Type
Integer
SSHSettingsObfuscateHandshake Property (SFTPClient Class)
Enables or disables handshake obfuscation.
Syntax
ANSI (Cross Platform) int GetSSHSettingsObfuscateHandshake();
int SetSSHSettingsObfuscateHandshake(int bSSHSettingsObfuscateHandshake); Unicode (Windows) BOOL GetSSHSettingsObfuscateHandshake();
INT SetSSHSettingsObfuscateHandshake(BOOL bSSHSettingsObfuscateHandshake);
int secureblackbox_sftpclient_getsshsettingsobfuscatehandshake(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsobfuscatehandshake(void* lpObj, int bSSHSettingsObfuscateHandshake);
bool GetSSHSettingsObfuscateHandshake();
int SetSSHSettingsObfuscateHandshake(bool bSSHSettingsObfuscateHandshake);
Default Value
FALSE
Remarks
Enables or disables handshake obfuscation.
Data Type
Boolean
SSHSettingsObfuscationPassword Property (SFTPClient Class)
Specifies the password used to encrypt the handshake when ObfuscateHandshake is set.
Syntax
ANSI (Cross Platform) char* GetSSHSettingsObfuscationPassword();
int SetSSHSettingsObfuscationPassword(const char* lpszSSHSettingsObfuscationPassword); Unicode (Windows) LPWSTR GetSSHSettingsObfuscationPassword();
INT SetSSHSettingsObfuscationPassword(LPCWSTR lpszSSHSettingsObfuscationPassword);
char* secureblackbox_sftpclient_getsshsettingsobfuscationpassword(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsobfuscationpassword(void* lpObj, const char* lpszSSHSettingsObfuscationPassword);
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
ANSI (Cross Platform) char* GetSSHSettingsPublicKeyAlgorithms();
int SetSSHSettingsPublicKeyAlgorithms(const char* lpszSSHSettingsPublicKeyAlgorithms); Unicode (Windows) LPWSTR GetSSHSettingsPublicKeyAlgorithms();
INT SetSSHSettingsPublicKeyAlgorithms(LPCWSTR lpszSSHSettingsPublicKeyAlgorithms);
char* secureblackbox_sftpclient_getsshsettingspublickeyalgorithms(void* lpObj);
int secureblackbox_sftpclient_setsshsettingspublickeyalgorithms(void* lpObj, const char* lpszSSHSettingsPublicKeyAlgorithms);
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
- rsa-sha2-256
- rsa-sha2-512
Data Type
String
SSHSettingsRequestPasswordChange Property (SFTPClient Class)
Whether to request a password change when connecting.
Syntax
ANSI (Cross Platform) int GetSSHSettingsRequestPasswordChange();
int SetSSHSettingsRequestPasswordChange(int bSSHSettingsRequestPasswordChange); Unicode (Windows) BOOL GetSSHSettingsRequestPasswordChange();
INT SetSSHSettingsRequestPasswordChange(BOOL bSSHSettingsRequestPasswordChange);
int secureblackbox_sftpclient_getsshsettingsrequestpasswordchange(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsrequestpasswordchange(void* lpObj, int bSSHSettingsRequestPasswordChange);
bool GetSSHSettingsRequestPasswordChange();
int SetSSHSettingsRequestPasswordChange(bool bSSHSettingsRequestPasswordChange);
Default Value
FALSE
Remarks
Whether to request a password change when connecting.
Data Type
Boolean
SSHSettingsSoftwareName Property (SFTPClient Class)
The name to be used by the class to identify itself.
Syntax
ANSI (Cross Platform) char* GetSSHSettingsSoftwareName();
int SetSSHSettingsSoftwareName(const char* lpszSSHSettingsSoftwareName); Unicode (Windows) LPWSTR GetSSHSettingsSoftwareName();
INT SetSSHSettingsSoftwareName(LPCWSTR lpszSSHSettingsSoftwareName);
char* secureblackbox_sftpclient_getsshsettingssoftwarename(void* lpObj);
int secureblackbox_sftpclient_setsshsettingssoftwarename(void* lpObj, const char* lpszSSHSettingsSoftwareName);
QString GetSSHSettingsSoftwareName();
int SetSSHSettingsSoftwareName(QString qsSSHSettingsSoftwareName);
Default Value
"SecureBlackbox"
Remarks
The name to be used by the component to identify itself.
Data Type
String
SSHSettingsTrustAllKeys Property (SFTPClient Class)
Enables or disables explicit trust to all server keys.
Syntax
ANSI (Cross Platform) int GetSSHSettingsTrustAllKeys();
int SetSSHSettingsTrustAllKeys(int bSSHSettingsTrustAllKeys); Unicode (Windows) BOOL GetSSHSettingsTrustAllKeys();
INT SetSSHSettingsTrustAllKeys(BOOL bSSHSettingsTrustAllKeys);
int secureblackbox_sftpclient_getsshsettingstrustallkeys(void* lpObj);
int secureblackbox_sftpclient_setsshsettingstrustallkeys(void* lpObj, int bSSHSettingsTrustAllKeys);
bool GetSSHSettingsTrustAllKeys();
int SetSSHSettingsTrustAllKeys(bool bSSHSettingsTrustAllKeys);
Default Value
FALSE
Remarks
Enables or disables explicit trust to all server keys. Use with care.
Data Type
Boolean
SSHSettingsUseAuthAgent Property (SFTPClient Class)
Enables or disables the use of external key agent, such as Putty key agent.
Syntax
ANSI (Cross Platform) int GetSSHSettingsUseAuthAgent();
int SetSSHSettingsUseAuthAgent(int bSSHSettingsUseAuthAgent); Unicode (Windows) BOOL GetSSHSettingsUseAuthAgent();
INT SetSSHSettingsUseAuthAgent(BOOL bSSHSettingsUseAuthAgent);
int secureblackbox_sftpclient_getsshsettingsuseauthagent(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsuseauthagent(void* lpObj, int bSSHSettingsUseAuthAgent);
bool GetSSHSettingsUseAuthAgent();
int SetSSHSettingsUseAuthAgent(bool bSSHSettingsUseAuthAgent);
Default Value
FALSE
Remarks
Enables or disables the use of external key agent, such as Putty key agent.
Data Type
Boolean
SSHSettingsVersions Property (SFTPClient Class)
Specifies enabled SSH protocol versions (1 or 2).
Syntax
ANSI (Cross Platform) int GetSSHSettingsVersions();
int SetSSHSettingsVersions(int iSSHSettingsVersions); Unicode (Windows) INT GetSSHSettingsVersions();
INT SetSSHSettingsVersions(INT iSSHSettingsVersions);
int secureblackbox_sftpclient_getsshsettingsversions(void* lpObj);
int secureblackbox_sftpclient_setsshsettingsversions(void* lpObj, int iSSHSettingsVersions);
int GetSSHSettingsVersions();
int SetSSHSettingsVersions(int iSSHSettingsVersions);
Default Value
1
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
ANSI (Cross Platform) char* GetTrustedKeysFile();
int SetTrustedKeysFile(const char* lpszTrustedKeysFile); Unicode (Windows) LPWSTR GetTrustedKeysFile();
INT SetTrustedKeysFile(LPCWSTR lpszTrustedKeysFile);
char* secureblackbox_sftpclient_gettrustedkeysfile(void* lpObj);
int secureblackbox_sftpclient_settrustedkeysfile(void* lpObj, const char* lpszTrustedKeysFile);
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
ANSI (Cross Platform) int GetUploadBlockSize();
int SetUploadBlockSize(int iUploadBlockSize); Unicode (Windows) INT GetUploadBlockSize();
INT SetUploadBlockSize(INT iUploadBlockSize);
int secureblackbox_sftpclient_getuploadblocksize(void* lpObj);
int secureblackbox_sftpclient_setuploadblocksize(void* lpObj, int iUploadBlockSize);
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
ANSI (Cross Platform) char* GetUsername();
int SetUsername(const char* lpszUsername); Unicode (Windows) LPWSTR GetUsername();
INT SetUsername(LPCWSTR lpszUsername);
char* secureblackbox_sftpclient_getusername(void* lpObj);
int secureblackbox_sftpclient_setusername(void* lpObj, const char* lpszUsername);
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
ANSI (Cross Platform) int GetUseUTF8();
int SetUseUTF8(int bUseUTF8); Unicode (Windows) BOOL GetUseUTF8();
INT SetUseUTF8(BOOL bUseUTF8);
int secureblackbox_sftpclient_getuseutf8(void* lpObj);
int secureblackbox_sftpclient_setuseutf8(void* lpObj, int bUseUTF8);
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
ANSI (Cross Platform) int GetVersion(); Unicode (Windows) INT GetVersion();
int secureblackbox_sftpclient_getversion(void* lpObj);
int GetVersion();
Default Value
0
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
ANSI (Cross Platform) char* AbsolutePath(const char* lpszRemotePath); Unicode (Windows) LPWSTR AbsolutePath(LPCWSTR lpszRemotePath);
char* secureblackbox_sftpclient_absolutepath(void* lpObj, const char* lpszRemotePath);
QString AbsolutePath(const QString& qsRemotePath);
Remarks
Use this method to ask the SFTP server to convert a relative path to an absolute.
Error Handling (C++)
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
ANSI (Cross Platform) int ChangeDir(const char* lpszRemoteDir); Unicode (Windows) INT ChangeDir(LPCWSTR lpszRemoteDir);
int secureblackbox_sftpclient_changedir(void* lpObj, const char* lpszRemoteDir);
int ChangeDir(const QString& qsRemoteDir);
Remarks
Changes current working directory on the server to RemoteDir.
Error Handling (C++)
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
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* secureblackbox_sftpclient_config(void* lpObj, const char* lpszConfigurationString);
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 (C++)
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.
Connect Method (SFTPClient Class)
Connects to an SFTP server.
Syntax
ANSI (Cross Platform) int Connect(const char* lpszAddress, int iPort); Unicode (Windows) INT Connect(LPCWSTR lpszAddress, INT iPort);
int secureblackbox_sftpclient_connect(void* lpObj, const char* lpszAddress, int iPort);
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 (C++)
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.)
CreateLink Method (SFTPClient Class)
Creates a symbolic or hard link to a remote file.
Syntax
ANSI (Cross Platform) int CreateLink(const char* lpszLinkPath, const char* lpszTargetPath, int bHardLink); Unicode (Windows) INT CreateLink(LPCWSTR lpszLinkPath, LPCWSTR lpszTargetPath, BOOL bHardLink);
int secureblackbox_sftpclient_createlink(void* lpObj, const char* lpszLinkPath, const char* lpszTargetPath, int bHardLink);
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 (C++)
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.)
DeleteDir Method (SFTPClient Class)
Removes directory from the SFTP server.
Syntax
ANSI (Cross Platform) int DeleteDir(const char* lpszRemoteDir); Unicode (Windows) INT DeleteDir(LPCWSTR lpszRemoteDir);
int secureblackbox_sftpclient_deletedir(void* lpObj, const char* lpszRemoteDir);
int DeleteDir(const QString& qsRemoteDir);
Remarks
Use RemoteDir to provide a path to the directory to be deleted.
Error Handling (C++)
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.)
DeleteFile Method (SFTPClient Class)
Deletes a file from the SFTP server.
Syntax
ANSI (Cross Platform) int DeleteFile(const char* lpszRemoteFile); Unicode (Windows) INT DeleteFile(LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_deletefile(void* lpObj, const char* lpszRemoteFile);
int DeleteFile(const QString& qsRemoteFile);
Remarks
Use the RemoteFile parameter to specify the name of the file to delete.
Error Handling (C++)
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.)
DeleteFiles Method (SFTPClient Class)
Deletes a group of files from the SFTP server.
Syntax
ANSI (Cross Platform) int DeleteFiles(const char* lpszRemotePath, const char* lpszMask, int bCaseSensitive, int bRecursive); Unicode (Windows) INT DeleteFiles(LPCWSTR lpszRemotePath, LPCWSTR lpszMask, BOOL bCaseSensitive, BOOL bRecursive);
int secureblackbox_sftpclient_deletefiles(void* lpObj, const char* lpszRemotePath, const char* lpszMask, int bCaseSensitive, int bRecursive);
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 (C++)
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.)
DirExists Method (SFTPClient Class)
Checks if a directory exists on the SFTP server.
Syntax
ANSI (Cross Platform) int DirExists(const char* lpszRemoteDir); Unicode (Windows) INT DirExists(LPCWSTR lpszRemoteDir);
int secureblackbox_sftpclient_direxists(void* lpObj, const char* lpszRemoteDir);
bool DirExists(const QString& qsRemoteDir);
Remarks
RemoteDir specifies the name of the remote directory to check for existence.
Error Handling (C++)
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
ANSI (Cross Platform) int Disconnect(); Unicode (Windows) INT Disconnect();
int secureblackbox_sftpclient_disconnect(void* lpObj);
int Disconnect();
Remarks
Call this method to disconnect from the SFTP server.
Error Handling (C++)
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.)
DoAction Method (SFTPClient Class)
Performs an additional action.
Syntax
ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams);
char* secureblackbox_sftpclient_doaction(void* lpObj, const char* lpszActionID, const char* lpszActionParams);
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 (case insencitive) of the action is provided in the ActionID parameter.
ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....
Error Handling (C++)
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.
DownloadBytes Method (SFTPClient Class)
Downloads a file from the server into an array of bytes.
Syntax
ANSI (Cross Platform) char* DownloadBytes(const char* lpszRemoteFile, int *lpSize = NULL); Unicode (Windows) LPSTR DownloadBytes(LPCWSTR lpszRemoteFile, LPINT lpSize = NULL);
char* secureblackbox_sftpclient_downloadbytes(void* lpObj, const char* lpszRemoteFile, int *lpSize);
QByteArray DownloadBytes(const QString& qsRemoteFile);
Remarks
Use this method to download RemoteFile into a byte array.
Error Handling (C++)
This method returns a Binary String value (with length lpSize); 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
ANSI (Cross Platform) int DownloadFile(const char* lpszRemoteFile, const char* lpszLocalFile); Unicode (Windows) INT DownloadFile(LPCWSTR lpszRemoteFile, LPCWSTR lpszLocalFile);
int secureblackbox_sftpclient_downloadfile(void* lpObj, const char* lpszRemoteFile, const char* lpszLocalFile);
int DownloadFile(const QString& qsRemoteFile, const QString& qsLocalFile);
Remarks
Use this method to download RemoteFile into the location specified by LocalFile.
Error Handling (C++)
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.)
DownloadFiles Method (SFTPClient Class)
Downloads multiple files from the SFTP server.
Syntax
ANSI (Cross Platform) int DownloadFiles(const char* lpszRemotePath, const char* lpszLocalDir); Unicode (Windows) INT DownloadFiles(LPCWSTR lpszRemotePath, LPCWSTR lpszLocalDir);
int secureblackbox_sftpclient_downloadfiles(void* lpObj, const char* lpszRemotePath, const char* lpszLocalDir);
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 (C++)
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.)
DownloadStream Method (SFTPClient Class)
Downloads a file from the SFTP server.
Syntax
ANSI (Cross Platform) int DownloadStream(const char* lpszRemoteFile, SecureBlackboxStream* sLocalStream); Unicode (Windows) INT DownloadStream(LPCWSTR lpszRemoteFile, SecureBlackboxStream* sLocalStream);
int secureblackbox_sftpclient_downloadstream(void* lpObj, const char* lpszRemoteFile, SecureBlackboxStream* sLocalStream);
int DownloadStream(const QString& qsRemoteFile, SecureBlackboxStream* sLocalStream);
Remarks
Use this method to download RemoteFile into a LocalStream object.
Error Handling (C++)
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.)
ExecuteSSHCommand Method (SFTPClient Class)
Sends an SSH command to the server in the middle of SFTP session.
Syntax
ANSI (Cross Platform) char* ExecuteSSHCommand(const char* lpszCommand, int *lpSize = NULL); Unicode (Windows) LPSTR ExecuteSSHCommand(LPCWSTR lpszCommand, LPINT lpSize = NULL);
char* secureblackbox_sftpclient_executesshcommand(void* lpObj, const char* lpszCommand, int *lpSize);
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 (C++)
This method returns a Byte Array value (with length lpSize); 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
ANSI (Cross Platform) char* ExtensionCmd(const char* lpszExtn, const char* lpDataBuffer, int lenDataBuffer, int *lpSize = NULL); Unicode (Windows) LPSTR ExtensionCmd(LPCWSTR lpszExtn, LPCSTR lpDataBuffer, INT lenDataBuffer, LPINT lpSize = NULL);
char* secureblackbox_sftpclient_extensioncmd(void* lpObj, const char* lpszExtn, const char* lpDataBuffer, int lenDataBuffer, int *lpSize);
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 (C++)
This method returns a Byte Array value (with length lpSize); 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.
FileExists Method (SFTPClient Class)
Checks whether a file exists on the server.
Syntax
ANSI (Cross Platform) int FileExists(const char* lpszRemoteFile); Unicode (Windows) INT FileExists(LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_fileexists(void* lpObj, const char* lpszRemoteFile);
bool FileExists(const QString& qsRemoteFile);
Remarks
Use this method to check if a RemoteFile exists on the server.
Error Handling (C++)
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.
GetCurrentDir Method (SFTPClient Class)
Returns the current directory on the SFTP server.
Syntax
ANSI (Cross Platform) char* GetCurrentDir(); Unicode (Windows) LPWSTR GetCurrentDir();
char* secureblackbox_sftpclient_getcurrentdir(void* lpObj);
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 (C++)
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.
GetFileSize Method (SFTPClient Class)
Checks the size of a remote file.
Syntax
ANSI (Cross Platform) int64 GetFileSize(const char* lpszRemoteFile); Unicode (Windows) LONG64 GetFileSize(LPCWSTR lpszRemoteFile);
int64 secureblackbox_sftpclient_getfilesize(void* lpObj, const char* lpszRemoteFile);
qint64 GetFileSize(const QString& qsRemoteFile);
Remarks
Returns the size of the RemoteFile.
Error Handling (C++)
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
ANSI (Cross Platform) char* ListDir(int bIncludeFiles, int bIncludeDirectories); Unicode (Windows) LPWSTR ListDir(BOOL bIncludeFiles, BOOL bIncludeDirectories);
char* secureblackbox_sftpclient_listdir(void* lpObj, int bIncludeFiles, int bIncludeDirectories);
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 (C++)
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.
MakeDir Method (SFTPClient Class)
Creates a new directory on the server.
Syntax
ANSI (Cross Platform) int MakeDir(const char* lpszRemoteDir); Unicode (Windows) INT MakeDir(LPCWSTR lpszRemoteDir);
int secureblackbox_sftpclient_makedir(void* lpObj, const char* lpszRemoteDir);
int MakeDir(const QString& qsRemoteDir);
Remarks
RemoteDir specifies the name of the new directory.
Error Handling (C++)
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.)
RenameFile Method (SFTPClient Class)
Renames a file.
Syntax
ANSI (Cross Platform) int RenameFile(const char* lpszSourceFile, const char* lpszDestFile); Unicode (Windows) INT RenameFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile);
int secureblackbox_sftpclient_renamefile(void* lpObj, const char* lpszSourceFile, const char* lpszDestFile);
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 (C++)
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.)
RequestAttributes Method (SFTPClient Class)
Requests attributes of the remote file.
Syntax
ANSI (Cross Platform) char* RequestAttributes(const char* lpszRemotePath, int bFollowSymLinks); Unicode (Windows) LPWSTR RequestAttributes(LPCWSTR lpszRemotePath, BOOL bFollowSymLinks);
char* secureblackbox_sftpclient_requestattributes(void* lpObj, const char* lpszRemotePath, int bFollowSymLinks);
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.
The method returns the list of attributes as a line of semicolon-separated entries: Size=78220;Owner=user@system;Group=none@system;Permissions=432;ATime=2020-04-28 08:21:00.295;MTime=2020-04-28 08:21:00.302;CTime=2020-04-28 08:21:00.295;AttribBits=24;LinkCount=1.
Error Handling (C++)
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.
SetAttributes Method (SFTPClient Class)
Sets the attributes upon a remote file.
Syntax
ANSI (Cross Platform) int SetAttributes(const char* lpszRemotePath, const char* lpszAttributes); Unicode (Windows) INT SetAttributes(LPCWSTR lpszRemotePath, LPCWSTR lpszAttributes);
int secureblackbox_sftpclient_setattributes(void* lpObj, const char* lpszRemotePath, const char* lpszAttributes);
int SetAttributes(const QString& qsRemotePath, const QString& qsAttributes);
Remarks
Use this method to set the attributes of a remote file.
Error Handling (C++)
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.)
UploadBytes Method (SFTPClient Class)
Uploads a byte array to the server.
Syntax
ANSI (Cross Platform) int UploadBytes(const char* lpBytes, int lenBytes, const char* lpszRemoteFile); Unicode (Windows) INT UploadBytes(LPCSTR lpBytes, INT lenBytes, LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_uploadbytes(void* lpObj, const char* lpBytes, int lenBytes, const char* lpszRemoteFile);
int UploadBytes(QByteArray qbaBytes, const QString& qsRemoteFile);
Remarks
Use this method to upload Bytes or its part to RemoteFile on the server.
Error Handling (C++)
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.)
UploadFile Method (SFTPClient Class)
Uploads a file to the server.
Syntax
ANSI (Cross Platform) int UploadFile(const char* lpszLocalFile, const char* lpszRemoteFile); Unicode (Windows) INT UploadFile(LPCWSTR lpszLocalFile, LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_uploadfile(void* lpObj, const char* lpszLocalFile, const char* lpszRemoteFile);
int UploadFile(const QString& qsLocalFile, const QString& qsRemoteFile);
Remarks
Use this method to upload LocalFile to the RemoteFile location on the server.
Error Handling (C++)
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.)
UploadFiles Method (SFTPClient Class)
Uploads multiple files to the server.
Syntax
ANSI (Cross Platform) int UploadFiles(const char* lpszLocalPath, const char* lpszRemoteDir); Unicode (Windows) INT UploadFiles(LPCWSTR lpszLocalPath, LPCWSTR lpszRemoteDir);
int secureblackbox_sftpclient_uploadfiles(void* lpObj, const char* lpszLocalPath, const char* lpszRemoteDir);
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 (C++)
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.)
UploadStream Method (SFTPClient Class)
Uploads a file to the server.
Syntax
ANSI (Cross Platform) int UploadStream(SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile); Unicode (Windows) INT UploadStream(SecureBlackboxStream* sLocalStream, LPCWSTR lpszRemoteFile);
int secureblackbox_sftpclient_uploadstream(void* lpObj, SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile);
int UploadStream(SecureBlackboxStream* sLocalStream, const QString& qsRemoteFile);
Remarks
Use this method to upload the contents of LocalStream to the RemoteFile location on the server.
Error Handling (C++)
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.)
AuthAttempt Event (SFTPClient Class)
Fires when an authentication attempt is performed.
Syntax
ANSI (Cross Platform) virtual int FireAuthAttempt(SFTPClientAuthAttemptEventParams *e);
typedef struct {
int AuthType; int reserved; } SFTPClientAuthAttemptEventParams;
Unicode (Windows) virtual INT FireAuthAttempt(SFTPClientAuthAttemptEventParams *e);
typedef struct {
INT AuthType; INT reserved; } SFTPClientAuthAttemptEventParams;
#define EID_SFTPCLIENT_AUTHATTEMPT 1 virtual INT SECUREBLACKBOX_CALL FireAuthAttempt(INT &iAuthType);
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
ANSI (Cross Platform) virtual int FireAuthFailed(SFTPClientAuthFailedEventParams *e);
typedef struct {
int AuthType; int reserved; } SFTPClientAuthFailedEventParams;
Unicode (Windows) virtual INT FireAuthFailed(SFTPClientAuthFailedEventParams *e);
typedef struct {
INT AuthType; INT reserved; } SFTPClientAuthFailedEventParams;
#define EID_SFTPCLIENT_AUTHFAILED 2 virtual INT SECUREBLACKBOX_CALL FireAuthFailed(INT &iAuthType);
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
ANSI (Cross Platform) virtual int FireAuthSucceeded(SFTPClientAuthSucceededEventParams *e);
typedef struct { int reserved; } SFTPClientAuthSucceededEventParams;
Unicode (Windows) virtual INT FireAuthSucceeded(SFTPClientAuthSucceededEventParams *e);
typedef struct { INT reserved; } SFTPClientAuthSucceededEventParams;
#define EID_SFTPCLIENT_AUTHSUCCEEDED 3 virtual INT SECUREBLACKBOX_CALL FireAuthSucceeded();
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
ANSI (Cross Platform) virtual int FireBanner(SFTPClientBannerEventParams *e);
typedef struct {
const char *Text; int lenText;
const char *Language; int lenLanguage; int reserved; } SFTPClientBannerEventParams;
Unicode (Windows) virtual INT FireBanner(SFTPClientBannerEventParams *e);
typedef struct {
LPCSTR Text; INT lenText;
LPCSTR Language; INT lenLanguage; INT reserved; } SFTPClientBannerEventParams;
#define EID_SFTPCLIENT_BANNER 4 virtual INT SECUREBLACKBOX_CALL FireBanner(LPSTR &lpText, INT &lenText, LPSTR &lpLanguage, INT &lenLanguage);
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
ANSI (Cross Platform) virtual int FireDisconnect(SFTPClientDisconnectEventParams *e);
typedef struct {
int CloseReason; int reserved; } SFTPClientDisconnectEventParams;
Unicode (Windows) virtual INT FireDisconnect(SFTPClientDisconnectEventParams *e);
typedef struct {
INT CloseReason; INT reserved; } SFTPClientDisconnectEventParams;
#define EID_SFTPCLIENT_DISCONNECT 5 virtual INT SECUREBLACKBOX_CALL FireDisconnect(INT &iCloseReason);
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
ANSI (Cross Platform) virtual int FireError(SFTPClientErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } SFTPClientErrorEventParams;
Unicode (Windows) virtual INT FireError(SFTPClientErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } SFTPClientErrorEventParams;
#define EID_SFTPCLIENT_ERROR 6 virtual INT SECUREBLACKBOX_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
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
ANSI (Cross Platform) virtual int FireExternalSign(SFTPClientExternalSignEventParams *e);
typedef struct {
const char *OperationId;
const char *HashAlgorithm;
const char *Pars;
const char *Data;
char *SignedData; int reserved; } SFTPClientExternalSignEventParams;
Unicode (Windows) virtual INT FireExternalSign(SFTPClientExternalSignEventParams *e);
typedef struct {
LPCWSTR OperationId;
LPCWSTR HashAlgorithm;
LPCWSTR Pars;
LPCWSTR Data;
LPWSTR SignedData; INT reserved; } SFTPClientExternalSignEventParams;
#define EID_SFTPCLIENT_EXTERNALSIGN 7 virtual INT SECUREBLACKBOX_CALL FireExternalSign(LPSTR &lpszOperationId, LPSTR &lpszHashAlgorithm, LPSTR &lpszPars, LPSTR &lpszData, LPSTR &lpszSignedData);
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
ANSI (Cross Platform) virtual int FireFileOperation(SFTPClientFileOperationEventParams *e);
typedef struct {
int Operation;
const char *RemotePath;
const char *LocalPath;
int Skip;
int Cancel; int reserved; } SFTPClientFileOperationEventParams;
Unicode (Windows) virtual INT FireFileOperation(SFTPClientFileOperationEventParams *e);
typedef struct {
INT Operation;
LPCWSTR RemotePath;
LPCWSTR LocalPath;
BOOL Skip;
BOOL Cancel; INT reserved; } SFTPClientFileOperationEventParams;
#define EID_SFTPCLIENT_FILEOPERATION 8 virtual INT SECUREBLACKBOX_CALL FireFileOperation(INT &iOperation, LPSTR &lpszRemotePath, LPSTR &lpszLocalPath, BOOL &bSkip, BOOL &bCancel);
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
ANSI (Cross Platform) virtual int FireFileOperationResult(SFTPClientFileOperationResultEventParams *e);
typedef struct {
int Operation;
const char *RemotePath;
const char *LocalPath;
int ErrorCode;
const char *Comment;
int Cancel; int reserved; } SFTPClientFileOperationResultEventParams;
Unicode (Windows) virtual INT FireFileOperationResult(SFTPClientFileOperationResultEventParams *e);
typedef struct {
INT Operation;
LPCWSTR RemotePath;
LPCWSTR LocalPath;
INT ErrorCode;
LPCWSTR Comment;
BOOL Cancel; INT reserved; } SFTPClientFileOperationResultEventParams;
#define EID_SFTPCLIENT_FILEOPERATIONRESULT 9 virtual INT SECUREBLACKBOX_CALL FireFileOperationResult(INT &iOperation, LPSTR &lpszRemotePath, LPSTR &lpszLocalPath, INT &iErrorCode, LPSTR &lpszComment, BOOL &bCancel);
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
ANSI (Cross Platform) virtual int FireKnownKeyReceived(SFTPClientKnownKeyReceivedEventParams *e);
typedef struct {
const char *Algorithm;
int Bits;
const char *FingerprintSHA256; int reserved; } SFTPClientKnownKeyReceivedEventParams;
Unicode (Windows) virtual INT FireKnownKeyReceived(SFTPClientKnownKeyReceivedEventParams *e);
typedef struct {
LPCWSTR Algorithm;
INT Bits;
LPCWSTR FingerprintSHA256; INT reserved; } SFTPClientKnownKeyReceivedEventParams;
#define EID_SFTPCLIENT_KNOWNKEYRECEIVED 10 virtual INT SECUREBLACKBOX_CALL FireKnownKeyReceived(LPSTR &lpszAlgorithm, INT &iBits, LPSTR &lpszFingerprintSHA256);
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
ANSI (Cross Platform) virtual int FireListEntry(SFTPClientListEntryEventParams *e);
typedef struct {
const char *Filename; int reserved; } SFTPClientListEntryEventParams;
Unicode (Windows) virtual INT FireListEntry(SFTPClientListEntryEventParams *e);
typedef struct {
LPCWSTR Filename; INT reserved; } SFTPClientListEntryEventParams;
#define EID_SFTPCLIENT_LISTENTRY 11 virtual INT SECUREBLACKBOX_CALL FireListEntry(LPSTR &lpszFilename);
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
ANSI (Cross Platform) virtual int FireNotification(SFTPClientNotificationEventParams *e);
typedef struct {
const char *EventID;
const char *EventParam; int reserved; } SFTPClientNotificationEventParams;
Unicode (Windows) virtual INT FireNotification(SFTPClientNotificationEventParams *e);
typedef struct {
LPCWSTR EventID;
LPCWSTR EventParam; INT reserved; } SFTPClientNotificationEventParams;
#define EID_SFTPCLIENT_NOTIFICATION 12 virtual INT SECUREBLACKBOX_CALL FireNotification(LPSTR &lpszEventID, LPSTR &lpszEventParam);
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
ANSI (Cross Platform) virtual int FirePasswordChangeRequest(SFTPClientPasswordChangeRequestEventParams *e);
typedef struct {
const char *Prompt;
char *NewPassword;
int Cancel; int reserved; } SFTPClientPasswordChangeRequestEventParams;
Unicode (Windows) virtual INT FirePasswordChangeRequest(SFTPClientPasswordChangeRequestEventParams *e);
typedef struct {
LPCWSTR Prompt;
LPWSTR NewPassword;
BOOL Cancel; INT reserved; } SFTPClientPasswordChangeRequestEventParams;
#define EID_SFTPCLIENT_PASSWORDCHANGEREQUEST 13 virtual INT SECUREBLACKBOX_CALL FirePasswordChangeRequest(LPSTR &lpszPrompt, LPSTR &lpszNewPassword, BOOL &bCancel);
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
ANSI (Cross Platform) virtual int FirePrivateKeyNeeded(SFTPClientPrivateKeyNeededEventParams *e);
typedef struct {
int Skip; int reserved; } SFTPClientPrivateKeyNeededEventParams;
Unicode (Windows) virtual INT FirePrivateKeyNeeded(SFTPClientPrivateKeyNeededEventParams *e);
typedef struct {
BOOL Skip; INT reserved; } SFTPClientPrivateKeyNeededEventParams;
#define EID_SFTPCLIENT_PRIVATEKEYNEEDED 14 virtual INT SECUREBLACKBOX_CALL FirePrivateKeyNeeded(BOOL &bSkip);
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
ANSI (Cross Platform) virtual int FireProgress(SFTPClientProgressEventParams *e);
typedef struct {
int64 Total;
int64 Current;
int Cancel; int reserved; } SFTPClientProgressEventParams;
Unicode (Windows) virtual INT FireProgress(SFTPClientProgressEventParams *e);
typedef struct {
LONG64 Total;
LONG64 Current;
BOOL Cancel; INT reserved; } SFTPClientProgressEventParams;
#define EID_SFTPCLIENT_PROGRESS 15 virtual INT SECUREBLACKBOX_CALL FireProgress(LONG64 &lTotal, LONG64 &lCurrent, BOOL &bCancel);
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
ANSI (Cross Platform) virtual int FireUnknownKeyReceived(SFTPClientUnknownKeyReceivedEventParams *e);
typedef struct {
const char *Algorithm;
int Bits;
const char *FingerprintSHA256;
int Action; int reserved; } SFTPClientUnknownKeyReceivedEventParams;
Unicode (Windows) virtual INT FireUnknownKeyReceived(SFTPClientUnknownKeyReceivedEventParams *e);
typedef struct {
LPCWSTR Algorithm;
INT Bits;
LPCWSTR FingerprintSHA256;
INT Action; INT reserved; } SFTPClientUnknownKeyReceivedEventParams;
#define EID_SFTPCLIENT_UNKNOWNKEYRECEIVED 16 virtual INT SECUREBLACKBOX_CALL FireUnknownKeyReceived(LPSTR &lpszAlgorithm, INT &iBits, LPSTR &lpszFingerprintSHA256, INT &iAction);
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. |
SecureBlackboxStream Type
Syntax
SecureBlackboxStream (declared in secureblackbox.h)
Remarks
The SFTPClient class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecureBlackboxStream interface and pass the SFTPClient class an instance of that concrete class.
When implementing the SecureBlackboxStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Properties | |
| CanRead |
Whether the stream supports reading.
bool CanRead() { return true; }
|
| CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; }
|
| CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; }
|
| Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
| Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {}
This method is called automatically when a SecureBlackboxStream object is deleted. |
| Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; }
Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
| Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
| Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
| Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Config 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 Config Settings
Since both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are:
| 0 | Disabled. Strict key exchange is not supported in the class. |
| 1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. |
| 2 | Enabled, but reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange all algorithms may be used. If the remote host does not support strict key exchange the connection will only continue if the selected encryption and MAC algorithms are not affected by the Terrapin attack. |
| 3 | Required. If the remote host does not support strict key exchange the connection will fail. |
Base Config Settings
You can switch this property off to improve performance if your project only uses known, good private keys.
Supported values are:
| off | No caching (default) | |
| local | Local caching | |
| global | Global caching |
This setting only applies to sessions negotiated with TLS version 1.3.
Supported values are:
| file | File | |
| console | Console | |
| systemlog | System Log (supported for Android only) | |
| debugger | Debugger (supported for VCL for Windows and .Net) |
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 |
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 |
| none | No flush (caching only) | |
| immediate | Immediate flush (real-time logging) | |
| maxcount | Flush cached entries upon reaching LogMaxEventCount entries in the cache. |
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. |
The default value of this setting is 100.
| 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) |
Supported values are:
| none | No static DNS rules (default) | |
| local | Local static DNS rules | |
| global | Global static DNS rules |
This setting only applies to certificates originating from a Windows system store.
Trappable Errors (SFTPClient Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
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) |