SFTPServer Component

Properties   Methods   Events   Config Settings   Errors  

The SFTPServer component provides server-side functionality for SFTP connections.

Syntax

nsoftware.SecureBlackbox.Sftpserver

Remarks

SFTPServer is an implementation for SSH File Transfer Protocol server. It works over a secure SSH channel, and should not be confused with the FTP/FTPS protocol.

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.

Active Property (SFTPServer Component)

Specifies whether the SFTP server has started and ready to accept connections.

Syntax

• C#
• VB.NET

public bool Active { get; }

Public ReadOnly Property Active As Boolean

Default Value

False

Remarks

Check this property to find out whether the SFTP server is in active mode. Use Start and Stop methods to activate or deactivate the server.

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

AuthTypes Property (SFTPServer Component)

Defines allowed authentication types.

Syntax

• C#
• VB.NET

public int AuthTypes { get; set; }

Public Property AuthTypes As Integer

Default Value

30

Remarks

Use this property to define which authentication types are allowed on the server, set of

BaseDir Property (SFTPServer Component)

Specifies the server's base (root) directory.

Syntax

• C#
• VB.NET

public string BaseDir { get; set; }

Public Property BaseDir As String

Default Value

""

Remarks

Use this property to set the base (root) directory on the server.

ClientFileEntry Property (SFTPServer Component)

A container for file entry details.

Syntax

• C#
• VB.NET

public SFTPListEntry ClientFileEntry { get; set; }

Public Property ClientFileEntry As SFTPListEntry

Remarks

This property is a placeholder for file entry details. Use it communicate file details from your code to the server component and back. Pass the contents of ClientFileEntry to the server with SetClientFileEntry method, and retrieve them with GetClientFileEntry method.

This property may come handy when customizing file system operations, such as file listings or attribute requests.

This property is not available at design time.

CompressionLevel Property (SFTPServer Component)

Specifies the preferable compression level

Syntax

• C#
• VB.NET

public int CompressionLevel { get; set; }

Public Property CompressionLevel As Integer

Default Value

9

Remarks

Set this property before starting the server. Possible values range from 0 (lowest compression) to 9 (maximum compression). This property is ignored if compression wasn't accepted.

