SFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

SFTPServer

Remarks

The SFTPServer class 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 class 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 class 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 class'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.

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 class with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

ConnectionBacklog Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

Unicode (Windows)
INT GetConnectionBacklog();
INT SetConnectionBacklog(INT iConnectionBacklog);

int ipworksssh_sftpserver_getconnectionbacklog(void* lpObj);
int ipworksssh_sftpserver_setconnectionbacklog(void* lpObj, int iConnectionBacklog);

int GetConnectionBacklog();
int SetConnectionBacklog(int iConnectionBacklog);

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.

Data Type

Integer

Connections Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

IPWorksSSHList<IPWorksSSHSFTPConnection>* GetConnections();

int ipworksssh_sftpserver_getsftpconnectioncount(void* lpObj);

int ipworksssh_sftpserver_getsftpconnectionconnected(void* lpObj, int connectionid);

char* ipworksssh_sftpserver_getsftpconnectionerrormessage(void* lpObj, int connectionid);

int ipworksssh_sftpserver_getsftpconnectionfiledata(void* lpObj, int connectionid, char** lpSFTPConnectionFileData, int* lenSFTPConnectionFileData);
int ipworksssh_sftpserver_setsftpconnectionfiledata(void* lpObj, int connectionid, const char* lpSFTPConnectionFileData, int lenSFTPConnectionFileData);

char* ipworksssh_sftpserver_getsftpconnectionlocaladdress(void* lpObj, int connectionid);

int ipworksssh_sftpserver_getsftpconnectionprotocolversion(void* lpObj, int connectionid);

char* ipworksssh_sftpserver_getsftpconnectionremotehost(void* lpObj, int connectionid);

int ipworksssh_sftpserver_getsftpconnectionremoteport(void* lpObj, int connectionid);

int ipworksssh_sftpserver_getsftpconnectiontimeout(void* lpObj, int connectionid);
int ipworksssh_sftpserver_setsftpconnectiontimeout(void* lpObj, int connectionid, int iSFTPConnectionTimeout);

int GetSFTPConnectionCount();

bool GetSFTPConnectionConnected(int iConnectionId);

QString GetSFTPConnectionErrorMessage(int iConnectionId);

QByteArray GetSFTPConnectionFileData(int iConnectionId);
int SetSFTPConnectionFileData(int iConnectionId, QByteArray qbaSFTPConnectionFileData);

QString GetSFTPConnectionLocalAddress(int iConnectionId);

int GetSFTPConnectionProtocolVersion(int iConnectionId);

QString GetSFTPConnectionRemoteHost(int iConnectionId);

int GetSFTPConnectionRemotePort(int iConnectionId);

int GetSFTPConnectionTimeout(int iConnectionId);
int SetSFTPConnectionTimeout(int iConnectionId, int iSFTPConnectionTimeout);

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.

Data Type

IPWorksSSHSFTPConnection

DefaultAuthMethods Property (SFTPServer Class)

The supported authentication methods.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDefaultAuthMethods();
int SetDefaultAuthMethods(const char* lpszDefaultAuthMethods);

Unicode (Windows)
LPWSTR GetDefaultAuthMethods();
INT SetDefaultAuthMethods(LPCWSTR lpszDefaultAuthMethods);

char* ipworksssh_sftpserver_getdefaultauthmethods(void* lpObj);
int ipworksssh_sftpserver_setdefaultauthmethods(void* lpObj, const char* lpszDefaultAuthMethods);

QString GetDefaultAuthMethods();
int SetDefaultAuthMethods(QString qsDefaultAuthMethods);

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

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 class:

Data Type

String

DefaultTimeout Property (SFTPServer Class)

An initial timeout value to be used by incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

Unicode (Windows)
INT GetDefaultTimeout();
INT SetDefaultTimeout(INT iDefaultTimeout);

int ipworksssh_sftpserver_getdefaulttimeout(void* lpObj);
int ipworksssh_sftpserver_setdefaulttimeout(void* lpObj, int iDefaultTimeout);

int GetDefaultTimeout();
int SetDefaultTimeout(int iDefaultTimeout);

Default Value

60

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established. If the timeout is set to 0, all inbound connections will behave asynchronously. The default value is 60, meaning the class will behave synchronously.

Data Type

Integer

KeyboardInteractiveMessage Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetKeyboardInteractiveMessage();
int SetKeyboardInteractiveMessage(const char* lpszKeyboardInteractiveMessage);

Unicode (Windows)
LPWSTR GetKeyboardInteractiveMessage();
INT SetKeyboardInteractiveMessage(LPCWSTR lpszKeyboardInteractiveMessage);

char* ipworksssh_sftpserver_getkeyboardinteractivemessage(void* lpObj);
int ipworksssh_sftpserver_setkeyboardinteractivemessage(void* lpObj, const char* lpszKeyboardInteractiveMessage);

QString GetKeyboardInteractiveMessage();
int SetKeyboardInteractiveMessage(QString qsKeyboardInteractiveMessage);

Default Value

""

Remarks

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

Data Type

String

KeyboardInteractivePrompts Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

IPWorksSSHList<IPWorksSSHSSHPrompt>* GetKeyboardInteractivePrompts();
int SetKeyboardInteractivePrompts(IPWorksSSHList<IPWorksSSHSSHPrompt>* val);

