SFTPClient Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.SecureBlackbox.Sftpclient

Remarks

SFTP is a file transfer subsystem that runs on top of secure shell (SSH) connection. This means that SFTP uses the whole strength of security provided by the SSH protocol, at the same time providing strong file transfer capabilities.

Please do keep in mind that there exist two protocols that offer similar secure file transfer features. SFTP works on top of SSH and normally uses port 22. FTPS works on top of TLS (or SSL) and normally uses ports 21 and 990. The protocols are very different, so please make sure you are after the right component. This component works with SFTP. Use the FTPClient component to connect to FTPS servers.

Below are the typical steps that let you integrate SFTPClient to your project:

• Set up your Username and Password. SSH uses mandatory client-side authentication, so in most cases you need to provide your username, your password, or, sometimes, your private key. Use Key property to provide your key, if needed.
• Be ready to handle server authentication, which is also mandatory in SSH. SSH operates a concept of a trusted keys file, where keys of known servers are stored. You can assign a path to your own trusted keys file to the TrustedKeysFile property. When a client receives a server key, it reports it to your code via its KnownKeyReceived or UnknownKeyReceived event, depending on whether the key was found in the trusted list. If you leave TrustedKeysFile empty, SFTPClient will only be able to fire the UnknownKeyReceived event, since there will be no known keys to report.
• If needed, customize Proxy parameters and SSHSettings.
• Consider interacting more with SFTPClient by subscribing to AuthAttempt, AuthFailed, and AuthSucceeded events to be notified about the client authentication progress.
• When you are ready to connect, call Connect, passing the details of the server as parameters. During the initial handshake, the following events will fire: UnknownKeyReceived (or KnownKeyReceived), and then one or more AuthAttempt, AuthFailed and AuthSucceeded.
• Upon completion of the Connect method, the component is ready for file operations. Use DownloadFile, UploadFile, ListDir, DeleteFile and other file transfer methods to work with the server file system.
• When you are done with your work, call Disconnect to close the connection.

Some SFTP servers, primarily older ones, may expose various transfer issues. If you come across a weird issue that you believe should not be happening (such as repeated connection closures in the middle of the transfer), please try adjusting the following properties:

• AutoAdjustTransferBlock to false,
• PipelineLength to 1,
• UploadBlockSize to 16384,
• DownloadBlockSize to 16384.

Property List

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

Method List

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

Event List

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

Config Settings

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

AuthAttempts Property (SFTPClient Component)

Specifies the number of SSH authentication attempts.

Syntax

• C#
• VB.NET

public int AuthAttempts { get; set; }

Public Property AuthAttempts As Integer

Default Value

1

Remarks

Use this property to specify the number of authentication attempts to try. The AuthFailed event is fired for every failed attempt.

AutoAdjustTransferBlock Property (SFTPClient Component)

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

Syntax

• C#
• VB.NET

public bool AutoAdjustTransferBlock { get; set; }

Public Property AutoAdjustTransferBlock As Boolean

Default Value

True

Remarks

Automatic transfer block size adjustment may be beneficial for maximizing interoperability and achieving the best transfer speeds.

Use DownloadBlockSize, UploadBlockSize, and PipelineLength properties to adjust the transfer settings manually.

Connected Property (SFTPClient Component)

Indicates if the client is connected to the SFTP server.

Syntax

• C#
• VB.NET

public bool Connected { get; }

Public ReadOnly Property Connected As Boolean

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.

ConnectionInfo Property (SFTPClient Component)

Contains the secure connection info.

Syntax

• C#
• VB.NET

public SSHInfo ConnectionInfo { get; }

Public ReadOnly Property ConnectionInfo As SSHInfo

Remarks

This property contains various information about the secure connection.

This property is read-only.

CurrentListEntry Property (SFTPClient Component)

Contains the current entry returned by ListDir .

Syntax

• C#
• VB.NET

public SFTPListEntry CurrentListEntry { get; }

Public ReadOnly Property CurrentListEntry As SFTPListEntry

