SFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

IPWorksSSH_SFTPServer

Procedural Interface

 ipworksssh_sftpserver_open();
 ipworksssh_sftpserver_close($res);
 ipworksssh_sftpserver_register_callback($res, $id, $function);
 ipworksssh_sftpserver_get_last_error($res);
 ipworksssh_sftpserver_get_last_error_code($res);
 ipworksssh_sftpserver_set($res, $id, $index, $value);
 ipworksssh_sftpserver_get($res, $id, $index);
 ipworksssh_sftpserver_do_config($res, $configurationstring);
 ipworksssh_sftpserver_do_disconnect($res, $connectionid);
 ipworksssh_sftpserver_do_doevents($res);
 ipworksssh_sftpserver_do_exchangekeys($res, $connectionid);
 ipworksssh_sftpserver_do_reset($res);
 ipworksssh_sftpserver_do_setfilelist($res, $connectionid, $list);
 ipworksssh_sftpserver_do_shutdown($res);
 ipworksssh_sftpserver_do_startlistening($res);
 ipworksssh_sftpserver_do_stoplistening($res);

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

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

Object Oriented Interface

public function getConnectionBacklog();
public function setConnectionBacklog($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 1 );
ipworksssh_sftpserver_set($res, 1, $value );

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

SFTPConnectionCount Property (IPWorksSSH_SFTPServer Class)

The number of records in the SFTPConnection arrays.

Object Oriented Interface

public function getSFTPConnectionCount();

Procedural Interface