int ipworksssh_sftpserver_getkeyboardinteractivepromptcount(void* lpObj);
int ipworksssh_sftpserver_setkeyboardinteractivepromptcount(void* lpObj, int iKeyboardInteractivePromptCount);

int ipworksssh_sftpserver_getkeyboardinteractivepromptecho(void* lpObj, int promptindex);
int ipworksssh_sftpserver_setkeyboardinteractivepromptecho(void* lpObj, int promptindex, int bKeyboardInteractivePromptEcho);

char* ipworksssh_sftpserver_getkeyboardinteractivepromptprompt(void* lpObj, int promptindex);
int ipworksssh_sftpserver_setkeyboardinteractivepromptprompt(void* lpObj, int promptindex, const char* lpszKeyboardInteractivePromptPrompt);

int GetKeyboardInteractivePromptCount();
int SetKeyboardInteractivePromptCount(int iKeyboardInteractivePromptCount);

bool GetKeyboardInteractivePromptEcho(int iPromptIndex);
int SetKeyboardInteractivePromptEcho(int iPromptIndex, bool bKeyboardInteractivePromptEcho);

QString GetKeyboardInteractivePromptPrompt(int iPromptIndex);
int SetKeyboardInteractivePromptPrompt(int iPromptIndex, QString qsKeyboardInteractivePromptPrompt);

Remarks

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

Data Type

IPWorksSSHSSHPrompt

Listening Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetListening();

Unicode (Windows)
BOOL GetListening();

int ipworksssh_sftpserver_getlistening(void* lpObj);

bool GetListening();

Default Value

FALSE

Remarks

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

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

Data Type

Boolean

LocalHost Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* ipworksssh_sftpserver_getlocalhost(void* lpObj);
int ipworksssh_sftpserver_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

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 class initiate connections (or accept in the case of server classs) 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 class 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.

Data Type

String

LocalPort Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLocalPort();
int SetLocalPort(int iLocalPort);

Unicode (Windows)
INT GetLocalPort();
INT SetLocalPort(INT iLocalPort);

int ipworksssh_sftpserver_getlocalport(void* lpObj);
int ipworksssh_sftpserver_setlocalport(void* lpObj, int iLocalPort);

int GetLocalPort();
int SetLocalPort(int iLocalPort);

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

Data Type

Integer

RootDirectory Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRootDirectory();
int SetRootDirectory(const char* lpszRootDirectory);

Unicode (Windows)
LPWSTR GetRootDirectory();
INT SetRootDirectory(LPCWSTR lpszRootDirectory);

char* ipworksssh_sftpserver_getrootdirectory(void* lpObj);
int ipworksssh_sftpserver_setrootdirectory(void* lpObj, const char* lpszRootDirectory);

QString GetRootDirectory();
int SetRootDirectory(QString qsRootDirectory);

Default Value

""

Remarks

RootDirectory specifies the root of the SFTP server ('/'). If a value is provided, the class 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.

Data Type

String

