SFTP Class

Properties   Methods   Events   Config Settings   Errors  

The SFTP class can be used to transfer files to and from SFTP servers using the SFTP Protocol.

Class Name

IPWorksSSH_SFTP

Procedural Interface

 ipworksssh_sftp_open();
 ipworksssh_sftp_close($res);
 ipworksssh_sftp_register_callback($res, $id, $function);
 ipworksssh_sftp_get_last_error($res);
 ipworksssh_sftp_get_last_error_code($res);
 ipworksssh_sftp_set($res, $id, $index, $value);
 ipworksssh_sftp_get($res, $id, $index);
 ipworksssh_sftp_do_append($res);
 ipworksssh_sftp_do_changeremotepath($res, $remotepath);
 ipworksssh_sftp_do_checkfileexists($res);
 ipworksssh_sftp_do_config($res, $configurationstring);
 ipworksssh_sftp_do_connect($res);
 ipworksssh_sftp_do_createfile($res, $filename);
 ipworksssh_sftp_do_decodepacket($res, $encodedpacket);
 ipworksssh_sftp_do_deletefile($res, $filename);
 ipworksssh_sftp_do_disconnect($res);
 ipworksssh_sftp_do_doevents($res);
 ipworksssh_sftp_do_download($res);
 ipworksssh_sftp_do_encodepacket($res, $packet);
 ipworksssh_sftp_do_getsshparam($res, $payload, $field);
 ipworksssh_sftp_do_getsshparambytes($res, $payload, $field);
 ipworksssh_sftp_do_interrupt($res);
 ipworksssh_sftp_do_listdirectory($res);
 ipworksssh_sftp_do_makedirectory($res, $newdir);
 ipworksssh_sftp_do_queryfileattributes($res);
 ipworksssh_sftp_do_queuefile($res, $localfile, $remotefile);
 ipworksssh_sftp_do_removedirectory($res, $dirname);
 ipworksssh_sftp_do_renamefile($res, $newname);
 ipworksssh_sftp_do_reset($res);
 ipworksssh_sftp_do_resetqueue($res);
 ipworksssh_sftp_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);
 ipworksssh_sftp_do_sshlogoff($res);
 ipworksssh_sftp_do_sshlogon($res, $sshhost, $sshport);
 ipworksssh_sftp_do_updatefileattributes($res);
 ipworksssh_sftp_do_upload($res);

Remarks

The SFTP class is the SSH-enabled equivalent of the IPWorks FTP class. The SSHHost and SSHPort properties specify the SSH server to use. The SSHUser and SSHPassword properties allow the client to authenticate itself with the server. The SSHServerAuthentication event and/or SSHAcceptServerHostKey property allow you to check the server identity. Finally, the SSHStatus event provides information about the SSH handshake.

The SFTP class implements a standard SSH File Transfer client.

The first step in using the class is specifying the SSHHost, SSHUser and SSHPassword. The file to upload to or download from is given by the RemoteFile property. The file to download to or upload from is specified by LocalFile. The current path in the server is specified by the RemotePath property.

If LocalFile is set to something other than an empty string, then files are received in LocalFile, otherwise the data is received through the Transfer event. StartTransfer and EndTransfer are fired at the beginning and end of transmission.

Directory listings are received through the DirList event.

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.

Connected Property (IPWorksSSH_SFTP Class)

This shows whether the class is connected.

Object Oriented Interface

public function getConnected();


public function setConnected($value);

Procedural Interface

ipworksssh_sftp_get($res, 1 );


ipworksssh_sftp_set($res, 1, $value );

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

DirListCount Property (IPWorksSSH_SFTP Class)

The number of records in the DirList arrays.

Object Oriented Interface

public function getDirListCount();

Procedural Interface