ipworksssh_sftpserver_get($res, 2 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• SFTPConnectionConnected
• SFTPConnectionErrorMessage
• SFTPConnectionFileData
• SFTPConnectionLocalAddress
• SFTPConnectionProtocolVersion
• SFTPConnectionRemoteHost
• SFTPConnectionRemotePort
• SFTPConnectionTimeout

The array indices start at 0 and end at SFTPConnectionCount - 1.

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

Data Type

Integer

SFTPConnectionConnected Property (IPWorksSSH_SFTPServer Class)

This property indicates the status of individual connections.

Object Oriented Interface

public function getSFTPConnectionConnected($connectionid);

Procedural Interface

ipworksssh_sftpserver_get($res, 3 , $connectionid);

Default Value

false

Remarks

This property indicates the status of individual connections.

When true, the connection is established. Use the Disconnect method to disconnect an existing connection.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

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

Data Type

Boolean

SFTPConnectionErrorMessage Property (IPWorksSSH_SFTPServer Class)

ErrorMessage is used together with status codes returned from events to send informative errors back to the secure file transfer protocol (SFTP) client through the SSH_FXP_STATUS message.

Object Oriented Interface

public function getSFTPConnectionErrorMessage($connectionid);

Procedural Interface

ipworksssh_sftpserver_get($res, 5 , $connectionid);

Default Value

''

Remarks

SFTPConnectionErrorMessage is used together with status codes returned from events to send informative errors back to the secure file transfer protocol (SFTP) client through the SSH_FXP_STATUS message. If left blank, the class will set a default message based on the returned status code.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

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

Data Type

String

SFTPConnectionFileData Property (IPWorksSSH_SFTPServer Class)

The FileData should be set or read when processing read/write file events.

Object Oriented Interface

public function getSFTPConnectionFileData($connectionid);
public function setSFTPConnectionFileData($connectionid, $value);

Procedural Interface

ipworksssh_sftpserver_get($res, 6 , $connectionid);
ipworksssh_sftpserver_set($res, 6, $value , $connectionid);

Default Value

''

Remarks

The SFTPConnectionFileData should be set or read when processing read/write file events.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

This property is not available at design time.

Data Type

Binary String

SFTPConnectionLocalAddress Property (IPWorksSSH_SFTPServer Class)

This property shows the IP address of the interface through which the connection is passing.

Object Oriented Interface

public function getSFTPConnectionLocalAddress($connectionid);

Procedural Interface

ipworksssh_sftpserver_get($res, 7 , $connectionid);

Default Value

''

Remarks

This property shows the IP address of the interface through which the connection is passing.

SFTPConnectionLocalAddress is important for multihomed hosts in cases in which it can be used to identify the particular network interface an individual connection is going through.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

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

Data Type

String

SFTPConnectionProtocolVersion Property (IPWorksSSH_SFTPServer Class)

The ProtocolVersion shows the secure file transfer protocol (SFTP) protocol version negotiated with the client when the SFTP connection was established.

Object Oriented Interface

public function getSFTPConnectionProtocolVersion($connectionid);

Procedural Interface

ipworksssh_sftpserver_get($res, 8 , $connectionid);

Default Value

3

Remarks

The SFTPConnectionProtocolVersion shows the secure file transfer protocol (SFTP) protocol version negotiated with the client when the SFTP connection was established.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

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

Data Type

Integer

SFTPConnectionRemoteHost Property (IPWorksSSH_SFTPServer Class)

The RemoteHost shows the IP address of the remote host through which the connection is coming.

Object Oriented Interface

public function getSFTPConnectionRemoteHost($connectionid);

Procedural Interface

ipworksssh_sftpserver_get($res, 9 , $connectionid);

Default Value

''

Remarks

The SFTPConnectionRemoteHost shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

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

Data Type

String

SFTPConnectionRemotePort Property (IPWorksSSH_SFTPServer Class)

The RemotePort shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Object Oriented Interface

public function getSFTPConnectionRemotePort($connectionid);

Procedural Interface

ipworksssh_sftpserver_get($res, 10 , $connectionid);

Default Value

0

Remarks

The SFTPConnectionRemotePort shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

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

Data Type

Integer

SFTPConnectionTimeout Property (IPWorksSSH_SFTPServer Class)

This property contains a timeout for the class.

Object Oriented Interface

public function getSFTPConnectionTimeout($connectionid);
public function setSFTPConnectionTimeout($connectionid, $value);

Procedural Interface

ipworksssh_sftpserver_get($res, 11 , $connectionid);
ipworksssh_sftpserver_set($res, 11, $value , $connectionid);

Default Value

0

Remarks

This property contains a timeout for the class.

If the Timeout property is set to 0, all operations return immediately, potentially failing with an 'WOULDBLOCK' error if data cannot be sent or received immediately.

If Timeout is set to a positive value, the class will automatically retry each operation that otherwise would result in a 'WOULDBLOCK' error for a maximum of Timeout seconds.

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

If Timeout expires, and the operation is not yet complete, the class fails with an error.

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

The default value for the Timeout property is 0 (asynchronous operation).

The $connectionid parameter specifies the index of the item in the array. The size of the array is controlled by the SFTPConnectionCount property.

This property is not available at design time.

Data Type

Integer

DefaultAuthMethods Property (IPWorksSSH_SFTPServer Class)

The supported authentication methods.

Object Oriented Interface

public function getDefaultAuthMethods();
public function setDefaultAuthMethods($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 12 );
ipworksssh_sftpserver_set($res, 12, $value );

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

An initial timeout value to be used by incoming connections.

Object Oriented Interface

public function getDefaultTimeout();
public function setDefaultTimeout($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 13 );
ipworksssh_sftpserver_set($res, 13, $value );

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

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

Object Oriented Interface

public function getKeyboardInteractiveMessage();
public function setKeyboardInteractiveMessage($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 14 );
ipworksssh_sftpserver_set($res, 14, $value );

Default Value

''

Remarks

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

Data Type

String

KeyboardInteractivePromptCount Property (IPWorksSSH_SFTPServer Class)

The number of records in the KeyboardInteractivePrompt arrays.

Object Oriented Interface

public function getKeyboardInteractivePromptCount();
public function setKeyboardInteractivePromptCount($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 15 );
ipworksssh_sftpserver_set($res, 15, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• KeyboardInteractivePromptEcho
• KeyboardInteractivePromptPrompt

The array indices start at 0 and end at KeyboardInteractivePromptCount - 1.

This property is not available at design time.

Data Type

Integer

KeyboardInteractivePromptEcho Property (IPWorksSSH_SFTPServer Class)

This property specifies whether or not the client should echo the value entered by the user.

Object Oriented Interface

public function getKeyboardInteractivePromptEcho($promptindex);
public function setKeyboardInteractivePromptEcho($promptindex, $value);

Procedural Interface

ipworksssh_sftpserver_get($res, 16 , $promptindex);
ipworksssh_sftpserver_set($res, 16, $value , $promptindex);

Default Value

false

Remarks

This property specifies whether or not the client should echo the value entered by the user.

The $promptindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.

This property is not available at design time.

Data Type

Boolean

KeyboardInteractivePromptPrompt Property (IPWorksSSH_SFTPServer Class)

This property contains the prompt label or text the client should present to the user.

Object Oriented Interface

public function getKeyboardInteractivePromptPrompt($promptindex);
public function setKeyboardInteractivePromptPrompt($promptindex, $value);

Procedural Interface

ipworksssh_sftpserver_get($res, 17 , $promptindex);
ipworksssh_sftpserver_set($res, 17, $value , $promptindex);

Default Value

''

Remarks

This property contains the prompt label or text the client should present to the user.

The $promptindex parameter specifies the index of the item in the array. The size of the array is controlled by the KeyboardInteractivePromptCount property.

This property is not available at design time.

Data Type

String

Listening Property (IPWorksSSH_SFTPServer Class)

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

Object Oriented Interface

public function getListening();

Procedural Interface

ipworksssh_sftpserver_get($res, 18 );

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

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

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 19 );
ipworksssh_sftpserver_set($res, 19, $value );

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

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

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 20 );
ipworksssh_sftpserver_set($res, 20, $value );

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

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