Remarks

Use this property to access the current list entry as returned by ListDir call. Entries are passed back to the application one by one, with ListEntry thrown for each entry.

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

DownloadBlockSize Property (SFTPClient Component)

The download block size in bytes.

Syntax

• C#
• VB.NET

public int DownloadBlockSize { get; set; }

Public Property DownloadBlockSize As Integer

Default Value

65536

Remarks

Use this property to manually control the size of download blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

ExternalCrypto Property (SFTPClient Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on OnExternalSign event) and asynchronous (based on DC protocol and DCAuth signing component).

This property is read-only.

FIPSMode Property (SFTPClient Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

ForceCompression Property (SFTPClient Component)

Enforces compression for the SSH layer.

Syntax

• C#
• VB.NET

public bool ForceCompression { get; set; }

Public Property ForceCompression As Boolean

Default Value

False

Remarks

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

Key Property (SFTPClient Component)

Contains the client's SSH key.

Syntax

• C#
• VB.NET

public SSHKey Key { get; set; }

Public Property Key As SSHKey

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

Alternative, you may load the private key straightaway.

This property is not available at design time.

MaxSFTPVersion Property (SFTPClient Component)

Higher SFTP version to support.

Syntax

• C#
• VB.NET

public int MaxSFTPVersion { get; set; }

Public Property MaxSFTPVersion As Integer

Default Value

6

Remarks

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

MinSFTPVersion Property (SFTPClient Component)

Lower SFTP version to support.

Syntax

• C#
• VB.NET

public int MinSFTPVersion { get; set; }

Public Property MinSFTPVersion As Integer

Default Value

0

Remarks

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

Password Property (SFTPClient Component)

Specifies user's authentication password.

Syntax

• C#
• VB.NET

public string Password { get; set; }

Public Property Password As String

Default Value

""

Remarks

Use this property to provide an authentication password. This property is only applicable for password-based and keyboard-interactive authentication types.

PipelineLength Property (SFTPClient Component)

The number of parallelized transfer requests.

Syntax

• C#
• VB.NET

public int PipelineLength { get; set; }

Public Property PipelineLength As Integer

Default Value

32

Remarks

This property controls the number of upload/download requests sent simultaneously. This speeds the transfer up, but may lead to issues with older/immature servers.

Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Proxy Property (SFTPClient Component)

The proxy server settings.

Syntax

• C#
• VB.NET

public ProxySettings Proxy { get; }

Public ReadOnly Property Proxy As ProxySettings

Remarks

Use this property to tune up the proxy server settings.

This property is read-only.

ServerKey Property (SFTPClient Component)

Returns the server's public key.

Syntax

• C#
• VB.NET

public SSHKey ServerKey { get; }

Public ReadOnly Property ServerKey As SSHKey

Remarks

Use this property to check the details of the server public key.

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

SocketSettings Property (SFTPClient Component)

Manages network connection settings.

Syntax

• C#
• VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

SSHSettings Property (SFTPClient Component)

The SSH connection settings.

Syntax

• C#
• VB.NET

public SSHSettings SSHSettings { get; }

Public ReadOnly Property SSHSettings As SSHSettings

Remarks

Use this property to access and tune-up the SSH layer settings.

This property is read-only.

TrustedKeysFile Property (SFTPClient Component)

A file containing the keys of authorized servers.

Syntax

• C#
• VB.NET

public string TrustedKeysFile { get; set; }

Public Property TrustedKeysFile As String

Default Value

""

Remarks

Use this property to provide a path to the 'authorized_keys' file to be used by the client.

UploadBlockSize Property (SFTPClient Component)

The upload block size in bytes.

Syntax

• C#
• VB.NET

public int UploadBlockSize { get; set; }

Public Property UploadBlockSize As Integer

Default Value

32256

Remarks

Use this property to manually control the size of upload blocks. Typically you will only need to adjust this property if the default transfer settings (AutoAdjustTransferBlock) don't work.

Username Property (SFTPClient Component)

The client's username to authenticate to the server.

Syntax

• C#
• VB.NET

public string Username { get; set; }

Public Property Username As String

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.

UseUTF8 Property (SFTPClient Component)

Enables UTF8 for all string content.

Syntax

• C#
• VB.NET

public bool UseUTF8 { get; set; }

Public Property UseUTF8 As Boolean

Default Value

False

Remarks

If UseUTF8 is true, the component 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.

Version Property (SFTPClient Component)

The SFTP version negotiated.

Syntax

• C#
• VB.NET

public int Version { get; }

Public ReadOnly Property Version As Integer

Default Value

0

Remarks

Use this property to get the negotiated SFTP version.

This property is read-only.

AbsolutePath Method (SFTPClient Component)

Requests the absolute path for a relative path.

Syntax

• C#
• VB.NET

public string AbsolutePath(string remotePath);

Public Function AbsolutePath(ByVal RemotePath As String) As String

Remarks

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

ChangeDir Method (SFTPClient Component)

Changes current working directory on the server.

Syntax

• C#
• VB.NET

public void ChangeDir(string remoteDir);

Public Sub ChangeDir(ByVal RemoteDir As String)

Remarks

Changes current working directory on the server to RemoteDir.

Config Method (SFTPClient Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (SFTPClient Component)

Connects to an SFTP server.

Syntax

• C#
• VB.NET

public void Connect(string address, int port);

Public Sub Connect(ByVal Address As String, ByVal Port As Integer)

Remarks

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

CreateLink Method (SFTPClient Component)

Creates a symbolic or hard link to a remote file.

Syntax

• C#
• VB.NET

public void CreateLink(string linkPath, string targetPath, bool hardLink);

Public Sub CreateLink(ByVal LinkPath As String, ByVal TargetPath As String, ByVal HardLink As Boolean)

Remarks

Use this method to create a symbolic or hard link on the server. Provide the name of the new link object via the LinkPath parameter, and the destinating file or directory path via the TargetPath parameter. HardLink specifies whether the new link should be hard (true) or symbolic (false).

DeleteDir Method (SFTPClient Component)

Removes directory from the SFTP server.

Syntax

• C#
• VB.NET

public void DeleteDir(string remoteDir);

Public Sub DeleteDir(ByVal RemoteDir As String)

Remarks

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

DeleteFile Method (SFTPClient Component)

Deletes a file from the SFTP server.

Syntax

• C#
• VB.NET

public void DeleteFile(string remoteFile);

Public Sub DeleteFile(ByVal RemoteFile As String)

Remarks

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

DeleteFiles Method (SFTPClient Component)

Deletes a group of files from the SFTP server.

Syntax

• C#
• VB.NET

public void DeleteFiles(string remotePath, string mask, bool caseSensitive, bool recursive);

Public Sub DeleteFiles(ByVal RemotePath As String, ByVal Mask As String, ByVal CaseSensitive As Boolean, ByVal Recursive As Boolean)

Remarks

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

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

DirExists Method (SFTPClient Component)

Checks if a directory exists on the SFTP server.

Syntax

• C#
• VB.NET

public bool DirExists(string remoteDir);

Public Function DirExists(ByVal RemoteDir As String) As Boolean

Remarks

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

Disconnect Method (SFTPClient Component)

Disconnects from the SFTP server.

Syntax

• C#
• VB.NET

public void Disconnect();

Public Sub Disconnect()

Remarks

Call this method to disconnect from the SFTP server.

DoAction Method (SFTPClient Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insencitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DownloadBytes Method (SFTPClient Component)

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

Syntax

• C#
• VB.NET

public byte[] DownloadBytes(string remoteFile);

Public Function DownloadBytes(ByVal RemoteFile As String) As String

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (SFTPClient Component)

Downloads a file from the SFTP server.

Syntax

• C#
• VB.NET

public void DownloadFile(string remoteFile, string localFile);

Public Sub DownloadFile(ByVal RemoteFile As String, ByVal LocalFile As String)

Remarks

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

DownloadFiles Method (SFTPClient Component)

Downloads multiple files from the SFTP server.

Syntax

• C#
• VB.NET

public void DownloadFiles(string remotePath, string localDir);

Public Sub DownloadFiles(ByVal RemotePath As String, ByVal LocalDir As String)

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.

DownloadStream Method (SFTPClient Component)

Downloads a file from the SFTP server.

Syntax

• C#
• VB.NET

public void DownloadStream(string remoteFile, System.IO.Stream localStream);

Public Sub DownloadStream(ByVal RemoteFile As String, ByVal LocalStream As System.IO.Stream)

Remarks

Use this method to download RemoteFile into a LocalStream object.

ExecuteSSHCommand Method (SFTPClient Component)

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

Syntax

• C#
• VB.NET

public byte[] ExecuteSSHCommand(string command);

Public Function ExecuteSSHCommand(ByVal Command As String) As Byte()

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.

ExtensionCmd Method (SFTPClient Component)

Sends an extension command to the server.

Syntax

• C#
• VB.NET

public byte[] ExtensionCmd(string extn, byte[] dataBuffer);

Public Function ExtensionCmd(ByVal Extn As String, ByVal DataBuffer As Byte()) As Byte()

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.

FileExists Method (SFTPClient Component)

Checks whether a file exists on the server.

Syntax

• C#
• VB.NET

public bool FileExists(string remoteFile);

Public Function FileExists(ByVal RemoteFile As String) As Boolean

Remarks

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

GetCurrentDir Method (SFTPClient Component)

Returns the current directory on the SFTP server.

Syntax

• C#
• VB.NET

public string GetCurrentDir();

Public Function GetCurrentDir() As String

Remarks

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

GetFileSize Method (SFTPClient Component)

Checks the size of a remote file.

Syntax

• C#
• VB.NET

public long GetFileSize(string remoteFile);

Public Function GetFileSize(ByVal RemoteFile As String) As Long

Remarks

Returns the size of the RemoteFile.

ListDir Method (SFTPClient Component)

Lists the content of the current remote directory.

Syntax

• C#
• VB.NET

public string ListDir(bool includeFiles, bool includeDirectories);

Public Function ListDir(ByVal IncludeFiles As Boolean, ByVal IncludeDirectories As Boolean) As String

Remarks

IncludeFiles specifies whether file names and symlinks should be included in the results. IncludeDirectories specifies whether directory names should be included in the result.

Upon receiving the listing, the component will report each entry in it via ListEntry event.

MakeDir Method (SFTPClient Component)

Creates a new directory on the server.

Syntax

• C#
• VB.NET

public void MakeDir(string remoteDir);

Public Sub MakeDir(ByVal RemoteDir As String)

Remarks

RemoteDir specifies the name of the new directory.

RenameFile Method (SFTPClient Component)

Renames a file.

Syntax

• C#
• VB.NET

public void RenameFile(string sourceFile, string destFile);

Public Sub RenameFile(ByVal SourceFile As String, ByVal DestFile As String)

Remarks

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

RequestAttributes Method (SFTPClient Component)

Requests attributes of the remote file.

Syntax

• C#
• VB.NET

public string RequestAttributes(string remotePath, bool followSymLinks);

Public Function RequestAttributes(ByVal RemotePath As String, ByVal FollowSymLinks As Boolean) As String

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.

SetAttributes Method (SFTPClient Component)

Sets the attributes upon a remote file.

Syntax

• C#
• VB.NET

public void SetAttributes(string remotePath, string attributes);

Public Sub SetAttributes(ByVal RemotePath As String, ByVal Attributes As String)

Remarks

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

UploadBytes Method (SFTPClient Component)

Uploads a byte array to the server.

Syntax

• C#
• VB.NET

public void UploadBytes(byte[] bytes, string remoteFile);

Public Sub UploadBytes(ByVal Bytes As String, ByVal RemoteFile As String)

Remarks

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

UploadFile Method (SFTPClient Component)

Uploads a file to the server.

Syntax

• C#
• VB.NET

public void UploadFile(string localFile, string remoteFile);

Public Sub UploadFile(ByVal LocalFile As String, ByVal RemoteFile As String)

Remarks

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

UploadFiles Method (SFTPClient Component)

Uploads multiple files to the server.

Syntax

• C#
• VB.NET

public void UploadFiles(string localPath, string remoteDir);

Public Sub UploadFiles(ByVal LocalPath As String, ByVal RemoteDir As String)

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.

UploadStream Method (SFTPClient Component)

Uploads a file to the server.

Syntax

• C#
• VB.NET

public void UploadStream(System.IO.Stream localStream, string remoteFile);

Public Sub UploadStream(ByVal LocalStream As System.IO.Stream, ByVal RemoteFile As String)

Remarks

Use this method to upload the contents of LocalStream to the RemoteFile location on the server.

AuthAttempt Event (SFTPClient Component)

Fires when an authentication attempt is performed.

Syntax

• C#
• VB.NET

public event OnAuthAttemptHandler OnAuthAttempt;

public delegate void OnAuthAttemptHandler(object sender, SftpclientAuthAttemptEventArgs e);

public class SftpclientAuthAttemptEventArgs : EventArgs {
  public int AuthType { get; }
}

Public Event OnAuthAttempt As OnAuthAttemptHandler

Public Delegate Sub OnAuthAttemptHandler(sender As Object, e As SftpclientAuthAttemptEventArgs)

Public Class SftpclientAuthAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property AuthType As Integer
End Class

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:

AuthFailed Event (SFTPClient Component)

Fires if an authentication attempt fails.

Syntax

• C#
• VB.NET

public event OnAuthFailedHandler OnAuthFailed;

public delegate void OnAuthFailedHandler(object sender, SftpclientAuthFailedEventArgs e);

public class SftpclientAuthFailedEventArgs : EventArgs {
  public int AuthType { get; }
}

Public Event OnAuthFailed As OnAuthFailedHandler

Public Delegate Sub OnAuthFailedHandler(sender As Object, e As SftpclientAuthFailedEventArgs)

Public Class SftpclientAuthFailedEventArgs Inherits EventArgs
  Public ReadOnly Property AuthType As Integer
End Class

Remarks

This event fires if an authentication attempt fails (for example, if a bad password had been provided). AuthType parameter indicates the authentication type.

AuthFailed may be fired more than once, depending on the configured authentication parameters and the value assigned to the AuthAttempts property.

This event does not necessarily lead to connection abortion, as the client may still have a chance of authenticating with a different method.

Supported authentication types:

AuthSucceeded Event (SFTPClient Component)

Reports a successful authentication.

Syntax

• C#
• VB.NET

public event OnAuthSucceededHandler OnAuthSucceeded;

public delegate void OnAuthSucceededHandler(object sender, SftpclientAuthSucceededEventArgs e);

public class SftpclientAuthSucceededEventArgs : EventArgs {
}

Public Event OnAuthSucceeded As OnAuthSucceededHandler

Public Delegate Sub OnAuthSucceededHandler(sender As Object, e As SftpclientAuthSucceededEventArgs)

Public Class SftpclientAuthSucceededEventArgs Inherits EventArgs
End Class

Remarks

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

Banner Event (SFTPClient Component)

Reports the receipt of the Welcome message from the server.

Syntax

• C#
• VB.NET

public event OnBannerHandler OnBanner;

public delegate void OnBannerHandler(object sender, SftpclientBannerEventArgs e);

public class SftpclientBannerEventArgs : EventArgs {
  public byte[] Text { get; }
  public byte[] Language { get; }
}

Public Event OnBanner As OnBannerHandler

Public Delegate Sub OnBannerHandler(sender As Object, e As SftpclientBannerEventArgs)

Public Class SftpclientBannerEventArgs Inherits EventArgs
  Public ReadOnly Property Text As Byte()
  Public ReadOnly Property Language As Byte()
End Class

Remarks

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

Disconnect Event (SFTPClient Component)

Reports SFTP connection closure.

Syntax

• C#
• VB.NET

public event OnDisconnectHandler OnDisconnect;

public delegate void OnDisconnectHandler(object sender, SftpclientDisconnectEventArgs e);

public class SftpclientDisconnectEventArgs : EventArgs {
  public int CloseReason { get; }
}

Public Event OnDisconnect As OnDisconnectHandler

Public Delegate Sub OnDisconnectHandler(sender As Object, e As SftpclientDisconnectEventArgs)

Public Class SftpclientDisconnectEventArgs Inherits EventArgs
  Public ReadOnly Property CloseReason As Integer
End Class

Remarks

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

Error Event (SFTPClient Component)

Information about errors during SFTP connection.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SftpclientErrorEventArgs e);

public class SftpclientErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SftpclientErrorEventArgs)

Public Class SftpclientErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The event is fired in case of exceptional conditions during data transfer.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of error codes please refer to SFTP.

ExternalSign Event (SFTPClient Component)

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

Syntax

• C#
• VB.NET

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, SftpclientExternalSignEventArgs e);

