Discuss this help topic in SecureBlackbox Forum

TElSimpleSFTPClient class

Properties     Methods     Events     Declared in     Licensing     


TElSimpleSFTPClient provides client-side functionality for SFTP (Secure File Transfer Protocol). It is a descendant of TElSSHBaseClient.

Description

TElSimpleSFTPClient is an implementation for SSH File Transfer Protocol. It works over a secure SSH channel, and has nothing in common with the 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. TElSimpleSFTPClient implementation is synchronous.

To use external socket class, set UseInternalSocket property to False, and handle OnSend/OnReceive events. To let TElSimpleSFTPClient use internal socket, just set the values of the 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

Inherited from TElSSHBaceClient Inherited from TElBaseSocketClient

Methods

Inherited from TElSSHBaseClient Inherited from TElBaseSocketClient

Events

Inherited from TElSSHBaseClient Inherited from TElBaseSocketClient

Declared in

.NET:
  • Namespace: SBSimpleSFTP
  • Assembly: SecureBlackbox.SFTP
VCL:
  • Unit: SBSimpleSFTP
Java:
  • Package: SecureBlackbox.SFTP.jar
C++:
  • sbsimplesftp.h

Licensing

To use this class in the development and distribution of your software projects, you need to purchase one of the following licenses:

SecureBlackbox Professional, SecureBlackbox Standard, SecureBlackbox Lite

Discuss this help topic in SecureBlackbox Forum