ExternalCrypto Property (SFTPServer 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 the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

FIPSMode Property (SFTPServer 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 (SFTPServer Component)

This property specifies whether server explicitly requires data compression.

Syntax

• C#
• VB.NET

public bool ForceCompression { get; set; }

Public Property ForceCompression As Boolean

Default Value

False

Remarks

Set this property before starting the server. If it is set to true, the component will explicitly request data compression. If it is set to False, the component will support compression, although compression will be used only if the remote party doesn't support algorithms without compression.

Host Property (SFTPServer Component)

Specifies server's host name.

Syntax

• C#
• VB.NET

public string Host { get; set; }

Public Property Host As String

Default Value

""

Remarks

Use this property to set the host name for this server.

Key Property (SFTPServer Component)

Contains client's public key.

Syntax

• C#
• VB.NET

public SSHKey Key { get; }

Public ReadOnly Property Key As SSHKey

Remarks

This property returns the currently pinned client's public key. Call PinClient to propagate the key of a particular client prior to checking this property.

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

MaxSFTPVersion Property (SFTPServer Component)

Maximum SFTP version supported.

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

MinSFTPVersion Property (SFTPServer Component)

Minimum SFTP version supported.

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 supported by this server.

PinnedClient Property (SFTPServer Component)

Populates the pinned client details.

Syntax

• C#
• VB.NET

public SSHClientEntry PinnedClient { get; }

Public ReadOnly Property PinnedClient As SSHClientEntry

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

Port Property (SFTPServer Component)

Specifies the listening port number.

Syntax

• C#
• VB.NET

public int Port { get; set; }

Public Property Port As Integer

Default Value

22

Remarks

Use this property to specify on which port the component will be listening to client connections.

ReadOnly Property (SFTPServer Component)

Specifies whether files on the server are read-only.

Syntax

• C#
• VB.NET

public bool ReadOnly { get; set; }

Public Property ReadOnly As Boolean

Default Value

False

Remarks

Set this property to true to deny all client requests to change files on the server.

ServerKeys Property (SFTPServer Component)

The server's SSH keys.

Syntax

• C#
• VB.NET

public SSHKeyList ServerKeys { get; }

Public Property ServerKeys As SSHKeyList

Remarks

Use this property to provide a list of SSH private keys for the server endpoint.

An SSH endpoint needs a private key to be able to accept secure connections. Apart from being employed for the handshake, the key is also used as a unique server identifier.

The collection may include more than one endpoint key. A typical usage scenario is to include two or three keys (ECDSA, RSA, and DSS), to cater for clients with different algorithm preferences.

This property is not available at design time.

SocketSettings Property (SFTPServer 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 (SFTPServer 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.

Users Property (SFTPServer Component)

A collection of known users.

Syntax

• C#
• VB.NET

public UserAccountList Users { get; }

Public Property Users As UserAccountList

Remarks

This property provides access to registered user database.

This property is not available at design time.

UseUTF8 Property (SFTPServer Component)

Specifies whether UTF8 conversion is to be used when parsing file names.

Syntax

• C#
• VB.NET

public bool UseUTF8 { get; set; }

Public Property UseUTF8 As Boolean

Default Value

False

Remarks

This property specifies whether UTF8 conversion of filenames is used by the server. It is set automatically according to protocol flow, but user could also set it to the desired value.

Config Method (SFTPServer 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.

DoAction Method (SFTPServer 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 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;....

DropClient Method (SFTPServer Component)

Terminates a client connection.

Syntax

• C#
• VB.NET

public void DropClient(long connectionId, bool forced);

Public Sub DropClient(ByVal ConnectionId As Long, ByVal Forced As Boolean)

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetClientBuffer Method (SFTPServer Component)

Acquires a piece of operation data.

Syntax

• C#
• VB.NET

public byte[] GetClientBuffer(long connectionID, string handle);

Public Function GetClientBuffer(ByVal ConnectionID As Long, ByVal Handle As String) As Byte()

Remarks

Use this method to obtain a piece of data relevant to a transfer operation in a thread-safe way.

A typical place to call this method is inside the WriteFile event handler, when implementing customized file transfers.

GetClientFileEntry Method (SFTPServer Component)

Acquires file entry details from the component.

Syntax

• C#
• VB.NET

public void GetClientFileEntry(long connectionID, string handle);

Public Sub GetClientFileEntry(ByVal ConnectionID As Long, ByVal Handle As String)

Remarks

Use this method to acquire the details of a file entry from the server in atomic and thread-safe way. After this method completes, the entry details will be propagated in ClientFileEntry property.

When calling this method, pass the client connection ID in ConnectionID property, and the opened file handle (if needed) in Handle property.

ListClients Method (SFTPServer Component)

Enumerates the connected clients.

Syntax

• C#
• VB.NET

public string ListClients();

Public Function ListClients() As String

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (SFTPServer Component)

Takes a snapshot of the connection's properties.

Syntax

• C#
• VB.NET

public void PinClient(long connectionId);

Public Sub PinClient(ByVal ConnectionId As Long)

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient property.

SetClientBuffer Method (SFTPServer Component)

Commits a data buffer to the server component.

Syntax

• C#
• VB.NET

public void SetClientBuffer(long connectionID, string handle, byte[] value);

Public Sub SetClientBuffer(ByVal ConnectionID As Long, ByVal Handle As String, ByVal Value As Byte())

Remarks

Use this method to commit a data buffer passed via the Value parameter to the server control in a thread-safe way.

One example where you might need to pass your buffer to the server is when customizing upload operations via ReadFile event.

SetClientFileEntry Method (SFTPServer Component)

Commits the file entry details to the component.

Syntax

• C#
• VB.NET

public void SetClientFileEntry(long connectionID, string handle);

Public Sub SetClientFileEntry(ByVal ConnectionID As Long, ByVal Handle As String)

Remarks

Use this method to commit the file entry details configured in ClientFileEntry property to the server object in a thread-safe way. Pass the client's connection ID via ConnectionID property, and the file entry's handle via Handle.

Start Method (SFTPServer Component)

Starts SFTP server operation.

Syntax

• C#
• VB.NET

public void Start();

Public Sub Start()

Remarks

Call this method to start listening to incoming connections.

Stop Method (SFTPServer Component)

Stops SFTP server.

Syntax

• C#
• VB.NET

public void Stop();

Public Sub Stop()

Remarks

Call this method to close all connections and stop listening to clients.

Accept Event (SFTPServer Component)

This event is fired when new incoming connection is accepted.

Syntax

• C#
• VB.NET

public event OnAcceptHandler OnAccept;

public delegate void OnAcceptHandler(object sender, SftpserverAcceptEventArgs e);

public class SftpserverAcceptEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public bool Accept { get; set; }
}

Public Event OnAccept As OnAcceptHandler

Public Delegate Sub OnAcceptHandler(sender As Object, e As SftpserverAcceptEventArgs)

Public Class SftpserverAcceptEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public Property Accept As Boolean
End Class

Remarks

This event is fired by the component before a new incoming connection is accepted. RemoteAddress contains the IP address of the connecting client. Use the Accept parameter to either accept, or reject the connection.

AfterCreateDirectory Event (SFTPServer Component)

This event indicates completion of directory creation request.

Syntax

• C#
• VB.NET

public event OnAfterCreateDirectoryHandler OnAfterCreateDirectory;

public delegate void OnAfterCreateDirectoryHandler(object sender, SftpserverAfterCreateDirectoryEventArgs e);

public class SftpserverAfterCreateDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterCreateDirectory As OnAfterCreateDirectoryHandler

Public Delegate Sub OnAfterCreateDirectoryHandler(sender As Object, e As SftpserverAfterCreateDirectoryEventArgs)

Public Class SftpserverAfterCreateDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired to report completion of a directory creation request. The ConnectionID parameter specifies in which session the request was received, the Path specifies the directory path, and the OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRemove Event (SFTPServer Component)

This event indicates completion of file removal request.

Syntax

• C#
• VB.NET

public event OnAfterRemoveHandler OnAfterRemove;

public delegate void OnAfterRemoveHandler(object sender, SftpserverAfterRemoveEventArgs e);

public class SftpserverAfterRemoveEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRemove As OnAfterRemoveHandler

Public Delegate Sub OnAfterRemoveHandler(sender As Object, e As SftpserverAfterRemoveEventArgs)

Public Class SftpserverAfterRemoveEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to delete a file or directory has been processed by the server. The ConnectionID parameter specifies the session in which the request was received. OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRenameFile Event (SFTPServer Component)

This event indicates completion of a file rename operation.

Syntax

• C#
• VB.NET

public event OnAfterRenameFileHandler OnAfterRenameFile;

public delegate void OnAfterRenameFileHandler(object sender, SftpserverAfterRenameFileEventArgs e);

public class SftpserverAfterRenameFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRenameFile As OnAfterRenameFileHandler

Public Delegate Sub OnAfterRenameFileHandler(sender As Object, e As SftpserverAfterRenameFileEventArgs)

Public Class SftpserverAfterRenameFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) has been processed. The ConnectionID parameter specifies in which session the request was received, and OperationStatus contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AfterRequestAttributes Event (SFTPServer Component)

This event indicates completion of file attributes request.

Syntax

• C#
• VB.NET

public event OnAfterRequestAttributesHandler OnAfterRequestAttributes;

public delegate void OnAfterRequestAttributesHandler(object sender, SftpserverAfterRequestAttributesEventArgs e);

public class SftpserverAfterRequestAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRequestAttributes As OnAfterRequestAttributesHandler

Public Delegate Sub OnAfterRequestAttributesHandler(sender As Object, e As SftpserverAfterRequestAttributesEventArgs)

Public Class SftpserverAfterRequestAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request for get file attributes has been processed by the server. The ConnectionID parameter specifies in which session the request was received. OperationStatus contains the result of the operation.

If needed, you can amend the OperationStatus to return a different operation result:

AfterSetAttributes Event (SFTPServer Component)

This event indicates completion of a set attributes request.

Syntax

• C#
• VB.NET

public event OnAfterSetAttributesHandler OnAfterSetAttributes;

public delegate void OnAfterSetAttributesHandler(object sender, SftpserverAfterSetAttributesEventArgs e);

public class SftpserverAfterSetAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterSetAttributes As OnAfterSetAttributesHandler

Public Delegate Sub OnAfterSetAttributesHandler(sender As Object, e As SftpserverAfterSetAttributesEventArgs)

Public Class SftpserverAfterSetAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request for set file attributes has been processed. The ConnectionID parameter specifies in which session the request was received. The OperationStatus parameter contains the operation result.

If needed, you can amend the OperationStatus to return a different operation result:

AuthAttempt Event (SFTPServer Component)

Reports a user authentication attempt.

Syntax

• C#
• VB.NET

public event OnAuthAttemptHandler OnAuthAttempt;

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

public class SftpserverAuthAttemptEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Username { get; }
  public int AuthType { get; }
  public bool Accept { get; set; }
}

Public Event OnAuthAttempt As OnAuthAttemptHandler

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

Public Class SftpserverAuthAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Username As String
  Public ReadOnly Property AuthType As Integer
  Public Property Accept As Boolean
End Class

Remarks

ConnectionID identifies the session, Username specifies client's username, and AuthType specifies the authentication type. Use the Accept parameter to accept or decline the attempt.

Supported authentication types:

AuthFailed Event (SFTPServer Component)

Reports user authentication failure.

Syntax

• C#
• VB.NET

public event OnAuthFailedHandler OnAuthFailed;

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

public class SftpserverAuthFailedEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Username { get; }
  public int AuthType { get; }
}

Public Event OnAuthFailed As OnAuthFailedHandler

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

Public Class SftpserverAuthFailedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Username As String
  Public ReadOnly Property AuthType As Integer
End Class

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

AuthPassword Event (SFTPServer Component)

This event is fired on password authentication attempt from a client.

Syntax

• C#
• VB.NET

public event OnAuthPasswordHandler OnAuthPassword;

public delegate void OnAuthPasswordHandler(object sender, SftpserverAuthPasswordEventArgs e);

public class SftpserverAuthPasswordEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Username { get; }
  public string Password { get; }
  public bool Accept { get; set; }
  public bool ForceChangePassword { get; set; }
}

Public Event OnAuthPassword As OnAuthPasswordHandler

Public Delegate Sub OnAuthPasswordHandler(sender As Object, e As SftpserverAuthPasswordEventArgs)

Public Class SftpserverAuthPasswordEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Username As String
  Public ReadOnly Property Password As String
  Public Property Accept As Boolean
  Public Property ForceChangePassword As Boolean
End Class

Remarks

Parameters Username and Password contain user credentials. If they are correct, set Accept to true. You can request password change by setting ForceChangePassword to true.

AuthPublicKey Event (SFTPServer Component)

This event is fired on public key authentication attempt from a client.

Syntax

• C#
• VB.NET

public event OnAuthPublicKeyHandler OnAuthPublicKey;

public delegate void OnAuthPublicKeyHandler(object sender, SftpserverAuthPublicKeyEventArgs e);

public class SftpserverAuthPublicKeyEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Username { get; }
  public bool Accept { get; set; }
}