public class SftpclientExternalSignEventArgs : EventArgs {
  public string OperationId { get; }
  public string HashAlgorithm { get; }
  public string Pars { get; }
  public string Data { get; }
  public string SignedData { get; set; }
}

Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As SftpclientExternalSignEventArgs)

Public Class SftpclientExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property Data As String
  Public Property SignedData As String
End Class

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contain algorithm-dependent parameters.

The component uses base16 (hex) encoding for Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses a .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FileOperation Event (SFTPClient Component)

Signifies the start of a file transfer operation.

Syntax

• C#
• VB.NET

public event OnFileOperationHandler OnFileOperation;

public delegate void OnFileOperationHandler(object sender, SftpclientFileOperationEventArgs e);

public class SftpclientFileOperationEventArgs : EventArgs {
  public int Operation { get; }
  public string RemotePath { get; }
  public string LocalPath { get; }
  public bool Skip { get; set; }
  public bool Cancel { get; set; }
}

Public Event OnFileOperation As OnFileOperationHandler

Public Delegate Sub OnFileOperationHandler(sender As Object, e As SftpclientFileOperationEventArgs)

Public Class SftpclientFileOperationEventArgs Inherits EventArgs
  Public ReadOnly Property Operation As Integer
  Public ReadOnly Property RemotePath As String
  Public ReadOnly Property LocalPath As String
  Public Property Skip As Boolean
  Public Property Cancel As Boolean
