SFTPServer Component

Properties   Methods   Events   Config Settings   Errors  

The SFTPServer component is used to create a Secure File Transfer Protocol (SFTP) server.

Syntax

nsoftware.IPWorksEDI.SFTPServer

Remarks

The SFTPServer component provides a simple way to create a Secure File Transfer Protocol (SFTP) server. Any SFTP client will be able to connect and transfer files to and from the server.

Getting Started

To begin, first provide a valid certificate with a private key in the SSHCert property.

Optionally set the RootDirectory property to a valid local path. If this property is set, the component will serve files from this location, and when clients connect, they will see this as their initial directory. If this property is not set, then the component will fire events allowing customized responses for each operation.

To start the server, set Listening to True.

Client Authentication

Client authentication is handled through the SSHUserAuthRequest event. Inside this event, the Accept parameter determines whether authentication is accepted; this parameter should be set to True if a successful authentication is detected and False otherwise.

When a client connects, the AuthMethod parameter indicates the method of authentication the client wishes to use. Connecting clients will initially attempt authentication with an AuthMethod of "none". This is done with the expectation that the request will fail and the server will provide a list of support authentication methods. The client then selects an available method and reauthenticates. If AuthMethod is "none", Accept should be set to False.

For password authentication, the User parameter will hold the client's username and the AuthParam parameter will hold the password provided by the client. An external list of known usernames and passwords should be maintained to check these values against.

For publickey authentication, the User parameter will hold the client's username and the AuthParam parameter will hold the key provided by the client. This key should be compared to an external list of known keys and usernames.

For keyboard-interactive authentication, the SSHUserAuthRequest event will fire multiple times; once for each prompt and response sent by the client. The index of the response is specified as a suffix in the AuthMethod parameter (e.g., keyboard-interactive-1, keyboard-interactive-2), and AuthParam will contain the client's response to the prompt. Finally, SSHUserAuthRequest will fire one last time with AuthMethod set to "keyboard-interactive" and AuthParam set to an empty string. The Accept parameter must be set to True each time the event fires for the authentication process to succeed.

Directory Listing

When a client requests a directory listing, the DirList event fires with the Path parameter set to the directory to enumerate. If the directory listing is allowed, the appropriate set of files should be passed to the SetFileList method. The StatusCode parameter should be set according to the status of the operation, and the valid status codes can be found in the documentation for the DirList event.

Handling Events

Event handlers are the primary method of customizing the component's functionality. When a client attempts to connect, open a file, authenticate to the server, and so on, the corresponding SFTPServer event will fire to allow for custom handling of the client's request.

The following events are fired both before and after the requested operation is executed:

• DirCreate
• DirList
• DirRemove
• FileOpen
• FileRemove
• FileRename
• FileWrite
• SetAttributes

Each of these events has a BeforeExec event parameter that is True when the event is fired before execution of the operation, and False after execution of the operation. Handling the event before execution provides an opportunity to use custom logic to determine whether the operation should be denied, diverted, or otherwise modified. Handling the event after execution provides an opportunity to report success or any errors related to the operation to the client.

The following events are fired only after the requested operation is executed:

• FileClose
• FileRead
• GetAttributes
• ResolvePath

Any logic to deny opening a file for read or write should be done in the FileOpen event handler.

Threading in Server Applications

In .NET, all socket-based components perform all Socket.IO through asynchronous methods. Each call consumes a thread from the system's thread pool, and thus the number of concurrent calls is limited to the number of worker threads returned by System.Threading.ThreadPool.GetMaxThreads. When using several components that can each create a socket connection or a single component that can create multiple socket connections, the application may enter a state in which all of the pool threads are in use for receiving. In a scenario such as this, the remote hosts may be waiting for data from the application before sending, but the application cannot send that data because all the threads are tied up waiting for inbound data. This is particularly important for server applications that use a daemon component.

For example, say a server application 'S' has a max thread pool size of three, and clients 'A' and 'B' connect to it and each client uploads a large file. After all uploads are complete, 'S' enqueues an asynchronous read request in the thread pool for each client. Because no work is being done, the thread pool immediately consumes two threads that wait for any further data from 'A' and 'B'. While 'S' is still processing the first two files it has received, client 'C' connects and uploads a relatively small file. Similarly, once that upload has completed 'S' enqueues a third read request, and the thread pool immediately consumes the third and final thread to wait for further data from 'C'. Once 'S' completes processing any of the files, it will enqueue a send request. However, because all three threads are in use and waiting for data from the clients, the send operation cannot be completed. The entire system becomes deadlocked because each of the clients is waiting for data from the server, which cannot send that data because all of its pool threads are in turn waiting for data from the clients.

To avoid a deadlock situation such as this, it is necessary to ensure that the maximum number of socket connections an application can make is always at least one less than the number of available worker threads. One method to achieve this is to call System.Threading.ThreadPool.SetMaxThreads during the application's startup to set the maximum number of threads to a value high enough to support the application for the duration of its execution. Another option is to trap an event such as ConnectionRequest and Disconnected from each component instance with logic to manage the maximum thread pool size according to the application's current needs.

Note: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, DoEvents should be called in a loop after the server is started.

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.

ConnectionBacklog Property (SFTPServer Component)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Syntax

• C#
• VB.NET

public int ConnectionBacklog { get; set; }

Public Property ConnectionBacklog As Integer

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

This property is not available at design time.

Connections Property (SFTPServer Component)

The collection of currently connected secure file transfer protocol (SFTP) clients.

Syntax

• C#
• VB.NET

public SFTPConnectionMap Connections { get; }

Public ReadOnly Property Connections As SFTPConnectionMap

Remarks

This property is the collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the SFTPConnection type.

This property is read-only.

DefaultAuthMethods Property (SFTPServer Component)

The supported authentication methods.

Syntax

• C#
• VB.NET

public string DefaultAuthMethods { get; set; }

Public Property DefaultAuthMethods As String

Default Value

"password,publickey"

Remarks

This property specifies the supported authentication methods. The client will choose one of the supported mechanisms when authenticating to the component.

This must be a comma-separated list of values. For more information on authenticating clients, see the SSHUserAuthRequest event.

The following is a list of methods implemented by the component:

DefaultTimeout Property (SFTPServer Component)

An initial timeout value to be used by incoming connections.

Syntax

• C#
• VB.NET