Object Oriented Interface

public function getRootDirectory();
public function setRootDirectory($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 21 );
ipworksssh_sftpserver_set($res, 21, $value );

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

SSHCertEffectiveDate Property (IPWorksSSH_SFTPServer Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSHCertEffectiveDate();

Procedural Interface

ipworksssh_sftpserver_get($res, 22 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSHCertExpirationDate Property (IPWorksSSH_SFTPServer Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSHCertExpirationDate();

Procedural Interface

ipworksssh_sftpserver_get($res, 23 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSHCertExtendedKeyUsage Property (IPWorksSSH_SFTPServer Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSHCertExtendedKeyUsage();

Procedural Interface

ipworksssh_sftpserver_get($res, 24 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSHCertFingerprint Property (IPWorksSSH_SFTPServer Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprint();

Procedural Interface

ipworksssh_sftpserver_get($res, 25 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSHCertFingerprintSHA1 Property (IPWorksSSH_SFTPServer Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprintSHA1();

Procedural Interface

ipworksssh_sftpserver_get($res, 26 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSHCertFingerprintSHA256 Property (IPWorksSSH_SFTPServer Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSHCertFingerprintSHA256();

Procedural Interface

ipworksssh_sftpserver_get($res, 27 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSHCertIssuer Property (IPWorksSSH_SFTPServer Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSHCertIssuer();

Procedural Interface

ipworksssh_sftpserver_get($res, 28 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSHCertPrivateKey Property (IPWorksSSH_SFTPServer Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSHCertPrivateKey();

Procedural Interface

ipworksssh_sftpserver_get($res, 29 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSHCertPrivateKey may be available but not exportable. In this case, SSHCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSHCertPrivateKeyAvailable Property (IPWorksSSH_SFTPServer Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSHCertPrivateKeyAvailable();

Procedural Interface

ipworksssh_sftpserver_get($res, 30 );

Default Value

false

Remarks

Whether a SSHCertPrivateKey is available for the selected certificate. If SSHCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSHCertPrivateKeyContainer Property (IPWorksSSH_SFTPServer Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSHCertPrivateKeyContainer();

Procedural Interface

ipworksssh_sftpserver_get($res, 31 );

Default Value

''

Remarks

The name of the SSHCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSHCertPublicKey Property (IPWorksSSH_SFTPServer Class)

The public key of the certificate.

Object Oriented Interface

public function getSSHCertPublicKey();

Procedural Interface

ipworksssh_sftpserver_get($res, 32 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSHCertPublicKeyAlgorithm Property (IPWorksSSH_SFTPServer Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSHCertPublicKeyAlgorithm();

Procedural Interface

ipworksssh_sftpserver_get($res, 33 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHCertPublicKeyLength Property (IPWorksSSH_SFTPServer Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSHCertPublicKeyLength();

Procedural Interface

ipworksssh_sftpserver_get($res, 34 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSHCertSerialNumber Property (IPWorksSSH_SFTPServer Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSHCertSerialNumber();

Procedural Interface

ipworksssh_sftpserver_get($res, 35 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSHCertSignatureAlgorithm Property (IPWorksSSH_SFTPServer Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSHCertSignatureAlgorithm();

Procedural Interface

ipworksssh_sftpserver_get($res, 36 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSHCertStore Property (IPWorksSSH_SFTPServer Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSHCertStore();
public function setSSHCertStore($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 37 );
ipworksssh_sftpserver_set($res, 37, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSHCertStoreType property denotes the type of the certificate store specified by SSHCertStore. If the store is password-protected, specify the password in SSHCertStorePassword.

SSHCertStore is used in conjunction with the SSHCertSubject property to specify client certificates. If SSHCertStore has a value, and SSHCertSubject or SSHCertEncoded is set, a search for a certificate is initiated. Please see the SSHCertSubject property for details.

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

Data Type

Binary String

SSHCertStorePassword Property (IPWorksSSH_SFTPServer Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSHCertStorePassword();
public function setSSHCertStorePassword($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 38 );
ipworksssh_sftpserver_set($res, 38, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSHCertStoreType Property (IPWorksSSH_SFTPServer Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSHCertStoreType();
public function setSSHCertStoreType($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 39 );
ipworksssh_sftpserver_set($res, 39, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

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 property can take one of the following values:

Data Type

Integer

SSHCertSubjectAltNames Property (IPWorksSSH_SFTPServer Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSHCertSubjectAltNames();

Procedural Interface

ipworksssh_sftpserver_get($res, 40 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSHCertThumbprintMD5 Property (IPWorksSSH_SFTPServer Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintMD5();

Procedural Interface

ipworksssh_sftpserver_get($res, 41 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertThumbprintSHA1 Property (IPWorksSSH_SFTPServer Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA1();

Procedural Interface

ipworksssh_sftpserver_get($res, 42 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertThumbprintSHA256 Property (IPWorksSSH_SFTPServer Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSHCertThumbprintSHA256();

Procedural Interface

ipworksssh_sftpserver_get($res, 43 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSHCertUsage Property (IPWorksSSH_SFTPServer Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSHCertUsage();

Procedural Interface

ipworksssh_sftpserver_get($res, 44 );

Default Value

''

Remarks

The text description of SSHCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSHCertUsageFlags Property (IPWorksSSH_SFTPServer Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSHCertUsageFlags();

Procedural Interface

ipworksssh_sftpserver_get($res, 45 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSHCertUsageFlags is a combination of the following flags:

Please see the SSHCertUsage property for a text representation of SSHCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSHCertVersion Property (IPWorksSSH_SFTPServer Class)

The certificate's version number.

Object Oriented Interface

public function getSSHCertVersion();

Procedural Interface

ipworksssh_sftpserver_get($res, 46 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSHCertSubject Property (IPWorksSSH_SFTPServer Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSHCertSubject();
public function setSSHCertSubject($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 47 );
ipworksssh_sftpserver_set($res, 47, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate 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.

Data Type

String

SSHCertEncoded Property (IPWorksSSH_SFTPServer Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHCertEncoded();
public function setSSHCertEncoded($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 48 );
ipworksssh_sftpserver_set($res, 48, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSHCertStore and SSHCertSubject properties also may be used to specify a certificate.

When SSHCertEncoded is set, a search is initiated in the current SSHCertStore for the private key of the certificate. If the key is found, SSHCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSHCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSHCompressionAlgorithms Property (IPWorksSSH_SFTPServer Class)

The comma-separated list containing all allowable compression algorithms.

Object Oriented Interface

public function getSSHCompressionAlgorithms();
public function setSSHCompressionAlgorithms($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 49 );
ipworksssh_sftpserver_set($res, 49, $value );

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

The comma-separated list containing all allowable encryption algorithms.

Object Oriented Interface

public function getSSHEncryptionAlgorithms();
public function setSSHEncryptionAlgorithms($value);

Procedural Interface

ipworksssh_sftpserver_get($res, 50 );
ipworksssh_sftpserver_set($res, 50, $value );

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

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksssh_sftpserver_do_config($res, $configurationstring);

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.

Disconnect Method (IPWorksSSH_SFTPServer Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

ipworksssh_sftpserver_do_disconnect($res, $connectionid);

Remarks

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

DoEvents Method (IPWorksSSH_SFTPServer Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksssh_sftpserver_do_doevents($res);

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.

ExchangeKeys Method (IPWorksSSH_SFTPServer Class)

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

Object Oriented Interface

public function doExchangeKeys($connectionid);

Procedural Interface

ipworksssh_sftpserver_do_exchangekeys($res, $connectionid);

Remarks

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

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

Reset Method (IPWorksSSH_SFTPServer Class)

This method will reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksssh_sftpserver_do_reset($res);

Remarks

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

SetFileList Method (IPWorksSSH_SFTPServer Class)

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

Object Oriented Interface

public function doSetFileList($connectionid, $list);

Procedural Interface

ipworksssh_sftpserver_do_setfilelist($res, $connectionid, $list);

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.

Shutdown Method (IPWorksSSH_SFTPServer Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

ipworksssh_sftpserver_do_shutdown($res);

Remarks

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

StartListening Method (IPWorksSSH_SFTPServer Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksssh_sftpserver_do_startlistening($res);

Remarks

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

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

StopListening Method (IPWorksSSH_SFTPServer Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksssh_sftpserver_do_stoplistening($res);

Remarks

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

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

Connected Event (IPWorksSSH_SFTPServer Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'
 'certstoretype'
 'certstore'
 'certpassword'
 'certsubject'

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 property 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 (IPWorksSSH_SFTPServer Class)

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

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 2, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

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

Fired when a client wants to create a new directory.

Object Oriented Interface

public function fireDirCreate($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 3, array($this, 'fireDirCreate'));

Parameter List

 'connectionid'
 'user'
 'path'
 'filetype'
 'filesize'
 'fileowner'
 'filegroup'
 'filepermissions'
 'fileatime'
 'filecreatetime'
 'filemtime'
 'fileattribbits'
 'fileattribbitsvalid'
 'otherattributes'
 'beforeexec'
 'statuscode'

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

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

Object Oriented Interface

public function fireDirList($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 4, array($this, 'fireDirList'));

Parameter List

 'connectionid'
 'user'
 'path'
 'beforeexec'
 'statuscode'

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

Fired when a client wants to delete a directory.

Object Oriented Interface

public function fireDirRemove($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 5, array($this, 'fireDirRemove'));

Parameter List

 'connectionid'
 'user'
 'path'
 'beforeexec'
 'statuscode'

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

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 6, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

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

Fired when errors occur during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 7, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

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

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

Object Oriented Interface

public function fireFileClose($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 8, array($this, 'fireFileClose'));

Parameter List

 'connectionid'
 'user'
 'path'
 'handle'
 'statuscode'

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

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

Object Oriented Interface

public function fireFileOpen($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 9, array($this, 'fireFileOpen'));

Parameter List

 'connectionid'
 'user'
 'path'
 'desiredaccess'
 'flags'
 'filetype'
 'filesize'
 'fileowner'
 'filegroup'
 'filepermissions'
 'fileatime'
 'filecreatetime'
 'filemtime'
 'fileattribbits'
 'fileattribbitsvalid'
 'otherattributes'
 'handle'
 'beforeexec'
 'statuscode'

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

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

Object Oriented Interface

public function fireFileRead($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 10, array($this, 'fireFileRead'));

Parameter List

 'connectionid'
 'user'
 'handle'
 'fileoffset'
 'length'
 'statuscode'

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 SFTPConnectionFileData

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

Fired when a client wants to delete a file.

Object Oriented Interface

public function fireFileRemove($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 11, array($this, 'fireFileRemove'));

Parameter List

 'connectionid'
 'user'
 'path'
 'beforeexec'
 'statuscode'

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

Fired when a client wants to rename a file.

Object Oriented Interface

public function fireFileRename($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 12, array($this, 'fireFileRename'));

Parameter List

 'connectionid'
 'user'
 'path'
 'newpath'
 'flags'
 'beforeexec'
 'statuscode'

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

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

Object Oriented Interface

public function fireFileWrite($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 13, array($this, 'fireFileWrite'));

Parameter List

 'connectionid'
 'user'
 'handle'
 'fileoffset'
 'beforeexec'
 'statuscode'

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 SFTPConnectionFileData

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

Fired when a client needs to get file information.

Object Oriented Interface

public function fireGetAttributes($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 14, array($this, 'fireGetAttributes'));

Parameter List

 'connectionid'
 'user'
 'path'
 'flags'
 'filetype'
 'filesize'
 'fileowner'
 'filegroup'
 'filepermissions'
 'fileatime'
 'filecreatetime'
 'filemtime'
 'fileattribbits'
 'fileattribbitsvalid'
 'otherattributes'
 'statuscode'

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

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 15, array($this, 'fireLog'));

Parameter List

 'connectionid'
 'loglevel'
 'message'
 'logtype'

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

Fired when a client attempts to canonicalize a path.

Object Oriented Interface

public function fireResolvePath($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 16, array($this, 'fireResolvePath'));

Parameter List

 'connectionid'
 'user'
 'originalpath'
 'controlflags'
 'realpath'
 'statuscode'

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

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

Object Oriented Interface

public function fireSetAttributes($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 17, array($this, 'fireSetAttributes'));

Parameter List

 'connectionid'
 'user'
 'path'
 'filetype'
 'filesize'
 'fileowner'
 'filegroup'
 'filepermissions'
 'fileatime'
 'filecreatetime'
 'filemtime'
 'fileattribbits'
 'fileattribbitsvalid'
 'otherattributes'
 'beforeexec'
 'statuscode'

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

Fired to track the progress of the secure connection.

Object Oriented Interface

public function fireSSHStatus($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 18, array($this, 'fireSSHStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

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

SSHUserAuthRequest Event (IPWorksSSH_SFTPServer Class)

Fired when a client attempts to authenticate a connection.

Object Oriented Interface

public function fireSSHUserAuthRequest($param);

Procedural Interface

ipworksssh_sftpserver_register_callback($res, 19, array($this, 'fireSSHUserAuthRequest'));

Parameter List

 'connectionid'
 'user'
 'service'
 'authmethod'
 'authparam'
 'accept'
 'partialsuccess'
 'availablemethods'
 'homedir'
 'keyalgorithm'

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.

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)

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