End Class

Remarks

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

FileOperationResult Event (SFTPClient Component)

Signifies the completion of a file transfer operation.

Syntax

• C#
• VB.NET

public event OnFileOperationResultHandler OnFileOperationResult;

public delegate void OnFileOperationResultHandler(object sender, SftpclientFileOperationResultEventArgs e);

public class SftpclientFileOperationResultEventArgs : EventArgs {
  public int Operation { get; }
  public string RemotePath { get; }
  public string LocalPath { get; }
  public int ErrorCode { get; }
  public string Comment { get; }
  public bool Cancel { get; set; }
}

Public Event OnFileOperationResult As OnFileOperationResultHandler

Public Delegate Sub OnFileOperationResultHandler(sender As Object, e As SftpclientFileOperationResultEventArgs)

Public Class SftpclientFileOperationResultEventArgs Inherits EventArgs
  Public ReadOnly Property Operation As Integer
  Public ReadOnly Property RemotePath As String
  Public ReadOnly Property LocalPath As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Comment As String
  Public Property Cancel As Boolean
End Class

Remarks

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

KnownKeyReceived Event (SFTPClient Component)

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

Syntax

• C#
• VB.NET

public event OnKnownKeyReceivedHandler OnKnownKeyReceived;

public delegate void OnKnownKeyReceivedHandler(object sender, SftpclientKnownKeyReceivedEventArgs e);

