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.

Syntax

class ipworkssftp.SFTP

Remarks

The SFTP class is the SSH-enabled equivalent of the IPWorks FTP class. The ssh_host and ssh_port properties specify the SSH server to use. The ssh_user and ssh_password properties allow the client to authenticate itself with the server. The on_ssh_server_authentication event and/or ssh_accept_server_host_key property allow you to check the server identity. Finally, the on_ssh_status 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 ssh_host, ssh_user and ssh_password. The file to upload to or download from is given by the remote_file property. The file to download to or upload from is specified by local_file. The current path in the server is specified by the remote_path property.

If local_file is set to something other than an empty string, then files are received in local_file, otherwise the data is received through the on_transfer event. on_start_transfer and on_end_transfer are fired at the beginning and end of transmission.

Directory listings are received through the on_dir_list 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

This shows whether the class is connected.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

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.

dir_list_count Property

The number of records in the DirList arrays.

Syntax

def get_dir_list_count() -> int: ...

dir_list_count = property(get_dir_list_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• dir_list_entry
• dir_list_file_name
• dir_list_file_size
• dir_list_file_time
• dir_list_is_dir
• dir_list_is_symlink

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

This property is read-only.

dir_list_entry Property

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

Syntax

def get_dir_list_entry(entry_index: int) -> str: ...

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 entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the dir_list_count property.

This property is read-only.

dir_list_file_name Property

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

Syntax

def get_dir_list_file_name(entry_index: int) -> str: ...

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 dir_list_is_dir property.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the dir_list_count property.

This property is read-only.

dir_list_file_size Property

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

Syntax

def get_dir_list_file_size(entry_index: int) -> int: ...

Default Value

0

Remarks

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

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the dir_list_count property.

This property is read-only.

dir_list_file_time Property

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

Syntax

def get_dir_list_file_time(entry_index: int) -> str: ...

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 entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the dir_list_count property.

This property is read-only.

dir_list_is_dir Property

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

Syntax

def get_dir_list_is_dir(entry_index: int) -> bool: ...

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 dir_list_file_name is a file or a directory.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the dir_list_count property.

This property is read-only.

dir_list_is_symlink Property

This property indicates whether the entry is a symbolic link.

Syntax

def get_dir_list_is_symlink(entry_index: int) -> bool: ...

Default Value

FALSE

Remarks

This property indicates whether the entry is a symbolic link. When the entry is a symbolic link, the value of dir_list_is_dir 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 remote_file and query the file_attributes.file_is_dir property.

The entry_index parameter specifies the index of the item in the array. The size of the array is controlled by the dir_list_count property.

This property is read-only.

file_access_time Property

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

Syntax

def get_file_access_time() -> int: ...
def set_file_access_time(value: int) -> None: ...

file_access_time = property(get_file_access_time, set_file_access_time)

Default Value

0

Remarks

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

file_acl Property

A string containing an Access Control List (ACL).

Syntax

def get_file_acl() -> str: ...
def set_file_acl(value: str) -> None: ...

file_acl = property(get_file_acl, set_file_acl)

Default Value

""

Remarks

A string containing an Access Control List (ACL).

file_allocation_size Property

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

Syntax

def get_file_allocation_size() -> int: ...

file_allocation_size = property(get_file_allocation_size, None)

Default Value

0

Remarks

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

This property is read-only.

file_attribute_bits Property

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

Syntax

def get_file_attribute_bits() -> int: ...

file_attribute_bits = property(get_file_attribute_bits, None)

Default Value

0

Remarks

file_attribute_bits and file_attribute_bits_valid each contain a bitmask representing attributes of the file on the SFTP server. These two values must be interpreted together. Any value present in file_attribute_bits_valid must be ignored in file_attribute_bits. 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.

file_attribute_bits_valid Property

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

Syntax

def get_file_attribute_bits_valid() -> int: ...

file_attribute_bits_valid = property(get_file_attribute_bits_valid, None)

Default Value

0

Remarks

file_attribute_bits and file_attribute_bits_valid each contain a bitmask representing attributes of the file on the SFTP server. These two values must be interpreted together. Any value present in file_attribute_bits_valid must be ignored in file_attribute_bits. 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.

file_creation_time Property

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

Syntax

def get_file_creation_time() -> int: ...
def set_file_creation_time(value: int) -> None: ...

file_creation_time = property(get_file_creation_time, set_file_creation_time)

Default Value

0

Remarks

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

file_type Property

The type of file.

Syntax

def get_file_type() -> int: ...

file_type = property(get_file_type, None)

Default Value

0

Remarks

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

This property is read-only.

file_group_id Property

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

Syntax

def get_file_group_id() -> str: ...
def set_file_group_id(value: str) -> None: ...

file_group_id = property(get_file_group_id, set_file_group_id)

Default Value

""

Remarks

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

file_is_dir Property

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

Syntax

def get_file_is_dir() -> bool: ...

file_is_dir = property(get_file_is_dir, None)

Default Value

FALSE

Remarks

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

This property is read-only.

file_is_symlink Property

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

Syntax

def get_file_is_symlink() -> bool: ...

file_is_symlink = property(get_file_is_symlink, None)

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.

file_modified_time Property

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

Syntax

def get_file_modified_time() -> int: ...
def set_file_modified_time(value: int) -> None: ...

file_modified_time = property(get_file_modified_time, set_file_modified_time)

Default Value

0

Remarks

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

file_owner_id Property

The user id of this file's owner.

Syntax

def get_file_owner_id() -> str: ...
def set_file_owner_id(value: str) -> None: ...

file_owner_id = property(get_file_owner_id, set_file_owner_id)

Default Value

""

Remarks

The user id of this file's owner.

file_permissions Property

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

Syntax

def get_file_permissions() -> int: ...
def set_file_permissions(value: int) -> None: ...

file_permissions = property(get_file_permissions, set_file_permissions)

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

file_permissions_octal Property

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

Syntax

def get_file_permissions_octal() -> str: ...
def set_file_permissions_octal(value: str) -> None: ...

file_permissions_octal = property(get_file_permissions_octal, set_file_permissions_octal)

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.

file_size Property

The total size, in bytes, of this file.

Syntax

def get_file_size() -> int: ...

file_size = property(get_file_size, None)

Default Value

0

Remarks

The total size, in bytes, of this file.

This property is read-only.

file_exists Property

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

Syntax

def get_file_exists() -> bool: ...

file_exists = property(get_file_exists, None)

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

firewall_auto_detect Property

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

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

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

firewall_host Property

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

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host 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.

firewall_password Property

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

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

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

firewall_port Property

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

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

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.

local_file Property

The path to a local file for upload/download.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

The local_file 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()

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

The local_host 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 local_host 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: local_host is not persistent. You must always set it in code, and never in the property window.

local_port Property

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

Syntax

def get_local_port() -> int: ...
def set_local_port(value: int) -> None: ...

local_port = property(get_local_port, set_local_port)

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 local_port property after the connection is established.

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

overwrite Property

Whether or not the class should overwrite files during transfer.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

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

remote_file Property

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

Syntax

def get_remote_file() -> str: ...
def set_remote_file(value: str) -> None: ...

remote_file = property(get_remote_file, set_remote_file)

Default Value

""

Remarks

The remote_file is either an absolute file path, or a relative path based on remote_path.

A number of methods use remote_file 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 list_directory.

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.

remote_path Property

The current path in the SFTP server.

Syntax

def get_remote_path() -> str: ...
def set_remote_path(value: str) -> None: ...

remote_path = property(get_remote_path, set_remote_path)

Default Value

""

Remarks

The remote_path 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 remote_path.

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

Setting remote_path 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 change_remote_path method instead of setting this property.

ssh_accept_server_host_key_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssh_accept_server_host_key_encoded() -> bytes: ...
def set_ssh_accept_server_host_key_encoded(value: bytes) -> None: ...

ssh_accept_server_host_key_encoded = property(get_ssh_accept_server_host_key_encoded, set_ssh_accept_server_host_key_encoded)

Default Value

""

Remarks

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

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

ssh_auth_mode Property

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

Syntax

def get_ssh_auth_mode() -> int: ...
def set_ssh_auth_mode(value: int) -> None: ...

ssh_auth_mode = property(get_ssh_auth_mode, set_ssh_auth_mode)

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 ssh_logon, 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 ssh_host containing the ssh_user. 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 ssh_auth_mode 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)