ipworksssh_sftp_get($res, 2 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• DirListEntry
• DirListFileName
• DirListFileSize
• DirListFileTime
• DirListIsDir
• DirListIsSymlink

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

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

Data Type

Integer

DirListEntry Property (IPWorksSSH_SFTP Class)

This property contains the raw entry as received from the server.

Object Oriented Interface

public function getDirListEntry($entryindex);

Procedural Interface

ipworksssh_sftp_get($res, 3 , $entryindex);

Default Value

''

Remarks

This property contains the raw entry as received from the server. It is the complete unparsed entry in the directory listing.

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

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

Data Type

String

DirListFileName Property (IPWorksSSH_SFTP Class)

This property shows the file name in the last directory listing.

Object Oriented Interface

public function getDirListFileName($entryindex);

Procedural Interface

ipworksssh_sftp_get($res, 4 , $entryindex);

Default Value

''

Remarks

This property shows the file name in the last directory listing. This also may be the directory name if a directory is being listed. You can tell whether it is a file or a directory by the Boolean DirListIsDir property.

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

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

Data Type

String

DirListFileSize Property (IPWorksSSH_SFTP Class)

This property shows the file size in the last directory listing.

Object Oriented Interface

public function getDirListFileSize($entryindex);

Procedural Interface

ipworksssh_sftp_get($res, 5 , $entryindex);

Default Value

0

Remarks

This property shows the file size in the last directory listing.

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

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

Data Type

Long64

DirListFileTime Property (IPWorksSSH_SFTP Class)

This property shows the file time in the last directory listing.

Object Oriented Interface

public function getDirListFileTime($entryindex);

Procedural Interface

ipworksssh_sftp_get($res, 6 , $entryindex);

Default Value

''

Remarks

This property shows the file time in the last directory listing. This contains the date/time stamp in which the file was created.

Note: In Unix systems, the date is given in two types of formats: If the date is in the past 12 months, the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

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

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

Data Type

String

DirListIsDir Property (IPWorksSSH_SFTP Class)

This property specifies whether entries in the last directory listing are directories.

Object Oriented Interface

public function getDirListIsDir($entryindex);

Procedural Interface

ipworksssh_sftp_get($res, 7 , $entryindex);

Default Value

false

Remarks

This property specifies whether entries in the last directory listing are directories. This Boolean value denotes whether or not the directory entry listed in DirListFileName is a file or a directory.

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

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

Data Type

Boolean

DirListIsSymlink Property (IPWorksSSH_SFTP Class)

This property indicates whether the entry is a symbolic link.

Object Oriented Interface

public function getDirListIsSymlink($entryindex);

Procedural Interface

ipworksssh_sftp_get($res, 8 , $entryindex);

Default Value

false

Remarks

This property indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of DirListIsDir will always be False because this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or a folder, set RemoteFile and query the FileAttributes.FileIsDir property.

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

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

Data Type

Boolean

FileAccessTime Property (IPWorksSSH_SFTP Class)

The number of milliseconds since 12:00:00 AM January 1, 1970 when this file was last accessed.

Object Oriented Interface

public function getFileAccessTime();


public function setFileAccessTime($value);

Procedural Interface

ipworksssh_sftp_get($res, 9 );


ipworksssh_sftp_set($res, 9, $value );

Default Value

0

Remarks

The number of milliseconds since 12:00:00 AM January 1, 1970 when this file was last accessed.

This property is not available at design time.

Data Type

Long64

FileACL Property (IPWorksSSH_SFTP Class)

A string containing an Access Control List (ACL).

Object Oriented Interface

public function getFileACL();


public function setFileACL($value);

Procedural Interface

ipworksssh_sftp_get($res, 11 );


ipworksssh_sftp_set($res, 11, $value );

Default Value

''

Remarks

A string containing an Access Control List (ACL).

This property is not available at design time.

Data Type

String

FileAllocationSize Property (IPWorksSSH_SFTP Class)

The size, in bytes, that this file consumes on disk.

Object Oriented Interface

public function getFileAllocationSize();

Procedural Interface

ipworksssh_sftp_get($res, 12 );

Default Value

0

Remarks

The size, in bytes, that this file consumes on disk.

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

Data Type

Long64

FileAttributeBits Property (IPWorksSSH_SFTP Class)

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the SFTP server.

Object Oriented Interface

public function getFileAttributeBits();

Procedural Interface

ipworksssh_sftp_get($res, 13 );

Default Value

0

Remarks

FileAttributeBits and FileAttributeBitsValid each contain a bitmask representing attributes of the file on the SFTP server. These two values must be interpreted together. Any value present in FileAttributeBitsValid must be ignored in FileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This field can have one or more of the following values OR'd together:

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

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

Data Type

Integer

FileAttributeBitsValid Property (IPWorksSSH_SFTP Class)

AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the SFTP server.

Object Oriented Interface

public function getFileAttributeBitsValid();

Procedural Interface

ipworksssh_sftp_get($res, 14 );

Default Value

0

Remarks

FileAttributeBits and FileAttributeBitsValid each contain a bitmask representing attributes of the file on the SFTP server. These two values must be interpreted together. Any value present in FileAttributeBitsValid must be ignored in FileAttributeBits. This is done so that the server and client can communicate the attributes they know about without confusing any bits they do not understand.

This field can have one or more of the following values OR'd together:

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

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

Data Type

Integer

FileCreationTime Property (IPWorksSSH_SFTP Class)

The number of milliseconds since 12:00:00 AM January 1, 1970 when this file was created.

Object Oriented Interface

public function getFileCreationTime();


public function setFileCreationTime($value);

Procedural Interface

ipworksssh_sftp_get($res, 15 );


ipworksssh_sftp_set($res, 15, $value );

Default Value

0

Remarks

The number of milliseconds since 12:00:00 AM January 1, 1970 when this file was created.

This property is not available at design time.

Data Type

Long64

FileType Property (IPWorksSSH_SFTP Class)

The type of file.

Object Oriented Interface

public function getFileType();

Procedural Interface

ipworksssh_sftp_get($res, 17 );

Default Value

0

Remarks

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

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

Data Type

Integer

FileGroupId Property (IPWorksSSH_SFTP Class)

The id of the group that has access rights this file.

Object Oriented Interface

public function getFileGroupId();


public function setFileGroupId($value);

Procedural Interface

ipworksssh_sftp_get($res, 19 );


ipworksssh_sftp_set($res, 19, $value );

Default Value

''

Remarks

The id of the group that has access rights this file.

This property is not available at design time.

Data Type

String

FileIsDir Property (IPWorksSSH_SFTP Class)

Whether or not the file represented by these attributes is a directory.

Object Oriented Interface

public function getFileIsDir();

Procedural Interface

ipworksssh_sftp_get($res, 20 );

Default Value

false

Remarks

Whether or not the file represented by these attributes is a directory.

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

Data Type

Boolean

FileIsSymlink Property (IPWorksSSH_SFTP Class)

Whether or not the file or directory represented by these attributes is a symbolic link.

Object Oriented Interface

public function getFileIsSymlink();

Procedural Interface

ipworksssh_sftp_get($res, 21 );

Default Value

false

Remarks

Whether or not the file or directory represented by these attributes is a symbolic link. This setting is only applicable when GetSymlinkAttrs is set to True. By default the attributes of the actual file referred to by the link (not the symbolic link itself) are returned and this property will always be False.

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

Data Type

Boolean

FileModifiedTime Property (IPWorksSSH_SFTP Class)

The number of milliseconds since 12:00:00 AM January 1, 1970 that this file was last modified.

Object Oriented Interface

public function getFileModifiedTime();


public function setFileModifiedTime($value);

Procedural Interface

ipworksssh_sftp_get($res, 24 );


ipworksssh_sftp_set($res, 24, $value );

Default Value

0

Remarks

The number of milliseconds since 12:00:00 AM January 1, 1970 that this file was last modified.

This property is not available at design time.

Data Type

Long64

FileOwnerId Property (IPWorksSSH_SFTP Class)

The user id of this file's owner.

Object Oriented Interface

public function getFileOwnerId();


public function setFileOwnerId($value);

Procedural Interface

ipworksssh_sftp_get($res, 26 );


ipworksssh_sftp_set($res, 26, $value );

Default Value

''

Remarks

The user id of this file's owner.

This property is not available at design time.

Data Type

String

FilePermissions Property (IPWorksSSH_SFTP Class)

A 32-bit integer containing the a POSIX-compatible file permission bitmask.

Object Oriented Interface

public function getFilePermissions();


public function setFilePermissions($value);

Procedural Interface

ipworksssh_sftp_get($res, 27 );


ipworksssh_sftp_set($res, 27, $value );

Default Value

0

Remarks

A 32-bit integer containing the a POSIX-compatible file permission bitmask.

The bitmask should be interpreted as a decimal value of a series of octal digits. For example, an octal permission value of "100644" would be "33188" in base-10, and "40755" in octal would be "16877" in base-10.

The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:

An octal permission digit of 7 would have all three values set and would mean that the file can be read, written and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.

The previous octal digit is another bitmask with the following values:

The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:

For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.

Please note that you will need to convert the octal permissions bitmask into its decimal representation

This property is not available at design time.

Data Type

Integer

FilePermissionsOctal Property (IPWorksSSH_SFTP Class)

An octal string containing the a POSIX-compatible file permission bitmask The bitmask should be interpreted as a series of octal digits.

Object Oriented Interface

public function getFilePermissionsOctal();


public function setFilePermissionsOctal($value);

Procedural Interface

ipworksssh_sftp_get($res, 28 );


ipworksssh_sftp_set($res, 28, $value );

Default Value

''

Remarks

An octal string containing the a POSIX-compatible file permission bitmask

The bitmask should be interpreted as a series of octal digits. For example, "100644" and "40755".

The last three octal digits are the most significant and represent, in order, the file access capabilities of the file's owner, the owner's group and other users. Each of these octal digits is, on its own, a 3-bit bitmask with the following possible values:

An octal permission digit of 7 would have all three values set and would mean that the file can be read, written and executed by that user class. For example, the octal permissions "100644" would have a value "6" for the owner, "4" for the group, and "4" for other users. This would be interpreted to mean that all users can read the file, no users can execute it and only the owner can write it. The permissions "40755" would mean that all users can read and execute the file, but only the owner can write it.

The previous octal digit is another bitmask with the following values:

The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:

For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.

This property is not available at design time.

Data Type

String

FileSize Property (IPWorksSSH_SFTP Class)

The total size, in bytes, of this file.

Object Oriented Interface

public function getFileSize();

Procedural Interface

ipworksssh_sftp_get($res, 29 );

Default Value

0

Remarks

The total size, in bytes, of this file.

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

Data Type

Long64

FileExists Property (IPWorksSSH_SFTP Class)

Returns true if the file specified by RemoteFile exists on the remote server.

Object Oriented Interface

public function getFileExists();

Procedural Interface

ipworksssh_sftp_get($res, 32 );

Default Value

false

Remarks

This property returns True if the file exists on the remote server. It returns false if the file does not exist. You must specify the file you wish to check by setting the RemoteFile prior to calling this method.

If there is no session in place, the value of this property will always be false.

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

Data Type

Boolean

FirewallAutoDetect Property (IPWorksSSH_SFTP Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

ipworksssh_sftp_get($res, 33 );


ipworksssh_sftp_set($res, 33, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksSSH_SFTP Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

ipworksssh_sftp_get($res, 34 );


ipworksssh_sftp_set($res, 34, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksSSH_SFTP Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

ipworksssh_sftp_get($res, 35 );


ipworksssh_sftp_set($res, 35, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksSSH_SFTP Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

ipworksssh_sftp_get($res, 36 );


ipworksssh_sftp_set($res, 36, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorksSSH_SFTP Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

ipworksssh_sftp_get($res, 37 );


ipworksssh_sftp_set($res, 37, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorksSSH_SFTP Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

ipworksssh_sftp_get($res, 38 );


ipworksssh_sftp_set($res, 38, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (IPWorksSSH_SFTP Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworksssh_sftp_get($res, 39 );

Default Value

true

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (IPWorksSSH_SFTP Class)

The path to a local file for upload/download.

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

ipworksssh_sftp_get($res, 40 );


ipworksssh_sftp_set($res, 40, $value );

Default Value

''

Remarks

The LocalFile property is used by the Upload and Download methods. The file will only be overwritten if the Overwrite property is set to True.

Example (Setting LocalFile)

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

Data Type

String

LocalHost Property (IPWorksSSH_SFTP 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_sftp_get($res, 41 );


ipworksssh_sftp_set($res, 41, $value );

Default Value

''

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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_SFTP Class)

The TCP port in the local host where the class binds.

Object Oriented Interface

public function getLocalPort();


public function setLocalPort($value);

Procedural Interface

ipworksssh_sftp_get($res, 42 );


ipworksssh_sftp_set($res, 42, $value );

Default Value

0

Remarks

This property must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this property to 0 (default) enables the system to choose an open port at random. The chosen port will be returned by the LocalPort property after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this property when a connection is active will generate an error.

This property is useful when trying to connect to services that require a trusted port in the client side.

Data Type

Integer

Overwrite Property (IPWorksSSH_SFTP Class)

Whether or not the class should overwrite files during transfer.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

ipworksssh_sftp_get($res, 43 );


ipworksssh_sftp_set($res, 43, $value );

Default Value

false

Remarks

This property is a value indicating whether or not the class should overwrite LocalFile when downloading, and RemoteFile when uploading. If Overwrite is false, an error will be thrown whenever LocalFile exists before a download operation.

Data Type

Boolean

RemoteFile Property (IPWorksSSH_SFTP Class)

The name of the remote file for uploading, downloading, etc.

Object Oriented Interface

public function getRemoteFile();


public function setRemoteFile($value);

Procedural Interface

ipworksssh_sftp_get($res, 44 );


ipworksssh_sftp_set($res, 44, $value );

Default Value

''

Remarks

The RemoteFile is either an absolute file path, or a relative path based on RemotePath.

A number of methods use RemoteFile as an argument.

Example (Setting RemoteFile)

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

Note: This property will also act as a file mask when performing ListDirectory.

Example (Using RemoteFile as a file mask): SFTPControl.RemoteFile = "*.txt" SFTPControl.ListDirectory()

The following special characters are supported for pattern matching:

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

String

RemotePath Property (IPWorksSSH_SFTP Class)

The current path in the SFTP server.

Object Oriented Interface

public function getRemotePath();


public function setRemotePath($value);

Procedural Interface

ipworksssh_sftp_get($res, 45 );


ipworksssh_sftp_set($res, 45, $value );

Default Value

''

Remarks

The RemotePath shows the current working directory on the SFTP server. It can also be used to change the working directory by setting it to an absolute directory path, or a relative path with respect to the existing value of RemotePath.

If the first two bytes of the new path are "..", then a change to one level above in the directory tree is performed.

Setting RemotePath causes the class to send the appropriate command to the remote server only if connected.

Example (Changing Directory)

sftp1.SSHLogon("sftp.server.net", 22); sftp1.ChangeRemotePath("/home/user");

Note:It is recommended to use the ChangeRemotePath method instead of setting this property.

Data Type

String

SSHAcceptServerHostKeyEncoded Property (IPWorksSSH_SFTP Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHAcceptServerHostKeyEncoded();


public function setSSHAcceptServerHostKeyEncoded($value);

Procedural Interface

ipworksssh_sftp_get($res, 47 );


ipworksssh_sftp_set($res, 47, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSHAuthMode Property (IPWorksSSH_SFTP Class)

The authentication method to be used the class when calling SSHLogon .

Object Oriented Interface

public function getSSHAuthMode();


public function setSSHAuthMode($value);

Procedural Interface

ipworksssh_sftp_get($res, 74 );


ipworksssh_sftp_set($res, 74, $value );

Default Value

2

Remarks

The SSH Authentication specification (RFC 4252) specifies multiple methods by which a user can be authenticated by an SSH server. When a call is made to SSHLogon, the class will connect to the SSH server and establish the security layer. After the connection has been secured, the client will send an authentication request to the SSHHost containing the SSHUser. The server will respond containing a list of methods by which that user may be authenticated.

The class will attempt to authenticate the user by one of those methods based on the value of SSHAuthMode and other property values supplied by the user. Currently, the class supports the following authentication methods:

Example (User/Password Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example (Public Key Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

Integer

SSHCertEncoded Property (IPWorksSSH_SFTP Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSHCertEncoded();


public function setSSHCertEncoded($value);

Procedural Interface

ipworksssh_sftp_get($res, 76 );


ipworksssh_sftp_set($res, 76, $value );

Default Value

''

Remarks

This is 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

SSHCertStore Property (IPWorksSSH_SFTP Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSHCertStore();


public function setSSHCertStore($value);

Procedural Interface

ipworksssh_sftp_get($res, 92 );


ipworksssh_sftp_set($res, 92, $value );

Default Value

'MY'

Remarks

This is 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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_SFTP 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_sftp_get($res, 93 );


ipworksssh_sftp_set($res, 93, $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_SFTP Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSHCertStoreType();


public function setSSHCertStoreType($value);

Procedural Interface

ipworksssh_sftp_get($res, 94 );


ipworksssh_sftp_set($res, 94, $value );

Default Value

0

Remarks

This is 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

SSHCertSubject Property (IPWorksSSH_SFTP Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSHCertSubject();


public function setSSHCertSubject($value);

Procedural Interface

ipworksssh_sftp_get($res, 95 );


ipworksssh_sftp_set($res, 95, $value );

Default Value

''

Remarks

This is 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

SSHCompressionAlgorithms Property (IPWorksSSH_SFTP Class)

A comma-separated list containing all allowable compression algorithms.

Object Oriented Interface

public function getSSHCompressionAlgorithms();


public function setSSHCompressionAlgorithms($value);

Procedural Interface

ipworksssh_sftp_get($res, 103 );


ipworksssh_sftp_set($res, 103, $value );

Default Value

'none,zlib'

Remarks

During the 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, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, 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_SFTP Class)

A comma-separated list containing all allowable encryption algorithms.

Object Oriented Interface

public function getSSHEncryptionAlgorithms();


public function setSSHEncryptionAlgorithms($value);

Procedural Interface

ipworksssh_sftp_get($res, 104 );


ipworksssh_sftp_set($res, 104, $value );

Default Value

'aes256-ctr,aes192-ctr,aes128-ctr,aes256-cbc,aes192-cbc,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,arcfour256,arcfour128,arcfour,cast128-cbc,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com'

Remarks

During the 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, so it is important to list multiple algorithms in preferential order. If no algorithm can be agreed upon, 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

SSHHost Property (IPWorksSSH_SFTP Class)

The address of the SSH host.

Object Oriented Interface

public function getSSHHost();


public function setSSHHost($value);

Procedural Interface

ipworksssh_sftp_get($res, 105 );


ipworksssh_sftp_set($res, 105, $value );

Default Value

''

Remarks

The SSHHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the remote host. It is set before a connection is attempted and cannot be changed once a connection is established.

If the SSHHost property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the SSHHost property is set to the corresponding address. If the search is not successful, an error is returned.

The SSHHost must be the same host that will be assumed for SSH as for the remote service being connected to.

Data Type

String

SSHPassword Property (IPWorksSSH_SFTP Class)

The password for SSH password-based authentication.

Object Oriented Interface

public function getSSHPassword();


public function setSSHPassword($value);

Procedural Interface

ipworksssh_sftp_get($res, 106 );


ipworksssh_sftp_set($res, 106, $value );

Default Value

''

Remarks

SSHPassword specifies the password which is used to authenticate the client to the SSH server.

Data Type

String

SSHPort Property (IPWorksSSH_SFTP Class)

The port on the SSH server where the SSH service is running; by default, 22.

Object Oriented Interface

public function getSSHPort();


public function setSSHPort($value);

Procedural Interface

ipworksssh_sftp_get($res, 107 );


ipworksssh_sftp_set($res, 107, $value );

Default Value

22

Remarks

The SSHPort specifies a service port on the SSH host to connect to.

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

Data Type

Integer

SSHUser Property (IPWorksSSH_SFTP Class)

The username for SSH authentication.

Object Oriented Interface

public function getSSHUser();


public function setSSHUser($value);

Procedural Interface

ipworksssh_sftp_get($res, 108 );


ipworksssh_sftp_set($res, 108, $value );

Default Value

''

Remarks

SSHUser specifies the username which is used to authenticate the client to the SSH server. This property is required.

Example (User/Password Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) Example (Public Key Auth): Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22)

Data Type

String

StartByte Property (IPWorksSSH_SFTP Class)

The offset in bytes at which to begin the Upload or Download.

Object Oriented Interface

public function getStartByte();


public function setStartByte($value);

Procedural Interface

ipworksssh_sftp_get($res, 109 );


ipworksssh_sftp_set($res, 109, $value );

Default Value

0

Remarks

The StartByte property is used by the Upload and Download methods to determine at what offset to begin the transfer. This allows for resuming both uploads and downloads. The value of this property is reset to 0 after a successful transfer. StartByte is not valid for use with Append.

When downloading, this property can be used in conjunction with the TransferredDataLimit configuration setting in order to only download a specific range of data from the current RemoteFile.

Data Type

Long64

Timeout Property (IPWorksSSH_SFTP Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

ipworksssh_sftp_get($res, 110 );


ipworksssh_sftp_set($res, 110, $value );

Default Value

60

Remarks

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

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

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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 60 seconds.

Data Type

Integer

Append Method (IPWorksSSH_SFTP Class)

Append data from LocalFile to a remote file RemoteFile on an SFTP server.

Object Oriented Interface

public function doAppend();

Procedural Interface

ipworksssh_sftp_do_append($res);

Remarks

Similar to the Upload method but the local file specified by LocalFile is appended to RemoteFile on the server as opposed to replacing it as done by the Upload method. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. The server will create a file with that name if it doesn't already exist (similar to Upload).

If there is no SSH session in place, one is automatically created by the component first.

ChangeRemotePath Method (IPWorksSSH_SFTP Class)

Changes the current path on the server.

Object Oriented Interface

public function doChangeRemotePath($remotepath);

Procedural Interface

ipworksssh_sftp_do_changeremotepath($res, $remotepath);

Remarks

This method changes the current path on the server to the specified RemotePath. When called, the class will issue a command to the server to change the directory. The RemotePath parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a / it is considered and absolute path and must specify the entire path from the root of the server. For instance:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a / it is considered a relative path and is resolved in relation to the current directory. For instance a value of myfolder will indicate a sub-folder of the current directory. The special value .. refers to the parent directory of the current path. For instance:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

CheckFileExists Method (IPWorksSSH_SFTP Class)

Returns if the file specified by RemoteFile exists on the remote server.

Object Oriented Interface

public function doCheckFileExists();

Procedural Interface

ipworksssh_sftp_do_checkfileexists($res);

Remarks

This property returns true if the file exists on the remote server. It returns false if the file does not exist. You must specify the file you wish to check by setting the RemoteFile prior to calling this method.

If there is no session in place, the value of this property will always be false.

Config Method (IPWorksSSH_SFTP Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

Connect Method (IPWorksSSH_SFTP Class)

Connects to the SSH host without logging in.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksssh_sftp_do_connect($res);

Remarks

This method establishes a connection with the SSHHost but does not log in. In most cases it is recommended to use the SSHLogon method which will both establish a connection and log in to the server.

This method may be useful in cases where it is desirable to separate the connection and logon operations, for instance confirming a host is available by first creating the connection.

CreateFile Method (IPWorksSSH_SFTP Class)

Creates a file on the SFTP server.

Object Oriented Interface

public function doCreateFile($filename);

Procedural Interface

ipworksssh_sftp_do_createfile($res, $filename);

Remarks

This method creates an empty file on the server with the name specified by the FileName parameter.

To upload a file with content use Upload instead.

DecodePacket Method (IPWorksSSH_SFTP Class)

Decodes a hex-encoded SSH packet.

Object Oriented Interface

public function doDecodePacket($encodedpacket);

Procedural Interface

ipworksssh_sftp_do_decodepacket($res, $encodedpacket);

Remarks

This method is used to decode an SSH packet created by EncodePacket.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

DeleteFile Method (IPWorksSSH_SFTP Class)

Remove a file specified by FileName from an SFTP server.

Object Oriented Interface

public function doDeleteFile($filename);

Procedural Interface

ipworksssh_sftp_do_deletefile($res, $filename);

Remarks

The remote file or directory specified by FileName is deleted. FileName is either an absolute path on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by the component first.

Disconnect Method (IPWorksSSH_SFTP Class)

This method disconnects from the server without first logging off.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksssh_sftp_do_disconnect($res);

Remarks

This method immediately disconnects from the server without first logging off.

In most cases the SSHLogoff method should be used to logoff and disconnect from the server. Call the Disconnect method in cases where it is desirable to immediately disconnect without first logging off.

DoEvents Method (IPWorksSSH_SFTP Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

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

Download Method (IPWorksSSH_SFTP Class)

Download a RemoteFile from an SFTP server.

Object Oriented Interface

public function doDownload();

Procedural Interface

ipworksssh_sftp_do_download($res);

Remarks

The remote file specified by RemoteFile is downloaded to the local file specified by LocalFile, or it is retrieved through the Transfer event, if the LocalFile property is "" (empty string). RemoteFile is either an absolute path on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by the component first.

Example (Download a File)

SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download()

EncodePacket Method (IPWorksSSH_SFTP Class)

Hex encodes an SSH packet.

Object Oriented Interface

public function doEncodePacket($packet);

Procedural Interface

ipworksssh_sftp_do_encodepacket($res, $packet);

Remarks

This method is used to encode a raw SSH packet created by SetSSHParam.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

GetSSHParam Method (IPWorksSSH_SFTP Class)

Used to read a field from an SSH packet's payload.

Object Oriented Interface

public function doGetSSHParam($payload, $field);

Procedural Interface

ipworksssh_sftp_do_getsshparam($res, $payload, $field);

Remarks

This method is used to read the value of a particular field from an SSH packet's payload. Payload should contain the full payload of a packet received by an event such as SSHChannelRequest. Field is the name of a field to be read out of the packet.

The following is a list of the names of well-known channel request field names and their encodings:

The remaining fields that are available in the payload are dependent upon the value of RequestType.

pty-req

Pty-req is a request to open a pseudo terminal on the specified channel. The following fields are available:

x11-req

X11-req is a request to forward x11 sessions over a channel. The following fields are available:

env

Env is a request to set an environment variable to be passed into a shell that may be started later. The following fields are available:

exec

Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:

subsystem

Subsystem is a request to start a subsystem on the specified channel. The following field is available:

xon-xoff

Instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:

signal

Sends a signal to the remote process/service. The following field is available:

If the packet type is not well known, Field should start with the special character "%" and contain a comma-separated list of field types as defined in SetSSHParam. For example, reading out the X11AuthProtocol of an x11-req payload, you can use "%s,f".

Note: the return value is a string encoded the same way as the FieldValue param in SetSSHParam.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

GetSSHParamBytes Method (IPWorksSSH_SFTP Class)

Used to read a field from an SSH packet's payload.

Object Oriented Interface

public function doGetSSHParamBytes($payload, $field);

Procedural Interface

ipworksssh_sftp_do_getsshparambytes($res, $payload, $field);

Remarks

This method is the same as calling GetSSHParam, but returns raw bytes instead of strings.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

Interrupt Method (IPWorksSSH_SFTP Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksssh_sftp_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListDirectory Method (IPWorksSSH_SFTP Class)

List the current directory specified by RemotePath on an SFTP server.

Object Oriented Interface

public function doListDirectory();

Procedural Interface

ipworksssh_sftp_do_listdirectory($res);

Remarks

A listing is requested for the directory (or file mask) specified in RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath. The file listing is received through the DirList event.

If there is no SSH session in place, one is automatically created by the component first.

MakeDirectory Method (IPWorksSSH_SFTP Class)

Create a directory on an SFTP server.

Object Oriented Interface

public function doMakeDirectory($newdir);

Procedural Interface

ipworksssh_sftp_do_makedirectory($res, $newdir);

Remarks

A directory with path specified by NewDir is created on the SFTP server. NewDir is either an absolute path on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by the component first.

QueryFileAttributes Method (IPWorksSSH_SFTP Class)

Queries the server for the attributes of RemoteFile .

Object Oriented Interface

public function doQueryFileAttributes();

Procedural Interface

ipworksssh_sftp_do_queryfileattributes($res);

Remarks

This method queries the server for attributes of RemoteFile. After calling this method FileAttributes will be populated with the values returned by the server.

To update attributes modify the desired values in FileAttributes and call UpdateFileAttributes.

QueueFile Method (IPWorksSSH_SFTP Class)

Adds a file to the transfer queue.

Object Oriented Interface

public function doQueueFile($localfile, $remotefile);

Procedural Interface

ipworksssh_sftp_do_queuefile($res, $localfile, $remotefile);

Remarks

This method adds a file to the queue of files that will be transferred.

It is not required to use this method, however this extends the ability of the class to allow for multiple simultaneous file transfers.

To simply transfer a file without using this method you need only set LocalFile, RemoteFile, and call Upload or Download as appropriate. This method allows you to instead queue multiple files before beginning a transfer.

When a file is queued it will not be transferred until the Upload or Download method is called. If multiple files are queued the files will be transferred simultaneously. The SimultaneousTransferLimit setting controls the maximum number of simultaneous transfers.

The Upload or Download method will not return until the Queue has been completely processed. This method may be called from within events in order to add additional files to the Queue before processing is complete.

To clear the queue call ResetQueue. This will not affect current transfers.

To cancel and individual file transfer set the Cancel parameter of the Transfer event to true. The rest of the queue will continue to process as normal.

The Interrupt method may be called to immediately stop all current transfers.

In the event of a file specific error the Error event will fire and the LocalFile and RemoteFile event parameters can be used to identify the file to which the error applies.

RemoveDirectory Method (IPWorksSSH_SFTP Class)

Remove a directory specified by DirName from an SFTP server.

Object Oriented Interface

public function doRemoveDirectory($dirname);

Procedural Interface

ipworksssh_sftp_do_removedirectory($res, $dirname);

Remarks

A directory with path specified by DirName is deleted on the SFTP server. DirName is either an absolute path on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by the component first.

RenameFile Method (IPWorksSSH_SFTP Class)

Change the name of RemoteFile to NewName .

Object Oriented Interface

public function doRenameFile($newname);

Procedural Interface

ipworksssh_sftp_do_renamefile($res, $newname);

Remarks

The name of remote file or folder specified by RemoteFile is changed to NewName. RemoteFile and NewName are either absolute paths on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by the component first.

Reset Method (IPWorksSSH_SFTP Class)

Reset the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksssh_sftp_do_reset($res);

Remarks

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

ResetQueue Method (IPWorksSSH_SFTP Class)

Resets the queue of files to be transferred.

Object Oriented Interface

public function doResetQueue();

Procedural Interface

ipworksssh_sftp_do_resetqueue($res);

Remarks

This method will remove all files from the transfer queue.

Calling this method will clear all files that were queued by QueueFile. Calling this method will not affect current transfers.

SetSSHParam Method (IPWorksSSH_SFTP Class)

Used to write a field to the end of a payload.

Object Oriented Interface

public function doSetSSHParam($payload, $fieldtype, $fieldvalue);

Procedural Interface

ipworksssh_sftp_do_setsshparam($res, $payload, $fieldtype, $fieldvalue);

Remarks

This method is used to build the payload portion of an SSH packet to be sent later by a call to SendSSHPacket. Payload should contain the result of a previous call to SetSSHParam. FieldType is a string defining the type of field to be written to the packet. FieldValue should be the string representation of the field to be written.

The following is a list of supported field types and a description of how FieldValue should be encoded:

Note: integer values may be encoded in hexadecimal by prefixing "0x" to the beginning of the string, otherwise the value is assumed to be base-10.

Note: This method is only applicable for reading and creating SSH packets for use within the SSHCustomAuth event.

SSHLogoff Method (IPWorksSSH_SFTP Class)

Logoff from the SSH server.

Object Oriented Interface

public function doSSHLogoff();

Procedural Interface

ipworksssh_sftp_do_sshlogoff($res);

Remarks

Logoff from the SSH server. If that fails, the connection is terminated by the local host.

SSHLogon Method (IPWorksSSH_SFTP Class)

Logon to the SSHHost using the current SSHUser and SSHPassword .

Object Oriented Interface

public function doSSHLogon($sshhost, $sshport);

Procedural Interface

ipworksssh_sftp_do_sshlogon($res, $sshhost, $sshport);

Remarks

Logon to the SSH server using the current SSHUser and SSHPassword. This will perform the SSH handshake and authentication.

Example (Logging On)

SSHClient.SSHUser = "username" SSHClient.SSHPassword = "password" SSHClient.SSHLogon("sshHost", sshPort)

UpdateFileAttributes Method (IPWorksSSH_SFTP Class)

Instructs the class to send the FileAttributes to the server.

Object Oriented Interface

public function doUpdateFileAttributes();

Procedural Interface

ipworksssh_sftp_do_updatefileattributes($res);

Remarks

When UpdateFileAttributes is called, the class will send the values of the following properties to the server:

• FileAccessTime
• FileACL
• FileAllocationSize
• FileAttributeBits
• FileAttributeBitsValid
• FileCreationTime
• FileType
• FileGroupId
• FileIsDir
• FileModifiedTime
• FileOwnerId
• FilePermissions
• FileSize

Upload Method (IPWorksSSH_SFTP Class)

Upload a file specified by LocalFile to an SFTP server.

Object Oriented Interface

public function doUpload();

Procedural Interface

ipworksssh_sftp_do_upload($res);

Remarks

The local file specified by LocalFile is uploaded to the remote file specified by RemoteFile. RemoteFile is either an absolute path on the server, or a path relative to RemotePath.

If there is no SSH session in place, one is automatically created by the component first.

If you want to append to a server file, please refer to the Append method.

Example (Upload a File)

FTPControl.LocalFile = "C:\\localfile.txt" FTPControl.RemoteFile = "remotefile.txt" FTPControl.Upload() FTPControl.LocalFile = "C:\\localfile2.txt" FTPControl.RemoteFile = "folder/remotefile2.txt" FTPControl.Upload()

Connected Event (IPWorksSSH_SFTP Class)

This event is fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

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

Parameter List

 'statuscode'
 'description'

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 Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (IPWorksSSH_SFTP Class)

This event is fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

The ConnectionStatus event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

DirList Event (IPWorksSSH_SFTP Class)

Fired when a directory entry is received.

Object Oriented Interface

public function fireDirList($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 3, array($this, 'fireDirList'));

Parameter List

 'direntry'
 'filename'
 'isdir'
 'filesize'
 'filetime'
 'issymlink'

Remarks

The DirList events are fired when a directory listing is received as a response to a ListDirectory.

The StartTransfer and EndTransfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when ListDirectory is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the ListDirectory method.

The format of the FileTime parameter returned by the class can be controlled through the FileTimeFormat configuration setting. If no format is specified, the class will format the date dependent on the year. If the filetime is in the same year, it will be formatted as "MMM dd HH:mm", otherwise it will be formatted as "MMM dd yyyy".

IsSymlink indicates whether the entry is a symbolic link. When the entry is a symbolic link the value of IsDir will always be False since this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or folder set RemoteFile and query the FileIsDir property.

Disconnected Event (IPWorksSSH_SFTP Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 4, array($this, 'fireDisconnected'));

Parameter List

 '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 Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorksSSH_SFTP Class)

Fired when a file completes downloading/uploading.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 5, array($this, 'fireEndTransfer'));

Parameter List

 'direction'
 'localfile'
 'remotefile'

Remarks

The EndTransfer event fires when either an upload or a download operation completes. This is when the file finishes transferring and/or a directory listing is finished.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

Error Event (IPWorksSSH_SFTP Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 6, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'
 'localfile'
 'remotefile'

Remarks

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

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.

LocalFile identifies the local file. RemoteFile is the remote file.

Log Event (IPWorksSSH_SFTP Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 7, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event fires once for each log messages generated by the class. The verbosity is controlled by the LogLevel setting.

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

Message is the log message.

LogType is reserved for future use.

SSHCustomAuth Event (IPWorksSSH_SFTP Class)

Fired when the class is doing custom authentication.

Object Oriented Interface

public function fireSSHCustomAuth($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 8, array($this, 'fireSSHCustomAuth'));

Parameter List

 'packet'

Remarks

SSHCustomAuth is fired during the user authentication stage of the SSH logon process if SSHAuthMode is set to amCustom. Packet contains the raw last SSH packet sent by the server, in HEX-encoded format.

The client should create a new raw SSH packet to send to the server and set Packet to the HEX-encoded representation of the packet to send.

In all cases, Packet will start with the message type field.

To read the incoming packet call DecodePacket and then use the GetSSHParam and GetSSHParamBytes methods. To create a packet use the SetSSHParam method and then call EncodePacket to obtain a HEX-encoded value and assign this to the Packet parameter.

SSHKeyboardInteractive Event (IPWorksSSH_SFTP Class)

Fired when the class receives a request for user input from the server.

Object Oriented Interface

public function fireSSHKeyboardInteractive($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 9, array($this, 'fireSSHKeyboardInteractive'));

Parameter List

 'name'
 'instructions'
 'prompt'
 'response'
 'echoresponse'

Remarks

SSHKeyboardInteractive is fired during the user authentication stage of the SSH logon process. During authentication, the class will request a list of available authentication methods for the SSHUser. For example, if the SSHHost responds with "keyboard-interactive", the class will fire this event to allow the client application to set the password.

During authentication, the SSH server may respond with a request for the user's authentication information. Name is a server-provided value associated with the authentication method such as "CRYPTOCard Authentication". Instructions will contain specific instructions, also supplied by the server, for how the user should respond.

Along with these values, the server will also send at least one input Prompt to be displayed to and filled out by the user. Response should be set to the user's input, and will be sent back in the user authentication information response. EchoResponse is a server recommendation for whether or not the user's response should be echoed back during input.

Note: the server may send several prompts in a single packet. The class will fire the SSHKeyboardInteractive event once for each prompt.

SSHServerAuthentication Event (IPWorksSSH_SFTP Class)

Fired after the server presents its public key to the client.

Object Oriented Interface

public function fireSSHServerAuthentication($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 10, array($this, 'fireSSHServerAuthentication'));

Parameter List

 'hostkey'
 'fingerprint'
 'keyalgorithm'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

This event is where the client can decide whether to continue with the connection process or not. If the public key is known to be a valid key for the SSH server, Accept should be set to True within the event. Otherwise, the server will not be authenticated and the connection will be broken.

Accept will be True only if either HostKey or Fingerprint is identical to the value of SSHAcceptServerHostKey.

Accept may be set to True manually to accept the server host key.

Note that SSH's security inherently relies on client verification of the host key. Ignoring the host key and always setting Accept to true is strongly discouraged, and could cause potentially serious security vulnerabilities in your application. It is recommended that clients maintain a list of known keys for each server and check HostKey against this list each time a connection is attempted.

Host Key contains the full binary text of the key, in the same format used internally by SSH.

Fingerprint holds the SHA-256 hash of HostKey in the hex-encoded form: 0a:1b:2c:3d. To configure the hash algorithm used to calculate this value see SSHFingerprintHashAlgorithm.

KeyAlgorithm identifies the host key algorithm. Supported values are:

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

CertSubject is the subject of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

CertIssuer is the issuer of the certificate. This is only applicable when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".

Status is reserved for future use.

SSHStatus Event (IPWorksSSH_SFTP Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSHStatus($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 11, array($this, 'fireSSHStatus'));

Parameter List

 'message'

Remarks

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

StartTransfer Event (IPWorksSSH_SFTP Class)

Fired when a file starts downloading/uploading.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 12, array($this, 'fireStartTransfer'));

Parameter List

 'direction'
 'localfile'
 'remotefile'

Remarks

The StartTransfer event fires when a Data Interface connection is created. This is when the file starts transferring and/or a directory listing is started.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

Transfer Event (IPWorksSSH_SFTP Class)

Fired during file download/upload.

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksssh_sftp_register_callback($res, 13, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'localfile'
 'remotefile'
 'bytestransferred'
 'percentdone'
 'text'
 'cancel'

Remarks

One or more Transfer events are fired during file transfer. The BytesTransferred parameter shows the number of bytes transferred since the beginning of the transfer.

Text contains the portion of the file data being delivered.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

LocalFile identifies the local file. RemoteFile is the remote file.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

To cancel the current transfer set Cancel to true.

Config Settings (SFTP Class)

SFTP Config Settings

SSHClient Config Settings

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

TCPClient Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (SFTP Class)

SFTP Errors

SSHClient Errors

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

TCPClient Errors

TCP/IP Errors