public class SftpclientKnownKeyReceivedEventArgs : EventArgs {
  public string Algorithm { get; }
  public int Bits { get; }
  public string FingerprintSHA256 { get; }
}

Public Event OnKnownKeyReceived As OnKnownKeyReceivedHandler

Public Delegate Sub OnKnownKeyReceivedHandler(sender As Object, e As SftpclientKnownKeyReceivedEventArgs)

Public Class SftpclientKnownKeyReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property Algorithm As String
  Public ReadOnly Property Bits As Integer
  Public ReadOnly Property FingerprintSHA256 As String
End Class

Remarks

The component fires this event to tell the application that the server has introduced itself with a known key from TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

Use ServerKey to access more key details.

ListEntry Event (SFTPClient Component)

Reports a directory listing entry to the application.

Syntax

• C#
• VB.NET

public event OnListEntryHandler OnListEntry;

public delegate void OnListEntryHandler(object sender, SftpclientListEntryEventArgs e);

public class SftpclientListEntryEventArgs : EventArgs {
  public string Filename { get; }
}

Public Event OnListEntry As OnListEntryHandler

Public Delegate Sub OnListEntryHandler(sender As Object, e As SftpclientListEntryEventArgs)

Public Class SftpclientListEntryEventArgs Inherits EventArgs
  Public ReadOnly Property Filename As String