ssh_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssh_cert_encoded() -> bytes: ...
def set_ssh_cert_encoded(value: bytes) -> None: ...

ssh_cert_encoded = property(get_ssh_cert_encoded, set_ssh_cert_encoded)

Default Value

""

Remarks

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

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

ssh_cert_store Property

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

Syntax

def get_ssh_cert_store() -> bytes: ...
def set_ssh_cert_store(value: bytes) -> None: ...

ssh_cert_store = property(get_ssh_cert_store, set_ssh_cert_store)

Default Value

"MY"

Remarks

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

The ssh_cert_store_type property denotes the type of the certificate store specified by ssh_cert_store. If the store is password protected, specify the password in ssh_cert_store_password.

ssh_cert_store is used in conjunction with the ssh_cert_subject property to specify client certificates. If ssh_cert_store has a value, and ssh_cert_subject or ssh_cert_encoded is set, a search for a certificate is initiated. Please see the ssh_cert_subject 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).

ssh_cert_store_password Property

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

Syntax

def get_ssh_cert_store_password() -> str: ...
def set_ssh_cert_store_password(value: str) -> None: ...

ssh_cert_store_password = property(get_ssh_cert_store_password, set_ssh_cert_store_password)

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.

ssh_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssh_cert_store_type() -> int: ...
def set_ssh_cert_store_type(value: int) -> None: ...