Public Event OnAuthPublicKey As OnAuthPublicKeyHandler

Public Delegate Sub OnAuthPublicKeyHandler(sender As Object, e As SftpserverAuthPublicKeyEventArgs)

Public Class SftpserverAuthPublicKeyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Username As String
  Public Property Accept As Boolean
End Class

Remarks

Username specifies client's username, and Accept is used to accept or reject authentication.

AuthSucceeded Event (SFTPServer Component)

Reports a successful user authentication.

Syntax

• C#
• VB.NET

public event OnAuthSucceededHandler OnAuthSucceeded;

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

public class SftpserverAuthSucceededEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Username { get; }
  public int AuthType { get; }
}

Public Event OnAuthSucceeded As OnAuthSucceededHandler

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

Public Class SftpserverAuthSucceededEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Username As String
  Public ReadOnly Property AuthType As Integer
End Class

Remarks

ConnectionID identifies the session, Username specify client's username, and AuthType specifies what authentication type was used.

Supported authentication types:

BeforeCreateDirectory Event (SFTPServer Component)

This event is fired when a client requests to create a directory.

Syntax

• C#
• VB.NET

public event OnBeforeCreateDirectoryHandler OnBeforeCreateDirectory;

public delegate void OnBeforeCreateDirectoryHandler(object sender, SftpserverBeforeCreateDirectoryEventArgs e);

public class SftpserverBeforeCreateDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeCreateDirectory As OnBeforeCreateDirectoryHandler

Public Delegate Sub OnBeforeCreateDirectoryHandler(sender As Object, e As SftpserverBeforeCreateDirectoryEventArgs)

Public Class SftpserverBeforeCreateDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when a request to create a directory has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeDownloadFile Event (SFTPServer Component)

This event is fired when a download file request is received.

Syntax

• C#
• VB.NET

public event OnBeforeDownloadFileHandler OnBeforeDownloadFile;

public delegate void OnBeforeDownloadFileHandler(object sender, SftpserverBeforeDownloadFileEventArgs e);

public class SftpserverBeforeDownloadFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeDownloadFile As OnBeforeDownloadFileHandler

Public Delegate Sub OnBeforeDownloadFileHandler(sender As Object, e As SftpserverBeforeDownloadFileEventArgs)

Public Class SftpserverBeforeDownloadFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when a request to download file is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeFind Event (SFTPServer Component)

This event is fired when a client requests to find files and folders in Path.

Syntax

• C#
• VB.NET

public event OnBeforeFindHandler OnBeforeFind;

public delegate void OnBeforeFindHandler(object sender, SftpserverBeforeFindEventArgs e);

public class SftpserverBeforeFindEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeFind As OnBeforeFindHandler

Public Delegate Sub OnBeforeFindHandler(sender As Object, e As SftpserverBeforeFindEventArgs)

Public Class SftpserverBeforeFindEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when a request to find files and folders in Path has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeRemove Event (SFTPServer Component)

This event is fired when a client requests to delete a file or directory.

Syntax

• C#
• VB.NET

public event OnBeforeRemoveHandler OnBeforeRemove;

public delegate void OnBeforeRemoveHandler(object sender, SftpserverBeforeRemoveEventArgs e);

public class SftpserverBeforeRemoveEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRemove As OnBeforeRemoveHandler

Public Delegate Sub OnBeforeRemoveHandler(sender As Object, e As SftpserverBeforeRemoveEventArgs)

Public Class SftpserverBeforeRemoveEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeRenameFile Event (SFTPServer Component)

This event is fired when a client requests to rename a file.

Syntax

• C#
• VB.NET

public event OnBeforeRenameFileHandler OnBeforeRenameFile;

public delegate void OnBeforeRenameFileHandler(object sender, SftpserverBeforeRenameFileEventArgs e);

public class SftpserverBeforeRenameFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRenameFile As OnBeforeRenameFileHandler

Public Delegate Sub OnBeforeRenameFileHandler(sender As Object, e As SftpserverBeforeRenameFileEventArgs)

Public Class SftpserverBeforeRenameFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeRequestAttributes Event (SFTPServer Component)

This event is fired when a client requests to get file attributes.

Syntax

• C#
• VB.NET

public event OnBeforeRequestAttributesHandler OnBeforeRequestAttributes;

public delegate void OnBeforeRequestAttributesHandler(object sender, SftpserverBeforeRequestAttributesEventArgs e);

public class SftpserverBeforeRequestAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRequestAttributes As OnBeforeRequestAttributesHandler

Public Delegate Sub OnBeforeRequestAttributesHandler(sender As Object, e As SftpserverBeforeRequestAttributesEventArgs)

Public Class SftpserverBeforeRequestAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when a request to get file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeSetAttributes Event (SFTPServer Component)

This event is fired when a client requests to set file attributes.

Syntax

• C#
• VB.NET

public event OnBeforeSetAttributesHandler OnBeforeSetAttributes;

public delegate void OnBeforeSetAttributesHandler(object sender, SftpserverBeforeSetAttributesEventArgs e);

public class SftpserverBeforeSetAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeSetAttributes As OnBeforeSetAttributesHandler

Public Delegate Sub OnBeforeSetAttributesHandler(sender As Object, e As SftpserverBeforeSetAttributesEventArgs)

Public Class SftpserverBeforeSetAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when a request to set file attributes has been received. The ConnectionID parameter specifies in which session the request was received.

Choose Action as one of the following values:

BeforeUploadFile Event (SFTPServer Component)

This event is fired when an upload file request is received.

Syntax

• C#
• VB.NET

public event OnBeforeUploadFileHandler OnBeforeUploadFile;

public delegate void OnBeforeUploadFileHandler(object sender, SftpserverBeforeUploadFileEventArgs e);

public class SftpserverBeforeUploadFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeUploadFile As OnBeforeUploadFileHandler

Public Delegate Sub OnBeforeUploadFileHandler(sender As Object, e As SftpserverBeforeUploadFileEventArgs)

Public Class SftpserverBeforeUploadFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when an upload file request is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location on the server where the file needs to be saved.

Choose Action as one of the following values:

CloseFile Event (SFTPServer Component)

This event instructs the application to close an opened file.

Syntax

• C#
• VB.NET

public event OnCloseFileHandler OnCloseFile;

public delegate void OnCloseFileHandler(object sender, SftpserverCloseFileEventArgs e);

public class SftpserverCloseFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Handle { get; }
  public int OperationStatus { get; set; }
}

Public Event OnCloseFile As OnCloseFileHandler

Public Delegate Sub OnCloseFileHandler(sender As Object, e As SftpserverCloseFileEventArgs)

Public Class SftpserverCloseFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Handle As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired upon receipt of a close-file packet from a client. Servers implementing virtualized transfers must close the previously opened local file referenced by Handle in this event handler. No further operations are allowed with the closed file.

Set OperationStatus to one of the following values to report the result of this operation to the client:

Connect Event (SFTPServer Component)

This event is fired when a remote connection has been established.

Syntax

• C#
• VB.NET

public event OnConnectHandler OnConnect;

public delegate void OnConnectHandler(object sender, SftpserverConnectEventArgs e);

public class SftpserverConnectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string RemoteAddress { get; }
  public int RemotePort { get; }
}

Public Event OnConnect As OnConnectHandler

Public Delegate Sub OnConnectHandler(sender As Object, e As SftpserverConnectEventArgs)

Public Class SftpserverConnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
End Class

Remarks

ConnectionID contains a session identifier, and RemoteAddress specifies the client's IP address.

CreateDirectory Event (SFTPServer Component)

This event instructs the application to create a directory.

Syntax

• C#
• VB.NET

public event OnCreateDirectoryHandler OnCreateDirectory;

public delegate void OnCreateDirectoryHandler(object sender, SftpserverCreateDirectoryEventArgs e);

public class SftpserverCreateDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnCreateDirectory As OnCreateDirectoryHandler

Public Delegate Sub OnCreateDirectoryHandler(sender As Object, e As SftpserverCreateDirectoryEventArgs)