SSHCert Property (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

IPWorksSSHCertificate* GetSSHCert();
int SetSSHCert(IPWorksSSHCertificate* val);

char* ipworksssh_sftpserver_getsshcerteffectivedate(void* lpObj);

char* ipworksssh_sftpserver_getsshcertexpirationdate(void* lpObj);

char* ipworksssh_sftpserver_getsshcertextendedkeyusage(void* lpObj);

char* ipworksssh_sftpserver_getsshcertfingerprint(void* lpObj);

char* ipworksssh_sftpserver_getsshcertfingerprintsha1(void* lpObj);

char* ipworksssh_sftpserver_getsshcertfingerprintsha256(void* lpObj);

char* ipworksssh_sftpserver_getsshcertissuer(void* lpObj);

char* ipworksssh_sftpserver_getsshcertprivatekey(void* lpObj);

int ipworksssh_sftpserver_getsshcertprivatekeyavailable(void* lpObj);

char* ipworksssh_sftpserver_getsshcertprivatekeycontainer(void* lpObj);

char* ipworksssh_sftpserver_getsshcertpublickey(void* lpObj);

char* ipworksssh_sftpserver_getsshcertpublickeyalgorithm(void* lpObj);

int ipworksssh_sftpserver_getsshcertpublickeylength(void* lpObj);

char* ipworksssh_sftpserver_getsshcertserialnumber(void* lpObj);

char* ipworksssh_sftpserver_getsshcertsignaturealgorithm(void* lpObj);

int ipworksssh_sftpserver_getsshcertstore(void* lpObj, char** lpSSHCertStore, int* lenSSHCertStore);
int ipworksssh_sftpserver_setsshcertstore(void* lpObj, const char* lpSSHCertStore, int lenSSHCertStore);

char* ipworksssh_sftpserver_getsshcertstorepassword(void* lpObj);
int ipworksssh_sftpserver_setsshcertstorepassword(void* lpObj, const char* lpszSSHCertStorePassword);

int ipworksssh_sftpserver_getsshcertstoretype(void* lpObj);
int ipworksssh_sftpserver_setsshcertstoretype(void* lpObj, int iSSHCertStoreType);

char* ipworksssh_sftpserver_getsshcertsubjectaltnames(void* lpObj);

char* ipworksssh_sftpserver_getsshcertthumbprintmd5(void* lpObj);

char* ipworksssh_sftpserver_getsshcertthumbprintsha1(void* lpObj);

char* ipworksssh_sftpserver_getsshcertthumbprintsha256(void* lpObj);

char* ipworksssh_sftpserver_getsshcertusage(void* lpObj);

int ipworksssh_sftpserver_getsshcertusageflags(void* lpObj);

char* ipworksssh_sftpserver_getsshcertversion(void* lpObj);

char* ipworksssh_sftpserver_getsshcertsubject(void* lpObj);
int ipworksssh_sftpserver_setsshcertsubject(void* lpObj, const char* lpszSSHCertSubject);

int ipworksssh_sftpserver_getsshcertencoded(void* lpObj, char** lpSSHCertEncoded, int* lenSSHCertEncoded);
int ipworksssh_sftpserver_setsshcertencoded(void* lpObj, const char* lpSSHCertEncoded, int lenSSHCertEncoded);

QString GetSSHCertEffectiveDate();

QString GetSSHCertExpirationDate();

QString GetSSHCertExtendedKeyUsage();

QString GetSSHCertFingerprint();

QString GetSSHCertFingerprintSHA1();

QString GetSSHCertFingerprintSHA256();

QString GetSSHCertIssuer();

QString GetSSHCertPrivateKey();

bool GetSSHCertPrivateKeyAvailable();

QString GetSSHCertPrivateKeyContainer();

QString GetSSHCertPublicKey();

QString GetSSHCertPublicKeyAlgorithm();

int GetSSHCertPublicKeyLength();

QString GetSSHCertSerialNumber();

QString GetSSHCertSignatureAlgorithm();

QByteArray GetSSHCertStore();
int SetSSHCertStore(QByteArray qbaSSHCertStore);

QString GetSSHCertStorePassword();
int SetSSHCertStorePassword(QString qsSSHCertStorePassword);

int GetSSHCertStoreType();
int SetSSHCertStoreType(int iSSHCertStoreType);

QString GetSSHCertSubjectAltNames();

QString GetSSHCertThumbprintMD5();

QString GetSSHCertThumbprintSHA1();

QString GetSSHCertThumbprintSHA256();

QString GetSSHCertUsage();

int GetSSHCertUsageFlags();

QString GetSSHCertVersion();

QString GetSSHCertSubject();
int SetSSHCertSubject(QString qsSSHCertSubject);

QByteArray GetSSHCertEncoded();
int SetSSHCertEncoded(QByteArray qbaSSHCertEncoded);

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.

Data Type

IPWorksSSHCertificate

SSHCompressionAlgorithms Property (SFTPServer Class)

The comma-separated list containing all allowable compression algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(const char* lpszSSHCompressionAlgorithms);

Unicode (Windows)
LPWSTR GetSSHCompressionAlgorithms();
INT SetSSHCompressionAlgorithms(LPCWSTR lpszSSHCompressionAlgorithms);

char* ipworksssh_sftpserver_getsshcompressionalgorithms(void* lpObj);
int ipworksssh_sftpserver_setsshcompressionalgorithms(void* lpObj, const char* lpszSSHCompressionAlgorithms);

QString GetSSHCompressionAlgorithms();
int SetSSHCompressionAlgorithms(QString qsSSHCompressionAlgorithms);

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 class 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 class:

• zlib
• zlib@openssh.com
• none

Data Type

String

SSHEncryptionAlgorithms Property (SFTPServer Class)

The comma-separated list containing all allowable encryption algorithms.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(const char* lpszSSHEncryptionAlgorithms);

Unicode (Windows)
LPWSTR GetSSHEncryptionAlgorithms();
INT SetSSHEncryptionAlgorithms(LPCWSTR lpszSSHEncryptionAlgorithms);

char* ipworksssh_sftpserver_getsshencryptionalgorithms(void* lpObj);
int ipworksssh_sftpserver_setsshencryptionalgorithms(void* lpObj, const char* lpszSSHEncryptionAlgorithms);

QString GetSSHEncryptionAlgorithms();
int SetSSHEncryptionAlgorithms(QString qsSSHEncryptionAlgorithms);

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 class 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 class:

Data Type

String

Config Method (SFTPServer Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksssh_sftpserver_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Disconnect Method (SFTPServer Class)

This method disconnects the specified client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Disconnect(int iConnectionId);

Unicode (Windows)
INT Disconnect(INT iConnectionId);

int ipworksssh_sftpserver_disconnect(void* lpObj, int iConnectionId);

int Disconnect(int iConnectionId);

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (SFTPServer Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int ipworksssh_sftpserver_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ExchangeKeys Method (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExchangeKeys(int iConnectionId);

Unicode (Windows)
INT ExchangeKeys(INT iConnectionId);

int ipworksssh_sftpserver_exchangekeys(void* lpObj, int iConnectionId);

int ExchangeKeys(int iConnectionId);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (SFTPServer Class)

This method will reset the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksssh_sftpserver_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetFileList Method (SFTPServer Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetFileList(int iConnectionId, const char* lpszList);

Unicode (Windows)
INT SetFileList(INT iConnectionId, LPCWSTR lpszList);

int ipworksssh_sftpserver_setfilelist(void* lpObj, int iConnectionId, const char* lpszList);

int SetFileList(int iConnectionId, const QString& qsList);

Remarks

SetFileList should be set when a directory listing is requested by the client. The list parameter should be a string of all the filenames to include, separated by CRLF.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Shutdown Method (SFTPServer Class)

This method shuts down the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Shutdown();

Unicode (Windows)
INT Shutdown();

int ipworksssh_sftpserver_shutdown(void* lpObj);

int Shutdown();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartListening Method (SFTPServer Class)

This method starts listening for incoming connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StartListening();

Unicode (Windows)
INT StartListening();

int ipworksssh_sftpserver_startlistening(void* lpObj);

int StartListening();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StopListening Method (SFTPServer Class)

This method stops listening for new connections.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int StopListening();

Unicode (Windows)
INT StopListening();

int ipworksssh_sftpserver_stoplistening(void* lpObj);

int StopListening();

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Connected Event (SFTPServer Class)

Fired immediately after a connection completes (or fails).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnected(SFTPServerConnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int CertStoreType;
  char *CertStore;
  char *CertPassword;
  char *CertSubject;
  int reserved;
} SFTPServerConnectedEventParams;


Unicode (Windows)
virtual INT FireConnected(SFTPServerConnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT CertStoreType;
  LPWSTR CertStore;
  LPWSTR CertPassword;
  LPWSTR CertSubject;
  INT reserved;
} SFTPServerConnectedEventParams;

#define EID_SFTPSERVER_CONNECTED 1

virtual INT IPWORKSSSH_CALL FireConnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription, INT &iCertStoreType, LPSTR &lpszCertStore, LPSTR &lpszCertPassword, LPSTR &lpszCertSubject);

class SFTPServerConnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int CertStoreType();
  void SetCertStoreType(int iCertStoreType);

  const QString &CertStore();
  void SetCertStore(const QString &qsCertStore);

  const QString &CertPassword();
  void SetCertPassword(const QString &qsCertPassword);

  const QString &CertSubject();
  void SetCertSubject(const QString &qsCertSubject);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Connected(SFTPServerConnectedEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireConnected(SFTPServerConnectedEventParams *e) {...}

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 class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireConnectionRequest(SFTPServerConnectionRequestEventParams *e);

typedef struct {
  const char *Address;
  int Port;
  int Accept;
  int reserved;
} SFTPServerConnectionRequestEventParams;


Unicode (Windows)
virtual INT FireConnectionRequest(SFTPServerConnectionRequestEventParams *e);

typedef struct {
  LPCWSTR Address;
  INT Port;
  BOOL Accept;
  INT reserved;
} SFTPServerConnectionRequestEventParams;

#define EID_SFTPSERVER_CONNECTIONREQUEST 2

virtual INT IPWORKSSSH_CALL FireConnectionRequest(LPSTR &lpszAddress, INT &iPort, BOOL &bAccept);

class SFTPServerConnectionRequestEventParams {
public:
  const QString &Address();

  int Port();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ConnectionRequest(SFTPServerConnectionRequestEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireConnectionRequest(SFTPServerConnectionRequestEventParams *e) {...}

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

Fired when a client wants to create a new directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDirCreate(SFTPServerDirCreateEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  int FileType;
  int64 FileSize;
  const char *FileOwner;
  const char *FileGroup;
  int FilePermissions;
  int64 FileATime;
  int64 FileCreateTime;
  int64 FileMTime;
  int FileAttribBits;
  int FileAttribBitsValid;
  const char *OtherAttributes;
  int BeforeExec;
  int StatusCode;
  int reserved;
} SFTPServerDirCreateEventParams;


Unicode (Windows)
virtual INT FireDirCreate(SFTPServerDirCreateEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  INT FileType;
  LONG64 FileSize;
  LPCWSTR FileOwner;
  LPCWSTR FileGroup;
  INT FilePermissions;
  LONG64 FileATime;
  LONG64 FileCreateTime;
  LONG64 FileMTime;
  INT FileAttribBits;
  INT FileAttribBitsValid;
  LPCWSTR OtherAttributes;
  BOOL BeforeExec;
  INT StatusCode;
  INT reserved;
} SFTPServerDirCreateEventParams;

#define EID_SFTPSERVER_DIRCREATE 3

virtual INT IPWORKSSSH_CALL FireDirCreate(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, INT &iFileType, LONG64 &lFileSize, LPSTR &lpszFileOwner, LPSTR &lpszFileGroup, INT &iFilePermissions, LONG64 &lFileATime, LONG64 &lFileCreateTime, LONG64 &lFileMTime, INT &iFileAttribBits, INT &iFileAttribBitsValid, LPSTR &lpszOtherAttributes, BOOL &bBeforeExec, INT &iStatusCode);

class SFTPServerDirCreateEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  int FileType();

  qint64 FileSize();

  const QString &FileOwner();

  const QString &FileGroup();

  int FilePermissions();

  qint64 FileATime();

  qint64 FileCreateTime();

  qint64 FileMTime();

  int FileAttribBits();

  int FileAttribBitsValid();

  const QString &OtherAttributes();

  bool BeforeExec();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DirCreate(SFTPServerDirCreateEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireDirCreate(SFTPServerDirCreateEventParams *e) {...}

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDirList(SFTPServerDirListEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  int BeforeExec;
  int StatusCode;
  int reserved;
} SFTPServerDirListEventParams;


Unicode (Windows)
virtual INT FireDirList(SFTPServerDirListEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  BOOL BeforeExec;
  INT StatusCode;
  INT reserved;
} SFTPServerDirListEventParams;

#define EID_SFTPSERVER_DIRLIST 4

virtual INT IPWORKSSSH_CALL FireDirList(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, BOOL &bBeforeExec, INT &iStatusCode);

class SFTPServerDirListEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  bool BeforeExec();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DirList(SFTPServerDirListEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireDirList(SFTPServerDirListEventParams *e) {...}

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

Fired when a client wants to delete a directory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDirRemove(SFTPServerDirRemoveEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  int BeforeExec;
  int StatusCode;
  int reserved;
} SFTPServerDirRemoveEventParams;


Unicode (Windows)
virtual INT FireDirRemove(SFTPServerDirRemoveEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  BOOL BeforeExec;
  INT StatusCode;
  INT reserved;
} SFTPServerDirRemoveEventParams;

#define EID_SFTPSERVER_DIRREMOVE 5

virtual INT IPWORKSSSH_CALL FireDirRemove(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, BOOL &bBeforeExec, INT &iStatusCode);

class SFTPServerDirRemoveEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  bool BeforeExec();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DirRemove(SFTPServerDirRemoveEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireDirRemove(SFTPServerDirRemoveEventParams *e) {...}

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

This event is fired when a connection is closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDisconnected(SFTPServerDisconnectedEventParams *e);

typedef struct {
  int ConnectionId;
  int StatusCode;
  const char *Description;
  int reserved;
} SFTPServerDisconnectedEventParams;


Unicode (Windows)
virtual INT FireDisconnected(SFTPServerDisconnectedEventParams *e);

typedef struct {
  INT ConnectionId;
  INT StatusCode;
  LPCWSTR Description;
  INT reserved;
} SFTPServerDisconnectedEventParams;

#define EID_SFTPSERVER_DISCONNECTED 6

virtual INT IPWORKSSSH_CALL FireDisconnected(INT &iConnectionId, INT &iStatusCode, LPSTR &lpszDescription);

class SFTPServerDisconnectedEventParams {
public:
  int ConnectionId();

  int StatusCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Disconnected(SFTPServerDisconnectedEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireDisconnected(SFTPServerDisconnectedEventParams *e) {...}

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

Fired when errors occur during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(SFTPServerErrorEventParams *e);

typedef struct {
  int ConnectionId;
  int ErrorCode;
  const char *Description;
  int reserved;
} SFTPServerErrorEventParams;


Unicode (Windows)
virtual INT FireError(SFTPServerErrorEventParams *e);

typedef struct {
  INT ConnectionId;
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} SFTPServerErrorEventParams;

#define EID_SFTPSERVER_ERROR 7

virtual INT IPWORKSSSH_CALL FireError(INT &iConnectionId, INT &iErrorCode, LPSTR &lpszDescription);

class SFTPServerErrorEventParams {
public:
  int ConnectionId();

  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(SFTPServerErrorEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireError(SFTPServerErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFileClose(SFTPServerFileCloseEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  const char *Handle;
  int StatusCode;
  int reserved;
} SFTPServerFileCloseEventParams;


Unicode (Windows)
virtual INT FireFileClose(SFTPServerFileCloseEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  LPCWSTR Handle;
  INT StatusCode;
  INT reserved;
} SFTPServerFileCloseEventParams;

#define EID_SFTPSERVER_FILECLOSE 8

virtual INT IPWORKSSSH_CALL FireFileClose(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, LPSTR &lpszHandle, INT &iStatusCode);

class SFTPServerFileCloseEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  const QString &Handle();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileClose(SFTPServerFileCloseEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireFileClose(SFTPServerFileCloseEventParams *e) {...}

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFileOpen(SFTPServerFileOpenEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  int DesiredAccess;
  int Flags;
  int FileType;
  int64 FileSize;
  const char *FileOwner;
  const char *FileGroup;
  int FilePermissions;
  int64 FileATime;
  int64 FileCreateTime;
  int64 FileMTime;
  int FileAttribBits;
  int FileAttribBitsValid;
  const char *OtherAttributes;
  char *Handle;
  int BeforeExec;
  int StatusCode;
  int reserved;
} SFTPServerFileOpenEventParams;


Unicode (Windows)
virtual INT FireFileOpen(SFTPServerFileOpenEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  INT DesiredAccess;
  INT Flags;
  INT FileType;
  LONG64 FileSize;
  LPCWSTR FileOwner;
  LPCWSTR FileGroup;
  INT FilePermissions;
  LONG64 FileATime;
  LONG64 FileCreateTime;
  LONG64 FileMTime;
  INT FileAttribBits;
  INT FileAttribBitsValid;
  LPCWSTR OtherAttributes;
  LPWSTR Handle;
  BOOL BeforeExec;
  INT StatusCode;
  INT reserved;
} SFTPServerFileOpenEventParams;

#define EID_SFTPSERVER_FILEOPEN 9

virtual INT IPWORKSSSH_CALL FireFileOpen(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, INT &iDesiredAccess, INT &iFlags, INT &iFileType, LONG64 &lFileSize, LPSTR &lpszFileOwner, LPSTR &lpszFileGroup, INT &iFilePermissions, LONG64 &lFileATime, LONG64 &lFileCreateTime, LONG64 &lFileMTime, INT &iFileAttribBits, INT &iFileAttribBitsValid, LPSTR &lpszOtherAttributes, LPSTR &lpszHandle, BOOL &bBeforeExec, INT &iStatusCode);

class SFTPServerFileOpenEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  int DesiredAccess();

  int Flags();

  int FileType();

  qint64 FileSize();

  const QString &FileOwner();

  const QString &FileGroup();

  int FilePermissions();

  qint64 FileATime();

  qint64 FileCreateTime();

  qint64 FileMTime();

  int FileAttribBits();

  int FileAttribBitsValid();

  const QString &OtherAttributes();

  const QString &Handle();
  void SetHandle(const QString &qsHandle);

  bool BeforeExec();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileOpen(SFTPServerFileOpenEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireFileOpen(SFTPServerFileOpenEventParams *e) {...}

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 class 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 Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFileRead(SFTPServerFileReadEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Handle;
  int64 FileOffset;
  int Length;
  int StatusCode;
  int reserved;
} SFTPServerFileReadEventParams;


Unicode (Windows)
virtual INT FireFileRead(SFTPServerFileReadEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Handle;
  LONG64 FileOffset;
  INT Length;
  INT StatusCode;
  INT reserved;
} SFTPServerFileReadEventParams;

#define EID_SFTPSERVER_FILEREAD 10

virtual INT IPWORKSSSH_CALL FireFileRead(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszHandle, LONG64 &lFileOffset, INT &iLength, INT &iStatusCode);

class SFTPServerFileReadEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Handle();

  qint64 FileOffset();

  int Length();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileRead(SFTPServerFileReadEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireFileRead(SFTPServerFileReadEventParams *e) {...}

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

Fired when a client wants to delete a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFileRemove(SFTPServerFileRemoveEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  int BeforeExec;
  int StatusCode;
  int reserved;
} SFTPServerFileRemoveEventParams;


Unicode (Windows)
virtual INT FireFileRemove(SFTPServerFileRemoveEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  BOOL BeforeExec;
  INT StatusCode;
  INT reserved;
} SFTPServerFileRemoveEventParams;

#define EID_SFTPSERVER_FILEREMOVE 11

virtual INT IPWORKSSSH_CALL FireFileRemove(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, BOOL &bBeforeExec, INT &iStatusCode);

class SFTPServerFileRemoveEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  bool BeforeExec();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileRemove(SFTPServerFileRemoveEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireFileRemove(SFTPServerFileRemoveEventParams *e) {...}

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

Fired when a client wants to rename a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFileRename(SFTPServerFileRenameEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  const char *NewPath;
  int Flags;
  int BeforeExec;
  int StatusCode;
  int reserved;
} SFTPServerFileRenameEventParams;


Unicode (Windows)
virtual INT FireFileRename(SFTPServerFileRenameEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  LPCWSTR NewPath;
  INT Flags;
  BOOL BeforeExec;
  INT StatusCode;
  INT reserved;
} SFTPServerFileRenameEventParams;

#define EID_SFTPSERVER_FILERENAME 12

virtual INT IPWORKSSSH_CALL FireFileRename(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, LPSTR &lpszNewPath, INT &iFlags, BOOL &bBeforeExec, INT &iStatusCode);

class SFTPServerFileRenameEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  const QString &NewPath();

  int Flags();

  bool BeforeExec();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileRename(SFTPServerFileRenameEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireFileRename(SFTPServerFileRenameEventParams *e) {...}

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFileWrite(SFTPServerFileWriteEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Handle;
  int64 FileOffset;
  int BeforeExec;
  int StatusCode;
  int reserved;
} SFTPServerFileWriteEventParams;


Unicode (Windows)
virtual INT FireFileWrite(SFTPServerFileWriteEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Handle;
  LONG64 FileOffset;
  BOOL BeforeExec;
  INT StatusCode;
  INT reserved;
} SFTPServerFileWriteEventParams;

#define EID_SFTPSERVER_FILEWRITE 13

virtual INT IPWORKSSSH_CALL FireFileWrite(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszHandle, LONG64 &lFileOffset, BOOL &bBeforeExec, INT &iStatusCode);

class SFTPServerFileWriteEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Handle();

  qint64 FileOffset();

  bool BeforeExec();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FileWrite(SFTPServerFileWriteEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireFileWrite(SFTPServerFileWriteEventParams *e) {...}

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

Fired when a client needs to get file information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireGetAttributes(SFTPServerGetAttributesEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  int Flags;
  int FileType;
  int64 *pFileSize;
  char *FileOwner;
  char *FileGroup;
  int FilePermissions;
  int64 *pFileATime;
  int64 *pFileCreateTime;
  int64 *pFileMTime;
  int FileAttribBits;
  int FileAttribBitsValid;
  char *OtherAttributes;
  int StatusCode;
  int reserved;
} SFTPServerGetAttributesEventParams;


Unicode (Windows)
virtual INT FireGetAttributes(SFTPServerGetAttributesEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  INT Flags;
  INT FileType;
  LONG64 *pFileSize;
  LPWSTR FileOwner;
  LPWSTR FileGroup;
  INT FilePermissions;
  LONG64 *pFileATime;
  LONG64 *pFileCreateTime;
  LONG64 *pFileMTime;
  INT FileAttribBits;
  INT FileAttribBitsValid;
  LPWSTR OtherAttributes;
  INT StatusCode;
  INT reserved;
} SFTPServerGetAttributesEventParams;

#define EID_SFTPSERVER_GETATTRIBUTES 14

virtual INT IPWORKSSSH_CALL FireGetAttributes(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, INT &iFlags, INT &iFileType, LONG64 &lFileSize, LPSTR &lpszFileOwner, LPSTR &lpszFileGroup, INT &iFilePermissions, LONG64 &lFileATime, LONG64 &lFileCreateTime, LONG64 &lFileMTime, INT &iFileAttribBits, INT &iFileAttribBitsValid, LPSTR &lpszOtherAttributes, INT &iStatusCode);

class SFTPServerGetAttributesEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  int Flags();

  int FileType();
  void SetFileType(int iFileType);

  qint64 FileSize();
  void SetFileSize(qint64 lFileSize);

  const QString &FileOwner();
  void SetFileOwner(const QString &qsFileOwner);

  const QString &FileGroup();
  void SetFileGroup(const QString &qsFileGroup);

  int FilePermissions();
  void SetFilePermissions(int iFilePermissions);

  qint64 FileATime();
  void SetFileATime(qint64 lFileATime);

  qint64 FileCreateTime();
  void SetFileCreateTime(qint64 lFileCreateTime);

  qint64 FileMTime();
  void SetFileMTime(qint64 lFileMTime);

  int FileAttribBits();
  void SetFileAttribBits(int iFileAttribBits);

  int FileAttribBitsValid();
  void SetFileAttribBitsValid(int iFileAttribBitsValid);

  const QString &OtherAttributes();
  void SetOtherAttributes(const QString &qsOtherAttributes);

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void GetAttributes(SFTPServerGetAttributesEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireGetAttributes(SFTPServerGetAttributesEventParams *e) {...}

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

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(SFTPServerLogEventParams *e);

typedef struct {
  int ConnectionId;
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} SFTPServerLogEventParams;


Unicode (Windows)
virtual INT FireLog(SFTPServerLogEventParams *e);

typedef struct {
  INT ConnectionId;
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} SFTPServerLogEventParams;

#define EID_SFTPSERVER_LOG 15

virtual INT IPWORKSSSH_CALL FireLog(INT &iConnectionId, INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class SFTPServerLogEventParams {
public:
  int ConnectionId();

  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(SFTPServerLogEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireLog(SFTPServerLogEventParams *e) {...}

Remarks

Fired once for each log message generated by the class. 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 Class)

Fired when a client attempts to canonicalize a path.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResolvePath(SFTPServerResolvePathEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *OriginalPath;
  int ControlFlags;
  char *RealPath;
  int StatusCode;
  int reserved;
} SFTPServerResolvePathEventParams;


Unicode (Windows)
virtual INT FireResolvePath(SFTPServerResolvePathEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR OriginalPath;
  INT ControlFlags;
  LPWSTR RealPath;
  INT StatusCode;
  INT reserved;
} SFTPServerResolvePathEventParams;

#define EID_SFTPSERVER_RESOLVEPATH 16

virtual INT IPWORKSSSH_CALL FireResolvePath(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszOriginalPath, INT &iControlFlags, LPSTR &lpszRealPath, INT &iStatusCode);

class SFTPServerResolvePathEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &OriginalPath();

  int ControlFlags();

  const QString &RealPath();
  void SetRealPath(const QString &qsRealPath);

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ResolvePath(SFTPServerResolvePathEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireResolvePath(SFTPServerResolvePathEventParams *e) {...}

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSetAttributes(SFTPServerSetAttributesEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Path;
  int FileType;
  int64 FileSize;
  const char *FileOwner;
  const char *FileGroup;
  int FilePermissions;
  int64 FileATime;
  int64 FileCreateTime;
  int64 FileMTime;
  int FileAttribBits;
  int FileAttribBitsValid;
  const char *OtherAttributes;
  int BeforeExec;
  int StatusCode;
  int reserved;
} SFTPServerSetAttributesEventParams;


Unicode (Windows)
virtual INT FireSetAttributes(SFTPServerSetAttributesEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Path;
  INT FileType;
  LONG64 FileSize;
  LPCWSTR FileOwner;
  LPCWSTR FileGroup;
  INT FilePermissions;
  LONG64 FileATime;
  LONG64 FileCreateTime;
  LONG64 FileMTime;
  INT FileAttribBits;
  INT FileAttribBitsValid;
  LPCWSTR OtherAttributes;
  BOOL BeforeExec;
  INT StatusCode;
  INT reserved;
} SFTPServerSetAttributesEventParams;

#define EID_SFTPSERVER_SETATTRIBUTES 17

virtual INT IPWORKSSSH_CALL FireSetAttributes(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszPath, INT &iFileType, LONG64 &lFileSize, LPSTR &lpszFileOwner, LPSTR &lpszFileGroup, INT &iFilePermissions, LONG64 &lFileATime, LONG64 &lFileCreateTime, LONG64 &lFileMTime, INT &iFileAttribBits, INT &iFileAttribBitsValid, LPSTR &lpszOtherAttributes, BOOL &bBeforeExec, INT &iStatusCode);

class SFTPServerSetAttributesEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Path();

  int FileType();

  qint64 FileSize();

  const QString &FileOwner();

  const QString &FileGroup();

  int FilePermissions();

  qint64 FileATime();

  qint64 FileCreateTime();

  qint64 FileMTime();

  int FileAttribBits();

  int FileAttribBitsValid();

  const QString &OtherAttributes();

  bool BeforeExec();

  int StatusCode();
  void SetStatusCode(int iStatusCode);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SetAttributes(SFTPServerSetAttributesEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireSetAttributes(SFTPServerSetAttributesEventParams *e) {...}

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

Fired to track the progress of the secure connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHStatus(SFTPServerSSHStatusEventParams *e);

typedef struct {
  int ConnectionId;
  const char *Message;
  int reserved;
} SFTPServerSSHStatusEventParams;


Unicode (Windows)
virtual INT FireSSHStatus(SFTPServerSSHStatusEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR Message;
  INT reserved;
} SFTPServerSSHStatusEventParams;

#define EID_SFTPSERVER_SSHSTATUS 18

virtual INT IPWORKSSSH_CALL FireSSHStatus(INT &iConnectionId, LPSTR &lpszMessage);

class SFTPServerSSHStatusEventParams {
public:
  int ConnectionId();

  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHStatus(SFTPServerSSHStatusEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireSSHStatus(SFTPServerSSHStatusEventParams *e) {...}

Remarks

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

SSHUserAuthRequest Event (SFTPServer Class)

Fired when a client attempts to authenticate a connection.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSHUserAuthRequest(SFTPServerSSHUserAuthRequestEventParams *e);

typedef struct {
  int ConnectionId;
  const char *User;
  const char *Service;
  const char *AuthMethod;
  const char *AuthParam;
  int Accept;
  int PartialSuccess;
  char *AvailableMethods;
  char *HomeDir;
  const char *KeyAlgorithm;
  int reserved;
} SFTPServerSSHUserAuthRequestEventParams;


Unicode (Windows)
virtual INT FireSSHUserAuthRequest(SFTPServerSSHUserAuthRequestEventParams *e);

typedef struct {
  INT ConnectionId;
  LPCWSTR User;
  LPCWSTR Service;
  LPCWSTR AuthMethod;
  LPCWSTR AuthParam;
  BOOL Accept;
  BOOL PartialSuccess;
  LPWSTR AvailableMethods;
  LPWSTR HomeDir;
  LPCWSTR KeyAlgorithm;
  INT reserved;
} SFTPServerSSHUserAuthRequestEventParams;

#define EID_SFTPSERVER_SSHUSERAUTHREQUEST 19

virtual INT IPWORKSSSH_CALL FireSSHUserAuthRequest(INT &iConnectionId, LPSTR &lpszUser, LPSTR &lpszService, LPSTR &lpszAuthMethod, LPSTR &lpszAuthParam, BOOL &bAccept, BOOL &bPartialSuccess, LPSTR &lpszAvailableMethods, LPSTR &lpszHomeDir, LPSTR &lpszKeyAlgorithm);

class SFTPServerSSHUserAuthRequestEventParams {
public:
  int ConnectionId();

  const QString &User();

  const QString &Service();

  const QString &AuthMethod();

  const QString &AuthParam();

  bool Accept();
  void SetAccept(bool bAccept);

  bool PartialSuccess();
  void SetPartialSuccess(bool bPartialSuccess);

  const QString &AvailableMethods();
  void SetAvailableMethods(const QString &qsAvailableMethods);

  const QString &HomeDir();
  void SetHomeDir(const QString &qsHomeDir);

  const QString &KeyAlgorithm();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSHUserAuthRequest(SFTPServerSSHUserAuthRequestEventParams *e);

// Or, subclass SFTPServer and override this emitter function.
virtual int FireSSHUserAuthRequest(SFTPServerSSHUserAuthRequestEventParams *e) {...}

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 class:

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.

Syntax

IPWorksSSHCertificate (declared in ipworksssh.h)

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

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

SFTPConnection Type

A currently connected client.

Syntax

IPWorksSSHSFTPConnection (declared in ipworksssh.h)

Remarks

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

Fields

Constructors

SFTPConnection()

SSHPrompt Type

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

Syntax

IPWorksSSHSSHPrompt (declared in ipworksssh.h)

Remarks

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

Fields

Constructors

SSHPrompt()

SSHPrompt(const char* lpszPrompt, int bEcho)

IPWorksSSHList Type

Syntax

IPWorksSSHList<T> (declared in ipworksssh.h)

Remarks

IPWorksSSHList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the SFTPServer class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (SFTPServer Class)

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

Base Config Settings

Trappable Errors (SFTPServer Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

SFTPServer Errors

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

SSHServer Errors

TCPServer Errors

TCP/IP Errors