public int DefaultTimeout { get; set; }

Public Property DefaultTimeout As Integer

Default Value

60

Remarks

If the DefaultTimeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If DefaultTimeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the DefaultTimeout property is 60 (seconds).

KeyboardInteractiveMessage Property (SFTPServer Component)

The instructions to send to the client during keyboard-interactive authentication.

Syntax

• C#
• VB.NET

public string KeyboardInteractiveMessage { get; set; }

Public Property KeyboardInteractiveMessage As String

Default Value

""

Remarks

This property should be set to the main instructions to send to the client during keyboard-interactive authentication.

KeyboardInteractivePrompts Property (SFTPServer Component)

A collection of prompts to present to the user for keyboard-interactive authentication.

Syntax

• C#
• VB.NET

public SSHPromptList KeyboardInteractivePrompts { get; }

Public Property KeyboardInteractivePrompts As SSHPromptList

Remarks

This property is a collection of prompts to present to the user during keyboard-authentication. It is used together with the KeyboardInteractiveMessage property.

Listening Property (SFTPServer Component)

This property indicates whether the component is listening for incoming connections on LocalPort.

Syntax

• C#
• VB.NET

public bool Listening { get; }

Public ReadOnly Property Listening As Boolean

Default Value

False

Remarks

This property indicates whether the component is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the component is listening.

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

LocalHost Property (SFTPServer Component)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

LocalPort Property (SFTPServer Component)

The Transmission Control Protocol (TCP) port in the local host where the component listens.

Syntax

• C#
• VB.NET

public int LocalPort { get; set; }

Public Property LocalPort As Integer

Default Value

22

Remarks

The LocalPort property must be set before TCPServer starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of the LocalPort property after TCPServer is in listening mode (after successfully assigning True to the Listening property).

The service port is not shared among servers (i.e., only one TCPServer can be 'listening' on a particular port at one time).

RootDirectory Property (SFTPServer Component)

The root directory for the entire secure file transfer protocol (SFTP) server.

Syntax

• C#
• VB.NET

public string RootDirectory { get; set; }

Public Property RootDirectory As String

Default Value

""

Remarks

RootDirectory specifies the root of the SFTP server ('/'). If a value is provided, the component will handle all requests by doing all file operations itself, but the events will still give you the opportunity to override the default values and operations, as necessary.

If a value is not provided, all events must be handled appropriately to ensure correct operation.

SSHCert Property (SFTPServer Component)

A certificate to be used during Secure Shell (SSH) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSHCert { get; set; }

Public Property SSHCert As Certificate

Remarks

The digital certificate that the server will use during SSH negotiation. A certificate with a private key is required for session authentication and encryption.

This is the server's certificate, and must be set before setting Listening to True.

SSHCompressionAlgorithms Property (SFTPServer Component)

The comma-separated list containing all allowable compression algorithms.

Syntax

• C#
• VB.NET

public string SSHCompressionAlgorithms { get; set; }

Public Property SSHCompressionAlgorithms As String

Default Value

"none,zlib"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the component will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following compression algorithms are supported by the component:

• zlib
• zlib@openssh.com
• none

SSHEncryptionAlgorithms Property (SFTPServer Component)

The comma-separated list containing all allowable encryption algorithms.

Syntax

• C#
• VB.NET

public string SSHEncryptionAlgorithms { get; set; }

Public Property SSHEncryptionAlgorithms As String

Default Value

"aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"

Remarks

During the Secure Shell (SSH) handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the component will raise an error and the connection will be aborted.

At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the component:

Config Method (SFTPServer Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of 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.

Disconnect Method (SFTPServer Component)

This method disconnects the specified client.

Syntax

• C#
• VB.NET

public void Disconnect(string connectionId);

Async Version
public async Task Disconnect(string connectionId);
public async Task Disconnect(string connectionId, CancellationToken cancellationToken);

Public Sub Disconnect(ByVal ConnectionId As String)

Async Version
Public Sub Disconnect(ByVal ConnectionId As String) As Task
Public Sub Disconnect(ByVal ConnectionId As String, cancellationToken As CancellationToken) As Task

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (SFTPServer Component)

This method processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

When DoEvents is called, the component processes any available events. If no events are available, it waits for a preset period of time, and then returns.

ExchangeKeys Method (SFTPServer Component)

Causes the component to exchange a new set of session keys on the specified connection.

Syntax

• C#
• VB.NET

public void ExchangeKeys(string connectionId);

Async Version
public async Task ExchangeKeys(string connectionId);
public async Task ExchangeKeys(string connectionId, CancellationToken cancellationToken);

Public Sub ExchangeKeys(ByVal ConnectionId As String)

Async Version
Public Sub ExchangeKeys(ByVal ConnectionId As String) As Task
Public Sub ExchangeKeys(ByVal ConnectionId As String, cancellationToken As CancellationToken) As Task

Remarks

Secure Shell (SSH) key renegotiation can be initiated by either end of an established SSH connection. ExchangeKeys allows the server to start such a renegotiation with the client. During this process, SSHStatus events will fire containing updates regarding the key negotiation process.

The SSH 2.0 specification recommends that key renegotiation be done once for 2 gigabytes (GB) of data processed by the connection, or once every day. This makes it more difficult to break the security of data-intensive or long-lived connections.

Reset Method (SFTPServer Component)

This method will reset the component.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

This method will reset the component's properties to their default values.

SetFileList Method (SFTPServer Component)

Sets the file list for a connection during a directory listing request.

Syntax

• C#
• VB.NET

public void SetFileList(string connectionId, string[] list);

Async Version
public async Task SetFileList(string connectionId, string[] list);
public async Task SetFileList(string connectionId, string[] list, CancellationToken cancellationToken);

Public Sub SetFileList(ByVal ConnectionId As String, ByVal List As String())

Async Version
Public Sub SetFileList(ByVal ConnectionId As String, ByVal List As String()) As Task
Public Sub SetFileList(ByVal ConnectionId As String, ByVal List As String(), cancellationToken As CancellationToken) As Task

Remarks

SetFileList should be set when a directory listing is requested by the client.

Shutdown Method (SFTPServer Component)

This method shuts down the server.

Syntax

• C#
• VB.NET

public void Shutdown();

Async Version
public async Task Shutdown();
public async Task Shutdown(CancellationToken cancellationToken);

Public Sub Shutdown()

Async Version
Public Sub Shutdown() As Task
Public Sub Shutdown(cancellationToken As CancellationToken) As Task

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (SFTPServer Component)

This method starts listening for incoming connections.

Syntax

• C#
• VB.NET

public void StartListening();

Async Version
public async Task StartListening();
public async Task StartListening(CancellationToken cancellationToken);

Public Sub StartListening()

Async Version
Public Sub StartListening() As Task
Public Sub StartListening(cancellationToken As CancellationToken) As Task

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (SFTPServer Component)

This method stops listening for new connections.

Syntax

• C#
• VB.NET

public void StopListening();

Async Version
public async Task StopListening();
public async Task StopListening(CancellationToken cancellationToken);

Public Sub StopListening()

Async Version
Public Sub StopListening() As Task
Public Sub StopListening(cancellationToken As CancellationToken) As Task

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (SFTPServer Component)

Fired immediately after a connection completes (or fails).

Syntax

• C#
• VB.NET

public event OnConnectedHandler OnConnected;

public delegate void OnConnectedHandler(object sender, SFTPServerConnectedEventArgs e);

public class SFTPServerConnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int StatusCode { get; }
  public string Description { get; }
  public int CertStoreType { get; set; }
  public string CertStore { get; set; }
  public string CertPassword { get; set; }
  public string CertSubject { get; set; }
}