ssh_cert_store_type = property(get_ssh_cert_store_type, set_ssh_cert_store_type)

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:

ssh_cert_subject Property

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

Syntax

def get_ssh_cert_subject() -> str: ...
def set_ssh_cert_subject(value: str) -> None: ...

ssh_cert_subject = property(get_ssh_cert_subject, set_ssh_cert_subject)

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.

ssh_compression_algorithms Property

A comma-separated list containing all allowable compression algorithms.

Syntax

def get_ssh_compression_algorithms() -> str: ...
def set_ssh_compression_algorithms(value: str) -> None: ...

ssh_compression_algorithms = property(get_ssh_compression_algorithms, set_ssh_compression_algorithms)

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

ssh_encryption_algorithms Property

A comma-separated list containing all allowable encryption algorithms.

Syntax

def get_ssh_encryption_algorithms() -> str: ...
def set_ssh_encryption_algorithms(value: str) -> None: ...

ssh_encryption_algorithms = property(get_ssh_encryption_algorithms, set_ssh_encryption_algorithms)

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:

ssh_host Property

The address of the SSH host.

Syntax

def get_ssh_host() -> str: ...
def set_ssh_host(value: str) -> None: ...

ssh_host = property(get_ssh_host, set_ssh_host)

Default Value

""

Remarks

The ssh_host 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 ssh_host property is set to a Domain Name, a DNS request is initiated, and upon successful termination of the request, the ssh_host property is set to the corresponding address. If the search is not successful, an error is returned.

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

ssh_password Property

The password for SSH password-based authentication.

Syntax

def get_ssh_password() -> str: ...
def set_ssh_password(value: str) -> None: ...

ssh_password = property(get_ssh_password, set_ssh_password)

Default Value

""

Remarks

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

ssh_port Property

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

Syntax

def get_ssh_port() -> int: ...
def set_ssh_port(value: int) -> None: ...

ssh_port = property(get_ssh_port, set_ssh_port)

Default Value

22

Remarks

The ssh_port 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.

ssh_user Property

The username for SSH authentication.

Syntax

def get_ssh_user() -> str: ...
def set_ssh_user(value: str) -> None: ...

ssh_user = property(get_ssh_user, set_ssh_user)

Default Value

""

Remarks

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

start_byte Property

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

Syntax

def get_start_byte() -> int: ...
def set_start_byte(value: int) -> None: ...

start_byte = property(get_start_byte, set_start_byte)

Default Value

0

Remarks

The start_byte 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. start_byte 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 remote_file.

timeout Property

A timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

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

append Method

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

Syntax

def append() -> None: ...

Remarks

Similar to the upload method but the local file specified by local_file is appended to remote_file on the server as opposed to replacing it as done by the upload method. remote_file is either an absolute path on the server, or a path relative to remote_path. 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.

change_remote_path Method

Changes the current path on the server.

Syntax

def change_remote_path(remote_path: str) -> None: ...

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");

check_file_exists Method

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

Syntax

def check_file_exists() -> bool: ...

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 remote_file prior to calling this method.

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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

Connects to the SSH host without logging in.

Syntax

def connect() -> None: ...

Remarks

This method establishes a connection with the ssh_host but does not log in. In most cases it is recommended to use the ssh_logon 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.

create_file Method

Creates a file on the SFTP server.

Syntax

def create_file(file_name: str) -> None: ...

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.

decode_packet Method

Decodes a hex-encoded SSH packet.

Syntax

def decode_packet(encoded_packet: str) -> bytes: ...

Remarks

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

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

delete_file Method

Remove a file specified by FileName from an SFTP server.

Syntax

def delete_file(file_name: str) -> None: ...

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

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

disconnect Method

This method disconnects from the server without first logging off.

Syntax

def disconnect() -> None: ...

Remarks

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

In most cases the ssh_logoff 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.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events 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

Download a RemoteFile from an SFTP server.

Syntax

def download() -> None: ...

Remarks

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

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

encode_packet Method

Hex encodes an SSH packet.

Syntax