End Class

Remarks

The component fires this event to report a directory listing entry to the application. FileName contains the entry name.

Use CurrentListEntry to access the details of the entry.

Notification Event (SFTPClient Component)

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, SftpclientNotificationEventArgs e);

public class SftpclientNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As SftpclientNotificationEventArgs)

Public Class SftpclientNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

PasswordChangeRequest Event (SFTPClient Component)

Signals that the server requests a password change.

Syntax

• C#
• VB.NET

public event OnPasswordChangeRequestHandler OnPasswordChangeRequest;

public delegate void OnPasswordChangeRequestHandler(object sender, SftpclientPasswordChangeRequestEventArgs e);

public class SftpclientPasswordChangeRequestEventArgs : EventArgs {
  public string Prompt { get; }
  public string NewPassword { get; set; }
  public bool Cancel { get; set; }
}

Public Event OnPasswordChangeRequest As OnPasswordChangeRequestHandler

Public Delegate Sub OnPasswordChangeRequestHandler(sender As Object, e As SftpclientPasswordChangeRequestEventArgs)

Public Class SftpclientPasswordChangeRequestEventArgs Inherits EventArgs
  Public ReadOnly Property Prompt As String
  Public Property NewPassword As String
  Public Property Cancel As Boolean
End Class

Remarks