Public Event OnConnected As OnConnectedHandler

Public Delegate Sub OnConnectedHandler(sender As Object, e As SFTPServerConnectedEventArgs)

Public Class SFTPServerConnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
  Public Property CertStoreType As Integer
  Public Property CertStore As String
  Public Property CertPassword As String
  Public Property CertSubject As String
End Class

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionId is the connection Id of the client requesting the connection.

CertStoreType is the store type of the alternate certificate to use for this connection. The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This field can take one of the following values:

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ConnectionRequest Event (SFTPServer Component)

This event is fired when a request for connection comes from a remote host.

Syntax

• C#
• VB.NET

public event OnConnectionRequestHandler OnConnectionRequest;

public delegate void OnConnectionRequestHandler(object sender, SFTPServerConnectionRequestEventArgs e);

public class SFTPServerConnectionRequestEventArgs : EventArgs {
  public string Address { get; }
  public int Port { get; }
  public bool Accept { get; set; }
}

Public Event OnConnectionRequest As OnConnectionRequestHandler

Public Delegate Sub OnConnectionRequestHandler(sender As Object, e As SFTPServerConnectionRequestEventArgs)

Public Class SFTPServerConnectionRequestEventArgs Inherits EventArgs
  Public ReadOnly Property Address As String
  Public ReadOnly Property Port As Integer
  Public Property Accept As Boolean
End Class

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

DirCreate Event (SFTPServer Component)

Fired when a client wants to create a new directory.

Syntax

• C#
• VB.NET

public event OnDirCreateHandler OnDirCreate;

public delegate void OnDirCreateHandler(object sender, SFTPServerDirCreateEventArgs e);

public class SFTPServerDirCreateEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public int FileType { get; }
  public long FileSize { get; }
  public string FileOwner { get; }
  public string FileGroup { get; }
  public int FilePermissions { get; }
  public long FileATime { get; }
  public long FileCreateTime { get; }
  public long FileMTime { get; }
  public int FileAttribBits { get; }
  public int FileAttribBitsValid { get; }
  public string OtherAttributes { get; }
  public bool BeforeExec { get; }
  public int StatusCode { get; set; }
}

Public Event OnDirCreate As OnDirCreateHandler

Public Delegate Sub OnDirCreateHandler(sender As Object, e As SFTPServerDirCreateEventArgs)

Public Class SFTPServerDirCreateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileType As Integer
  Public ReadOnly Property FileSize As Long
  Public ReadOnly Property FileOwner As String
  Public ReadOnly Property FileGroup As String
  Public ReadOnly Property FilePermissions As Integer
  Public ReadOnly Property FileATime As Long
  Public ReadOnly Property FileCreateTime As Long
  Public ReadOnly Property FileMTime As Long
  Public ReadOnly Property FileAttribBits As Integer
  Public ReadOnly Property FileAttribBitsValid As Integer
  Public ReadOnly Property OtherAttributes As String
  Public ReadOnly Property BeforeExec As Boolean
  Public Property StatusCode As Integer
End Class

Remarks

The Path parameter specifies the path and name of the new directory.

This event is fired both before and after the directory is created. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

File/Directory Attributes are specified using the following values:

FileType: The type of file. Can be one of the following values:

• SSH_FILEXFER_TYPE_REGULAR (1)
• SSH_FILEXFER_TYPE_DIRECTORY (2)
• SSH_FILEXFER_TYPE_SYMLINK (3)
• SSH_FILEXFER_TYPE_SPECIAL (4)
• SSH_FILEXFER_TYPE_UNKNOWN (5)
• SSH_FILEXFER_TYPE_SOCKET (6)
• SSH_FILEXFER_TYPE_CHAR_DEVICE (7)
• SSH_FILEXFER_TYPE_BLOCK_DEVICE (8)
• SSH_FILEXFER_TYPE_FIFO (9)

FileSize: The file size, in bytes.

FileOwner: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4, V5, and V6 of the secure file transfer protocol (SFTP) allow for an arbitrary string.

FileGroup: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4, V5, and V6 of the SFTP allow for an arbitrary string.

FilePermissions: The POSIX-style file permissions.

FileATime: The file last-access time, in milliseconds since January 1, 1970, in UTC.

FileCreateTime: The file creation time, in milliseconds since January 1, 1970, in UTC.

FileMTime: The file last-modified time, in milliseconds since January 1, 1970, in UTC.

FileAttrBits: The file attributes, as a combination of the following values:

• SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001)
• SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002)
• SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004)
• SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008)
• SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010)
• SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020)
• SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040)
• SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080)
• SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100)
• SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200)
• SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400)
• SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800)

FileAttrBitsValid: A mask specifying which bits in FileAttrBits are supported by the server.

OtherAttributes: A semicolon (;) delimited list of Name=Value pairs of other attributes supported by SFTP. These include the following:

• MIMEType (String)
• AllocationSize (64-bit int)
• ATimeNS (int): ATime nanoseconds
• CreateTimeNS (int): CreateTime nanoseconds
• MTimeNS (int): MTime nanoseconds
• TextHint (8-bit int)
• LinkCount (int)
• UntranslatedName (String)

FileMimeType: The MIME type of the file.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

DirList Event (SFTPServer Component)

Fired when a client attempts to open a directory for listing.

Syntax

• C#
• VB.NET

public event OnDirListHandler OnDirList;

public delegate void OnDirListHandler(object sender, SFTPServerDirListEventArgs e);

public class SFTPServerDirListEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public bool BeforeExec { get; }
  public int StatusCode { get; set; }
}

Public Event OnDirList As OnDirListHandler

Public Delegate Sub OnDirListHandler(sender As Object, e As SFTPServerDirListEventArgs)

Public Class SFTPServerDirListEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property BeforeExec As Boolean
  Public Property StatusCode As Integer
End Class

Remarks

The DirList event is fired when a secure file transfer protocol (SFTP) client sends an SSH_FXP_OPENDIR request. The Path parameter will contain the path of the directory to list.

When necessary, you should call SetFileList with the list of files and directories in Path.

This event is fired both before and after the directory is listed. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

DirRemove Event (SFTPServer Component)

Fired when a client wants to delete a directory.

Syntax

• C#
• VB.NET

public event OnDirRemoveHandler OnDirRemove;

public delegate void OnDirRemoveHandler(object sender, SFTPServerDirRemoveEventArgs e);

public class SFTPServerDirRemoveEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public bool BeforeExec { get; }
  public int StatusCode { get; set; }
}

Public Event OnDirRemove As OnDirRemoveHandler

Public Delegate Sub OnDirRemoveHandler(sender As Object, e As SFTPServerDirRemoveEventArgs)

Public Class SFTPServerDirRemoveEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property BeforeExec As Boolean
  Public Property StatusCode As Integer
End Class

Remarks

The Path parameter will specify the directory to delete.

This event is fired both before and after the directory is deleted. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

Disconnected Event (SFTPServer Component)

This event is fired when a connection is closed.

Syntax

• C#
• VB.NET

public event OnDisconnectedHandler OnDisconnected;

public delegate void OnDisconnectedHandler(object sender, SFTPServerDisconnectedEventArgs e);

public class SFTPServerDisconnectedEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int StatusCode { get; }
  public string Description { get; }
}

Public Event OnDisconnected As OnDisconnectedHandler

Public Delegate Sub OnDisconnectedHandler(sender As Object, e As SFTPServerDisconnectedEventArgs)

Public Class SFTPServerDisconnectedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property StatusCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Error Event (SFTPServer Component)

Fired when errors occur during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

public class SFTPServerErrorEventArgs : EventArgs {
  public string ConnectionId { get; }
  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 ConnectionId As String
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

ConnectionId 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 Error Codes section.

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 Error Codes section.

FileClose Event (SFTPServer Component)

Fired when a client attempts to close an open file or directory handle.

Syntax

• C#
• VB.NET

public event OnFileCloseHandler OnFileClose;

public delegate void OnFileCloseHandler(object sender, SFTPServerFileCloseEventArgs e);

public class SFTPServerFileCloseEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public string Handle { get; }
  public int StatusCode { get; set; }
}

Public Event OnFileClose As OnFileCloseHandler

Public Delegate Sub OnFileCloseHandler(sender As Object, e As SFTPServerFileCloseEventArgs)

Public Class SFTPServerFileCloseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property Handle As String
  Public Property StatusCode As Integer
End Class

Remarks

The FileClose event is fired when a secure file transfer protocol (SFTP) client sends an SSH_FXP_CLOSE request. The Path parameter will contain the path of the file to close.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

FileOpen Event (SFTPServer Component)

Fired when a client wants to open or create a file.

Syntax

• C#
• VB.NET

public event OnFileOpenHandler OnFileOpen;

public delegate void OnFileOpenHandler(object sender, SFTPServerFileOpenEventArgs e);

public class SFTPServerFileOpenEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public int DesiredAccess { get; }
  public int Flags { get; }
  public int FileType { get; }
  public long FileSize { get; }
  public string FileOwner { get; }
  public string FileGroup { get; }
  public int FilePermissions { get; }
  public long FileATime { get; }
  public long FileCreateTime { get; }
  public long FileMTime { get; }
  public int FileAttribBits { get; }
  public int FileAttribBitsValid { get; }
  public string OtherAttributes { get; }
  public string Handle { get; set; }
  public bool BeforeExec { get; }
  public int StatusCode { get; set; }
}

Public Event OnFileOpen As OnFileOpenHandler

Public Delegate Sub OnFileOpenHandler(sender As Object, e As SFTPServerFileOpenEventArgs)

Public Class SFTPServerFileOpenEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property DesiredAccess As Integer
  Public ReadOnly Property Flags As Integer
  Public ReadOnly Property FileType As Integer
  Public ReadOnly Property FileSize As Long
  Public ReadOnly Property FileOwner As String
  Public ReadOnly Property FileGroup As String
  Public ReadOnly Property FilePermissions As Integer
  Public ReadOnly Property FileATime As Long
  Public ReadOnly Property FileCreateTime As Long
  Public ReadOnly Property FileMTime As Long
  Public ReadOnly Property FileAttribBits As Integer
  Public ReadOnly Property FileAttribBitsValid As Integer
  Public ReadOnly Property OtherAttributes As String
  Public Property Handle As String
  Public ReadOnly Property BeforeExec As Boolean
  Public Property StatusCode As Integer
End Class

Remarks

The Path parameter specifies the path and name of the file to open, create. If the operation can be completed successfully, the Handle parameter should be set to the handle identifying the opened file.

Note: The Handle parameter is limited to a 256-byte string. By default, the component will provide an incremental numeric string value for the Handle.

This event is fired both before and after the file is opened. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

The Flags parameter specifies file creation and locking options as a bitmask. This may be a combination of the following values:

• SSH_FXF_READ (0x00000001)
• SSH_FXF_WRITE (0x00000002)
• SSH_FXF_APPEND (0x00000004)
• SSH_FXF_CREAT (0x00000008)
• SSH_FXF_TRUNC (0x00000010)
• SSH_FXF_EXCL (0x00000020)

The DesiredAccess parameter is a bitmask containing a combination of values from the ace-mask flags (only for protocol versions 4 and up). This may be a combination of the following values:

