# SFTPClient Class The SFTPClient class provides client-side functionality for SFTP (Secure File Transfer Protocol). ## Syntax ```text 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](#username-property-sftpclient-class) and [Password](#password-property-sftpclient-class). 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](#key-property-sftpclient-class) 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](#trustedkeysfile-property-sftpclient-class) property. When a client receives a server key, it reports it to your code via its [KnownKeyReceived](#knownkeyreceived-event-sftpclient-class) or [UnknownKeyReceived](#unknownkeyreceived-event-sftpclient-class) event, depending on whether the key was found in the trusted list. If you leave [TrustedKeysFile](#trustedkeysfile-property-sftpclient-class) empty, SFTPClient will only be able to fire the [UnknownKeyReceived](#unknownkeyreceived-event-sftpclient-class) event, since there will be no known keys to report. - If needed, customize [Proxy](#proxy-property-sftpclient-class) parameters and [SSHSettings](#sshsettings-property-sftpclient-class). - Consider interacting more with SFTPClient by subscribing to [AuthAttempt](#authattempt-event-sftpclient-class), [AuthFailed](#authfailed-event-sftpclient-class), and [AuthSucceeded](#authsucceeded-event-sftpclient-class) events to be notified about the client authentication progress. - When you are ready to connect, call [Connect](#connect-method-sftpclient-class), passing the details of the server as parameters. During the initial handshake, the following events will fire: [UnknownKeyReceived](#unknownkeyreceived-event-sftpclient-class) (or [KnownKeyReceived](#knownkeyreceived-event-sftpclient-class)), and then one or more [AuthAttempt](#authattempt-event-sftpclient-class), [AuthFailed](#authfailed-event-sftpclient-class) and [AuthSucceeded](#authsucceeded-event-sftpclient-class). - Upon completion of the [Connect](#connect-method-sftpclient-class) method, the component is ready for file operations. Use [DownloadFile](#downloadfile-method-sftpclient-class), [UploadFile](#uploadfile-method-sftpclient-class), [ListDir](#listdir-method-sftpclient-class), [DeleteFile](#deletefile-method-sftpclient-class) and other file transfer methods to work with the server file system. - When you are done with your work, call [Disconnect](#disconnect-method-sftpclient-class) 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](#autoadjusttransferblock-property-sftpclient-class) to false, - [PipelineLength](#pipelinelength-property-sftpclient-class) to 1, - [UploadBlockSize](#uploadblocksize-property-sftpclient-class) to 16384, - [DownloadBlockSize](#downloadblocksize-property-sftpclient-class) to 16384. These adjustments will put SFTPClient in very conservative transfer setup. While this setup may be quite sluggish with modern servers, it should make SFTPClient interoperable with most older servers. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AuthAttempts](#authattempts-property-sftpclient-class) | Specifies the number of SSH authentication attempts. | | [AutoAdjustTransferBlock](#autoadjusttransferblock-property-sftpclient-class) | Specifies whether to adjust the send and receive buffer sizes automatically. | | [ConflictResolutionMode](#conflictresolutionmode-property-sftpclient-class) | Defines the approach that should be used to resolve various conflicts during batch processing. | | [Connected](#connected-property-sftpclient-class) | Indicates if the client is connected to the SFTP server. | | [ConnectionInfo](#connectioninfo-property-sftpclient-class) | Contains the secure connection info. | | [CurrentListEntry](#currentlistentry-property-sftpclient-class) | Contains the current entry returned by ListDir . | | [DownloadBlockSize](#downloadblocksize-property-sftpclient-class) | The download block size in bytes. | | [ExternalCrypto](#externalcrypto-property-sftpclient-class) | Provides access to external signing and DC parameters. | | [FIPSMode](#fipsmode-property-sftpclient-class) | Reserved. | | [ForceCompression](#forcecompression-property-sftpclient-class) | Enforces compression for the SSH layer. | | [Key](#key-property-sftpclient-class) | Contains the client's SSH key. | | [MaxSFTPVersion](#maxsftpversion-property-sftpclient-class) | Higher SFTP version to support. | | [MinSFTPVersion](#minsftpversion-property-sftpclient-class) | Lower SFTP version to support. | | [Password](#password-property-sftpclient-class) | Specifies user's authentication password. | | [PipelineLength](#pipelinelength-property-sftpclient-class) | The number of parallelized transfer requests. | | [Proxy](#proxy-property-sftpclient-class) | The proxy server settings. | | [ServerKey](#serverkey-property-sftpclient-class) | Returns the server's public key. | | [SocketSettings](#socketsettings-property-sftpclient-class) | Manages network connection settings. | | [SSHSettings](#sshsettings-property-sftpclient-class) | The SSH connection settings. | | [TrustedKeysFile](#trustedkeysfile-property-sftpclient-class) | A file containing the keys of authorized servers. | | [UploadBlockSize](#uploadblocksize-property-sftpclient-class) | The upload block size in bytes. | | [Username](#username-property-sftpclient-class) | The client's username to authenticate to the server. | | [UseUTF8](#useutf8-property-sftpclient-class) | Enables UTF8 for all string content. | | [Version](#version-property-sftpclient-class) | 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](#absolutepath-method-sftpclient-class) | Requests the absolute path for a relative path. | | [ChangeDir](#changedir-method-sftpclient-class) | Changes current working directory on the server. | | [Config](#config-method-sftpclient-class) | Sets or retrieves a configuration setting. | | [Connect](#connect-method-sftpclient-class) | Connects to an SFTP server. | | [CreateLink](#createlink-method-sftpclient-class) | Creates a symbolic or hard link to a remote file. | | [DeleteDir](#deletedir-method-sftpclient-class) | Removes directory from the SFTP server. | | [DeleteFile](#deletefile-method-sftpclient-class) | Deletes a file from the SFTP server. | | [DeleteFiles](#deletefiles-method-sftpclient-class) | Deletes a group of files from the SFTP server. | | [DirExists](#direxists-method-sftpclient-class) | Checks if a directory exists on the SFTP server. | | [Disconnect](#disconnect-method-sftpclient-class) | Disconnects from the SFTP server. | | [DoAction](#doaction-method-sftpclient-class) | Performs an additional action. | | [DownloadBytes](#downloadbytes-method-sftpclient-class) | Downloads a file from the server into an array of bytes. | | [DownloadFile](#downloadfile-method-sftpclient-class) | Downloads a file from the SFTP server. | | [DownloadFiles](#downloadfiles-method-sftpclient-class) | Downloads multiple files from the SFTP server. | | [DownloadStream](#downloadstream-method-sftpclient-class) | Downloads a file from the SFTP server. | | [ExecuteSSHCommand](#executesshcommand-method-sftpclient-class) | Sends an SSH command to the server in the middle of SFTP session. | | [ExtensionCmd](#extensioncmd-method-sftpclient-class) | Sends an extension command to the server. | | [FileExists](#fileexists-method-sftpclient-class) | Checks whether a file exists on the server. | | [GetCurrentDir](#getcurrentdir-method-sftpclient-class) | Returns the current directory on the SFTP server. | | [GetFileSize](#getfilesize-method-sftpclient-class) | Checks the size of a remote file. | | [ListDir](#listdir-method-sftpclient-class) | Lists the content of the current remote directory. | | [MakeDir](#makedir-method-sftpclient-class) | Creates a new directory on the server. | | [RenameFile](#renamefile-method-sftpclient-class) | Renames a file. | | [RequestAttributes](#requestattributes-method-sftpclient-class) | Requests attributes of the remote file. | | [Reset](#reset-method-sftpclient-class) | Resets the class settings. | | [SetAttributes](#setattributes-method-sftpclient-class) | Sets the attributes upon a remote file. | | [UploadBytes](#uploadbytes-method-sftpclient-class) | Uploads a byte array to the server. | | [UploadFile](#uploadfile-method-sftpclient-class) | Uploads a file to the server. | | [UploadFiles](#uploadfiles-method-sftpclient-class) | Uploads multiple files to the server. | | [UploadStream](#uploadstream-method-sftpclient-class) | 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](#authattempt-event-sftpclient-class) | Fires when an authentication attempt is performed. | | [AuthFailed](#authfailed-event-sftpclient-class) | Fires if an authentication attempt fails. | | [AuthSucceeded](#authsucceeded-event-sftpclient-class) | Reports a successful authentication. | | [Banner](#banner-event-sftpclient-class) | Reports the receipt of the Welcome message from the server. | | [Disconnect](#disconnect-event-sftpclient-class) | Reports SFTP connection closure. | | [Error](#error-event-sftpclient-class) | Information about errors during SFTP connection. | | [ExternalSign](#externalsign-event-sftpclient-class) | Handles remote or external signing initiated by the SignExternal method or other source. | | [FileNameChangeNeeded](#filenamechangeneeded-event-sftpclient-class) | Asks the application for a new file name. | | [FileOperation](#fileoperation-event-sftpclient-class) | Signifies the start of a file transfer operation. | | [FileOperationResult](#fileoperationresult-event-sftpclient-class) | Signifies the completion of a file transfer operation. | | [KnownKeyReceived](#knownkeyreceived-event-sftpclient-class) | Signals that the server has introduced itself with a known key. | | [ListEntry](#listentry-event-sftpclient-class) | Reports a directory listing entry to the application. | | [Notification](#notification-event-sftpclient-class) | This event notifies the application about an underlying control flow event. | | [PasswordChangeRequest](#passwordchangerequest-event-sftpclient-class) | Signals that the server requests a password change. | | [PrivateKeyNeeded](#privatekeyneeded-event-sftpclient-class) | Asks the application for the client's private key. | | [Progress](#progress-event-sftpclient-class) | Fires periodically during the data transfer. | | [UnknownKeyReceived](#unknownkeyreceived-event-sftpclient-class) | 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](#AdjustFileTimes) | Whether file times should be adjusted after upload/download. | | [AllAlgorithms](#AllAlgorithms) | Returns the list of algorithms enabled in the class. | | [ASCIIMode](#ASCIIMode) | Whether ASCII transfer mode is used. | | [AvailableSpace](#AvailableSpace) | Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work. | | [CaseConversion](#CaseConversion) | Whether file names and paths should be case-converted. | | [CaseSensitive](#CaseSensitive) | Specifies if file paths are case-sensitive. | | [CloseQuietly](#CloseQuietly) | Controls the client's approach to session closure. | | [CommandTimeout](#CommandTimeout) | Specifies the command timeout. | | [CompressionAlgorithms](#CompressionAlgorithms) | Returns the list of compression algorithms enabled in the class. | | [CopyMode](#CopyMode) | Tunes up the post-transfer action for batch uploads. | | [DefaultTransferBlock](#DefaultTransferBlock) | Specifies the default transfer block size. | | [DefOutboundBlockSize](#DefOutboundBlockSize) | The default outbound block size. | | [DisablePacketFragmentation](#DisablePacketFragmentation) | Enables or disables SSH packet fragmentation. | | [EarlyIdString](#EarlyIdString) | Enables the proactive approach to SSH handshake. | | [EncryptionAlgorithms](#EncryptionAlgorithms) | Returns the list of encryption algorithms enabled in the class. | | [ErrorOrigin](#ErrorOrigin) | Specifies whether the error is local or remote. | | [ErrorSeverity](#ErrorSeverity) | Specifies whether the error is fatal. | | [FileHash](#FileHash) | Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work. | | [HashAlgorithm](#HashAlgorithm) | The hash algorithm to use for the protocol operations. | | [HomeDir](#HomeDir) | Returns a user's home directory. This protocol extension must be supported by the server for this request to work. | | [IncomingSpeedLimit](#IncomingSpeedLimit) | Specifies incoming speed limit. | | [KeepAlivePeriod](#KeepAlivePeriod) | The inactivity period after which a keep-alive signal will be sent. | | [KexAlgorithms](#KexAlgorithms) | Returns the list of key exchange algorithms enabled in the class. | | [LocalCharset](#LocalCharset) | Charset used on the client machine. | | [LocalNewLineConvention](#LocalNewLineConvention) | A character string for the end of line (EOL) indication on the local machine. | | [MacAlgorithms](#MacAlgorithms) | Returns the list of MAC algorithms enabled in the class. | | [NewLineConvention](#NewLineConvention) | A character string for the end of line (EOL) indication on the server. | | [OutgoingSpeedLimit](#OutgoingSpeedLimit) | Specifies incoming speed limit. | | [PreserveExistingFileTimes](#PreserveExistingFileTimes) | Whether original file times should be restored upon transfer. | | [PublicKeyAlgorithms](#PublicKeyAlgorithms) | Returns the list of public key algorithms enabled in the class. | | [RedirectStdErr](#RedirectStdErr) | Whether to redirect output to StdErr. | | [RemoteCharset](#RemoteCharset) | Charset used on the server. | | [SFTPBufferSize](#SFTPBufferSize) | The size of internal buffer used for data transfer. | | [SFTPServerExecutableLocations](#SFTPServerExecutableLocations) | Location of the SFTP server executable. | | [SocketRecvBufferSize](#SocketRecvBufferSize) | The inbound socket buffer size. | | [SocketSendBufferSize](#SocketSendBufferSize) | The outbound socket buffer size. | | [StatVFS](#StatVFS) | Returns VFS details. This protocol extension must be supported by the server for this request to work. | | [StdErrData](#StdErrData) | The buffer for writing StdErr data. | | [SuppressAuxTransferOps](#SuppressAuxTransferOps) | TBD. | | [TempFolder](#TempFolder) | Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work. | | [TempPath](#TempPath) | Path for storing temporary files. | | [TreatZeroSizeAsUndefined](#TreatZeroSizeAsUndefined) | Whether zero size returned by STAT should be considered as undefined. | | [TryPasswordAuth](#TryPasswordAuth) | Specifies whether the class should attempt the password-based authentication if no password is set. | | [UseStrictKeyExchange](#UseStrictKeyExchange) | Specifies how strict key exchange is supported. | | [UseTruncateFlagOnUpload](#UseTruncateFlagOnUpload) | whether to use the 'truncate' flag on file upload. | | [UseUTF8OnV3](#UseUTF8OnV3) | Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower. | | [ASN1UseGlobalTagCache](#ASN1UseGlobalTagCache) | Controls whether ASN.1 module should use a global object cache. | | [AssignSystemSmartCardPins](#AssignSystemSmartCardPins) | Specifies whether CSP-level PINs should be assigned to CNG keys. | | [CheckKeyIntegrityBeforeUse](#CheckKeyIntegrityBeforeUse) | Enables or disable private key integrity check before use. | | [CookieCaching](#CookieCaching) | Specifies whether a cookie cache should be used for HTTP(S) transports. | | [Cookies](#Cookies) | Gets or sets local cookies for the class. | | [DefDeriveKeyIterations](#DefDeriveKeyIterations) | Specifies the default key derivation algorithm iteration count. | | [DNSLocalSuffix](#DNSLocalSuffix) | The suffix to assign for TLD names. | | [EnableClientSideSSLFFDHE](#EnableClientSideSSLFFDHE) | Enables or disables finite field DHE key exchange support in TLS clients. | | [EnableSSHMLKEM](#EnableSSHMLKEM) | Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server classes. | | [EnableTLSMLKEM](#EnableTLSMLKEM) | Enables support for ML-KEM and hybrid groups in TLS client and server classes. | | [GlobalCookies](#GlobalCookies) | Gets or sets global cookies for all the HTTP transports. | | [HardwareCryptoUsePolicy](#HardwareCryptoUsePolicy) | The hardware crypto usage policy. | | [HttpUserAgent](#HttpUserAgent) | Specifies the user agent name to be used by all HTTP clients. | | [HttpVersion](#HttpVersion) | The HTTP version to use in any inner HTTP client classes created. | | [IgnoreExpiredMSCTLSigningCert](#IgnoreExpiredMSCTLSigningCert) | Whether to tolerate the expired Windows Update signing certificate. | | [ListDelimiter](#ListDelimiter) | The delimiter character for multi-element lists. | | [LogDestination](#LogDestination) | Specifies the debug log destination. | | [LogDetails](#LogDetails) | Specifies the debug log details to dump. | | [LogFile](#LogFile) | Specifies the debug log filename. | | [LogFilters](#LogFilters) | Specifies the debug log filters. | | [LogFlushMode](#LogFlushMode) | Specifies the log flush mode. | | [LogLevel](#LogLevel) | Specifies the debug log level. | | [LogMaxEventCount](#LogMaxEventCount) | Specifies the maximum number of events to cache before further action is taken. | | [LogRotationMode](#LogRotationMode) | Specifies the log rotation mode. | | [MaxASN1BufferLength](#MaxASN1BufferLength) | Specifies the maximal allowed length for ASN.1 primitive tag data. | | [MaxASN1TreeDepth](#MaxASN1TreeDepth) | Specifies the maximal depth for processed ASN.1 trees. | | [OCSPHashAlgorithm](#OCSPHashAlgorithm) | Specifies the hash algorithm to be used to identify certificates in OCSP requests. | | [OldClientSideRSAFallback](#OldClientSideRSAFallback) | Specifies whether the SSH client should use a SHA1 fallback. | | [PKICache](#PKICache) | Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached. | | [PKICachePath](#PKICachePath) | Specifies the file system path where cached PKI data is stored. | | [ProductVersion](#ProductVersion) | Returns the version of the SecureBlackbox library. | | [ServerSSLDHKeyLength](#ServerSSLDHKeyLength) | Sets the size of the TLS DHE key exchange group. | | [StaticDNS](#StaticDNS) | Specifies whether static DNS rules should be used. | | [StaticIPAddress\[domain\]](#StaticIPAddress[domain]) | Gets or sets an IP address for the specified domain name. | | [StaticIPAddresses](#StaticIPAddresses) | Gets or sets all the static DNS rules. | | [Tag](#Tag) | Allows to store any custom data. | | [TLSSessionGroup](#TLSSessionGroup) | Specifies the group name of TLS sessions to be used for session resumption. | | [TLSSessionLifetime](#TLSSessionLifetime) | Specifies lifetime in seconds of the cached TLS session. | | [TLSSessionPurgeInterval](#TLSSessionPurgeInterval) | Specifies how often the session cache should remove the expired TLS sessions. | | [UseCRLObjectCaching](#UseCRLObjectCaching) | Specifies whether reuse of loaded CRL objects is enabled. | | [UseInternalRandom](#UseInternalRandom) | Switches between SecureBlackbox-own and platform PRNGs. | | [UseLegacyAdESValidation](#UseLegacyAdESValidation) | Enables legacy AdES validation mode. | | [UseOCSPResponseObjectCaching](#UseOCSPResponseObjectCaching) | Specifies whether reuse of loaded OCSP response objects is enabled. | | [UseOwnDNSResolver](#UseOwnDNSResolver) | Specifies whether the client classes should use own DNS resolver. | | [UseSharedSystemStorages](#UseSharedSystemStorages) | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. | | [UseSystemNativeSizeCalculation](#UseSystemNativeSizeCalculation) | An internal CryptoAPI access tweak. | | [UseSystemOAEPAndPSS](#UseSystemOAEPAndPSS) | Enforces or disables the use of system-driven RSA OAEP and PSS computations. | | [UseSystemRandom](#UseSystemRandom) | Enables or disables the use of the OS PRNG. | | [XMLRDNDescriptorName\[OID\]](#XMLRDNDescriptorName[OID]) | Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN. | | [XMLRDNDescriptorPriority\[OID\]](#XMLRDNDescriptorPriority[OID]) | Specifies the priority of descriptor names associated with a specific OID. | | [XMLRDNDescriptorReverseOrder](#XMLRDNDescriptorReverseOrder) | Specifies whether to reverse the order of descriptors in RDN. | | [XMLRDNDescriptorSeparator](#XMLRDNDescriptorSeparator) | Specifies the separator used between descriptors in RDN. | # AuthAttempts Property ([SFTPClient](#sftpclient-class) Class) Specifies the number of SSH authentication attempts. ## Syntax ```text ANSI (Cross Platform) int GetAuthAttempts();int SetAuthAttempts(int iAuthAttempts); Unicode (Windows) INT GetAuthAttempts();INT SetAuthAttempts(INT iAuthAttempts); ``` ## Default Value 1 ## Remarks Use this property to specify the number of authentication attempts to try. The [AuthFailed](#authfailed-event-sftpclient-class) event is fired for every failed attempt. ## Data Type Integer # AutoAdjustTransferBlock Property ([SFTPClient](#sftpclient-class) Class) Specifies whether to adjust the send and receive buffer sizes automatically. ## Syntax ```text ANSI (Cross Platform) int GetAutoAdjustTransferBlock();int SetAutoAdjustTransferBlock(int bAutoAdjustTransferBlock); Unicode (Windows) 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](#downloadblocksize-property-sftpclient-class), [UploadBlockSize](#uploadblocksize-property-sftpclient-class), and [PipelineLength](#pipelinelength-property-sftpclient-class) properties to adjust the transfer settings manually. ## Data Type Boolean # ConflictResolutionMode Property ([SFTPClient](#sftpclient-class) Class) Defines the approach that should be used to resolve various conflicts during batch processing. ## Syntax ```text ANSI (Cross Platform) int GetConflictResolutionMode();int SetConflictResolutionMode(int iConflictResolutionMode); Unicode (Windows) INT GetConflictResolutionMode();INT SetConflictResolutionMode(INT iConflictResolutionMode); ``` ## Possible Values ```text CFTM_OVERWRITE(0), CFTM_SKIP(1), CFTM_APPEND_TO_END(2), CFTM_RESUME(3), CFTM_OVERWRITE_IF_DIFF_SIZE(4), CFTM_SAVE_WITH_NEW_NAME(5), CFTM_RENAME_EXISTING_TARGET(6) ``` ## Default Value 0 ## Remarks Use this property to specify the approach to use when landing in conflicting transfer situations. | | | | | --- | --- | --- | | cftmOverwrite | 0 | | | cftmSkip | 1 | | | cftmAppendToEnd | 2 | The signature is corrupted | | cftmResume | 3 | | | cftmOverwriteIfDiffSize | 4 | | | cftmSaveWithNewName | 5 | | | cftmRenameExistingTarget | 5 | | ## Data Type Integer # Connected Property ([SFTPClient](#sftpclient-class) Class) Indicates if the client is connected to the SFTP server. ## Syntax ```text ANSI (Cross Platform) int GetConnected(); Unicode (Windows) 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 # ConnectionInfo Property ([SFTPClient](#sftpclient-class) Class) Contains the secure connection info. ## Syntax ```text SecureBlackboxSSHConnectionInfo* GetConnectionInfo(); ``` ## Remarks This property contains various information about the secure connection. This property is read-only and not available at design time. ## Data Type [SecureBlackboxSSHConnectionInfo](#sshconnectioninfo-type) # CurrentListEntry Property ([SFTPClient](#sftpclient-class) Class) Contains the current entry returned by ListDir . ## Syntax ```text SecureBlackboxFTPListEntry* GetCurrentListEntry(); ``` ## Remarks Use this property to access the current list entry as returned by [ListDir](#listdir-method-sftpclient-class) call. Entries are passed back to the application one by one, with [ListEntry](#listentry-event-sftpclient-class) thrown for each entry. This property is read-only and not available at design time. ## Data Type [SecureBlackboxFTPListEntry](#ftplistentry-type) # DownloadBlockSize Property ([SFTPClient](#sftpclient-class) Class) The download block size in bytes. ## Syntax ```text ANSI (Cross Platform) int GetDownloadBlockSize();int SetDownloadBlockSize(int iDownloadBlockSize); Unicode (Windows) 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](#autoadjusttransferblock-property-sftpclient-class)) don't work. ## Data Type Integer # ExternalCrypto Property ([SFTPClient](#sftpclient-class) Class) Provides access to external signing and DC parameters. ## Syntax ```text SecureBlackboxExternalCrypto* GetExternalCrypto(); ``` ## Remarks Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the [ExternalSign](#externalsign-event-sftpclient-class) event) and asynchronous (based on the DC protocol and the DCAuth signing component). This property is read-only. ## Data Type [SecureBlackboxExternalCrypto](#externalcrypto-type) # FIPSMode Property ([SFTPClient](#sftpclient-class) Class) Reserved. ## Syntax ```text ANSI (Cross Platform) int GetFIPSMode();int SetFIPSMode(int bFIPSMode); Unicode (Windows) BOOL GetFIPSMode();INT SetFIPSMode(BOOL bFIPSMode); ``` ## Default Value FALSE ## Remarks This property is reserved for future use. ## Data Type Boolean # ForceCompression Property ([SFTPClient](#sftpclient-class) Class) Enforces compression for the SSH layer. ## Syntax ```text ANSI (Cross Platform) int GetForceCompression();int SetForceCompression(int bForceCompression); Unicode (Windows) 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 # Key Property ([SFTPClient](#sftpclient-class) Class) Contains the client's SSH key. ## Syntax ```text SecureBlackboxSSHKey* GetKey(); int SetKey(SecureBlackboxSSHKey* val); ``` ## Remarks Use this property to provide the client's SSH key for authentication. Note that you may start with providing the public part of the key, and only complete it with the private part in response to [PrivateKeyNeeded](#privatekeyneeded-event-sftpclient-class) event. Alternative, you may load the private key straightaway. This property is not available at design time. ## Data Type [SecureBlackboxSSHKey](#sshkey-type) # MaxSFTPVersion Property ([SFTPClient](#sftpclient-class) Class) Higher SFTP version to support. ## Syntax ```text ANSI (Cross Platform) int GetMaxSFTPVersion();int SetMaxSFTPVersion(int iMaxSFTPVersion); Unicode (Windows) INT GetMaxSFTPVersion();INT SetMaxSFTPVersion(INT iMaxSFTPVersion); ``` ## Default Value 6 ## Remarks MaxSFTPVersion and [MinSFTPVersion](#minsftpversion-property-sftpclient-class) properties control the range of SFTP protocol versions supported by this client. ## Data Type Integer # MinSFTPVersion Property ([SFTPClient](#sftpclient-class) Class) Lower SFTP version to support. ## Syntax ```text ANSI (Cross Platform) int GetMinSFTPVersion();int SetMinSFTPVersion(int iMinSFTPVersion); Unicode (Windows) INT GetMinSFTPVersion();INT SetMinSFTPVersion(INT iMinSFTPVersion); ``` ## Default Value 0 ## Remarks [MaxSFTPVersion](#maxsftpversion-property-sftpclient-class) and MinSFTPVersion properties control the range of SFTP protocol versions to be supported by this client. ## Data Type Integer # Password Property ([SFTPClient](#sftpclient-class) Class) Specifies user's authentication password. ## Syntax ```text ANSI (Cross Platform) char* GetPassword();int SetPassword(const char* lpszPassword); Unicode (Windows) LPWSTR GetPassword();INT SetPassword(LPCWSTR lpszPassword); ``` ## 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](#sftpclient-class) Class) The number of parallelized transfer requests. ## Syntax ```text ANSI (Cross Platform) int GetPipelineLength();int SetPipelineLength(int iPipelineLength); Unicode (Windows) 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](#autoadjusttransferblock-property-sftpclient-class)) don't work. ## Data Type Integer # Proxy Property ([SFTPClient](#sftpclient-class) Class) The proxy server settings. ## Syntax ```text SecureBlackboxProxySettings* GetProxy(); ``` ## Remarks Use this property to tune up the proxy server settings. This property is read-only. ## Data Type [SecureBlackboxProxySettings](#proxysettings-type) # ServerKey Property ([SFTPClient](#sftpclient-class) Class) Returns the server's public key. ## Syntax ```text SecureBlackboxSSHKey* GetServerKey(); ``` ## Remarks Use this property to check the details of the server public key. This property is read-only and not available at design time. ## Data Type [SecureBlackboxSSHKey](#sshkey-type) # SocketSettings Property ([SFTPClient](#sftpclient-class) Class) Manages network connection settings. ## Syntax ```text SecureBlackboxSocketSettings* GetSocketSettings(); ``` ## Remarks Use this property to tune up network connection parameters. This property is read-only. ## Data Type [SecureBlackboxSocketSettings](#socketsettings-type) # SSHSettings Property ([SFTPClient](#sftpclient-class) Class) The SSH connection settings. ## Syntax ```text SecureBlackboxSSHSettings* GetSSHSettings(); ``` ## Remarks Use this property to access and tune-up the SSH layer settings. This property is read-only. ## Data Type [SecureBlackboxSSHSettings](#sshsettings-type) # TrustedKeysFile Property ([SFTPClient](#sftpclient-class) Class) A file containing the keys of authorized servers. ## Syntax ```text ANSI (Cross Platform) char* GetTrustedKeysFile();int SetTrustedKeysFile(const char* lpszTrustedKeysFile); Unicode (Windows) LPWSTR GetTrustedKeysFile();INT SetTrustedKeysFile(LPCWSTR lpszTrustedKeysFile); ``` ## 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](#sftpclient-class) Class) The upload block size in bytes. ## Syntax ```text ANSI (Cross Platform) int GetUploadBlockSize();int SetUploadBlockSize(int iUploadBlockSize); Unicode (Windows) 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](#autoadjusttransferblock-property-sftpclient-class)) don't work. ## Data Type Integer # Username Property ([SFTPClient](#sftpclient-class) Class) The client's username to authenticate to the server. ## Syntax ```text ANSI (Cross Platform) char* GetUsername();int SetUsername(const char* lpszUsername); Unicode (Windows) LPWSTR GetUsername();INT SetUsername(LPCWSTR lpszUsername); ``` ## 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](#sftpclient-class) Class) Enables UTF8 for all string content. ## Syntax ```text ANSI (Cross Platform) int GetUseUTF8();int SetUseUTF8(int bUseUTF8); Unicode (Windows) 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](#sftpclient-class) Class) The SFTP version negotiated. ## Syntax ```text ANSI (Cross Platform) int GetVersion(); Unicode (Windows) 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](#sftpclient-class) Class) Requests the absolute path for a relative path. ## Syntax ```text ANSI (Cross Platform) char* AbsolutePath(const char* lpszRemotePath); Unicode (Windows) LPWSTR AbsolutePath(LPCWSTR lpszRemotePath); ``` ## 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](#sftpclient-class) Class) Changes current working directory on the server. ## Syntax ```text ANSI (Cross Platform) int ChangeDir(const char* lpszRemoteDir); Unicode (Windows) INT ChangeDir(LPCWSTR lpszRemoteDir); ``` ## 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](#sftpclient-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-sftpclient-class) 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](#config-settings-sftpclient-class), 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](#sftpclient-class) Class) Connects to an SFTP server. ## Syntax ```text ANSI (Cross Platform) int Connect(const char* lpszAddress, int iPort); Unicode (Windows) INT Connect(LPCWSTR lpszAddress, 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](#sftpclient-class) Class) Creates a symbolic or hard link to a remote file. ## Syntax ```text ANSI (Cross Platform) int CreateLink(const char* lpszLinkPath, const char* lpszTargetPath, int bHardLink); Unicode (Windows) INT CreateLink(LPCWSTR lpszLinkPath, LPCWSTR lpszTargetPath, 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 destination 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](#sftpclient-class) Class) Removes directory from the SFTP server. ## Syntax ```text ANSI (Cross Platform) int DeleteDir(const char* lpszRemoteDir); Unicode (Windows) INT DeleteDir(LPCWSTR lpszRemoteDir); ``` ## 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](#sftpclient-class) Class) Deletes a file from the SFTP server. ## Syntax ```text ANSI (Cross Platform) int DeleteFile(const char* lpszRemoteFile); Unicode (Windows) INT DeleteFile(LPCWSTR lpszRemoteFile); ``` ## 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](#sftpclient-class) Class) Deletes a group of files from the SFTP server. ## Syntax ```text ANSI (Cross Platform) int DeleteFiles(const char* lpszRemotePath, const char* lpszMask, int bCaseSensitive, int bRecursive, int iErrorHandling); Unicode (Windows) INT DeleteFiles(LPCWSTR lpszRemotePath, LPCWSTR lpszMask, BOOL bCaseSensitive, BOOL bRecursive, INT iErrorHandling); ``` ## 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. The *ErrorHandling* parameter specifies the error handling tactics. | | | | | --- | --- | --- | | ehStopOnFailure | 0 | Stop on the first failure and throw an exception | | ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list | | ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process | 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](#sftpclient-class) Class) Checks if a directory exists on the SFTP server. ## Syntax ```text ANSI (Cross Platform) bool DirExists(const char* lpszRemoteDir); Unicode (Windows) bool DirExists(LPCWSTR lpszRemoteDir); ``` ## 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](#sftpclient-class) Class) Disconnects from the SFTP server. ## Syntax ```text ANSI (Cross Platform) int Disconnect(); Unicode (Windows) 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](#sftpclient-class) Class) Performs an additional action. ## Syntax ```text ANSI (Cross Platform) char* DoAction(const char* lpszActionID, const char* lpszActionParams); Unicode (Windows) LPWSTR DoAction(LPCWSTR lpszActionID, LPCWSTR lpszActionParams); ``` ## 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 insensitive) of the action is provided in the *ActionID* parameter. *ActionParams* contains the value of a single parameter, or a list of multiple parameters for the action in the form of *PARAM1=VALUE1;PARAM2=VALUE2;...*. Common ActionIDs: | | | | | | --- | --- | --- | --- | | Action | Parameters | Returned value | Description | | ResetTrustedListCache | none | none | Clears the cached list of trusted lists. | | ResetCertificateCache | none | none | Clears the cached certificates. | | ResetCRLCache | none | none | Clears the cached CRLs. | | ResetOCSPResponseCache | none | none | Clears the cached OCSP responses. | ## 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](#sftpclient-class) Class) Downloads a file from the server into an array of bytes. ## Syntax ```text ANSI (Cross Platform) char* DownloadBytes(const char* lpszRemoteFile, int *lpSize = NULL); Unicode (Windows) LPSTR DownloadBytes(LPCWSTR lpszRemoteFile, LPINT lpSize = NULL); ``` ## Remarks Use this method to download *RemoteFile* into a byte array. ## 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. # DownloadFile Method ([SFTPClient](#sftpclient-class) Class) Downloads a file from the SFTP server. ## Syntax ```text ANSI (Cross Platform) int DownloadFile(const char* lpszRemoteFile, const char* lpszLocalFile); Unicode (Windows) INT DownloadFile(LPCWSTR lpszRemoteFile, LPCWSTR lpszLocalFile); ``` ## 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](#sftpclient-class) Class) Downloads multiple files from the SFTP server. ## Syntax ```text ANSI (Cross Platform) int DownloadFiles(const char* lpszRemotePath, const char* lpszLocalDir, int bRecursive, int iErrorHandling); Unicode (Windows) INT DownloadFiles(LPCWSTR lpszRemotePath, LPCWSTR lpszLocalDir, BOOL bRecursive, INT iErrorHandling); ``` ## Remarks *RemotePath* contains a file mask or regular expression by which the files are selected for download. *LocalDir* specifies the local folder where the files should be saved. The *Recursive* parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual *RemotePath*, but not its subdirectories, will be downloaded. The *ErrorHandling* parameter specifies the error handling tactics. | | | | | --- | --- | --- | | ehStopOnFailure | 0 | Stop on the first failure and throw an exception | | ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list | | ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process | ## 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](#sftpclient-class) Class) Downloads a file from the SFTP server. ## Syntax ```text ANSI (Cross Platform) int DownloadStream(const char* lpszRemoteFile, SecureBlackboxStream* sLocalStream); Unicode (Windows) INT DownloadStream(LPCWSTR lpszRemoteFile, 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](#sftpclient-class) Class) Sends an SSH command to the server in the middle of SFTP session. ## Syntax ```text ANSI (Cross Platform) char* ExecuteSSHCommand(const char* lpszCommand, int *lpSize = NULL); Unicode (Windows) LPSTR ExecuteSSHCommand(LPCWSTR lpszCommand, LPINT lpSize = NULL); ``` ## 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](#sftpclient-class) Class) Sends an extension command to the server. ## Syntax ```text 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); ``` ## 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](#sftpclient-class) Class) Checks whether a file exists on the server. ## Syntax ```text ANSI (Cross Platform) bool FileExists(const char* lpszRemoteFile); Unicode (Windows) bool FileExists(LPCWSTR lpszRemoteFile); ``` ## 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](#sftpclient-class) Class) Returns the current directory on the SFTP server. ## Syntax ```text ANSI (Cross Platform) char* GetCurrentDir(); Unicode (Windows) LPWSTR 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](#sftpclient-class) Class) Checks the size of a remote file. ## Syntax ```text ANSI (Cross Platform) int64 GetFileSize(const char* lpszRemoteFile); Unicode (Windows) LONG64 GetFileSize(LPCWSTR lpszRemoteFile); ``` ## 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](#sftpclient-class) Class) Lists the content of the current remote directory. ## Syntax ```text ANSI (Cross Platform) char* ListDir(int bIncludeFiles, int bIncludeDirectories); Unicode (Windows) LPWSTR 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](#listentry-event-sftpclient-class) 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](#sftpclient-class) Class) Creates a new directory on the server. ## Syntax ```text ANSI (Cross Platform) int MakeDir(const char* lpszRemoteDir); Unicode (Windows) INT MakeDir(LPCWSTR lpszRemoteDir); ``` ## 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](#sftpclient-class) Class) Renames a file. ## Syntax ```text ANSI (Cross Platform) int RenameFile(const char* lpszSourceFile, const char* lpszDestFile); Unicode (Windows) INT RenameFile(LPCWSTR lpszSourceFile, LPCWSTR lpszDestFile); ``` ## 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](#sftpclient-class) Class) Requests attributes of the remote file. ## Syntax ```text ANSI (Cross Platform) char* RequestAttributes(const char* lpszRemotePath, int bFollowSymLinks); Unicode (Windows) LPWSTR RequestAttributes(LPCWSTR lpszRemotePath, 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. # Reset Method ([SFTPClient](#sftpclient-class) Class) Resets the class settings. ## Syntax ```text ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset(); ``` ## Remarks Reset is a generic method available in every class. ## 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.) # SetAttributes Method ([SFTPClient](#sftpclient-class) Class) Sets the attributes upon a remote file. ## Syntax ```text ANSI (Cross Platform) int SetAttributes(const char* lpszRemotePath, const char* lpszAttributes); Unicode (Windows) INT SetAttributes(LPCWSTR lpszRemotePath, LPCWSTR lpszAttributes); ``` ## 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](#sftpclient-class) Class) Uploads a byte array to the server. ## Syntax ```text ANSI (Cross Platform) int UploadBytes(const char* lpBytes, int lenBytes, const char* lpszRemoteFile); Unicode (Windows) INT UploadBytes(LPCSTR lpBytes, INT lenBytes, LPCWSTR lpszRemoteFile); ``` ## 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](#sftpclient-class) Class) Uploads a file to the server. ## Syntax ```text ANSI (Cross Platform) int UploadFile(const char* lpszLocalFile, const char* lpszRemoteFile); Unicode (Windows) INT UploadFile(LPCWSTR lpszLocalFile, LPCWSTR lpszRemoteFile); ``` ## 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](#sftpclient-class) Class) Uploads multiple files to the server. ## Syntax ```text ANSI (Cross Platform) int UploadFiles(const char* lpszLocalPath, const char* lpszRemoteDir, int bRecursive, int iErrorHandling); Unicode (Windows) INT UploadFiles(LPCWSTR lpszLocalPath, LPCWSTR lpszRemoteDir, BOOL bRecursive, INT iErrorHandling); ``` ## Remarks Use this property to upload a batch of files to the server. *LocalPath* specifies a wildcard or regular expression by which the local files are picked for uploading. *RemoteDir* specifies the location on the server where these files should be saved. The *Recursive* parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual *LocalPath*, but not its subdirectories, will be uploaded. The *ErrorHandling* parameter specifies one of the pre-defined error handling tactics: | | | | | --- | --- | --- | | ehStopOnFailure | 0 | Stop on the first failure and throw an exception | | ehIgnoreErrors | 1 | Ignore individual processing errors, just proceed to the next item on the list | | ehTryAllItems | 2 | Try to process all the items by ignoring any mid-way errors, but throw an exception at the end of the processing if any of the items failed to process | ## 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](#sftpclient-class) Class) Uploads a file to the server. ## Syntax ```text ANSI (Cross Platform) int UploadStream(SecureBlackboxStream* sLocalStream, const char* lpszRemoteFile); Unicode (Windows) INT UploadStream(SecureBlackboxStream* sLocalStream, LPCWSTR lpszRemoteFile); ``` ## 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](#sftpclient-class) Class) Fires when an authentication attempt is performed. ## Syntax ```text 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; ``` ## 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](#sftpclient-class) Class) Fires if an authentication attempt fails. ## Syntax ```text 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; ``` ## 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](#authattempts-property-sftpclient-class) 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](#sftpclient-class) Class) Reports a successful authentication. ## Syntax ```text 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; ``` ## Remarks This event marks the completion of the authentication procedure, and signifies transition to the SSH connection subprotocol. # Banner Event ([SFTPClient](#sftpclient-class) Class) Reports the receipt of the Welcome message from the server. ## Syntax ```text 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; ``` ## 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](#sftpclient-class) Class) Reports SFTP connection closure. ## Syntax ```text 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; ``` ## Remarks The class fires this event to report connection closure. No more SFTP activity could be done after the disconnect. # Error Event ([SFTPClient](#sftpclient-class) Class) Information about errors during SFTP connection. ## Syntax ```text 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; ``` ## 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](#trappable-errors-sftpclient-class). # ExternalSign Event ([SFTPClient](#sftpclient-class) Class) Handles remote or external signing initiated by the SignExternal method or other source. ## Syntax ```text 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; ``` ## 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 class via the *SignedData* parameter. *OperationId* provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. *HashAlgorithm* specifies the hash algorithm being used for the operation, and *Pars* contains algorithm-dependent parameters. The class uses base16 (hex) encoding for the *Data*, *SignedData*, and *Pars* parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing. A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16 A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: ```text signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); }; ``` # FileNameChangeNeeded Event ([SFTPClient](#sftpclient-class) Class) Asks the application for a new file name. ## Syntax ```text ANSI (Cross Platform) virtual int FireFileNameChangeNeeded(SFTPClientFileNameChangeNeededEventParams *e); typedef struct { char *FileName; int Force; int reserved; } SFTPClientFileNameChangeNeededEventParams; Unicode (Windows) virtual INT FireFileNameChangeNeeded(SFTPClientFileNameChangeNeededEventParams *e); typedef struct { LPWSTR FileName; BOOL Force; INT reserved; } SFTPClientFileNameChangeNeededEventParams; ``` ## Remarks The component uses this event to ask the application for a new file name in the case of a name conflict. Adjust the *FileName* as required to avoid the conflict, or set *Force* to true to go ahead with the current name (possibly overwriting an existing file). # FileOperation Event ([SFTPClient](#sftpclient-class) Class) Signifies the start of a file transfer operation. ## Syntax ```text 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; ``` ## 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: | | | | | --- | --- | --- | | cffoDownloadFile | 0 | Download file | | cffoUploadFile | 1 | Upload file | | cffoDeleteFile | 2 | Delete file | | cffoMakeDir | 3 | Make directory | # FileOperationResult Event ([SFTPClient](#sftpclient-class) Class) Signifies the completion of a file transfer operation. ## Syntax ```text 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; ``` ## 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: | | | | | --- | --- | --- | | cffoDownloadFile | 0 | Download file | | cffoUploadFile | 1 | Upload file | | cffoDeleteFile | 2 | Delete file | | cffoMakeDir | 3 | Make directory | # KnownKeyReceived Event ([SFTPClient](#sftpclient-class) Class) Signals that the server has introduced itself with a known key. ## Syntax ```text 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; ``` ## Remarks The class fires this event to tell the application that the server has introduced itself with a known key from [TrustedKeysFile](#trustedkeysfile-property-sftpclient-class). 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](#serverkey-property-sftpclient-class) to access more key details. # ListEntry Event ([SFTPClient](#sftpclient-class) Class) Reports a directory listing entry to the application. ## Syntax ```text 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; ``` ## Remarks The class fires this event to report a directory listing entry to the application. *FileName* contains the entry name. Use [CurrentListEntry](#currentlistentry-property-sftpclient-class) to access the details of the entry. # Notification Event ([SFTPClient](#sftpclient-class) Class) This event notifies the application about an underlying control flow event. ## Syntax ```text 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; ``` ## Remarks The class fires this event to let the application know about some event, occurrence, or milestone in the class. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time. The unique identifier of the event is provided in the *EventID* parameter. *EventParam* contains any parameters accompanying the occurrence. Depending on the type of the class, the exact action it is performing, or the document being processed, one or both may be omitted. # PasswordChangeRequest Event ([SFTPClient](#sftpclient-class) Class) Signals that the server requests a password change. ## Syntax ```text 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; ``` ## 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](#sftpclient-class) Class) Asks the application for the client's private key. ## Syntax ```text 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; ``` ## Remarks The class fires this event if the public key provided in [Key](#key-property-sftpclient-class) 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](#key-property-sftpclient-class). The component will pick the key up and continue the authentication. # Progress Event ([SFTPClient](#sftpclient-class) Class) Fires periodically during the data transfer. ## Syntax ```text 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; ``` ## 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](#sftpclient-class) Class) Signals that the server has introduced itself with an unknown key. ## Syntax ```text 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; ``` ## Remarks The class fires this event to tell the application that the server has introduced itself with a key not present in [TrustedKeysFile](#trustedkeysfile-property-sftpclient-class). The details of the key are provided: *Algorithm* and *Bits* specify the key algorithm and the number of bits. *FingerprintSHA256* contains the key's fingerprint. In this event handler, you need to make a decision whether to proceed with the connection. Use *Action* to tell the class what it should do with the key: | | | | | --- | --- | --- | | catAcceptOnce | 1 | Accept the key for the current session only. | | catAcceptPermanently | 2 | Accept the key for the current session and store the key to the trusted keys list. | | catReject | 3 | Reject the key and close the connection. | Note that accepting an unknown and unchecked key may be risky. # ExternalCrypto Type Specifies the parameters of external cryptographic calls. ## Syntax *SecureBlackboxExternalCrypto* (declared in *secureblackbox.h*) ## Remarks External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally. The following fields are available: - [AsyncDocumentID](#ExternalCrypto_f_AsyncDocumentID) - [CustomParams](#ExternalCrypto_f_CustomParams) - [Data](#ExternalCrypto_f_Data) - [ExternalHashCalculation](#ExternalCrypto_f_ExternalHashCalculation) - [HashAlgorithm](#ExternalCrypto_f_HashAlgorithm) - [KeyID](#ExternalCrypto_f_KeyID) - [KeySecret](#ExternalCrypto_f_KeySecret) - [Method](#ExternalCrypto_f_Method) - [Mode](#ExternalCrypto_f_Mode) - [PublicKeyAlgorithm](#ExternalCrypto_f_PublicKeyAlgorithm) ## Fields **AsyncDocumentID** *char** *Default Value: ""* Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls. Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses. If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages. **CustomParams** *char** *Default Value: ""* Custom parameters to be passed to the signing service (uninterpreted). **Data** *char** *Default Value: ""* Additional data to be included in the async state and mirrored back by the requestor. **ExternalHashCalculation** *int* *Default Value: FALSE* Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class. If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called. **HashAlgorithm** *char** *Default Value: "SHA256"* 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 | | **KeyID** *char** *Default Value: ""* The ID of the pre-shared key used for DC request authentication. Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use [KeySecret](#ExternalCrypto_f_KeySecret) 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: ```text signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789"; ``` **KeySecret** *char** *Default Value: ""* 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 [KeyID](#ExternalCrypto_f_KeyID) topic. **Method** *int* *Default Value: 0* Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup. Available options: | | | | --- | --- | | asmdPKCS1 | 0 | | asmdPKCS7 | 1 | **Mode** *int* *Default Value: 0* 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 the OnExternalSign event (2) | | ecmDCAuth | DCAuth signing (3) | | ecmDCAuthJSON | DCAuth signing in JSON format (4) | **PublicKeyAlgorithm** *char** *Default Value: ""* Provide the 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 | | | SB_CERT_ALGORITHM_MLDSA_44 | id-ml-dsa-44 | | | SB_CERT_ALGORITHM_MLDSA_65 | id-ml-dsa-65 | | | SB_CERT_ALGORITHM_MLDSA_87 | id-ml-dsa-87 | | | SB_CERT_ALGORITHM_HASH_MLDSA_44_SHA512 | id-hash-ml-dsa-44-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_65_SHA512 | id-hash-ml-dsa-65-with-sha512 | | | SB_CERT_ALGORITHM_HASH_MLDSA_87_SHA512 | id-hash-ml-dsa-87-with-sha512 | | | SB_CERT_ALGORITHM_MLKEM_512 | id-ml-kem-512 | | | SB_CERT_ALGORITHM_MLKEM_768 | id-ml-kem-768 | | | SB_CERT_ALGORITHM_MLKEM_1024 | id-ml-kem-1024 | | ## Constructors ```text ExternalCrypto() ``` Creates a new ExternalCrypto object with default field values. # FTPListEntry Type Represents a basic container for the remote file details. ## Syntax *SecureBlackboxFTPListEntry* (declared in *secureblackbox.h*) ## Remarks The class represents the details of a file entry returned by the FTP server. The following fields are available: - [AccessTime](#FTPListEntry_f_AccessTime) - [CreationTime](#FTPListEntry_f_CreationTime) - [EntryFormat](#FTPListEntry_f_EntryFormat) - [FileType](#FTPListEntry_f_FileType) - [Handle](#FTPListEntry_f_Handle) - [ModificationTime](#FTPListEntry_f_ModificationTime) - [Name](#FTPListEntry_f_Name) - [Path](#FTPListEntry_f_Path) - [Principal](#FTPListEntry_f_Principal) - [Size](#FTPListEntry_f_Size) - [UnixPerms](#FTPListEntry_f_UnixPerms) - [UnparsedName](#FTPListEntry_f_UnparsedName) ## Fields **AccessTime** *char** *Default Value: ""* Contains the last access time for this file, in UTC. **CreationTime** *char** *Default Value: ""* Contains this file's creation time, in UTC. **EntryFormat** *int* *Default Value: 0* The file listing format: | | | | --- | --- | | cfefUnknown | 0 | | cfefUnix | 1 | | cfefWindows | 2 | | cfefMLSD | 3 | **FileType** *int* *Default Value: 0* The type of the entry: | | | | --- | --- | | fetUnknown | 0 | | fetDirectory | 1 | | fetFile | 2 | | fetSymlink | 3 | | fetSpecial | 4 | | fetCurrentDirectory | 5 | | fetParentDirectory | 6 | | fetSocket | 7 | | fetCharDevice | 8 | | fetBlockDevice | 9 | | fetFIFO | 10 | **Handle** *int64* *Default Value: 0* 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` **ModificationTime** *char** *Default Value: ""* File last modification date/time. **Name** *char** *Default Value: ""* The file or directory name. **Path** *char** *Default Value: ""* The full path to the file or directory. **Principal** *char** *Default Value: ""* Specifies the owner of the file/directory. Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings. **Size** *int64* *Default Value: 0* File size in bytes. **UnixPerms** *int* *Default Value: 511* The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)). **UnparsedName** *char** *Default Value: ""* The unparsed entry as returned by the server. Sometimes this is also known as "long name". ## Constructors ```text FTPListEntry() ``` Creates a new FTPListEntry object. # ProxySettings Type A container for proxy server settings. ## Syntax *SecureBlackboxProxySettings* (declared in *secureblackbox.h*) ## Remarks This type exposes a collection of properties for tuning up the proxy server configuration. The following fields are available: - [Address](#ProxySettings_f_Address) - [Authentication](#ProxySettings_f_Authentication) - [Password](#ProxySettings_f_Password) - [Port](#ProxySettings_f_Port) - [ProxyType](#ProxySettings_f_ProxyType) - [RequestHeaders](#ProxySettings_f_RequestHeaders) - [ResponseBody](#ProxySettings_f_ResponseBody) - [ResponseHeaders](#ProxySettings_f_ResponseHeaders) - [UseIPv6](#ProxySettings_f_UseIPv6) - [Username](#ProxySettings_f_Username) ## Fields **Address** *char** *Default Value: ""* The IP address of the proxy server. **Authentication** *int* *Default Value: 0* The authentication type used by the proxy server. | | | | --- | --- | | patNoAuthentication | 0 | | patBasic | 1 | | patDigest | 2 | | patNTLM | 3 | **Password** *char** *Default Value: ""* The password to authenticate to the proxy server. **Port** *int* *Default Value: 0* The port on the proxy server to connect to. **ProxyType** *int* *Default Value: 0* The type of the proxy server. | | | | --- | --- | | cptNone | 0 | | cptSocks4 | 1 | | cptSocks5 | 2 | | cptWebTunnel | 3 | | cptHTTP | 4 | **RequestHeaders** *char** *Default Value: ""* Contains HTTP request headers for WebTunnel and HTTP proxy. **ResponseBody** *char** *Default Value: ""* Contains the HTTP or HTTPS (WebTunnel) proxy response body. **ResponseHeaders** *char** *Default Value: ""* Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server. **UseIPv6** *int* *Default Value: FALSE* Specifies whether IPv6 should be used when connecting through the proxy. **Username** *char** *Default Value: ""* Specifies the username credential for proxy authentication. ## Constructors ```text ProxySettings() ``` Creates a new ProxySettings object. # SocketSettings Type A container for the socket settings. ## Syntax *SecureBlackboxSocketSettings* (declared in *secureblackbox.h*) ## Remarks This type is a container for socket-layer parameters. The following fields are available: - [DNSMode](#SocketSettings_f_DNSMode) - [DNSPort](#SocketSettings_f_DNSPort) - [DNSQueryTimeout](#SocketSettings_f_DNSQueryTimeout) - [DNSServers](#SocketSettings_f_DNSServers) - [DNSTotalTimeout](#SocketSettings_f_DNSTotalTimeout) - [IncomingSpeedLimit](#SocketSettings_f_IncomingSpeedLimit) - [LocalAddress](#SocketSettings_f_LocalAddress) - [LocalPort](#SocketSettings_f_LocalPort) - [OutgoingSpeedLimit](#SocketSettings_f_OutgoingSpeedLimit) - [Timeout](#SocketSettings_f_Timeout) - [UseIPv6](#SocketSettings_f_UseIPv6) ## Fields **DNSMode** *int* *Default Value: 0* 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 | **DNSPort** *int* *Default Value: 0* Specifies the port number to be used for sending queries to the DNS server. **DNSQueryTimeout** *int* *Default Value: 0* The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout. **DNSServers** *char** *Default Value: ""* The addresses of DNS servers to use for address resolution, separated by commas or semicolons. **DNSTotalTimeout** *int* *Default Value: 0* The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout. **IncomingSpeedLimit** *int* *Default Value: 0* The maximum number of bytes to read from the socket, per second. **LocalAddress** *char** *Default Value: ""* The local network interface to bind the socket to. **LocalPort** *int* *Default Value: 0* The local port number to bind the socket to. **OutgoingSpeedLimit** *int* *Default Value: 0* The maximum number of bytes to write to the socket, per second. **Timeout** *int* *Default Value: 60000* 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). **UseIPv6** *int* *Default Value: FALSE* Enables or disables IP protocol version 6. ## Constructors ```text SocketSettings() ``` Creates a new SocketSettings object. # SSHConnectionInfo Type Contains information about SSH connection. ## Syntax *SecureBlackboxSSHConnectionInfo* (declared in *secureblackbox.h*) ## Remarks SSHConnectionInfo object contains information about one SSH connection. The following fields are available: - [ClientKeyAlgorithm](#SSHConnectionInfo_f_ClientKeyAlgorithm) - [ClientKeyBits](#SSHConnectionInfo_f_ClientKeyBits) - [ClientKeyFingerprint](#SSHConnectionInfo_f_ClientKeyFingerprint) - [CloseReason](#SSHConnectionInfo_f_CloseReason) - [CompressionAlgorithmInbound](#SSHConnectionInfo_f_CompressionAlgorithmInbound) - [CompressionAlgorithmOutbound](#SSHConnectionInfo_f_CompressionAlgorithmOutbound) - [EncryptionAlgorithmInbound](#SSHConnectionInfo_f_EncryptionAlgorithmInbound) - [EncryptionAlgorithmOutbound](#SSHConnectionInfo_f_EncryptionAlgorithmOutbound) - [InboundEncryptionKeyBits](#SSHConnectionInfo_f_InboundEncryptionKeyBits) - [KexAlgorithm](#SSHConnectionInfo_f_KexAlgorithm) - [KexBits](#SSHConnectionInfo_f_KexBits) - [KexLines](#SSHConnectionInfo_f_KexLines) - [MacAlgorithmInbound](#SSHConnectionInfo_f_MacAlgorithmInbound) - [MacAlgorithmOutbound](#SSHConnectionInfo_f_MacAlgorithmOutbound) - [OutboundEncryptionKeyBits](#SSHConnectionInfo_f_OutboundEncryptionKeyBits) - [PublicKeyAlgorithm](#SSHConnectionInfo_f_PublicKeyAlgorithm) - [RemoteAddress](#SSHConnectionInfo_f_RemoteAddress) - [RemotePort](#SSHConnectionInfo_f_RemotePort) - [RemoteSoftwareName](#SSHConnectionInfo_f_RemoteSoftwareName) - [ServerKeyAlgorithm](#SSHConnectionInfo_f_ServerKeyAlgorithm) - [ServerKeyBits](#SSHConnectionInfo_f_ServerKeyBits) - [ServerKeyFingerprint](#SSHConnectionInfo_f_ServerKeyFingerprint) - [TotalBytesReceived](#SSHConnectionInfo_f_TotalBytesReceived) - [TotalBytesSent](#SSHConnectionInfo_f_TotalBytesSent) - [Version](#SSHConnectionInfo_f_Version) ## Fields **ClientKeyAlgorithm** *char* (read-only)* *Default Value: ""* Specifies the client's key algorithm. **ClientKeyBits** *int (read-only)* *Default Value: 0* Specifies the length of the client's key. **ClientKeyFingerprint** *char* (read-only)* *Default Value: ""* The fingerprint (hash value) of the client's public key. **CloseReason** *char* (read-only)* *Default Value: ""* 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. **CompressionAlgorithmInbound** *char* (read-only)* *Default Value: ""* Compression algorithm for the incoming traffic. **CompressionAlgorithmOutbound** *char* (read-only)* *Default Value: ""* Compression algorithm for the outgoing traffic. **EncryptionAlgorithmInbound** *char* (read-only)* *Default Value: ""* Encryption algorithm for the incoming traffic. **EncryptionAlgorithmOutbound** *char* (read-only)* *Default Value: ""* Encryption algorithm for the outgoing traffic. **InboundEncryptionKeyBits** *int (read-only)* *Default Value: 0* Specifies the length of the key used to encrypt the incoming traffic. **KexAlgorithm** *char* (read-only)* *Default Value: ""* The key exchange algorithm used during the SSH handshake. **KexBits** *int (read-only)* *Default Value: 0* The number of bits used by the key exchange algorithm. **KexLines** *char* (read-only)* *Default Value: ""* The contents of the received KexInit packet. KexInit packet contains the list of algorithms supported by the remote party. **MacAlgorithmInbound** *char* (read-only)* *Default Value: ""* MAC algorithm used for the incoming connection. **MacAlgorithmOutbound** *char* (read-only)* *Default Value: ""* MAC algorithm used for outbound connection. **OutboundEncryptionKeyBits** *int (read-only)* *Default Value: 0* Specifies the length of the key used to encrypt the outgoing traffic. **PublicKeyAlgorithm** *char* (read-only)* *Default Value: ""* Specifies the public key algorithm which was used during the SSH handshake. **RemoteAddress** *char* (read-only)* *Default Value: ""* The client's IP address. **RemotePort** *int (read-only)* *Default Value: 0* The remote port of the client connection. **RemoteSoftwareName** *char* (read-only)* *Default Value: ""* Returns the name (self-advertised) of the SSH software running on the other side. **ServerKeyAlgorithm** *char* (read-only)* *Default Value: ""* Specifies the server's key algorithm. **ServerKeyBits** *int (read-only)* *Default Value: 0* Specifies the number of bits in the server's key. **ServerKeyFingerprint** *char* (read-only)* *Default Value: ""* The fingerprint (hash value) of the server's public key. **TotalBytesReceived** *int64 (read-only)* *Default Value: 0* Returns the total number of bytes received over this connection. **TotalBytesSent** *int64 (read-only)* *Default Value: 0* Returns the total number of bytes sent over this connection. **Version** *int (read-only)* *Default Value: 2* Specifies SSH protocol version. ## Constructors ```text SSHConnectionInfo() ``` Creates an empty object representing a SSH connection info. # SSHKey Type SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key. ## Syntax *SecureBlackboxSSHKey* (declared in *secureblackbox.h*) ## Remarks SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits. The following fields are available: - [Algorithm](#SSHKey_f_Algorithm) - [Bits](#SSHKey_f_Bits) - [Comment](#SSHKey_f_Comment) - [Curve](#SSHKey_f_Curve) - [Extractable](#SSHKey_f_Extractable) - [FingerprintMD5](#SSHKey_f_FingerprintMD5) - [FingerprintSHA1](#SSHKey_f_FingerprintSHA1) - [FingerprintSHA256](#SSHKey_f_FingerprintSHA256) - [Handle](#SSHKey_f_Handle) - [KeyFormat](#SSHKey_f_KeyFormat) - [KeyProtectionAlgorithm](#SSHKey_f_KeyProtectionAlgorithm) - [Private](#SSHKey_f_Private) - [Public](#SSHKey_f_Public) - [Subject](#SSHKey_f_Subject) ## Fields **Algorithm** *char* (read-only)* *Default Value: ""* Specifies the key algorithm. The following key algorithms are currently supported and can be returned by this property: - RSA - DSS - ECDSA - EDDSA - MLDSA - ECDSA-SK - EDDSA-SK **Bits** *int (read-only)* *Default Value: 0* The number of bits in the key: the more the better, 2048 or 4096 are typical values. **Comment** *char** *Default Value: ""* The comment for the public key. **Curve** *char* (read-only)* *Default Value: ""* Specifies the elliptical curve when EC cryptography is used. The following curves are currently supported: - NISTP256 - NISTP384 - NISTP521 - NISTK163 - NISTP192 - NISTP224 - NISTK233 - NISTB233 - NISTK283 - NISTK409 - NISTB409 - NISTK571 - CURVE25519 (EdDSA curve) - CURVE448 (EdDSA curve) **Extractable** *int (read-only)* *Default Value: FALSE* Whether the key is extractable (e.g., from a security token), or not. **FingerprintMD5** *char* (read-only)* *Default Value: ""* Contains the MD5 fingerprint (hash) of the key. **FingerprintSHA1** *char* (read-only)* *Default Value: ""* Contains the SHA-1 fingerprint (hash) of the key. **FingerprintSHA256** *char* (read-only)* *Default Value: ""* Contains the SHA-256 fingerprint (hash) of the key. **Handle** *int64* *Default Value: 0* 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. ```text pdfSigner.setSigningCertHandle(certMgr.getCertHandle()); ``` **KeyFormat** *int (read-only)* *Default Value: 0* 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 | | | ckfOpenSSHCert | 10 | | **KeyProtectionAlgorithm** *char* (read-only)* *Default Value: ""* Specifies the key protection algorithm. **Private** *int (read-only)* *Default Value: FALSE* Whether this key is a private key or not. **Public** *int (read-only)* *Default Value: FALSE* Whether this key is a public key or not. **Subject** *char** *Default Value: ""* Specifies the public key owner (subject). This property is used only for IETF-keys. ## Constructors ```text SSHKey() ``` Creates a new key. # SSHSettings Type A container for various SSH protocol settings. ## Syntax *SecureBlackboxSSHSettings* (declared in *secureblackbox.h*) ## Remarks SSHSettings stores various settings of SSH client or server. The following fields are available: - [AutoAdjustCiphers](#SSHSettings_f_AutoAdjustCiphers) - [BaseConfiguration](#SSHSettings_f_BaseConfiguration) - [CompressionAlgorithms](#SSHSettings_f_CompressionAlgorithms) - [CompressionLevel](#SSHSettings_f_CompressionLevel) - [DefaultWindowSize](#SSHSettings_f_DefaultWindowSize) - [EncryptionAlgorithms](#SSHSettings_f_EncryptionAlgorithms) - [ForceCompression](#SSHSettings_f_ForceCompression) - [ForwardAuthAgent](#SSHSettings_f_ForwardAuthAgent) - [GSSAuthTypes](#SSHSettings_f_GSSAuthTypes) - [GSSDelegateCreds](#SSHSettings_f_GSSDelegateCreds) - [GSSHostname](#SSHSettings_f_GSSHostname) - [GSSLib](#SSHSettings_f_GSSLib) - [GSSMechanisms](#SSHSettings_f_GSSMechanisms) - [GSSProtocols](#SSHSettings_f_GSSProtocols) - [HandshakeTimeout](#SSHSettings_f_HandshakeTimeout) - [KexAlgorithms](#SSHSettings_f_KexAlgorithms) - [MacAlgorithms](#SSHSettings_f_MacAlgorithms) - [MaxSSHPacketSize](#SSHSettings_f_MaxSSHPacketSize) - [MinWindowSize](#SSHSettings_f_MinWindowSize) - [ObfuscateHandshake](#SSHSettings_f_ObfuscateHandshake) - [ObfuscationPassword](#SSHSettings_f_ObfuscationPassword) - [PublicKeyAlgorithms](#SSHSettings_f_PublicKeyAlgorithms) - [RequestPasswordChange](#SSHSettings_f_RequestPasswordChange) - [SoftwareName](#SSHSettings_f_SoftwareName) - [TrustAllKeys](#SSHSettings_f_TrustAllKeys) - [UseAuthAgent](#SSHSettings_f_UseAuthAgent) - [Versions](#SSHSettings_f_Versions) ## Fields **AutoAdjustCiphers** *int* *Default Value: TRUE* Whether the SSH client should adjust its list of supported ciphers 'on-the-fly' for greater compatibility with the server it is connecting to. **BaseConfiguration** *int* *Default Value: 0* Allows to choose base configuration of SSH settings, tuned up for different purposes such as high security or higher compatibility. **CompressionAlgorithms** *char** *Default Value: ""* 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 **CompressionLevel** *int* *Default Value: 6* Possible values for the Compression Level range from 0 (minimum compression) to 9 (maximum compression). This setting is ignored if compression wasn't accepted. **DefaultWindowSize** *int* *Default Value: 2048000* 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. **EncryptionAlgorithms** *char** *Default Value: ""* 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 **ForceCompression** *int* *Default Value: FALSE* 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. **ForwardAuthAgent** *int* *Default Value: FALSE* Enables or disables auth agent forwarding. This allows the class to connect to the second and subsequent servers in the chain with the key agent available on the client computer. **GSSAuthTypes** *char** *Default Value: ""* A comma-separated list of authentication types. Two types are currently supported: gssapi-with-mic and gssapi-keyex. **GSSDelegateCreds** *int* *Default Value: FALSE* Switches credential delegation on or off. **GSSHostname** *char** *Default Value: ""* 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). **GSSLib** *char** *Default Value: ""* A path to the GSS-API library (DLL or SO). **GSSMechanisms** *char** *Default Value: ""* A comma-separated list of GSS mechanisms to use. Two values are currently supported: lib and SSPI. **GSSProtocols** *char** *Default Value: ""* A comma-separated list of SSPI protocols. Two protocols are currently supported: kerberos and NTLM. **HandshakeTimeout** *int* *Default Value: 45* 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. **KexAlgorithms** *char** *Default Value: ""* 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 **MacAlgorithms** *char** *Default Value: ""* 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 **MaxSSHPacketSize** *int* *Default Value: 262144* Specifies the maximum length of one SSH packet in bytes. **MinWindowSize** *int* *Default Value: 2048* 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. **ObfuscateHandshake** *int* *Default Value: FALSE* Enables or disables handshake obfuscation. **ObfuscationPassword** *char** *Default Value: ""* Specifies the password used to encrypt the handshake when ObfuscateHandshake is set. **PublicKeyAlgorithms** *char** *Default Value: ""* 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 **RequestPasswordChange** *int* *Default Value: FALSE* Whether to request a password change when connecting. **SoftwareName** *char** *Default Value: "SecureBlackbox"* The name to be used by the component to identify itself. **TrustAllKeys** *int* *Default Value: FALSE* Enables or disables explicit trust to all server keys. Use with care. **UseAuthAgent** *int* *Default Value: FALSE* Enables or disables the use of external key agent, such as Putty key agent. **Versions** *int* *Default Value: 1* Specifies enabled SSH protocol versions (1 or 2). ## Constructors ```text SSHSettings() ``` Creates a new object with default settings. # 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. ```text bool CanRead() { return true; } ``` ```text bool CanSeek() { return true; } ``` ```text bool CanWrite() { return true; } ``` ```text int64 GetLength() = 0; ``` ```text void Close() {} ``` ```text int Flush() { return 0; } ``` ```text int Read(void* buffer, int count) = 0; ``` ```text int64 Seek(int64 offset, int seekOrigin) = 0; ``` ```text int Write(const void* buffer, int count) = 0; ``` | | | | --- | --- | | Properties | | | CanRead | Whether the stream supports reading. | | CanSeek | Whether the stream supports seeking. | | CanWrite | Whether the stream supports writing. | | Length | Gets the length of the stream, in bytes. | | Methods | | | Close | Closes the stream, releasing all resources currently allocated for it. 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. 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. 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. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. 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. 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](#sftpclient-class) 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](#config-method-sftpclient-class) method. ### SFTPClient Config Settings **AdjustFileTimes**: Whether file times should be adjusted after upload/download.If this property value is True, file times (creation, access and last modification times) will be adjusted after upload/download operation. **AllAlgorithms**: Returns the list of algorithms enabled in the component.Use this configuration setting to obtain the list of algorithms currently enabled in the component in the *kexinit* format. **ASCIIMode**: Whether ASCII transfer mode is used.When this property is True, ASCII (text) transfer mode is used, otherwise the transfer is performed in binary mode. **AvailableSpace**: Returns details of server disk space availability. This protocol extension must be supported by the server for this request to work.This config property returns the details of the server disk space. The information is provided in the form of semicolon-separated entries: BytesOnDevice, UnusedBytesOnDevice, BytesAvailableToUser, UnusedBytesAvailableToUser, BytesPerAllocationUnit. You can use this property without parameters, or provide a specific mounting point in brackets: AvailableSpace(./path). **CaseConversion**: Whether file names and paths should be case-converted.Defines whether file names are converted (on the destination system) to: lowercase (1), uppercase (2). **CaseSensitive**: Specifies if file paths are case-sensitive.Set this property to True if all file names, paths and file masks should be case-sensitive. **CloseQuietly**: Controls the client's approach to session closure.The quiet closure entails the client shutting down the connection immediately without expecting graceful notifications from the other side. When closing non-quietly, the client will close the connection gradually, starting from the SSH session before proceeding to shutdown-based socket closure. Both options have their pros and cons; choose carefully the option that you want to use going forward. **CommandTimeout**: Specifies the command timeout.Specifies the command timeout (the maximum time to expect the result from the SSH command), in milliseconds. **CompressionAlgorithms**: Returns the list of compression algorithms enabled in the component.Use this configuration setting to get the list of compression algorithms currently enabled in the component, as a respective *kexinit* block line. **CopyMode**: Tunes up the post-transfer action for batch uploads.Use this setting to adjust the post-transfer action for files that are uploaded or downloaded as part of a batch. The following values are supported: - 0 (the default setting) - no post-transfer action. - 1 - delete each file immediately after it has been transferred to the destination system. - 2 - delete all the original files after all the files have been transferred to the destination system. The difference between modes 1 and 2 is about error management. In the latter case, any (and all) files will only be deleted if the entire batch has been transferred successfully. Any transfer error that happens in the middle cancels the deletion. In the former case, each file is deleted right after it has been transferred, independently of the outcome of transfer of other items in the batch. Note that this setting only applies to batch (multi-file_ transfers. It has no effect on single-file transfers. **DefaultTransferBlock**: Specifies the default transfer block size.This setting provides means to adjust the size of the SFTP transfer block (i.e. the size of the content of the write and read packets). It can be used to influence the transfer speed. **DefOutboundBlockSize**: The default outbound block size.Use this property to configure the outbound data block size. **DisablePacketFragmentation**: Enables or disables SSH packet fragmentation.Use this property to enable or disable SSH packet fragmentation. This is one of the settings that is worth a look if encountering unexplained transfer issues. **EarlyIdString**: Enables the proactive approach to SSH handshake.The rule of thumb in the majority of SSH environments is for the server to initiate the handshake with its identification string (and for the client to respond). By setting this property to true you can tell the client to initiate the handshake by sending out the identification string proactively without waiting for the server to send one in. This setting may help in situations where your SSH or SFTP connection fails unexpectedly due to a timeout or network error. **EncryptionAlgorithms**: Returns the list of encryption algorithms enabled in the component.Use this configuration setting to get the list of symmetric encryption algorithms currently enabled in the component, as a respective *kexinit* block line. **ErrorOrigin**: Specifies whether the error is local or remote.Use this property to check where the error took place. **ErrorSeverity**: Specifies whether the error is fatal.Use this property to check whether the error is fatal or not. **FileHash**: Returns the hash of the specified file. This protocol extension must be supported by the server for this request to work.Use this property to request the hash of a remote file. Pass the file name in brackets: FileHash(./path/file.ext). You can adjust the hash algorithm using the HashAlgorithm configuration setting. **HashAlgorithm**: The hash algorithm to use for the protocol operations.Specifies the hash algorithm to use for file protocol operations, such as FileHash. **HomeDir**: Returns a user's home directory. This protocol extension must be supported by the server for this request to work.Use this property to request a specific user's home directory on the server. Provide the username in brackets: HomeDir(user2). **IncomingSpeedLimit**: Specifies incoming speed limit.Use this property to limit the maximum number of bytes per second that client may receive. The value of 0 (zero) means "no limitation". **KeepAlivePeriod**: The inactivity period after which a keep-alive signal will be sent.Use this property to specify tunnel inactivity period (in milliseconds) after which a keep-alive signal will be sent. The default value is 0 (no keep-alive signals). **KexAlgorithms**: Returns the list of key exchange algorithms enabled in the component.Use this configuration setting to get the list of key exchange algorithms currently enabled in the component, as a respective *kexinit* block line. **LocalCharset**: Charset used on the client machine.This property specifies the charset used on the local client computer. **LocalNewLineConvention**: A character string for the end of line (EOL) indication on the local machine.This property contains a character string for the end of line (EOL) indication on the local machine. **MacAlgorithms**: Returns the list of MAC algorithms enabled in the component.Use this configuration setting to get the list of MAC algorithms currently enabled in the component, as a respective *kexinit* block line. **NewLineConvention**: A character string for the end of line (EOL) indication on the server.This property contains a character string for the end of line (EOL) indication used by the server. Usually its value is one of: 0x0d, 0x0d0x0a, 0x0a0x0d, or 0x0a, but it can differ for some servers. **OutgoingSpeedLimit**: Specifies incoming speed limit.Use this property to limit the maximum number of bytes per second that client may send. The value of 0 (zero) means "no limitation". **PreserveExistingFileTimes**: Whether original file times should be restored upon transfer.If the destination file exists and *PreserveExistingFileTimes* option is enabled, the class will remember the file's times before transfer, and restore them after the file has been transferred. The default value is False. **PublicKeyAlgorithms**: Returns the list of public key algorithms enabled in the component.Use this configuration setting to get the list of public key algorithms currently enabled in the component, as a respective *kexinit* block line. **RedirectStdErr**: Whether to redirect output to StdErr.If this property is True, all output will be redirected to StdErr. **RemoteCharset**: Charset used on the server.This property specifies the charset used on the server. **SFTPBufferSize**: The size of internal buffer used for data transfer.Use this property to control the size of the internal buffers used for data transfer. **SFTPServerExecutableLocations**: Location of the SFTP server executable.Specifies the location of the SFTP server executable. **SocketRecvBufferSize**: The inbound socket buffer size.Use this property to adjust the size of the inbound socket buffer. **SocketSendBufferSize**: The outbound socket buffer size.Use this property to adjust the size of the outbound socket buffer. **StatVFS**: Returns VFS details. This protocol extension must be supported by the server for this request to work.This config property returns the VFS details of the server file system. The information is provided in the form of semicolon-separated entries. You can use this property without parameters, or provide a specific mounting point in brackets: StatVFS(./). **StdErrData**: The buffer for writing StdErr data.This property represents a buffer where StdErr data is written by the class. **SuppressAuxTransferOps**: TBD.TBD **TempFolder**: Returns the temporary directory offered by the server. This protocol extension must be supported by the server for this request to work.Use this property to request a path to the temporary directory maintained by the server. **TempPath**: Path for storing temporary files.This setting specifies an absolute path to the location on disk where temporary files are stored. This setting is supported only in the Java edition for all applicable signing components except [PDFSigner](PDFSigner.md#PDFSigner), where this limitation does not apply. **TreatZeroSizeAsUndefined**: Whether zero size returned by STAT should be considered as undefined.This property specifies if the size of zero returned by the STAT command for a particular file should be considered as undefined. It makes sense to set this property to True, because some operating systems (e.g. Unix-based) return zero size for the files of certain type. For instance, most of the files contained in the /proc directory are reported as 0-sized, while actually not being empty. **TryPasswordAuth**: Specifies whether the component should attempt the password-based authentication if no password is set.If the Password property is not set, the component disables the password-based authentication. Set this property to true to make it try the empty password instead. **UseStrictKeyExchange**: Specifies how strict key exchange is supported.This setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the class will indicate support for strict key exchange by automatically including the pseudo-algorithm *kex-strict-c-v00@openssh.com* for client classes and *kex-strict-s-v00@openssh.com* for server classes in the list of supported key exchange algorithms. 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. | **UseTruncateFlagOnUpload**: whether to use the 'truncate' flag on file upload.If this property is True, the existing files are opened truncated on upload, otherwise new files are created. The default value is True. **UseUTF8OnV3**: Whether to apply UTF-8 conversion for SFTP protocol versions 3 and lower.If this property is True, UTF-8 encoding will be applied to file names for SFTP protocol versions 3 and lower. ### Base Config Settings **ASN1UseGlobalTagCache**: Controls whether ASN.1 module should use a global object cache.This is a performance setting. It is unlikely that you will ever need to adjust it. **AssignSystemSmartCardPins**: Specifies whether CSP-level PINs should be assigned to CNG keys.This is a low-level tweak for certain cryptographic providers. It is unlikely that you will ever need to adjust it. **CheckKeyIntegrityBeforeUse**: Enables or disable private key integrity check before use.This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used. You can switch this property off to improve performance if your project only uses known, good private keys. **CookieCaching**: Specifies whether a cookie cache should be used for HTTP(S) transports.Set this property to enable or disable cookies caching for the class. Supported values are: | | | | | --- | --- | --- | | off | | No caching (default) | | local | | Local caching | | global | | Global caching | **Cookies**: Gets or sets local cookies for the class.Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions. **DefDeriveKeyIterations**: Specifies the default key derivation algorithm iteration count.This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided. **DNSLocalSuffix**: The suffix to assign for TLD names.Use this global setting to adjust the default suffix to assign to top-level domain names. The default is *.local*. **EnableClientSideSSLFFDHE**: Enables or disables finite field DHE key exchange support in TLS clients.This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections. This setting only applies to sessions negotiated with TLS version 1.3. **EnableSSHMLKEM**: Enables support for ML-KEM/hybrid key exchange algorithms in SSH client and server components.Use this setting to enable hybrid key exchange algorithms in client and server SSH and SFTP components. This is a global setting that enables ML-KEM blanketly in all SSH-dependent components. **EnableTLSMLKEM**: Enables support for ML-KEM and hybrid groups in TLS client and server components.Use this setting to enable ML-KEM and hybrid key exchange groups in client and server TLS components. This is a global setting that enables ML-KEM blanketly in all TLS-dependent components. **GlobalCookies**: Gets or sets global cookies for all the HTTP transports.Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its *CookieCaching* property set to "global". **HardwareCryptoUsePolicy**: The hardware crypto usage policy.This global setting controls the hardware cryptography usage policy. Supported Values: | | | | --- | --- | | auto | Use hardware cryptography if available; otherwise, fall back to software-based cryptography (default). | | enable | Always attempt to use hardware cryptography. If unavailable, exception will be thrown. | | disable | Do not use hardware cryptography. | **HttpUserAgent**: Specifies the user agent name to be used by all HTTP clients.This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes. **HttpVersion**: The HTTP version to use in any inner HTTP client components created.Set this property to 1.0 or 1.1 to indicate the HTTP version that any internal HTTP clients should use. **IgnoreExpiredMSCTLSigningCert**: Whether to tolerate the expired Windows Update signing certificate.It is not uncommon for Microsoft Windows Update Certificate Trust List to be signed with an expired Microsoft certificate. Setting this global property to true makes SBB ignore the expired factor and take the Trust List into account. **ListDelimiter**: The delimiter character for multi-element lists.Allows to set the delimiter for any multi-entry values returned by the component as a string object, such as file lists. For most of the components, this property is set to a newline sequence. **LogDestination**: Specifies the debug log destination.Contains a comma-separated list of values that specifies where debug log should be dumped. Supported values are: | | | | | --- | --- | --- | | file | | File | | console | | Console | | systemlog | | System Log (supported for Android only) | | debugger | | Debugger (supported for VCL for Windows and .Net) | **LogDetails**: Specifies the debug log details to dump.Contains a comma-separated list of values that specifies which debug log details to dump. Supported values are: | | | | | --- | --- | --- | | time | | Current time | | level | | Level | | package | | Package name | | module | | Module name | | class | | Class name | | method | | Method name | | threadid | | Thread Id | | contenttype | | Content type | | content | | Content | | all | | All details | **LogFile**: Specifies the debug log filename.Use this property to provide a path to the log file. **LogFilters**: Specifies the debug log filters.Contains a comma-separated list of value pairs ("name:value") that describe filters. Supported filter names are: | | | | | --- | --- | --- | | exclude-package | | Exclude a package specified in the value | | exclude-module | | Exclude a module specified in the value | | exclude-class | | Exclude a class specified in the value | | exclude-method | | Exclude a method specified in the value | | include-package | | Include a package specified in the value | | include-module | | Include a module specified in the value | | include-class | | Include a class specified in the value | | include-method | | Include a method specified in the value | **LogFlushMode**: Specifies the log flush mode.Use this property to set the log flush mode. The following values are defined: | | | | | --- | --- | --- | | none | | No flush (caching only) | | immediate | | Immediate flush (real-time logging) | | maxcount | | Flush cached entries upon reaching LogMaxEventCount entries in the cache. | **LogLevel**: Specifies the debug log level.Use this property to provide the desired debug log level. Supported values are: | | | | | --- | --- | --- | | none | | None (by default) | | fatal | | Severe errors that cause premature termination. | | error | | Other runtime errors or unexpected conditions. | | warning | | Use of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong". | | info | | Interesting runtime events (startup/shutdown). | | debug | | Detailed information on flow of through the system. | | trace | | More detailed information. | **LogMaxEventCount**: Specifies the maximum number of events to cache before further action is taken.Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode. The default value of this setting is 100. **LogRotationMode**: Specifies the log rotation mode.Use this property to set the log rotation mode. The following values are defined: | | | | | --- | --- | --- | | none | | No rotation | | deleteolder | | Delete older entries from the cache upon reaching LogMaxEventCount | | keepolder | | Keep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded) | **MaxASN1BufferLength**: Specifies the maximal allowed length for ASN.1 primitive tag data.This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks. **MaxASN1TreeDepth**: Specifies the maximal depth for processed ASN.1 trees.This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks. **OCSPHashAlgorithm**: Specifies the hash algorithm to be used to identify certificates in OCSP requests.This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful. **OldClientSideRSAFallback**: Specifies whether the SSH client should use a SHA1 fallback.Tells the SSH client to use a legacy ssh-rsa authentication even if the server indicates support for newer algorithms, such as rsa-sha-256. This is a backward-compatibility tweak. **PKICache**: Specifies which PKI elements (certificates, CRLs, OCSP responses) should be cached.The PKICache setting specifies which Public Key Infrastructure (PKI) elements should be cached to optimize performance and reduce retrieval times. It supports comma-separated values to indicate the specific types of PKI data that should be cached. Supported Values: | | | | --- | --- | | certificate | Enables caching of certificates. | | crl | Enables caching of Certificate Revocation Lists (CRLs). | | ocsp | Enables caching of OCSP (Online Certificate Status Protocol) responses. | Example (default value): ```text PKICache=certificate,crl,ocsp ``` In this example, the component caches certificates, CRLs, and OCSP responses. **PKICachePath**: Specifies the file system path where cached PKI data is stored.The PKICachePath setting defines the file system path where cached PKI data (e.g., certificates, CRLs, OCSP responses and Trusted Lists) will be stored. This allows the system to persistently save and retrieve PKI cache data, even across application restarts. The default value is an empty string - no cached PKI data is stored on disk. Example: ```text PKICachePath=C:\Temp\cache ``` In this example, the cached PKI data is stored in the C:\Temp\cache directory. **ProductVersion**: Returns the version of the SecureBlackbox library.This property returns the long version string of the SecureBlackbox library being used (major.minor.build.revision). **ServerSSLDHKeyLength**: Sets the size of the TLS DHE key exchange group.Use this property to adjust the length, in bits, of the DHE prime to be used by the TLS server. **StaticDNS**: Specifies whether static DNS rules should be used.Set this property to enable or disable static DNS rules for the class. Works only if *UseOwnDNSResolver* is set to *true*. Supported values are: | | | | | --- | --- | --- | | none | | No static DNS rules (default) | | local | | Local static DNS rules | | global | | Global static DNS rules | **StaticIPAddress[domain]**: Gets or sets an IP address for the specified domain name.Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the *StaticDNS* value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are divided by the | (pipe) character. **StaticIPAddresses**: Gets or sets all the static DNS rules.Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If *StaticDNS* of the class is set to "*local*", the property returns/restores the rules from/to the internal storage of the class. If *StaticDNS* of the class is set to "*global*", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format. **Tag**: Allows to store any custom data.Use this config property to store any custom data. **TLSSessionGroup**: Specifies the group name of TLS sessions to be used for session resumption.Use this property to limit the search of cached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes. **TLSSessionLifetime**: Specifies lifetime in seconds of the cached TLS session.Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes). **TLSSessionPurgeInterval**: Specifies how often the session cache should remove the expired TLS sessions.Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute). **UseCRLObjectCaching**: Specifies whether reuse of loaded CRL objects is enabled.This setting enables or disables the caching of CRL objects. When set to true (the default value), the system checks if a CRL object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where CRL objects are frequently used. **UseInternalRandom**: Switches between SecureBlackbox-own and platform PRNGs.Allows to switch between internal/native PRNG implementation and the one provided by the platform. **UseLegacyAdESValidation**: Enables legacy AdES validation mode.Use this setting to switch the AdES component to the validation approach that was used in SBB 2020/SBB 2022 (less attention to temporal details). **UseOCSPResponseObjectCaching**: Specifies whether reuse of loaded OCSP response objects is enabled.This setting enables or disables the caching of OCSP response objects. When set to true (the default value), the system checks if a OCSP response object is already loaded in memory before attempting to load a new instance. If the object is found, the existing instance is reused, and its reference count is incremented to track its usage. When the reference count reaches zero, indicating that no references to the object remain, the system will free the object from memory. This setting enhances performance by minimizing unnecessary object instantiation and promotes efficient memory management, particularly in scenarios where OCSP response objects are frequently used. **UseOwnDNSResolver**: Specifies whether the client components should use own DNS resolver.Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one. **UseSharedSystemStorages**: Specifies whether the validation engine should use a global per-process copy of the system certificate stores.Set this global property to false to make each validation run use its own copy of system certificate stores. **UseSystemNativeSizeCalculation**: An internal CryptoAPI access tweak.This is an internal setting. Please do not use it unless instructed by the support team. **UseSystemOAEPAndPSS**: Enforces or disables the use of system-driven RSA OAEP and PSS computations.This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation. This setting only applies to certificates originating from a Windows system store. **UseSystemRandom**: Enables or disables the use of the OS PRNG.Use this global property to enable or disable the use of operating system-driven pseudorandom number generation. **XMLRDNDescriptorName[OID]**: Defines an OID mapping to descriptor names for the certificate's IssuerRDN or SubjectRDN.This property defines custom mappings between Object Identifiers (OIDs) and descriptor names. This mapping specifies how the certificate's issuer and subject information (ds:IssuerRDN and ds:SubjectRDN elements respectively) are represented in XML signatures. The property accepts comma-separated values where the first descriptor name is used when the OID is mapped, and subsequent values act as aliases for parsing. Syntax: ```text Config("XMLRDNDescriptorName[OID]=PrimaryName,Alias1,Alias2"); ``` Where: OID: The Object Identifier from the certificate's IssuerRDN or SubjectRDN that you want to map. PrimaryName: The main descriptor name used in the XML signature when the OID is encountered. Alias1, Alias2, ...: Optional alternative names recognized during parsing. Usage Examples: Map OID 2.5.4.5 to SERIALNUMBER: ```text Config("XMLRDNDescriptorName[2.5.4.5]=SERIALNUMBER"); ``` Map OID 1.2.840.113549.1.9.1 to E, with aliases EMAIL and EMAILADDRESS: ```text Config("XMLRDNDescriptorName[1.2.840.113549.1.9.1]=E,EMAIL,EMAILADDRESS"); ``` **XMLRDNDescriptorPriority[OID]**: Specifies the priority of descriptor names associated with a specific OID.This property specifies the priority of descriptor names associated with a specific OID that allows to reorder descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during signing. **XMLRDNDescriptorReverseOrder**: Specifies whether to reverse the order of descriptors in RDN.Specifies whether to reverse the order of descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to true (as specified in RFC 2253, 2.1). **XMLRDNDescriptorSeparator**: Specifies the separator used between descriptors in RDN.Specifies the separator used between descriptors in the ds:IssuerRDN and ds:SubjectRDN elements during XML signing. By default, this property is set to ", " value. # Trappable Errors ([SFTPClient](#sftpclient-class) 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 ([SB_ERROR_INVALID_PARAMETER](constants.md#const_SBERRORINVALIDPARAMETER)) | | 1048578 | Invalid configuration ([SB_ERROR_INVALID_SETUP](constants.md#const_SBERRORINVALIDSETUP)) | | 1048579 | Invalid state ([SB_ERROR_INVALID_STATE](constants.md#const_SBERRORINVALIDSTATE)) | | 1048580 | Invalid value ([SB_ERROR_INVALID_VALUE](constants.md#const_SBERRORINVALIDVALUE)) | | 1048581 | Private key not found ([SB_ERROR_NO_PRIVATE_KEY](constants.md#const_SBERRORNOPRIVATEKEY)) | | 1048582 | Cancelled by the user ([SB_ERROR_CANCELLED_BY_USER](constants.md#const_SBERRORCANCELLEDBYUSER)) | | 1048583 | The file was not found ([SB_ERROR_NO_SUCH_FILE](constants.md#const_SBERRORNOSUCHFILE)) | | 1048584 | Unsupported feature or operation ([SB_ERROR_UNSUPPORTED_FEATURE](constants.md#const_SBERRORUNSUPPORTEDFEATURE)) | | 1048585 | General error ([SB_ERROR_GENERAL_ERROR](constants.md#const_SBERRORGENERALERROR)) | | 31457281 | Unsupported file operation ([SB_ERROR_SFTP_UNSUPPORTED_FILE_OPERATION](constants.md#const_SBERRORSFTPUNSUPPORTEDFILEOPERATION)) | | 31457282 | Invalid authentication type ([SB_ERROR_SFTP_INVALID_AUTH_TYPE](constants.md#const_SBERRORSFTPINVALIDAUTHTYPE)) |