The component 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 Component)

Asks the application for the client's private key.

Syntax

• C#
• VB.NET

public event OnPrivateKeyNeededHandler OnPrivateKeyNeeded;

public delegate void OnPrivateKeyNeededHandler(object sender, SftpclientPrivateKeyNeededEventArgs e);

public class SftpclientPrivateKeyNeededEventArgs : EventArgs {
  public bool Skip { get; set; }
}

Public Event OnPrivateKeyNeeded As OnPrivateKeyNeededHandler

Public Delegate Sub OnPrivateKeyNeededHandler(sender As Object, e As SftpclientPrivateKeyNeededEventArgs)

Public Class SftpclientPrivateKeyNeededEventArgs Inherits EventArgs
  Public Property Skip As Boolean
End Class

Remarks

The component fires this event if the public key provided in Key was accepted by the server, but no private key is available for it.

Use this event handler to attach the private key to your Key. The component will pick the key up and continue the authentication.

Progress Event (SFTPClient Component)

Fires periodically during the data transfer.

Syntax

• C#
• VB.NET

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, SftpclientProgressEventArgs e);

public class SftpclientProgressEventArgs : EventArgs {
  public long Total { get; }
  public long Current { get; }
  public bool Cancel { get; set; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As SftpclientProgressEventArgs)

Public Class SftpclientProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Total As Long
  Public ReadOnly Property Current As Long
  Public Property Cancel As Boolean
End Class

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

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

Syntax

• C#
• VB.NET

public event OnUnknownKeyReceivedHandler OnUnknownKeyReceived;

public delegate void OnUnknownKeyReceivedHandler(object sender, SftpclientUnknownKeyReceivedEventArgs e);

public class SftpclientUnknownKeyReceivedEventArgs : EventArgs {
  public string Algorithm { get; }
  public int Bits { get; }
  public string FingerprintSHA256 { get; }
  public int Action { get; set; }
}

Public Event OnUnknownKeyReceived As OnUnknownKeyReceivedHandler

Public Delegate Sub OnUnknownKeyReceivedHandler(sender As Object, e As SftpclientUnknownKeyReceivedEventArgs)

Public Class SftpclientUnknownKeyReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property Algorithm As String
  Public ReadOnly Property Bits As Integer
  Public ReadOnly Property FingerprintSHA256 As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to tell the application that the server has introduced itself with a key not present in TrustedKeysFile.

The details of the key are provided: Algorithm and Bits specify the key algorithm and the number of bits. FingerprintSHA256 contains the key's fingerprint.

In this event handler, you need to make a decision whether to proceed with the connection. Use Action to tell the component what it should do with the key:

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

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.

Fields

• C#
• VB.NET

public ExternalCrypto();

Public ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

ProxySettings Type

A container for proxy server settings.

Remarks

This type exposes a collection of properties for tuning up the proxy server configuration.

Fields

• C#
• VB.NET

public ProxySettings();

Public ProxySettings()

Creates a new ProxySettings object.

SFTPListEntry Type

A container for filesystem element's attributes.

Remarks

This type contains attributes of a single entry returned by a ListDir command.

The contents of this container may differ for different servers (not all servers support all attributes).

Fields

• C#
• VB.NET

public SFTPListEntry();

Public SFTPListEntry()

Creates a new SFTPListEntry object.

SocketSettings Type

A container for the socket settings.

Remarks

This type is a container for socket-layer parameters.

Fields

• C#
• VB.NET

public SocketSettings();

Public SocketSettings()

Creates a new SocketSettings object.

SSHInfo Type

Contains information about SSH connection.

Remarks

SSHInfo object contains information about one SSH connection.

Fields

• C#
• VB.NET

public SSHInfo();

Public SSHInfo()

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.

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.

Fields

• C#
• VB.NET

public SSHKey(byte[] bytes, int startIndex, int count, string password);

Public SSHKey(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads private key from the Bytes buffer. Parameters StartIndex and Count specify the starting index of the key data and its length, correspondingly. Provide a Password to decrypt the key.

• C#
• VB.NET

public SSHKey(byte[] bytes, int startIndex, int count);

Public SSHKey(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads public key from the Bytes buffer. Parameters StartIndex and Count specify the starting index of the key data and its length, correspondingly.

• C#
• VB.NET

public SSHKey(System.IO.Stream stream, string password);

Public SSHKey(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads private key from the stream. Provide a Password to decrypt the key.

• C#
• VB.NET

public SSHKey(System.IO.Stream stream);

Public SSHKey(ByVal Stream As System.IO.Stream)

Loads public key from the stream.

• C#
• VB.NET

public SSHKey(string path, string password);

Public SSHKey(ByVal Path As String, ByVal Password As String)

Loads private key from the file. Provide a Path to the file and Password to decrypt the key.

• C#
• VB.NET

public SSHKey(string path);

Public SSHKey(ByVal Path As String)

Loads public key from the file specified by Path .

• C#
• VB.NET

public SSHKey();

Public SSHKey()

Creates a new key.

SSHSettings Type

A container for various SSH protocol settings.

Remarks

SSHSettings stores various settings of SSH client or server.

Fields

• C#
• VB.NET

public SSHSettings();

Public SSHSettings()

Creates a new object with default settings.

Config Settings (SFTPClient Component)

SFTPClient Config Settings

Base Config Settings

Trappable Errors (SFTPClient Component)

SFTPClient Errors