• ACE4_READ_DATA (0x00000001)
• ACE4_LIST_DIRECTORY (0x00000001)
• ACE4_WRITE_DATA (0x00000002)
• ACE4_ADD_FILE (0x00000002)
• ACE4_APPEND_DATA (0x00000004)
• ACE4_ADD_SUBDIRECTORY (0x00000004)
• ACE4_READ_NAMED_ATTRS (0x00000008)
• ACE4_WRITE_NAMED_ATTRS (0x00000010)
• ACE4_EXECUTE (0x00000020)
• ACE4_DELETE_CHILD (0x00000040)
• ACE4_READ_ATTRIBUTES (0x00000080)
• ACE4_WRITE_ATTRIBUTES (0x00000100)
• ACE4_DELETE (0x00010000)
• ACE4_READ_ACL (0x00020000)
• ACE4_WRITE_ACL (0x00040000)
• ACE4_WRITE_OWNER (0x00080000)
• ACE4_SYNCHRONIZE (0x00100000)

File/Directory Attributes are specified using the following values:

FileType: The type of file. Can be one of the following values:

• SSH_FILEXFER_TYPE_REGULAR (1)
• SSH_FILEXFER_TYPE_DIRECTORY (2)
• SSH_FILEXFER_TYPE_SYMLINK (3)
• SSH_FILEXFER_TYPE_SPECIAL (4)
• SSH_FILEXFER_TYPE_UNKNOWN (5)
• SSH_FILEXFER_TYPE_SOCKET (6)
• SSH_FILEXFER_TYPE_CHAR_DEVICE (7)
• SSH_FILEXFER_TYPE_BLOCK_DEVICE (8)
• SSH_FILEXFER_TYPE_FIFO (9)

FileSize: The file size, in bytes.

FileOwner: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4, V5, and V6 of the secure file transfer protocol (SFTP) allow for an arbitrary string.

FileGroup: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4, V5, and V6 of the SFTP allow for an arbitrary string.

FilePermissions: The POSIX-style file permissions.

FileATime: The file last-access time, in milliseconds since January 1, 1970, in UTC.

FileCreateTime: The file creation time, in milliseconds since January 1, 1970, in UTC.

FileMTime: The file last-modified time, in milliseconds since January 1, 1970, in UTC.

FileAttrBits: The file attributes, as a combination of the following values:

• SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001)
• SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002)
• SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004)
• SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008)
• SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010)
• SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020)
• SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040)
• SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080)
• SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100)
• SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200)
• SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400)
• SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800)

FileAttrBitsValid: A mask specifying which bits in FileAttrBits are supported by the server.

OtherAttributes: A semicolon (;) delimited list of Name=Value pairs of other attributes supported by SFTP. These include the following:

• MIMEType (String)
• AllocationSize (64-bit int)
• ATimeNS (int): ATime nanoseconds
• CreateTimeNS (int): CreateTime nanoseconds
• MTimeNS (int): MTime nanoseconds
• TextHint (8-bit int)
• LinkCount (int)
• UntranslatedName (String)

FileMimeType: The MIME type of the file.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

FileRead Event (SFTPServer Component)

Fired when a client wants to read from an open file.

Syntax

• C#
• VB.NET

public event OnFileReadHandler OnFileRead;

public delegate void OnFileReadHandler(object sender, SFTPServerFileReadEventArgs e);

public class SFTPServerFileReadEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Handle { get; }
  public long FileOffset { get; }
  public int Length { get; }
  public int StatusCode { get; set; }
}

Public Event OnFileRead As OnFileReadHandler

Public Delegate Sub OnFileReadHandler(sender As Object, e As SFTPServerFileReadEventArgs)

Public Class SFTPServerFileReadEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Handle As String
  Public ReadOnly Property FileOffset As Long
  Public ReadOnly Property Length As Integer
  Public Property StatusCode As Integer
End Class

Remarks

The Handle parameter identifies an open file on the server. FileOffset specifies the position from which to read data. Length specifies how much data to read. The data read should be set to through FileData

When processing a read request, the server should attempt to read at most Length bytes, but it is okay to read less than Length bytes as well, if no more data are available.

When there are no more data to be read from the file, set StatusCode to SSH_FXS_EOF.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

FileRemove Event (SFTPServer Component)

Fired when a client wants to delete a file.

Syntax

• C#
• VB.NET

public event OnFileRemoveHandler OnFileRemove;

public delegate void OnFileRemoveHandler(object sender, SFTPServerFileRemoveEventArgs e);

public class SFTPServerFileRemoveEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public bool BeforeExec { get; }
  public int StatusCode { get; set; }
}

Public Event OnFileRemove As OnFileRemoveHandler

Public Delegate Sub OnFileRemoveHandler(sender As Object, e As SFTPServerFileRemoveEventArgs)

Public Class SFTPServerFileRemoveEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property BeforeExec As Boolean
  Public Property StatusCode As Integer
End Class

Remarks

The Path parameter will specify the file to delete.

This event is fired both before and after the file is removed. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

FileRename Event (SFTPServer Component)

Fired when a client wants to rename a file.

Syntax

• C#
• VB.NET

public event OnFileRenameHandler OnFileRename;

public delegate void OnFileRenameHandler(object sender, SFTPServerFileRenameEventArgs e);

public class SFTPServerFileRenameEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public string NewPath { get; }
  public int Flags { get; }
  public bool BeforeExec { get; }
  public int StatusCode { get; set; }
}

Public Event OnFileRename As OnFileRenameHandler

Public Delegate Sub OnFileRenameHandler(sender As Object, e As SFTPServerFileRenameEventArgs)

Public Class SFTPServerFileRenameEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property NewPath As String
  Public ReadOnly Property Flags As Integer
  Public ReadOnly Property BeforeExec As Boolean
  Public Property StatusCode As Integer
End Class

Remarks

The Path parameter will specify the file to rename and NewPath will specify the new name. The Flags parameter will be a bit mask of the values SSH_FXF_RENAME_OVERWRITE (0x00000001), SSH_FXF_RENAME_ATOMIC (0x00000002), and SSH_FXF_RENAME_NATIVE (0x00000004).

This event is fired both before and after the file is renamed. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

FileWrite Event (SFTPServer Component)