Public Class SftpserverCreateDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to create a directory has been received and needs to be served (virtualized) by the application. The ConnectionID parameter specifies the session that has communicated the request, and Path contains the name of the directory to be created.

Set OperationStatus to one of the below values according to the outcome of the request processing:

Disconnect Event (SFTPServer Component)

This event is fired when a client has disconnected.

Syntax

• C#
• VB.NET

public event OnDisconnectHandler OnDisconnect;

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

public class SftpserverDisconnectEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnDisconnect As OnDisconnectHandler

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

Public Class SftpserverDisconnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

This event reports loss of connection to the client within the session specified by ConnectionID.

Error Event (SFTPServer Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class SftpserverErrorEventArgs 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 message processing.

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

ExternalSign Event (SFTPServer Component)

Handles remote or external signing initiated by the server protocol.

Syntax

• C#
• VB.NET

public event OnExternalSignHandler OnExternalSign;

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

public class SftpserverExternalSignEventArgs : EventArgs {
  public long ConnectionID { get; }
  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 SftpserverExternalSignEventArgs)

Public Class SftpserverExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  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 the 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 contains algorithm-dependent parameters.

The component 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: 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(); };

FindClose Event (SFTPServer Component)

This event signifies the completion of a custom file listing operation.

Syntax

• C#
• VB.NET

public event OnFindCloseHandler OnFindClose;

public delegate void OnFindCloseHandler(object sender, SftpserverFindCloseEventArgs e);

public class SftpserverFindCloseEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Handle { get; }
  public int OperationStatus { get; set; }
}

Public Event OnFindClose As OnFindCloseHandler

Public Delegate Sub OnFindCloseHandler(sender As Object, e As SftpserverFindCloseEventArgs)

Public Class SftpserverFindCloseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Handle As String
  Public Property OperationStatus As Integer
End Class

Remarks

FindClose notifies your code about the completion of a custom file listing request. Use it in conjunction with FindFirst and FindNext to handle file listing requests manually.

See FindFirst topic for the details on implementing customized file listing request processing.

Set OperationStatus to one of the below values according to the outcome of the request processing:

FindFirst Event (SFTPServer Component)

This event signifies the start of the custom file listing retrieval mechanism.

Syntax

• C#
• VB.NET

public event OnFindFirstHandler OnFindFirst;

public delegate void OnFindFirstHandler(object sender, SftpserverFindFirstEventArgs e);

public class SftpserverFindFirstEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
  public string Handle { get; set; }
}

Public Event OnFindFirst As OnFindFirstHandler

Public Delegate Sub OnFindFirstHandler(sender As Object, e As SftpserverFindFirstEventArgs)

Public Class SftpserverFindFirstEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
  Public Property Handle As String
End Class

Remarks

FindFirst, FindNext, and FindClose events represent a mechanism for providing customized file listings to component. They are only fired if Action parameter of the preceding BeforeFind event was set to fraCustom.

The behaviour of these events mimics that of the standard FindFirst/FindNext/FindClose functions found in many operating systems/frameworks. FindFirst fires once to request the first list entry; FindNext then fires continuously in a loop to request all subsequent entries. To indicate that the listing is over, set OperationStatus parameter to ostEOF. Not doing so may lead to an endless loop and session freeze, as the component would continue firing FindNext infinitely waiting for the EOF marker.

The handlers for both FindFirst and FindNext events should be implemented in the following way: if there are more entries in the directory to pass back to the server component,

• set OperationStatus to ostOK,
• fill in ClientFileEntry with the details of the next entry,
• commit the entry to the server using SetClientFileEntry method.

Use the by-ref Handle parameter to assign a handle (a unique identifier) to the file listing procedure inside the FindFirst event handler. This identifier will then be passed to all subsequent FindNext and FindClose calls to let your code chain the events together.

The ConnectionID parameter specifies in which SFTP session the request was received, and Path indicates the requested directory.

The following operation status constants are available, besides the ones referenced above:

FindNext Event (SFTPServer Component)

This event retrieves the next entry of a custom file listing.

Syntax

• C#
• VB.NET

public event OnFindNextHandler OnFindNext;

public delegate void OnFindNextHandler(object sender, SftpserverFindNextEventArgs e);

public class SftpserverFindNextEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Handle { get; }
  public int OperationStatus { get; set; }
}

Public Event OnFindNext As OnFindNextHandler

Public Delegate Sub OnFindNextHandler(sender As Object, e As SftpserverFindNextEventArgs)

Public Class SftpserverFindNextEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Handle As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired repeatedly after FindFirst to retrieve the directory contents entry-by-entry. Please see the FindFirst topic for more details about implementing a handler of this event.

Remember to set OperationStatus to ostEOF when there are no more entries left to close the listing operation. If there are more entries to pass, set it to ostOK. Other possible values are given in the table below:

Notification Event (SFTPServer 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, SftpserverNotificationEventArgs e);

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

Public Event OnNotification As OnNotificationHandler

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

Public Class SftpserverNotificationEventArgs 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 the 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.

This component can fire this event with the following EventID values:

OpenFile Event (SFTPServer Component)

This event instructs the application to handle the file open request.

Syntax

• C#
• VB.NET

public event OnOpenFileHandler OnOpenFile;

public delegate void OnOpenFileHandler(object sender, SftpserverOpenFileEventArgs e);

public class SftpserverOpenFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Modes { get; }
  public int Access { get; }
  public int OperationStatus { get; set; }
  public string Handle { get; set; }
}

Public Event OnOpenFile As OnOpenFileHandler

Public Delegate Sub OnOpenFileHandler(sender As Object, e As SftpserverOpenFileEventArgs)

Public Class SftpserverOpenFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property Modes As Integer
  Public ReadOnly Property Access As Integer
  Public Property OperationStatus As Integer
  Public Property Handle As String
End Class

Remarks

This event is fired when a file open request is received from the client and needs to be handled (virtualized) by the server. The ConnectionID parameter specifies in which session the request was received, and Path specifies the location of the file.

Modes can be a combination of one or several file open mode flags:

Different client applications may provide different selections of mode flags. For example, some clients specify (cfmCreate + cfmTruncate) when overwriting files, whereas others would specify cfmOpenOrCreate. Please make sure your code is prepared to receive different combinations of flags here and handles them gracefully.

The Access parameter provides additional file access modifiers:

The Handle string represents a unique identifier of the opened file, similar to file handles used in Windows or Unix APIs. Handles are unique across all files opened at the same time. Component generates handles automatically, but you can update the auto-generated values with your own in this event handler (just remember to keep them unique).

Set OperationStatus parameter in accordance with the outcome of the operation to one of the values given below:

ReadFile Event (SFTPServer Component)

This event is fired when a file read request is received.

Syntax

• C#
• VB.NET

public event OnReadFileHandler OnReadFile;

public delegate void OnReadFileHandler(object sender, SftpserverReadFileEventArgs e);

public class SftpserverReadFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Handle { get; }
  public long Offset { get; }
  public int Size { get; }
  public int OperationStatus { get; set; }
}

Public Event OnReadFile As OnReadFileHandler

Public Delegate Sub OnReadFileHandler(sender As Object, e As SftpserverReadFileEventArgs)

Public Class SftpserverReadFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Handle As String
  Public ReadOnly Property Offset As Long
  Public ReadOnly Property Size As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to read block from a file is received from the client. The ConnectionID parameter specifies in which session the request was received, and Handle indicates an opened file handle. Offset and Size denote the location and size of the file piece.

Inside the event handler, pass the appropriate file chunk to the component via SetClientBuffer method.

Set OperationStatus to one of the below values according to the outcome of the request processing:

Remove Event (SFTPServer Component)

This event is fired when a client requests to delete a file or directory.

Syntax

• C#
• VB.NET

public event OnRemoveHandler OnRemove;

public delegate void OnRemoveHandler(object sender, SftpserverRemoveEventArgs e);

public class SftpserverRemoveEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRemove As OnRemoveHandler

Public Delegate Sub OnRemoveHandler(sender As Object, e As SftpserverRemoveEventArgs)

Public Class SftpserverRemoveEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to delete a file or directory is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

RenameFile Event (SFTPServer Component)

This event is fired when a client requests to rename a file.

Syntax

• C#
• VB.NET

public event OnRenameFileHandler OnRenameFile;

public delegate void OnRenameFileHandler(object sender, SftpserverRenameFileEventArgs e);

public class SftpserverRenameFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRenameFile As OnRenameFileHandler

Public Delegate Sub OnRenameFileHandler(sender As Object, e As SftpserverRenameFileEventArgs)

Public Class SftpserverRenameFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to rename a file (from OldPath to NewPath) is received from the client. The ConnectionID parameter specifies in which session the request was received.

Set OperationStatus to one of the below values according to the outcome of the request processing:

RequestAttributes Event (SFTPServer Component)

This event is fired when a get file attributes request is received.

Syntax

• C#
• VB.NET

public event OnRequestAttributesHandler OnRequestAttributes;

public delegate void OnRequestAttributesHandler(object sender, SftpserverRequestAttributesEventArgs e);

