TElSimpleSftpClient class

Navigation

TElSimpleSftpClient class Properties Methods Events Declared in Licensing
TElSimpleSftpClient provides client-side functionality for SFTP (Secure File Transfer Protocol).

Description ElSimpleSftpClient is an implementation for SSH File Transfer Protocol. It works over secure SSH channel (and has nothing common with FTP protocol). SFTP works as a subsystem of SSHv2 protocol, i.e. SFTP negotiation flow is the following: TCP connection is established Secure SSH connection is established SFTP handshake is performed over SSH channel To add SFTP support to your product you should perform the following sequence of operations: Create the instance of TElSimpleSftpClient class. Set up the TElSimpleSftpClient (specify address/port, authentication parameters etc.). Call TElSimpleSftpClient.Open method. Please note that this method is synchronous (i.e. it will return when the connection is established or the error happens during connection attempt). After SFTP connection is successfully started, you may perform any necessary file operations. The TElSimpleSftpClient implementation is synchronous. To use external socket class set UseInternalSocket property to False and use OnSend/OnReceive events. To let TElSimpleSftpClient use internal socket just set values for Address and Port properties. See Increasing SFTP speed article for details about how to achieve maximum data transfer speed. This component supports FIPS compliant mode. For more information, read the corresponding article.

Properties Active AdjustFileTimes AuthAttempts AutoAdjustCiphers Address ASCIIMode AuthenticationTypes AuthTypePriorities AutoAdjustTransferBlock ClientHostname ClientUsername CompressionAlgorithmClientToServer CompressionAlgorithmPriorities CompressionAlgorithms CompressionAlgorithmServerToClient CompressionLevel CurrentOperationCancel CurrentOperationLocalFilename CurrentOperationRemoteFilename CurrentOperationProcessedInFile CurrentOperationTotalInFile OperationErrorHandling DefaultWindowSize DownloadBlockSize EncryptionAlgorithmClientToServer EncryptionAlgorithmPriorities EncryptionAlgorithms EncryptionAlgorithmServerToClient ExtendedProperties FIPSMode FileSystemAdapter ForceCompression IncomingSpeedLimit KbdIntName KbdIntInstruction KexAlgorithm KexAlgorithmPriorities KexAlgorithms KeyStorage LastSyncComment LastSyncError LocalAddress LocalNewLineConvention LocalPort MacAlgorithmClientToServer MacAlgorithmPriorities MacAlgorithms MacAlgorithmServerToClient MaxSSHPacketSize MinWindowSize NewLineConvention OutgoingSpeedLimit Password PipelineLength Port ProxyResult PublicKeyAlgorithm PublicKeyAlgorithmPriorities PublicKeyAlgorithms RequestPasswordChange ServerCloseReason ServerSoftwareName ServerKey SFTPExt SSHAuthOrder SoftwareName TotalBytesReceived TotalBytesSent TreatZeroSizeAsUndefined TrustedKeys UploadBlockSize UseInternalSocket Username UseUTF8 UseUTF8OnV3 Version Versions UseIPv6 UsingIPv6 SocksUseIPv6 SocketBinding SocketTimeout SocksAuthentication SocksPassword SocksPort SocksResolveAddress SocksServer SocksUserCode SocksVersion TransferBlockSize UseSocks UseTruncateFlagOnUpload UseWebTunneling WebTunnelAddress WebTunnelAuthentication WebTunnelPassword WebTunnelPort WebTunnelRequestHeaders WebTunnelResponseBody WebTunnelResponseHeaders WebTunnelUserId

Methods Constructor Destructor Block Close CloseHandle CopyRemoteData CopyRemoteFile CreateFile CreateHardLink CreateSymLink DownloadFile DownloadFiles DownloadStream ListDirectory MakeDirectory MakeTempFolder Open OpenFile OpenDirectory QueryAvailableSpace QueryHomeDirectory Read ReadDirectory ReadSymLink RemoveDirectory RemoveFile RemoveFiles RenameFile RenegotiateCiphers RequestAbsolutePath RequestAbsolutePathEx RequestAttributes RequestFileHash RequestFileHashByHandle RequestTempFolder SetAttributes SetAttributesByHandle TextSeek Unblock UploadFile UploadFiles UploadStream Write

Events MessageLoop OnAuthenticationAttempt OnAuthenticationFailed OnAuthenticationKeyboard OnAuthenticationStart OnAuthenticationSuccess OnBanner OnCiphersNegotiated OnCloseConnection OnDNSKeyNeeded OnDNSKeyValidate OnDNSResolve OnError OnFileOperation OnFileOperationResult OnKeyValidate OnPasswordChangeRequest OnPrivateKeyNeded OnProgress OnReceive OnSend

Declared in .NET: Namespace: SBSimpleSFTP Assembly: SecureBlackbox.SFTP VCL: Unit: SBSimpleSFTP ActiveX/DLL: SBB 5 interface module: SFTPBBoxCli.dll SBB 6 interface module: SFTPBBoxCli6.dll

Licensing To use the component in development and distribution of your projects, you need to purchase one of the licenses: .NET: SFTPBlackbox client-only OR SFTPBlackbox client-server OR SecureBlackbox Transports OR SecureBlackbox Standard OR SecureBlackbox Professional VCL: SFTPBlackbox client-only OR SFTPBlackbox client-server OR SecureBlackbox Transports OR SecureBlackbox Standard OR SecureBlackbox Professional ActiveX/DLL: SFTPBlackbox client-only OR SecureBlackbox Transports OR SecureBlackbox Standard