Fired when a client wants to write to an open file.

Syntax

• C#
• VB.NET

public event OnFileWriteHandler OnFileWrite;

public delegate void OnFileWriteHandler(object sender, SFTPServerFileWriteEventArgs e);

public class SFTPServerFileWriteEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Handle { get; }
  public long FileOffset { get; }
  public bool BeforeExec { get; }
  public int StatusCode { get; set; }
}

Public Event OnFileWrite As OnFileWriteHandler

Public Delegate Sub OnFileWriteHandler(sender As Object, e As SFTPServerFileWriteEventArgs)

Public Class SFTPServerFileWriteEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Handle As String
  Public ReadOnly Property FileOffset As Long
  Public ReadOnly Property BeforeExec As Boolean
  Public Property StatusCode As Integer
End Class

Remarks

The Handle parameter identifies an open file on the server. FileOffset specifies the position at which to write data. The data to write can be retrieved through FileData

This event is fired both before and after the file is written. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

GetAttributes Event (SFTPServer Component)

Fired when a client needs to get file information.

Syntax

• C#
• VB.NET

public event OnGetAttributesHandler OnGetAttributes;

public delegate void OnGetAttributesHandler(object sender, SFTPServerGetAttributesEventArgs e);

public class SFTPServerGetAttributesEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public int Flags { get; }
  public int FileType { get; set; }
  public long FileSize { get; set; }
  public string FileOwner { get; set; }
  public string FileGroup { get; set; }
  public int FilePermissions { get; set; }
  public long FileATime { get; set; }
  public long FileCreateTime { get; set; }
  public long FileMTime { get; set; }
  public int FileAttribBits { get; set; }
  public int FileAttribBitsValid { get; set; }
  public string OtherAttributes { get; set; }
  public int StatusCode { get; set; }
}

Public Event OnGetAttributes As OnGetAttributesHandler

Public Delegate Sub OnGetAttributesHandler(sender As Object, e As SFTPServerGetAttributesEventArgs)

Public Class SFTPServerGetAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property Flags As Integer
  Public Property FileType As Integer
  Public Property FileSize As Long
  Public Property FileOwner As String
  Public Property FileGroup As String
  Public Property FilePermissions As Integer
  Public Property FileATime As Long
  Public Property FileCreateTime As Long
  Public Property FileMTime As Long
  Public Property FileAttribBits As Integer
  Public Property FileAttribBitsValid As Integer
  Public Property OtherAttributes As String
  Public Property StatusCode As Integer
End Class

Remarks

The GetAttributes event fires when a secure file transfer protocol (SFTP) client sends an SSH_FXP_STAT, SSH_FXP_LSTAT, or SSH_FXP_FSTAT request. Path is the file path. Flags specifies the set of file attributes the client is interested in.

File/Directory Attributes are specified using the following values:

FileType: The type of file. Can be one of the following values:

• SSH_FILEXFER_TYPE_REGULAR (1)
• SSH_FILEXFER_TYPE_DIRECTORY (2)
• SSH_FILEXFER_TYPE_SYMLINK (3)
• SSH_FILEXFER_TYPE_SPECIAL (4)
• SSH_FILEXFER_TYPE_UNKNOWN (5)
• SSH_FILEXFER_TYPE_SOCKET (6)
• SSH_FILEXFER_TYPE_CHAR_DEVICE (7)
• SSH_FILEXFER_TYPE_BLOCK_DEVICE (8)
• SSH_FILEXFER_TYPE_FIFO (9)

FileSize: The file size, in bytes.

FileOwner: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4, V5, and V6 of the secure file transfer protocol (SFTP) allow for an arbitrary string.

FileGroup: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4, V5, and V6 of the SFTP allow for an arbitrary string.

FilePermissions: The POSIX-style file permissions.

FileATime: The file last-access time, in milliseconds since January 1, 1970, in UTC.

FileCreateTime: The file creation time, in milliseconds since January 1, 1970, in UTC.

FileMTime: The file last-modified time, in milliseconds since January 1, 1970, in UTC.

FileAttrBits: The file attributes, as a combination of the following values:

• SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001)
• SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002)
• SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004)
• SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008)
• SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010)
• SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020)
• SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040)
• SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080)
• SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100)
• SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200)
• SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400)
• SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800)

FileAttrBitsValid: A mask specifying which bits in FileAttrBits are supported by the server.

OtherAttributes: A semicolon (;) delimited list of Name=Value pairs of other attributes supported by SFTP. These include the following:

• MIMEType (String)
• AllocationSize (64-bit int)
• ATimeNS (int): ATime nanoseconds
• CreateTimeNS (int): CreateTime nanoseconds
• MTimeNS (int): MTime nanoseconds
• TextHint (8-bit int)
• LinkCount (int)
• UntranslatedName (String)

FileMimeType: The MIME type of the file.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

Log Event (SFTPServer Component)

Fired once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, SFTPServerLogEventArgs e);

public class SFTPServerLogEventArgs : EventArgs {
  public string ConnectionId { get; }
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As SFTPServerLogEventArgs)

Public Class SFTPServerLogEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

Fired once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the detail level of the message. Possible values are as follows:

Message is the log message.

LogType is reserved for future use.

ConnectionId identifies the connection to which the log message applies.

ResolvePath Event (SFTPServer Component)

Fired when a client attempts to canonicalize a path.

Syntax

• C#
• VB.NET

public event OnResolvePathHandler OnResolvePath;

public delegate void OnResolvePathHandler(object sender, SFTPServerResolvePathEventArgs e);

public class SFTPServerResolvePathEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string OriginalPath { get; }
  public int ControlFlags { get; }
  public string RealPath { get; set; }
  public int StatusCode { get; set; }
}

Public Event OnResolvePath As OnResolvePathHandler

Public Delegate Sub OnResolvePathHandler(sender As Object, e As SFTPServerResolvePathEventArgs)

Public Class SFTPServerResolvePathEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property OriginalPath As String
  Public ReadOnly Property ControlFlags As Integer
  Public Property RealPath As String
  Public Property StatusCode As Integer
End Class

Remarks

The ResolvePath event is fired when a secure file transfer protocol (SFTP) client sends an SSH_FXP_REALPATH request. The OriginalPath parameter will contain the path the client wants to canonicalize. ControlFlags can have one of the following values:

RealPath should be set to the resulting canonicalized path, and StatusCode should be set to indicate the success or failure of the operation to the client.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

SetAttributes Event (SFTPServer Component)

Fired when a client attempts to set file or directory attributes.

Syntax

• C#
• VB.NET

public event OnSetAttributesHandler OnSetAttributes;

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

public class SFTPServerSetAttributesEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Path { get; }
  public int FileType { get; }
  public long FileSize { get; }
  public string FileOwner { get; }
  public string FileGroup { get; }
  public int FilePermissions { get; }
  public long FileATime { get; }
  public long FileCreateTime { get; }
  public long FileMTime { get; }
  public int FileAttribBits { get; }
  public int FileAttribBitsValid { get; }
  public string OtherAttributes { get; }
  public bool BeforeExec { get; }
  public int StatusCode { 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 String
  Public ReadOnly Property User As String
  Public ReadOnly Property Path As String
  Public ReadOnly Property FileType As Integer
  Public ReadOnly Property FileSize As Long
  Public ReadOnly Property FileOwner As String
  Public ReadOnly Property FileGroup As String
  Public ReadOnly Property FilePermissions As Integer
  Public ReadOnly Property FileATime As Long
  Public ReadOnly Property FileCreateTime As Long
  Public ReadOnly Property FileMTime As Long
  Public ReadOnly Property FileAttribBits As Integer
  Public ReadOnly Property FileAttribBitsValid As Integer
  Public ReadOnly Property OtherAttributes As String
  Public ReadOnly Property BeforeExec As Boolean
  Public Property StatusCode As Integer
End Class

Remarks

The SetAttributes event is fired when a secure file transfer protocol (SFTP) client sends an SSH_FXP_SETSTAT, SSH_FXP_FSETSTAT, or SSH_FXP_FSTAT request. Path is the path of the file or directory the client wants to set attributes for.

This event is fired both before and after the attributes are set. The BeforeExec parameter is True before the operation has been executed and False otherwise. Handling this event before execution of the operation provides an opportunity to add custom logic that may prevent or deny the operation. Handling this event after execution of the operation provides an opportunity to report any errors that may have occurred during the operation.

File/Directory Attributes are specified using the following values:

FileType: The type of file. Can be one of the following values:

• SSH_FILEXFER_TYPE_REGULAR (1)
• SSH_FILEXFER_TYPE_DIRECTORY (2)
• SSH_FILEXFER_TYPE_SYMLINK (3)
• SSH_FILEXFER_TYPE_SPECIAL (4)
• SSH_FILEXFER_TYPE_UNKNOWN (5)
• SSH_FILEXFER_TYPE_SOCKET (6)
• SSH_FILEXFER_TYPE_CHAR_DEVICE (7)
• SSH_FILEXFER_TYPE_BLOCK_DEVICE (8)
• SSH_FILEXFER_TYPE_FIFO (9)

FileSize: The file size, in bytes.

FileOwner: The file owner. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like user identifier. V4, V5, and V6 of the secure file transfer protocol (SFTP) allow for an arbitrary string.

FileGroup: The file owner group. If the ProtocolVersion configuration option is "3" (default), this field should be a numeric Unix-like group identifier. V4, V5, and V6 of the SFTP allow for an arbitrary string.

FilePermissions: The POSIX-style file permissions.

FileATime: The file last-access time, in milliseconds since January 1, 1970, in UTC.

FileCreateTime: The file creation time, in milliseconds since January 1, 1970, in UTC.

FileMTime: The file last-modified time, in milliseconds since January 1, 1970, in UTC.

FileAttrBits: The file attributes, as a combination of the following values:

• SSH_FILEXFER_ATTR_FLAGS_READONLY (0x00000001)
• SSH_FILEXFER_ATTR_FLAGS_SYSTEM (0x00000002)
• SSH_FILEXFER_ATTR_FLAGS_HIDDEN (0x00000004)
• SSH_FILEXFER_ATTR_FLAGS_CASE_INSENSITIVE (0x00000008)
• SSH_FILEXFER_ATTR_FLAGS_ARCHIVE (0x00000010)
• SSH_FILEXFER_ATTR_FLAGS_ENCRYPTED (0x00000020)
• SSH_FILEXFER_ATTR_FLAGS_COMPRESSED (0x00000040)
• SSH_FILEXFER_ATTR_FLAGS_SPARSE (0x00000080)
• SSH_FILEXFER_ATTR_FLAGS_APPEND_ONLY (0x00000100)
• SSH_FILEXFER_ATTR_FLAGS_IMMUTABLE (0x00000200)
• SSH_FILEXFER_ATTR_FLAGS_SYNC (0x00000400)
• SSH_FILEXFER_ATTR_FLAGS_TRANSLATION_ERR (0x00000800)

FileAttrBitsValid: A mask specifying which bits in FileAttrBits are supported by the server.

OtherAttributes: A semicolon (;) delimited list of Name=Value pairs of other attributes supported by SFTP. These include the following:

• MIMEType (String)
• AllocationSize (64-bit int)
• ATimeNS (int): ATime nanoseconds
• CreateTimeNS (int): CreateTime nanoseconds
• MTimeNS (int): MTime nanoseconds
• TextHint (8-bit int)
• LinkCount (int)
• UntranslatedName (String)

FileMimeType: The MIME type of the file.

Valid status codes are as follows:

• SSH_FX_OK 0
• SSH_FX_EOF 1
• SSH_FX_NO_SUCH_FILE 2
• SSH_FX_PERMISSION_DENIED 3
• SSH_FX_FAILURE 4
• SSH_FX_BAD_MESSAGE 5
• SSH_FX_NO_CONNECTION 6
• SSH_FX_CONNECTION_LOST 7
• SSH_FX_OP_UNSUPPORTED 8
• SSH_FX_INVALID_HANDLE 9
• SSH_FX_NO_SUCH_PATH 10
• SSH_FX_FILE_ALREADY_EXISTS 11
• SSH_FX_WRITE_PROTECT 12
• SSH_FX_NO_MEDIA 13
• SSH_FX_NO_SPACE_ON_FILESYSTEM 14
• SSH_FX_QUOTA_EXCEEDED 15
• SSH_FX_UNKNOWN_PRINCIPAL 16
• SSH_FX_LOCK_CONFLICT 17
• SSH_FX_DIR_NOT_EMPTY 18
• SSH_FX_NOT_A_DIRECTORY 19
• SSH_FX_INVALID_FILENAME 20
• SSH_FX_LINK_LOOP 21
• SSH_FX_CANNOT_DELETE 22
• SSH_FX_INVALID_PARAMETER 23
• SSH_FX_FILE_IS_A_DIRECTORY 24
• SSH_FX_BYTE_RANGE_LOCK_CONFLICT 25
• SSH_FX_BYTE_RANGE_LOCK_REFUSED 26
• SSH_FX_DELETE_PENDING 27
• SSH_FX_FILE_CORRUPT 28
• SSH_FX_OWNER_INVALID 29
• SSH_FX_GROUP_INVALID 30
• SSH_FX_NO_MATCHING_BYTE_RANGE_LOCK 31

SSHStatus Event (SFTPServer Component)

Fired to track the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSHStatusHandler OnSSHStatus;

public delegate void OnSSHStatusHandler(object sender, SFTPServerSSHStatusEventArgs e);

public class SFTPServerSSHStatusEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string Message { get; }
}