def encode_packet(packet: bytes) -> str: ...

Remarks

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

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

get_ssh_param Method

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

Syntax

def get_ssh_param(payload: bytes, field: str) -> str: ...

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 on_ssh_channel_request. 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 set_ssh_param. 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 set_ssh_param.

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

get_ssh_param_bytes Method

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

Syntax

def get_ssh_param_bytes(payload: bytes, field: str) -> bytes: ...

Remarks

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

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

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_directory Method

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

Syntax

def list_directory() -> None: ...

Remarks

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

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

make_directory Method

Create a directory on an SFTP server.

Syntax

def make_directory(new_dir: str) -> None: ...

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

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

query_file_attributes Method

Queries the server for the attributes of RemoteFile .

Syntax

def query_file_attributes() -> None: ...

Remarks

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

To update attributes modify the desired values in file_attributes and call update_file_attributes.

queue_file Method

Adds a file to the transfer queue.

Syntax

def queue_file(local_file: str, remote_file: str) -> None: ...

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 local_file, remote_file, 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 reset_queue. This will not affect current transfers.

To cancel and individual file transfer set the Cancel parameter of the on_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 on_error event will fire and the LocalFile and RemoteFile event parameters can be used to identify the file to which the error applies.

remove_directory Method

Remove a directory specified by DirName from an SFTP server.

Syntax

def remove_directory(dir_name: str) -> None: ...

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

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

rename_file Method

Change the name of RemoteFile to NewName .

Syntax

def rename_file(new_name: str) -> None: ...

Remarks

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

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

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

reset_queue Method

Resets the queue of files to be transferred.

Syntax

def reset_queue() -> None: ...

Remarks

This method will remove all files from the transfer queue.

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

set_ssh_param Method

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

Syntax

def set_ssh_param(payload: bytes, field_type: str, field_value: str) -> bytes: ...

Remarks

This method is used to build the payload portion of an SSH packet to be sent later by a call to send_ssh_packet. Payload should contain the result of a previous call to set_ssh_param. 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 on_ssh_custom_auth event.

ssh_logoff Method

Logoff from the SSH server.

Syntax

def ssh_logoff() -> None: ...

Remarks

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

ssh_logon Method

Logon to the SSHHost using the current SSHUser and SSHPassword .

Syntax

def ssh_logon(ssh_host: str, ssh_port: int) -> None: ...

Remarks

Logon to the SSH server using the current ssh_user and ssh_password. This will perform the SSH handshake and authentication.

Example (Logging On)

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

update_file_attributes Method

Instructs the class to send the FileAttributes to the server.

Syntax

def update_file_attributes() -> None: ...

Remarks

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

• file_access_time
• file_acl
• file_allocation_size
• file_attribute_bits
• file_attribute_bits_valid
• file_creation_time
• file_type
• file_group_id
• file_is_dir
• file_modified_time
• file_owner_id
• file_permissions
• file_size

upload Method

Upload a file specified by LocalFile to an SFTP server.

Syntax

def upload() -> None: ...

Remarks

The local file specified by local_file is uploaded to the remote file specified by remote_file. remote_file is either an absolute path on the server, or a path relative to remote_path.

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

on_connected Event

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

Syntax

class SFTPConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SFTP:
@property
def on_connected() -> Callable[[SFTPConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[SFTPConnectedEventParams], None]) -> None: ...

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.

on_connection_status Event

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

Syntax

class SFTPConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SFTP:
@property
def on_connection_status() -> Callable[[SFTPConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[SFTPConnectionStatusEventParams], None]) -> None: ...

Remarks

The on_connection_status 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:

on_dir_list Event

Fired when a directory entry is received.

Syntax

class SFTPDirListEventParams(object):
  @property
  def dir_entry() -> str: ...

  @property
  def file_name() -> str: ...

  @property
  def is_dir() -> bool: ...

  @property
  def file_size() -> int: ...

  @property
  def file_time() -> str: ...

  @property
  def is_symlink() -> bool: ...

# In class SFTP:
@property
def on_dir_list() -> Callable[[SFTPDirListEventParams], None]: ...
@on_dir_list.setter
def on_dir_list(event_hook: Callable[[SFTPDirListEventParams], None]) -> None: ...

Remarks

The on_dir_list events are fired when a directory listing is received as a response to a list_directory.

The on_start_transfer and on_end_transfer events mark the beginning and end of the event stream.

The DirEntry parameter contains the filename when list_directory is called.

The class tries to fill out the FileName, IsDir, FileSize, and FileTime parameters when calling the list_directory 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 remote_file and query the file_is_dir property.

on_disconnected Event