public class SftpserverRequestAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string Handle { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRequestAttributes As OnRequestAttributesHandler

Public Delegate Sub OnRequestAttributesHandler(sender As Object, e As SftpserverRequestAttributesEventArgs)

Public Class SftpserverRequestAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property Handle As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to get file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location where the attributes need to be retrieved.

Set OperationStatus to one of the below values according to the outcome of the request processing:

SessionClosed Event (SFTPServer Component)

Reports session closure.

Syntax

• C#
• VB.NET

public event OnSessionClosedHandler OnSessionClosed;

public delegate void OnSessionClosedHandler(object sender, SftpserverSessionClosedEventArgs e);

public class SftpserverSessionClosedEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnSessionClosed As OnSessionClosedHandler

Public Delegate Sub OnSessionClosedHandler(sender As Object, e As SftpserverSessionClosedEventArgs)

Public Class SftpserverSessionClosedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

This event is fired when a connection identified by ConnectionID has been gracefully closed.

SessionEstablished Event (SFTPServer Component)

This event is fired when a new session is established.

Syntax

• C#
• VB.NET

public event OnSessionEstablishedHandler OnSessionEstablished;

public delegate void OnSessionEstablishedHandler(object sender, SftpserverSessionEstablishedEventArgs e);

public class SftpserverSessionEstablishedEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnSessionEstablished As OnSessionEstablishedHandler

Public Delegate Sub OnSessionEstablishedHandler(sender As Object, e As SftpserverSessionEstablishedEventArgs)

Public Class SftpserverSessionEstablishedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

This event is fired when a new connection identified by ConnectionID has been established with a client.

SetAttributes Event (SFTPServer Component)

This event is fired when an set file attributes request is received.

Syntax

• C#
• VB.NET

public event OnSetAttributesHandler OnSetAttributes;

public delegate void OnSetAttributesHandler(object sender, SftpserverSetAttributesEventArgs e);

public class SftpserverSetAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string Handle { get; }
  public int OperationStatus { get; set; }
}

Public Event OnSetAttributes As OnSetAttributesHandler

Public Delegate Sub OnSetAttributesHandler(sender As Object, e As SftpserverSetAttributesEventArgs)

Public Class SftpserverSetAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property Handle As String
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to set file attributes is received from the client. The ConnectionID parameter specifies in which session the request was received, and Path specifies the file location which the attributes needs to be set.

Set OperationStatus to one of the below values according to the outcome of the request processing:

TranslatePath Event (SFTPServer Component)

This event is fired when a client requests the server to translate a path to its absolute form.

Syntax

• C#
• VB.NET

public event OnTranslatePathHandler OnTranslatePath;

public delegate void OnTranslatePathHandler(object sender, SftpserverTranslatePathEventArgs e);

public class SftpserverTranslatePathEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public string AbsolutePath { get; set; }
  public int Action { get; set; }
}

Public Event OnTranslatePath As OnTranslatePathHandler

Public Delegate Sub OnTranslatePathHandler(sender As Object, e As SftpserverTranslatePathEventArgs)

Public Class SftpserverTranslatePathEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property AbsolutePath As String
  Public Property Action As Integer
End Class

Remarks

This event is fired when a request to translate a relative path to the corresponding absolute path is received. The ConnectionID parameter specifies the session in which the request was received.

You can let the server do the translation automatically according to the default file system rules, or take care of it yourself. Use the Action parameter to specify who is responsible for the translation. If doing the translation manually, return the translated path via the AbsolutePath parameter. Action can take one of the following values:

WriteFile Event (SFTPServer Component)

This event is fired when a file write request is received.

Syntax

• C#
• VB.NET

public event OnWriteFileHandler OnWriteFile;

public delegate void OnWriteFileHandler(object sender, SftpserverWriteFileEventArgs e);

public class SftpserverWriteFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Handle { get; }
  public long Offset { get; }
  public int OperationStatus { get; set; }
}

Public Event OnWriteFile As OnWriteFileHandler

Public Delegate Sub OnWriteFileHandler(sender As Object, e As SftpserverWriteFileEventArgs)

Public Class SftpserverWriteFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Handle As String
  Public ReadOnly Property Offset As Long
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a request to write a data block to a file is received from the client. The ConnectionID parameter specifies the session the request originates from. The Handle parameter references the opened file where the block should be written to. Offset references the position in the file where the block of data should be written.

Use GetClientBuffer method to obtain the piece of data that should be written to the file.

Set OperationStatus to one of the below values according to the outcome of the request processing:

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

Constructors

• C#
• VB.NET

public ExternalCrypto();

Public ExternalCrypto()

Creates a new ExternalCrypto object with default field values.

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

Constructors

• 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

Constructors

• C#
• VB.NET

public SocketSettings();

Public SocketSettings()

Creates a new SocketSettings object.

SSHClientEntry Type

Contains information about an accepted SSH connection.

Remarks

SSHClientEntry object contains information about one accepted SSH connection.

Fields

Constructors

• C#
• VB.NET

public SSHClientEntry();

Public SSHClientEntry()

Creates an empty object representing a SSH connection entry.

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

Constructors

• 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