Public Event OnSSHStatus As OnSSHStatusHandler

Public Delegate Sub OnSSHStatusHandler(sender As Object, e As SFTPServerSSHStatusEventArgs)

Public Class SFTPServerSSHStatusEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property Message As String
End Class

Remarks

This event is fired for informational and logging purposes only and is used to track the progress of the connection.

SSHUserAuthRequest Event (SFTPServer Component)

Fired when a client attempts to authenticate a connection.

Syntax

• C#
• VB.NET

public event OnSSHUserAuthRequestHandler OnSSHUserAuthRequest;

public delegate void OnSSHUserAuthRequestHandler(object sender, SFTPServerSSHUserAuthRequestEventArgs e);

public class SFTPServerSSHUserAuthRequestEventArgs : EventArgs {
  public string ConnectionId { get; }
  public string User { get; }
  public string Service { get; }
  public string AuthMethod { get; }
  public string AuthParam { get; }
  public bool Accept { get; set; }
  public bool PartialSuccess { get; set; }
  public string AvailableMethods { get; set; }
  public string HomeDir { get; set; }
  public string KeyAlgorithm { get; }
}

Public Event OnSSHUserAuthRequest As OnSSHUserAuthRequestHandler

Public Delegate Sub OnSSHUserAuthRequestHandler(sender As Object, e As SFTPServerSSHUserAuthRequestEventArgs)

Public Class SFTPServerSSHUserAuthRequestEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionId As String
  Public ReadOnly Property User As String
  Public ReadOnly Property Service As String
  Public ReadOnly Property AuthMethod As String
  Public ReadOnly Property AuthParam As String
  Public Property Accept As Boolean
  Public Property PartialSuccess As Boolean
  Public Property AvailableMethods As String
  Public Property HomeDir As String
  Public ReadOnly Property KeyAlgorithm As String
End Class

Remarks

The SSHUserAuthRequest event fires when a Secure Shell (SSH) client attempts to authenticate itself on a particular connection. ConnectionId will identify the connection being authenticated. User will be the name of the account requesting authentication, and Service will contain the name of the service the client is wishing to access.

AuthMethod will denote which method the client is attempting to use to authenticate itself. AuthParam will contain the value of the authentication token used by the client. If the token is acceptable, you may set Accept to True to allow the SFTPServer to authenticate the client. If it is not, set Accept to False.

Connecting clients will initially attempt authentication with an AuthMethod of "none". This is done with the expectation that the request will fail and the server will send a list of supported methods back to the client. In your implementation, check the AuthMethod parameter; if it is "none", you should set AvailableMethods and reject the request. The client will select one of the available methods and reauthenticate.

You may set AvailableMethods to a comma-delimited string of authentication methods that are available for the user. This list will be sent back to the client so that it may perform further authentication attempts.

The following is a list of methods implemented by the component:

If the user authentication succeeds, you may set HomeDir to the virtual path representing the initial directory for the user. If not set, the initial directory will be RootDirectory.

The PartialSuccess parameter is used only when multifactor authentication is needed. To implement multifactor authentication when this event fires, first verify the AuthParam for the given AuthMethod. If accepted, set PartialSuccess to True and Accept to False. The client should then send the authentication request for a different form of authentication specified in AvailableMethods. You may continue to set PartialSuccess to True until all authentication requirements are satisfied. Once all requirements are satisfied set Accept to True.

KeyAlgorithm holds the signing algorithm used when the client attempts public key authentication. Possible values are as follows:

• ssh-rsa
• rsa-sha2-256
• rsa-sha2-512
• ssh-dss
• ecdsa-sha2-nistp256
• ecdsa-sha2-nistp384
• ecdsa-sha2-nistp521
• x509v3-sign-rsa
• x509v3-sign-dss

Note: Processing long-running requests, including sending channel data, inside this event may cause the underlying transport to stop processing Secure Shell (SSH) data until the event returns. To prevent this from happening, all requests should be processed asynchronously in a separate thread outside of this event.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

SFTPConnection Type

A currently connected client.

Remarks

This type describes the connection of a client that currently is connected to the component. You may use the different fields of this type to manage the connection.

Fields

Constructors

• C#
• VB.NET

public SFTPConnection();

Public SFTPConnection()

SSHPrompt Type

A prompt to provide to the client during keyboard-interactive authentication.

Remarks

This type describes a prompt the Secure Shell (SSH) daemon will send to the client when requesting keyboard-interactive authentication.

Fields

Constructors

• C#
• VB.NET

public SSHPrompt();

Public SSHPrompt()

• C#
• VB.NET

public SSHPrompt(string prompt, bool echo);

Public SSHPrompt(ByVal Prompt As String, ByVal Echo As Boolean)

Config Settings (SFTPServer Component)

SFTPServer Config Settings

Root Directory: /

bin
boot
etc
home
  user1
    testfolder

Home Directory: /home/user1

/testfolder

Root Directory: /

bin
boot
etc
home
  user1
    testfolder

Home Directory: /

/testfolder

SSHServer Config Settings

*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*

TCPServer Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Base Config Settings

Trappable Errors (SFTPServer Component)

SFTPServer Errors

The component may also return one of the following error codes, which are inherited from other components.

SSHServer Errors

TCPServer Errors

TCP/IP Errors