This event is fired when a connection is closed.

Syntax

class SFTPDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class SFTP:
@property
def on_disconnected() -> Callable[[SFTPDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[SFTPDisconnectedEventParams], None]) -> None: ...

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.

on_end_transfer Event

Fired when a file completes downloading/uploading.

Syntax

class SFTPEndTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def local_file() -> str: ...

  @property
  def remote_file() -> str: ...

# In class SFTP:
@property
def on_end_transfer() -> Callable[[SFTPEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[SFTPEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer 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.

on_error Event

Information about errors during data delivery.

Syntax

class SFTPErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

  @property
  def local_file() -> str: ...

  @property
  def remote_file() -> str: ...

# In class SFTP:
@property
def on_error() -> Callable[[SFTPErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[SFTPErrorEventParams], None]) -> None: ...

Remarks

The on_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.

on_log Event

Fires once for each log message.

Syntax

class SFTPLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class SFTP:
@property
def on_log() -> Callable[[SFTPLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[SFTPLogEventParams], None]) -> None: ...

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.

on_ssh_custom_auth Event

Fired when the class is doing custom authentication.

Syntax

class SFTPSSHCustomAuthEventParams(object):
  @property
  def packet() -> str: ...
  @packet.setter
  def packet(value) -> None: ...

# In class SFTP:
@property
def on_ssh_custom_auth() -> Callable[[SFTPSSHCustomAuthEventParams], None]: ...
@on_ssh_custom_auth.setter
def on_ssh_custom_auth(event_hook: Callable[[SFTPSSHCustomAuthEventParams], None]) -> None: ...

Remarks

on_ssh_custom_auth is fired during the user authentication stage of the SSH logon process if ssh_auth_mode 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 decode_packet and then use the get_ssh_param and get_ssh_param_bytes methods. To create a packet use the set_ssh_param method and then call encode_packet to obtain a HEX-encoded value and assign this to the Packet parameter.

on_ssh_keyboard_interactive Event

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

Syntax

class SFTPSSHKeyboardInteractiveEventParams(object):
  @property
  def name() -> str: ...

  @property
  def instructions() -> str: ...

  @property
  def prompt() -> str: ...

  @property
  def response() -> str: ...
  @response.setter
  def response(value) -> None: ...

  @property
  def echo_response() -> bool: ...

# In class SFTP:
@property
def on_ssh_keyboard_interactive() -> Callable[[SFTPSSHKeyboardInteractiveEventParams], None]: ...
@on_ssh_keyboard_interactive.setter
def on_ssh_keyboard_interactive(event_hook: Callable[[SFTPSSHKeyboardInteractiveEventParams], None]) -> None: ...

Remarks

on_ssh_keyboard_interactive 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 ssh_user. For example, if the ssh_host 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 on_ssh_keyboard_interactive event once for each prompt.

on_ssh_server_authentication Event

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

Syntax

class SFTPSSHServerAuthenticationEventParams(object):
  @property
  def host_key() -> bytes: ...

  @property
  def fingerprint() -> str: ...

  @property
  def key_algorithm() -> str: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class SFTP:
@property
def on_ssh_server_authentication() -> Callable[[SFTPSSHServerAuthenticationEventParams], None]: ...
@on_ssh_server_authentication.setter
def on_ssh_server_authentication(event_hook: Callable[[SFTPSSHServerAuthenticationEventParams], None]) -> None: ...

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

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.

on_ssh_status Event

Shows the progress of the secure connection.

Syntax

class SFTPSSHStatusEventParams(object):
  @property
  def message() -> str: ...

# In class SFTP:
@property
def on_ssh_status() -> Callable[[SFTPSSHStatusEventParams], None]: ...
@on_ssh_status.setter
def on_ssh_status(event_hook: Callable[[SFTPSSHStatusEventParams], None]) -> None: ...

Remarks

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

on_start_transfer Event

Fired when a file starts downloading/uploading.

Syntax

class SFTPStartTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def local_file() -> str: ...

  @property
  def remote_file() -> str: ...

# In class SFTP:
@property
def on_start_transfer() -> Callable[[SFTPStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[SFTPStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer 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.

on_transfer Event

Fired during file download/upload.

Syntax

class SFTPTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def local_file() -> str: ...

  @property
  def remote_file() -> str: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class SFTP:
@property
def on_transfer() -> Callable[[SFTPTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[SFTPTransferEventParams], None]) -> None: ...

Remarks

One or more on_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.

SFTP Config Settings

SFTP Config Settings

SSHClient Config Settings

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

TCPClient Config Settings

Socket Config Settings

Base Config Settings

SFTP Errors

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