SFTPClient Class
Properties Methods Events Config Settings Errors
The SFTPClient class can be used to transfer files to and from secure file transfer protocol (SFTP) servers.
Syntax
class ipworksedi.SFTPClient
Remarks
The SFTPClient class is the Secure Shell (SSH)-enabled equivalent of the IPWorks FTP class. The ssh_host and ssh_port properties specify which Secure Shell (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 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 SFTPClient 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 are 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.
connected | Whether the class is connected. |
dir_list_count | The number of records in the DirList arrays. |
dir_list_entry | This property contains the raw entry as received from the server. |
dir_list_file_name | This property shows the file name in the last directory listing. |
dir_list_file_size | This property shows the file size in the last directory listing. |
dir_list_file_time | This property shows the file time in the last directory listing. |
dir_list_is_dir | This property specifies whether entries in the last directory listing are directories. |
dir_list_is_symlink | This property indicates whether the entry is a symbolic link. |
file_access_time | Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed. |
file_acl | Contains a string containing an access control list (ACL). |
file_allocation_size | Specifies the size, in bytes, that this file consumes on disk. |
file_attribute_bits | AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. |
file_attribute_bits_valid | AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. |
file_creation_time | Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created. |
file_type | The type of file. |
file_group_id | Specifies the Id of the group that has access rights this file. |
file_is_dir | Specifies whether or not the file represented by these attributes is a directory. |
file_is_symlink | Specifies whether or not the file or directory represented by these attributes is a symbolic link. |
file_modified_time | Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified. |
file_owner_id | Specifies the user Id of this file's owner. |
file_permissions | Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask. |
file_permissions_octal | Includes an octal string containing the a POSIX-compatible file permission bitmask. |
file_size | Specifies the total size, in bytes, of this file. |
firewall_auto_detect | Whether to automatically detect and use firewall system settings, if available. |
firewall_type | The type of firewall to connect through. |
firewall_host | The name or IP address of the firewall (optional). |
firewall_password | A password if authentication is to be used when connecting through the firewall. |
firewall_port | The Transmission Control Protocol (TCP) port for the firewall Host . |
firewall_user | A username if authentication is to be used when connecting through a firewall. |
idle | The current status of the class. |
local_file | The path to a local file for upload or download. |
local_host | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
local_port | The TCP port in the local host where the class binds. |
overwrite | The value indicating whether or not the class should overwrite files during transfer. |
remote_file | The name of the remote file for uploading or downloading. |
remote_path | The current path in the secure file transfer protocol (SFTP) server. |
ssh_accept_server_host_key_effective_date | The date on which this certificate becomes valid. |
ssh_accept_server_host_key_expiration_date | The date on which the certificate expires. |
ssh_accept_server_host_key_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
ssh_accept_server_host_key_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssh_accept_server_host_key_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssh_accept_server_host_key_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssh_accept_server_host_key_issuer | The issuer of the certificate. |
ssh_accept_server_host_key_private_key | The private key of the certificate (if available). |
ssh_accept_server_host_key_private_key_available | Whether a PrivateKey is available for the selected certificate. |
ssh_accept_server_host_key_private_key_container | The name of the PrivateKey container for the certificate (if available). |
ssh_accept_server_host_key_public_key | The public key of the certificate. |
ssh_accept_server_host_key_public_key_algorithm | The textual description of the certificate's public key algorithm. |
ssh_accept_server_host_key_public_key_length | The length of the certificate's public key (in bits). |
ssh_accept_server_host_key_serial_number | The serial number of the certificate encoded as a string. |
ssh_accept_server_host_key_signature_algorithm | The text description of the certificate's signature algorithm. |
ssh_accept_server_host_key_store | The name of the certificate store for the client certificate. |
ssh_accept_server_host_key_store_password | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
ssh_accept_server_host_key_store_type | The type of certificate store for this certificate. |
ssh_accept_server_host_key_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
ssh_accept_server_host_key_thumbprint_md5 | The MD5 hash of the certificate. |
ssh_accept_server_host_key_thumbprint_sha1 | The SHA-1 hash of the certificate. |
ssh_accept_server_host_key_thumbprint_sha256 | The SHA-256 hash of the certificate. |
ssh_accept_server_host_key_usage | The text description of UsageFlags . |
ssh_accept_server_host_key_usage_flags | The flags that show intended use for the certificate. |
ssh_accept_server_host_key_version | The certificate's version number. |
ssh_accept_server_host_key_subject | The subject of the certificate used for client authentication. |
ssh_accept_server_host_key_encoded | The certificate (PEM/Base64 encoded). |
ssh_auth_mode | The authentication method to be used with the class when calling SSHLogon . |
ssh_cert_effective_date | The date on which this certificate becomes valid. |
ssh_cert_expiration_date | The date on which the certificate expires. |
ssh_cert_extended_key_usage | A comma-delimited list of extended key usage identifiers. |
ssh_cert_fingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
ssh_cert_fingerprint_sha1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
ssh_cert_fingerprint_sha256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
ssh_cert_issuer | The issuer of the certificate. |
ssh_cert_private_key | The private key of the certificate (if available). |
ssh_cert_private_key_available | Whether a PrivateKey is available for the selected certificate. |
ssh_cert_private_key_container | The name of the PrivateKey container for the certificate (if available). |
ssh_cert_public_key | The public key of the certificate. |
ssh_cert_public_key_algorithm | The textual description of the certificate's public key algorithm. |
ssh_cert_public_key_length | The length of the certificate's public key (in bits). |
ssh_cert_serial_number | The serial number of the certificate encoded as a string. |
ssh_cert_signature_algorithm | The text description of the certificate's signature algorithm. |
ssh_cert_store | The name of the certificate store for the client certificate. |
ssh_cert_store_password | 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 | The type of certificate store for this certificate. |
ssh_cert_subject_alt_names | Comma-separated lists of alternative subject names for the certificate. |
ssh_cert_thumbprint_md5 | The MD5 hash of the certificate. |
ssh_cert_thumbprint_sha1 | The SHA-1 hash of the certificate. |
ssh_cert_thumbprint_sha256 | The SHA-256 hash of the certificate. |
ssh_cert_usage | The text description of UsageFlags . |
ssh_cert_usage_flags | The flags that show intended use for the certificate. |
ssh_cert_version | The certificate's version number. |
ssh_cert_subject | The subject of the certificate used for client authentication. |
ssh_cert_encoded | The certificate (PEM/Base64 encoded). |
ssh_compression_algorithms | The comma-separated list containing all allowable compression algorithms. |
ssh_encryption_algorithms | The comma-separated list containing all allowable encryption algorithms. |
ssh_host | The address of the Secure Shell (SSH) host. |
ssh_password | The password for Secure Shell (SSH) password-based authentication. |
ssh_port | The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22. |
ssh_user | The username for Secure Shell (SSH) authentication. |
start_byte | The offset in bytes at which to begin the upload or download. |
timeout | The timeout for the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
append | Append data from LocalFile to a remote file RemoteFile on a Secure File Transfer Protocol (SFTP) server. |
change_remote_path | Changes the current path on the server. |
check_file_exists | Returns if the file specified by RemoteFile exists on the remote server. |
config | Sets or retrieves a configuration setting. |
connect | Connects to the Secure Shell (SSH) host without logging in. |
create_file | Creates a file on the Secure File Transfer Protocol (SFTP) server. |
decode_packet | Decodes a hex-encoded Secure Shell (SSH) packet. |
delete_file | Delete a file specified by FileName from a Secure File Transfer Protocol (SFTP) server. |
disconnect | Disconnects from the server without first logging off. |
do_events | This method processes events from the internal message queue. |
download | Download a RemoteFile from a Secure File Transfer Protocol (SFTP) server. |
download_range | DownloadRange facilitates the partial downloading of a remote file from a Secure File Transfer Protocol (SFTP) server. |
encode_packet | Hex encodes a Secure Shell (SSH) packet. |
get_ssh_param | Reads a field from a Secure Shell (SSH) packet's payload. |
get_ssh_param_bytes | Reads a field from a Secure Shell (SSH) packet's payload. |
interrupt | This method interrupts the current method. |
list_directory | List the current directory specified by RemotePath on a Secure File Transfer Protocol (SFTP) server. |
make_directory | Creates a directory on a Secure File Transfer Protocol (SFTP) server. |
query_file_attributes | Queries the server for the attributes of RemoteFile . |
queue_file | Adds a file to the transfer queue. |
remove_directory | Remove a directory specified by DirName from a secure file transfer protocol (SFTP) server. |
rename_file | Change the name of RemoteFile to NewName . |
reset | This method will reset the class. |
reset_queue | Resets the queue of files to be transferred. |
set_ssh_param | Writes a field to the end of a payload. |
ssh_logoff | Logs off from the Secure Shell (SSH) server. |
ssh_logon | Logs on to the SSHHost using the current SSHUser and SSHPassword . |
update_file_attributes | Instructs the class to send the FileAttributes to the server. |
upload | Upload a file specified by LocalFile to a secure file transfer protocol (SFTP) server. |
upload_range | UploadRange inserts data into a remote file on a secure file transfer protocol (SFTP) server. |
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.
on_connected | Fired immediately after a connection completes (or fails). |
on_connection_status | Fired to indicate changes in the connection state. |
on_dir_list | Fired when a directory entry is received. |
on_disconnected | Fired when a connection is closed. |
on_end_transfer | Fired when a file completes downloading or uploading. |
on_error | Fired when errors occur during data delivery. |
on_log | Fired once for each log message. |
on_ssh_custom_auth | Fired when the class is doing a custom authentication. |
on_ssh_keyboard_interactive | Fired when the class receives a request for user input from the server. |
on_ssh_server_authentication | Fired after the server presents its public key to the client. |
on_ssh_status | Fired to track the progress of the secure connection. |
on_start_transfer | Fired when a file starts downloading or uploading. |
on_transfer | Fired during file download or upload. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
AllowBackslashInName | Whether backslashes are allowed in folder and file names. |
AsyncTransfer | Controls whether simultatenous requests are made to read or write files. |
AttrAccessTime | Can be queried for the AccessTime file attribute during the DirList event. |
AttrCreationTime | Can be queried for the CreationTime file attribute during the DirList event. |
AttrFileType | Can be queried for the FileType file attribute during the DirList event. |
AttrGroupId | Can be queried for the GroupId file attribute during the DirList event. |
AttrLinkCount | Can be queried for the LinkCount file attribute during the DirList event. |
AttrOwnerId | Can be queried for the OwnerId file attribute during the DirList event. |
AttrPermission | Can be queried for the Permissions file attribute during the DirList event. |
CheckFileHash | Compares a server-computed hash with a hash calculated locally. |
CopyRemoteData | Copies a specified range of bytes in one file to another. |
CopyRemoteFile | Copies a file from one location to another directly on the server. |
DisableRealPath | Controls whether or not the SSH_FXP_REALPATH request is sent. |
ExcludeFileMask | Specifies a file mask for excluding files in directory listings. |
FileMaskDelimiter | Specifies a delimiter to use for setting multiple file masks in the RemoteFile property. |
FiletimeFormat | Specifies the format to use when returning filetime strings. |
FreeSpace | The free space on the remote server in bytes. |
GetSpaceInfo | Queries the server for drive usage information. |
GetSymlinkAttrs | Whether to get the attributes of the symbolic link, or the resource pointed to by the link. |
IgnoreFileMaskCasing | Controls whether or not the file mask is case sensitive. |
LocalEOL | When TransferMode is set, this specifies the line ending for the local system. |
LogSFTPFileData | Whether SFTP file data is present in Debug logs. |
MaskSensitiveData | Masks passwords in logs. |
MaxFileData | Specifies the maximum payload size of an SFTP packet. |
MaxOutstandingPackets | Sets the maximum number of simultaneous read or write requests allowed. |
NegotiatedProtocolVersion | The negotiated SFTP version. |
NormalizeRemotePath | Whether to normalize the RemotePath. |
PreserveFileTime | Preserves the file's timestamps during transfer. |
ProtocolVersion | The highest allowable SFTP version to use. |
ReadLink | This settings returns the target of a specified symbolic link. |
RealTimeUpload | Enables real time uploading. |
RealTimeUploadAgeLimit | The age limit in seconds when using RealTimeUpload. |
ServerEOL | When TransferMode is set, this specifies the line ending for the remote system. |
SimultaneousTransferLimit | The maximum number of simultaneous file transfers. |
TotalSpace | The total space on the remote server in bytes. |
TransferMode | The transfer mode (ASCII or Binary). |
TransferredDataLimit | Specifies the maximum number of bytes to download from the remote file. |
UseFxpStat | Whether SSH_FXP_STAT is sent. |
UseServerFileTime | Controls if the file time returned from the server is converted to local time or not. |
UseServerFileTime | Controls if the file time returned from the server is converted to local time or not. |
ChannelDataEOL[ChannelId] | Used to break the incoming data stream into chunks. |
ChannelDataEOLFound[ChannelId] | Determines if ChannelDataEOL was found. |
ClientSSHVersionString | The SSH version string used by the class. |
DoNotRepeatAuthMethods | Whether the class will repeat authentication methods during multifactor authentication. |
EnablePageantAuth | Whether to use a key stored in Pageant to perform client authentication. |
KerberosDelegation | If true, asks for credentials with delegation enabled during authentication. |
KerberosRealm | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. |
KerberosSPN | The Kerberos Service Principal Name of the SSH host. |
KeyRenegotiationThreshold | Sets the threshold for the SSH Key Renegotiation. |
LogLevel | Specifies the level of detail that is logged. |
MaxChannelDataLength[ChannelId] | The maximum amount of data to accumulate when no ChannelDataEOL is found. |
MaxPacketSize | The maximum packet size of the channel, in bytes. |
MaxWindowSize | The maximum window size allowed for the channel, in bytes. |
NegotiatedStrictKex | Returns whether strict key exchange was negotiated to be used. |
PasswordPrompt | The text of the password prompt used in keyboard-interactive authentication. |
PreferredDHGroupBits | The size (in bits) of the preferred modulus (p) to request from the server. |
RecordLength | The length of received data records. |
ServerSSHVersionString | The remote host's SSH version string. |
SignedSSHCert | The CA signed client public key used when authenticating. |
SSHAcceptAnyServerHostKey | If set the class will accept any key presented by the server. |
SSHAcceptServerCAKey | The CA public key that signed the server's host key. |
SSHAcceptServerHostKeyFingerPrint | The fingerprint of the server key to accept. |
SSHFingerprintHashAlgorithm | The algorithm used to calculate the fingerprint. |
SSHFingerprintMD5 | The server hostkey's MD5 fingerprint. |
SSHFingerprintSHA1 | The server hostkey's SHA1 fingerprint. |
SSHFingerprintSHA256 | The server hostkey's SHA256 fingerprint. |
SSHKeepAliveCountMax | The maximum number of keep alive packets to send without a response. |
SSHKeepAliveInterval | The interval between keep alive packets. |
SSHKeyExchangeAlgorithms | Specifies the supported key exchange algorithms. |
SSHKeyRenegotiate | Causes the class to renegotiate the SSH keys. |
SSHMacAlgorithms | Specifies the supported Mac algorithms. |
SSHPubKeyAuthSigAlgorithms | Specifies the enabled signature algorithms that may be used when attempting public key authentication. |
SSHPublicKeyAlgorithms | Specifies the supported public key algorithms for the server's public key. |
SSHVersionPattern | The pattern used to match the remote host's version string. |
TryAllAvailableAuthMethods | If set to true, the class will try all available authentication methods. |
UseStrictKeyExchange | Specifies how strict key exchange is supported. |
WaitForChannelClose | Whether to wait for channels to be closed before disconnected. |
WaitForServerDisconnect | Whether to wait for the server to close the connection. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseFIPSCompliantAPI | Tells the class whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
connected Property
Whether the class is connected.
Syntax
def get_connected() -> bool: ...
connected = property(get_connected, None)
Default Value
FALSE
Remarks
This property is used to determine whether or not the class is connected to the remote host. Use the connect and disconnect methods to manage the connection.
This property is read-only.
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
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
Contains 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
Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed.
file_acl Property
Contains 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
Contains a string containing an access control list (ACL).
file_allocation_size Property
Specifies 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
Specifies 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 secure file transfer protocol (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 secure file transfer protocol (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 ORed 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 secure file transfer protocol (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 secure file transfer protocol (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 ORed 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
Specifies 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
Specifies 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:
1 (sftRegular - default) | A normal file. |
2 (sftDirectory) | A directory. |
3 (symlink) | The file is a Unix symbolic link. |
4 (sftSpecial) | The file type is a special system file. |
5 (sftUnknown) | The file type is unknown. |
6 (sftSocket) | The file handle is a socket handle. |
7 (sftCharDevice) | The file handle is a character input device. |
8 (sftBlockDevice) | The file handle is a block input device. |
9 (sftpFIFO) | The file handle is a buffering input device. |
This property is read-only.
file_group_id Property
Specifies 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
Specifies the Id of the group that has access rights this file.
file_is_dir Property
Specifies 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
Specifies whether or not the file represented by these attributes is a directory.
This property is read-only.
file_is_symlink Property
Specifies 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
Specifies whether or not the file or directory represented by these attributes is a symbolic link. This setting is applicable only when GetSymlinkAttrs is set to True. By default, the attributes of the actual file referred to by the link (not the symbolic link) are returned and this property will always be False.
This property is read-only.
file_modified_time Property
Specifies 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
Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified.
file_owner_id Property
Specifies 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
Specifies the user Id of this file's owner.
file_permissions Property
Includes 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
Includes 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 Base10, and "40755" in octal would be "16877" in Base10.
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:
1 (001) | Execute |
2 (010) | Write |
4 (100) | Read |
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:
1 (001) | Sticky Bit - retain the file in memory for performance |
2 (010) | Set GID - sets the group Id of the process to the file's group Id upon execution (only for executable files) |
4 (100) | Set UID - sets the user Id of the process to the file's user Id upon execution (only for executable files) |
The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:
01 (000001) | Named pipe |
02 (000010) | Character special |
04 (000100) | Directory |
06 (000110) | Block special |
10 (001000) | Regular |
12 (001010) | Symbolic link |
14 (001100) | Socket |
For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.
Note: You will need to convert the octal permissions bitmask into its decimal representation.
file_permissions_octal Property
Includes an octal string containing the a POSIX-compatible file permission bitmask.
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
Includes 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:
1 (001) | Execute |
2 (010) | Write |
4 (100) | Read |
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:
1 (001) | Sticky Bit - retain the file in memory for performance |
2 (010) | Set GID - sets the group Id of the process to the file's group Id upon execution (only for executable files) |
4 (100) | Set UID - sets the user Id of the process to the file's user Id upon execution (only for executable files) |
The previous two octal digits are used together as a bitmask to determine the type of file. This bitmask has the following values:
01 (000001) | Named pipe |
02 (000010) | Character special |
04 (000100) | Directory |
06 (000110) | Block special |
10 (001000) | Regular |
12 (001010) | Symbolic link |
14 (001100) | Socket |
For example, the octal file permissions "100644" would indicate a regular file and octal "40755" would indicate a directory.
file_size Property
Specifies 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
Specifies the total size, in bytes, of this file.
This property is read-only.
firewall_auto_detect Property
Whether 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
Whether to automatically detect and use firewall system settings, if available.
firewall_type Property
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
The type of firewall to connect through. The applicable values are as follows:
fwNone (0) | No firewall (default setting). |
fwTunnel (1) | Connect through a tunneling proxy. firewall_port is set to 80. |
fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. firewall_port is set to 1080. |
fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. firewall_port is set to 1080. |
fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. firewall_port is set to 1080. |
firewall_host Property
The name or IP address of the 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
The name or IP address of the 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
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
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
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
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
A username if authentication is to be used when 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
A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property 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
This property will be False if the component is currently busy (communicating 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 or 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 be overwritten only 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
This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the class is connected, the 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 multihomed 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 on the client side.
overwrite Property
The value indicating 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 or downloading.
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 1. 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 2. Using RemoteFile as a File Mask:
SFTPControl.RemoteFile = "*.txt"
SFTPControl.ListDirectory()
The following special characters are supported for pattern matching:
? | Any single character. |
* | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). |
[,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). |
\ | The slash is ignored and exact matching is performed on the next character. |
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:
Character | Escape Sequence |
? | [?] |
* | [*] |
[ | [[] |
\ | [\] |
For example, to match the value [Something].txt, specify the pattern [[]Something].txt.
remote_path Property
The current path in the secure file transfer protocol (SFTP) server.
Syntax
def get_remote_path() -> str: ...
remote_path = property(get_remote_path, None)
Default Value
""
Remarks
The remote_path shows the current working directory on the SFTP server. The change_remote_path method can be used to change the working directory to an absolute directory path or to a relative path with respect to the current value of remote_path.
Example. Changing Directory:
sftp1.SSHLogon("sftp.server.net", 22);
sftp1.ChangeRemotePath("/home/user");
This property is read-only.
ssh_accept_server_host_key_effective_date Property
The date on which this certificate becomes valid.
Syntax
def get_ssh_accept_server_host_key_effective_date() -> str: ...
ssh_accept_server_host_key_effective_date = property(get_ssh_accept_server_host_key_effective_date, None)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssh_accept_server_host_key_expiration_date Property
The date on which the certificate expires.
Syntax
def get_ssh_accept_server_host_key_expiration_date() -> str: ...
ssh_accept_server_host_key_expiration_date = property(get_ssh_accept_server_host_key_expiration_date, None)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssh_accept_server_host_key_extended_key_usage Property
A comma-delimited list of extended key usage identifiers.
Syntax
def get_ssh_accept_server_host_key_extended_key_usage() -> str: ...
ssh_accept_server_host_key_extended_key_usage = property(get_ssh_accept_server_host_key_extended_key_usage, None)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssh_accept_server_host_key_fingerprint Property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssh_accept_server_host_key_fingerprint() -> str: ...
ssh_accept_server_host_key_fingerprint = property(get_ssh_accept_server_host_key_fingerprint, None)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssh_accept_server_host_key_fingerprint_sha1 Property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssh_accept_server_host_key_fingerprint_sha1() -> str: ...
ssh_accept_server_host_key_fingerprint_sha1 = property(get_ssh_accept_server_host_key_fingerprint_sha1, None)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssh_accept_server_host_key_fingerprint_sha256 Property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssh_accept_server_host_key_fingerprint_sha256() -> str: ...
ssh_accept_server_host_key_fingerprint_sha256 = property(get_ssh_accept_server_host_key_fingerprint_sha256, None)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssh_accept_server_host_key_issuer Property
The issuer of the certificate.
Syntax
def get_ssh_accept_server_host_key_issuer() -> str: ...
ssh_accept_server_host_key_issuer = property(get_ssh_accept_server_host_key_issuer, None)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssh_accept_server_host_key_private_key Property
The private key of the certificate (if available).
Syntax
def get_ssh_accept_server_host_key_private_key() -> str: ...
ssh_accept_server_host_key_private_key = property(get_ssh_accept_server_host_key_private_key, None)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssh_accept_server_host_key_private_key may be available but not exportable. In this case, ssh_accept_server_host_key_private_key returns an empty string.
This property is read-only.
ssh_accept_server_host_key_private_key_available Property
Whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssh_accept_server_host_key_private_key_available() -> bool: ...
ssh_accept_server_host_key_private_key_available = property(get_ssh_accept_server_host_key_private_key_available, None)
Default Value
FALSE
Remarks
Whether a ssh_accept_server_host_key_private_key is available for the selected certificate. If ssh_accept_server_host_key_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssh_accept_server_host_key_private_key_container Property
The name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssh_accept_server_host_key_private_key_container() -> str: ...
ssh_accept_server_host_key_private_key_container = property(get_ssh_accept_server_host_key_private_key_container, None)
Default Value
""
Remarks
The name of the ssh_accept_server_host_key_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssh_accept_server_host_key_public_key Property
The public key of the certificate.
Syntax
def get_ssh_accept_server_host_key_public_key() -> str: ...
ssh_accept_server_host_key_public_key = property(get_ssh_accept_server_host_key_public_key, None)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssh_accept_server_host_key_public_key_algorithm Property
The textual description of the certificate's public key algorithm.
Syntax
def get_ssh_accept_server_host_key_public_key_algorithm() -> str: ...
ssh_accept_server_host_key_public_key_algorithm = property(get_ssh_accept_server_host_key_public_key_algorithm, None)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssh_accept_server_host_key_public_key_length Property
The length of the certificate's public key (in bits).
Syntax
def get_ssh_accept_server_host_key_public_key_length() -> int: ...
ssh_accept_server_host_key_public_key_length = property(get_ssh_accept_server_host_key_public_key_length, None)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssh_accept_server_host_key_serial_number Property
The serial number of the certificate encoded as a string.
Syntax
def get_ssh_accept_server_host_key_serial_number() -> str: ...
ssh_accept_server_host_key_serial_number = property(get_ssh_accept_server_host_key_serial_number, None)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssh_accept_server_host_key_signature_algorithm Property
The text description of the certificate's signature algorithm.
Syntax
def get_ssh_accept_server_host_key_signature_algorithm() -> str: ...
ssh_accept_server_host_key_signature_algorithm = property(get_ssh_accept_server_host_key_signature_algorithm, None)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssh_accept_server_host_key_store Property
The name of the certificate store for the client certificate.
Syntax
def get_ssh_accept_server_host_key_store() -> bytes: ... def set_ssh_accept_server_host_key_store(value: bytes) -> None: ...
ssh_accept_server_host_key_store = property(get_ssh_accept_server_host_key_store, set_ssh_accept_server_host_key_store)
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The ssh_accept_server_host_key_store_type property denotes the type of the certificate store specified by ssh_accept_server_host_key_store. If the store is password-protected, specify the password in ssh_accept_server_host_key_store_password.
ssh_accept_server_host_key_store is used in conjunction with the ssh_accept_server_host_key_subject property to specify client certificates. If ssh_accept_server_host_key_store has a value, and ssh_accept_server_host_key_subject or ssh_accept_server_host_key_encoded is set, a search for a certificate is initiated. Please see the ssh_accept_server_host_key_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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
ssh_accept_server_host_key_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_accept_server_host_key_store_password() -> str: ... def set_ssh_accept_server_host_key_store_password(value: str) -> None: ...
ssh_accept_server_host_key_store_password = property(get_ssh_accept_server_host_key_store_password, set_ssh_accept_server_host_key_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_accept_server_host_key_store_type Property
The type of certificate store for this certificate.
Syntax
def get_ssh_accept_server_host_key_store_type() -> int: ... def set_ssh_accept_server_host_key_store_type(value: int) -> None: ...
ssh_accept_server_host_key_store_type = property(get_ssh_accept_server_host_key_store_type, set_ssh_accept_server_host_key_store_type)
Default Value
0
Remarks
The type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssh_accept_server_host_key_store and set ssh_accept_server_host_key_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssh_accept_server_host_key_subject_alt_names Property
Comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssh_accept_server_host_key_subject_alt_names() -> str: ...
ssh_accept_server_host_key_subject_alt_names = property(get_ssh_accept_server_host_key_subject_alt_names, None)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssh_accept_server_host_key_thumbprint_md5 Property
The MD5 hash of the certificate.
Syntax
def get_ssh_accept_server_host_key_thumbprint_md5() -> str: ...
ssh_accept_server_host_key_thumbprint_md5 = property(get_ssh_accept_server_host_key_thumbprint_md5, None)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssh_accept_server_host_key_thumbprint_sha1 Property
The SHA-1 hash of the certificate.
Syntax
def get_ssh_accept_server_host_key_thumbprint_sha1() -> str: ...
ssh_accept_server_host_key_thumbprint_sha1 = property(get_ssh_accept_server_host_key_thumbprint_sha1, None)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssh_accept_server_host_key_thumbprint_sha256 Property
The SHA-256 hash of the certificate.
Syntax
def get_ssh_accept_server_host_key_thumbprint_sha256() -> str: ...
ssh_accept_server_host_key_thumbprint_sha256 = property(get_ssh_accept_server_host_key_thumbprint_sha256, None)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssh_accept_server_host_key_usage Property
The text description of UsageFlags .
Syntax
def get_ssh_accept_server_host_key_usage() -> str: ...
ssh_accept_server_host_key_usage = property(get_ssh_accept_server_host_key_usage, None)
Default Value
""
Remarks
The text description of ssh_accept_server_host_key_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssh_accept_server_host_key_usage_flags Property
The flags that show intended use for the certificate.
Syntax
def get_ssh_accept_server_host_key_usage_flags() -> int: ...
ssh_accept_server_host_key_usage_flags = property(get_ssh_accept_server_host_key_usage_flags, None)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of ssh_accept_server_host_key_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssh_accept_server_host_key_usage property for a text representation of ssh_accept_server_host_key_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssh_accept_server_host_key_version Property
The certificate's version number.
Syntax
def get_ssh_accept_server_host_key_version() -> str: ...
ssh_accept_server_host_key_version = property(get_ssh_accept_server_host_key_version, None)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssh_accept_server_host_key_subject Property
The subject of the certificate used for client authentication.
Syntax
def get_ssh_accept_server_host_key_subject() -> str: ... def set_ssh_accept_server_host_key_subject(value: str) -> None: ...
ssh_accept_server_host_key_subject = property(get_ssh_accept_server_host_key_subject, set_ssh_accept_server_host_key_subject)
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssh_accept_server_host_key_encoded Property
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
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 with 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 Secure Shell (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:
amNone (0) | No authentication will be performed. The current ssh_user value is ignored, and the connection will be logged as anonymous. |
amMultiFactor (1) | This allows the class to attempt a multistep authentication process. The class will send authentication data to the server based on the list of methods allowed for the current user and the authentication property values supplied. The class will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the class fails with an error. |
amPassword (2) | The class will use the values of ssh_user and ssh_password to authenticate the user. |
amPublicKey (3) | The class will use the values of ssh_user and the ssh_cert* properties to authenticate the user. the ssh_cert* properties must have a private key available for this authentication method to succeed. |
amKeyboardInteractive (4) | At the time of authentication, the class will fire the on_ssh_keyboard_interactive event containing instructions on how to complete the authentication step.
Note: amKeyboardInteractive is not supported in SSHTunnel. |
amGSSAPIWithMic (5) | This allows the class to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of ssh_user (single sign-on), or if ssh_password is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. |
amGSSAPIKeyex (6) | This allows the class to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of ssh_user (single sign-on), or if ssh_password is specified as well, it will try Kerberos authentication with alternate credentials. This is currently supported only on Windows, unless using the Java edition, which also provides support for Linux and macOS. |
amCustom (99) | This allows the class caller to take over the authentication process completely. When amCustom is set, the class will fire the on_ssh_custom_auth event as necessary to complete the authentication process. |
Example 1. User/Password Authentication:
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)
Example 2. Public Key Authentication:
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_effective_date Property
The date on which this certificate becomes valid.
Syntax
def get_ssh_cert_effective_date() -> str: ...
ssh_cert_effective_date = property(get_ssh_cert_effective_date, None)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
ssh_cert_expiration_date Property
The date on which the certificate expires.
Syntax
def get_ssh_cert_expiration_date() -> str: ...
ssh_cert_expiration_date = property(get_ssh_cert_expiration_date, None)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
ssh_cert_extended_key_usage Property
A comma-delimited list of extended key usage identifiers.
Syntax
def get_ssh_cert_extended_key_usage() -> str: ...
ssh_cert_extended_key_usage = property(get_ssh_cert_extended_key_usage, None)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
ssh_cert_fingerprint Property
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
def get_ssh_cert_fingerprint() -> str: ...
ssh_cert_fingerprint = property(get_ssh_cert_fingerprint, None)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
ssh_cert_fingerprint_sha1 Property
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
def get_ssh_cert_fingerprint_sha1() -> str: ...
ssh_cert_fingerprint_sha1 = property(get_ssh_cert_fingerprint_sha1, None)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
ssh_cert_fingerprint_sha256 Property
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
def get_ssh_cert_fingerprint_sha256() -> str: ...
ssh_cert_fingerprint_sha256 = property(get_ssh_cert_fingerprint_sha256, None)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
ssh_cert_issuer Property
The issuer of the certificate.
Syntax
def get_ssh_cert_issuer() -> str: ...
ssh_cert_issuer = property(get_ssh_cert_issuer, None)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
ssh_cert_private_key Property
The private key of the certificate (if available).
Syntax
def get_ssh_cert_private_key() -> str: ...
ssh_cert_private_key = property(get_ssh_cert_private_key, None)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The ssh_cert_private_key may be available but not exportable. In this case, ssh_cert_private_key returns an empty string.
This property is read-only.
ssh_cert_private_key_available Property
Whether a PrivateKey is available for the selected certificate.
Syntax
def get_ssh_cert_private_key_available() -> bool: ...
ssh_cert_private_key_available = property(get_ssh_cert_private_key_available, None)
Default Value
FALSE
Remarks
Whether a ssh_cert_private_key is available for the selected certificate. If ssh_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
ssh_cert_private_key_container Property
The name of the PrivateKey container for the certificate (if available).
Syntax
def get_ssh_cert_private_key_container() -> str: ...
ssh_cert_private_key_container = property(get_ssh_cert_private_key_container, None)
Default Value
""
Remarks
The name of the ssh_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
ssh_cert_public_key Property
The public key of the certificate.
Syntax
def get_ssh_cert_public_key() -> str: ...
ssh_cert_public_key = property(get_ssh_cert_public_key, None)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
ssh_cert_public_key_algorithm Property
The textual description of the certificate's public key algorithm.
Syntax
def get_ssh_cert_public_key_algorithm() -> str: ...
ssh_cert_public_key_algorithm = property(get_ssh_cert_public_key_algorithm, None)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssh_cert_public_key_length Property
The length of the certificate's public key (in bits).
Syntax
def get_ssh_cert_public_key_length() -> int: ...
ssh_cert_public_key_length = property(get_ssh_cert_public_key_length, None)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
ssh_cert_serial_number Property
The serial number of the certificate encoded as a string.
Syntax
def get_ssh_cert_serial_number() -> str: ...
ssh_cert_serial_number = property(get_ssh_cert_serial_number, None)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
ssh_cert_signature_algorithm Property
The text description of the certificate's signature algorithm.
Syntax
def get_ssh_cert_signature_algorithm() -> str: ...
ssh_cert_signature_algorithm = property(get_ssh_cert_signature_algorithm, None)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
ssh_cert_store Property
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
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:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
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
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
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:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: This store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS#11 DLL. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the ssh_cert_store and set ssh_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key:
|
99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
ssh_cert_subject_alt_names Property
Comma-separated lists of alternative subject names for the certificate.
Syntax
def get_ssh_cert_subject_alt_names() -> str: ...
ssh_cert_subject_alt_names = property(get_ssh_cert_subject_alt_names, None)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
ssh_cert_thumbprint_md5 Property
The MD5 hash of the certificate.
Syntax
def get_ssh_cert_thumbprint_md5() -> str: ...
ssh_cert_thumbprint_md5 = property(get_ssh_cert_thumbprint_md5, None)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssh_cert_thumbprint_sha1 Property
The SHA-1 hash of the certificate.
Syntax
def get_ssh_cert_thumbprint_sha1() -> str: ...
ssh_cert_thumbprint_sha1 = property(get_ssh_cert_thumbprint_sha1, None)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssh_cert_thumbprint_sha256 Property
The SHA-256 hash of the certificate.
Syntax
def get_ssh_cert_thumbprint_sha256() -> str: ...
ssh_cert_thumbprint_sha256 = property(get_ssh_cert_thumbprint_sha256, None)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
ssh_cert_usage Property
The text description of UsageFlags .
Syntax
def get_ssh_cert_usage() -> str: ...
ssh_cert_usage = property(get_ssh_cert_usage, None)
Default Value
""
Remarks
The text description of ssh_cert_usage_flags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
ssh_cert_usage_flags Property
The flags that show intended use for the certificate.
Syntax
def get_ssh_cert_usage_flags() -> int: ...
ssh_cert_usage_flags = property(get_ssh_cert_usage_flags, None)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of ssh_cert_usage_flags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the ssh_cert_usage property for a text representation of ssh_cert_usage_flags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
ssh_cert_version Property
The certificate's version number.
Syntax
def get_ssh_cert_version() -> str: ...
ssh_cert_version = property(get_ssh_cert_version, None)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
ssh_cert_subject Property
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
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:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
ssh_cert_encoded Property
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
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_compression_algorithms Property
The 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 Secure Shell (SSH) handshake, this list will be used to negotiate the compression algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following compression algorithms are supported by the class:
- zlib
- zlib@openssh.com
- none
ssh_encryption_algorithms Property
The 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,3des-ctr,arcfour256,arcfour128,arcfour,aes256-gcm@openssh.com,aes128-gcm@openssh.com,chacha20-poly1305@openssh.com"
Remarks
During the Secure Shell (SSH) handshake, this list will be used to negotiate the encryption algorithm to be used between the client and server. This list is used for both directions: client to server and server to client. When negotiating algorithms, each side sends a list of all algorithms it supports or allows. The algorithm chosen for each direction is the first algorithm to appear in the sender's list that the receiver supports. Therefore, it is important to list multiple algorithms in preferential order. If no algorithm can be agreed on, the class will raise an error and the connection will be aborted.
At least one supported algorithm must appear in this list. The following encryption algorithms are supported by the class:
aes256-ctr | 256-bit AES encryption in CTR mode. |
aes256-cbc | 256-bit AES encryption in CBC mode. |
aes192-ctr | 192-bit AES encryption in CTR mode. |
aes192-cbc | 192-bit AES encryption in CBC mode. |
aes128-ctr | 128-bit AES encryption in CTR mode. |
aes128-cbc | 128-bit AES encryption in CBC mode. |
3des-ctr | 192-bit (3-key) triple DES encryption in CTR mode. |
3des-cbc | 192-bit (3-key) triple DES encryption in CBC mode. |
cast128-cbc | CAST-128 encryption. |
blowfish-cbc | Blowfish encryption. |
arcfour | ARC4 encryption. |
arcfour128 | 128-bit ARC4 encryption. |
arcfour256 | 256-bit ARC4 encryption. |
aes256-gcm@openssh.com | 256-bit AES encryption in GCM mode. |
aes128-gcm@openssh.com | 128-bit AES encryption in GCM mode. |
chacha20-poly1305@openssh.com | ChaCha20 with Poly1305-AES encryption. |
ssh_host Property
The address of the Secure Shell (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 Secure Shell (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 that is used to authenticate the client to the SSH server.
ssh_port Property
The port on the Secure Shell (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 Secure Shell (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 that is used to authenticate the client to the SSH server. This property is required.
Example 1. User/Password Authentication:
Control.SSHAuthMode = SftpSSHAuthModes.amPassword
Control.SSHUser = "username"
Control.SSHPassword = "password"
Control.SSHLogon("server", 22)
Example 2. Public Key Authentication:
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 to download only a specific range of data from the current remote_file.
timeout Property
The 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.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.
The default value for the timeout property is 60 seconds.
append Method
Append data from LocalFile to a remote file RemoteFile on a Secure File Transfer Protocol (SFTP) server.
Syntax
def append() -> None: ...
Remarks
This method is 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 with 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 does not already exist (similar to upload).
If a Secure Shell (SSH) session is not 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 an absolute path and must specify the entire path from the root of the server. For example:
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 subfolder of the current directory. The special value .. refers to the parent directory of the current path. For example:
//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 before calling this method.
If no session is 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 Secure Shell (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 in which 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 Secure File Transfer Protocol (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 Secure Shell (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 applicable only for reading and creating Secure Shell (SSH) packets for use within the on_ssh_custom_auth event.
delete_file Method
Delete a file specified by FileName from a Secure File Transfer Protocol (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 a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
disconnect 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 log off and disconnect from the server. Call the disconnect method in cases in which it is desirable to immediately disconnect without first logging off.
do_events Method
This 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 a Secure File Transfer Protocol (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 is a path relative to remote_path.
If a Secure Shell (SSH) session is not 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()
download_range Method
DownloadRange facilitates the partial downloading of a remote file from a Secure File Transfer Protocol (SFTP) server.
Syntax
def download_range(path: str, file_name: str, start_byte: int, count: int, buffer: bytes) -> int: ...
Remarks
This method enables downloading a specific segment of a remote file specified by Path and FileName. StartByte is the offset (in bytes) relative to the beginning of the file from where to start reading, and Count is the number of bytes to read into the specified Buffer.
This functionality is particularly useful for efficient management of large files and targeted data retrieval within them.
Note: If the requested range extends beyond the end of the file, only the available bytes will be returned.
encode_packet Method
Hex encodes a Secure Shell (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 applicable only for reading and creating Secure Shell (SSH) packets for use within the on_ssh_custom_auth event.
get_ssh_param Method
Reads a field from a Secure Shell (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:
ChannelId (int32) | The Id of the channel that received the packet. |
RequestType (string) | The type of channel requested. |
WantsReply (boolean) | Whether or not the client wants a reply to the request. |
The remaining fields that are available in the payload are dependent on 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:
TerminalType (string) | The type of terminal being requested (e.g., "vt100"). |
TerminalWidthCharacters (int32) | The width, in characters, of the terminal to be opened. |
TerminalHeightRows (int32) | The height, in rows, of the terminal to be opened. |
TerminalWidthPixels (int32) | The width, in pixels, of the terminal to be opened. |
TerminalHeightPixels (int32) | The height, in pixels, of the terminal to be opened. |
TerminalModes (string) | A list of op-val (int32-byte) encoded modes to be used by the terminal. |
x11-req
X11-req is a request to forward x11 sessions over a channel. The following fields are available:
SingleConnection (boolean) | Disallows more than one connection to be forwarded by the channel. |
X11AuthProtocol (string) | The authentication protocol to be used (e.g., "MIT-MAGIC-COOKIE-1"). |
X11AuthCookie (string) | A hexadecimal-encoded cookie to be used for authentication. |
X11ScreenNumber (int32) | The x11 screen number to be used. |
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:
VariableName (string) | The name of the variable to be set. |
VariableValue (string) | The value of the variable to be set. |
exec
Exec is a request to execute a command on the channel using the authenticated user's shell. The following field is available:
Command (string) | The command to be executed. |
subsystem
Subsystem is a request to start a subsystem on the specified channel. The following field is available:
Subsystem (string) | The name of the subsystem to be started (e.g., "sftp"). |
xon-xoff
Xon-xoff instructs the server to allow or disallow control-S/control-Q style flow control. The following field is available:
ClientCanDo (boolean) | Whether or not the server should enable flow control. |
signal
Sends a signal to the remote process/service. The following field is available:
SignalName (string) | The name of the signal to be sent. |
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 applicable only for reading and creating Secure Shell (SSH) packets for use within the on_ssh_custom_auth event.
get_ssh_param_bytes Method
Reads a field from a Secure Shell (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 it returns raw bytes instead of strings.
Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the on_ssh_custom_auth event.
interrupt Method
This method interrupts 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 a Secure File Transfer Protocol (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 is a path relative to remote_path. The file listing is received through the on_dir_list event.
If a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
make_directory Method
Creates a directory on a Secure File Transfer Protocol (SFTP) server.
Syntax
def make_directory(new_dir: str) -> None: ...
Remarks
A directory with a path specified by NewDir is created on the SFTP server. NewDir is either an absolute path on the server or is a path relative to remote_path.
If a Secure Shell (SSH) session is not 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 method 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 to set local_file and remote_file and to 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 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 an 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 a secure file transfer protocol (SFTP) server.
Syntax
def remove_directory(dir_name: str) -> None: ...
Remarks
A directory with a 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 a Secure Shell (SSH) session is not 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 the remote file or the 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 a Secure Shell (SSH) session is not in place, one is automatically created by the component first.
reset Method
This method will 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
Writes 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 a Secure Shell (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:
s | A plaintext string containing the default system encoding of the data. |
sb | A string containing the hex-encoded data (e.g., "A1B23C") |
m | A variable-length large integer, encoded as a textual representation of the value (e.g., "1234"). |
i | A 32-bit integer, encoded as a textual representation of the value (e.g., "1234"). |
l | A 64-bit integer, encoded as a textual representation of the value (e.g., "1234"). |
b | A single byte, encoded as a textual representation of the value (e.g., "123"). |
f | A boolean flag, encoded as a textual representation of the value (e.g., 'True' or 'False') |
Note: Integer values may be hexadecimal encoded by prefixing "0x" to the beginning of the string; otherwise, the value is assumed to be Base10.
Note: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the on_ssh_custom_auth event.
ssh_logoff Method
Logs off from the Secure Shell (SSH) server.
Syntax
def ssh_logoff() -> None: ...
Remarks
Logs off from the SSH server. If that fails, the connection is terminated by the local host.
ssh_logon Method
Logs on to the SSHHost using the current SSHUser and SSHPassword .
Syntax
def ssh_logon(ssh_host: str, ssh_port: int) -> None: ...
Remarks
Logs on to the Secure Shell (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 a secure file transfer protocol (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 a Secure Shell (SSH) session is not 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()
upload_range Method
UploadRange inserts data into a remote file on a secure file transfer protocol (SFTP) server.
Syntax
def upload_range(path: str, file_name: str, start_byte: int, count: int, buffer: bytes) -> None: ...
Remarks
This method enables uploading a buffer into the remote file specified by the Path and FileName. Count bytes will be updated from the provided Buffer starting in the remote file at the StartByte offset.
This functionality enables precise control over the insertion of data into a remote file, allowing for targeted modifications, overwriting, or additions starting from a specific position within the file.
Note: If the offset specified is beyond the file length, empty bytes will be created between the last file byte and the uploaded buffer.
on_connected Event
Fired immediately after a connection completes (or fails).
Syntax
class SFTPClientConnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class SFTPClient: @property def on_connected() -> Callable[[SFTPClientConnectedEventParams], None]: ... @on_connected.setter def on_connected(event_hook: Callable[[SFTPClientConnectedEventParams], 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
Fired to indicate changes in the connection state.
Syntax
class SFTPClientConnectionStatusEventParams(object): @property def connection_event() -> str: ... @property def status_code() -> int: ... @property def description() -> str: ... # In class SFTPClient: @property def on_connection_status() -> Callable[[SFTPClientConnectionStatusEventParams], None]: ... @on_connection_status.setter def on_connection_status(event_hook: Callable[[SFTPClientConnectionStatusEventParams], None]) -> None: ...
Remarks
This 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:
Firewall connection complete. | |
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable). | |
Remote host connection complete. | |
Remote host disconnected. | |
SSL or S/Shell connection broken. | |
Firewall host disconnected. |
on_dir_list Event
Fired when a directory entry is received.
Syntax
class SFTPClientDirListEventParams(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 SFTPClient: @property def on_dir_list() -> Callable[[SFTPClientDirListEventParams], None]: ... @on_dir_list.setter def on_dir_list(event_hook: Callable[[SFTPClientDirListEventParams], 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 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_is_dir property.
on_disconnected Event
Fired when a connection is closed.
Syntax
class SFTPClientDisconnectedEventParams(object): @property def status_code() -> int: ... @property def description() -> str: ... # In class SFTPClient: @property def on_disconnected() -> Callable[[SFTPClientDisconnectedEventParams], None]: ... @on_disconnected.setter def on_disconnected(event_hook: Callable[[SFTPClientDisconnectedEventParams], 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 or uploading.
Syntax
class SFTPClientEndTransferEventParams(object): @property def direction() -> int: ... @property def local_file() -> str: ... @property def remote_file() -> str: ... # In class SFTPClient: @property def on_end_transfer() -> Callable[[SFTPClientEndTransferEventParams], None]: ... @on_end_transfer.setter def on_end_transfer(event_hook: Callable[[SFTPClientEndTransferEventParams], None]) -> None: ...
Remarks
The on_end_transfer event fires when either an upload or a download operation completes. This occurs when the file finishes transferring 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
Fired when errors occur during data delivery.
Syntax
class SFTPClientErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... @property def local_file() -> str: ... @property def remote_file() -> str: ... # In class SFTPClient: @property def on_error() -> Callable[[SFTPClientErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[SFTPClientErrorEventParams], 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
Fired once for each log message.
Syntax
class SFTPClientLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class SFTPClient: @property def on_log() -> Callable[[SFTPClientLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[SFTPClientLogEventParams], None]) -> None: ...
Remarks
Fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the detail level of the message. Possible values are as follows:
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as Secure Shell (SSH) handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information are logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
Message is the log message.
LogType is reserved for future use.
on_ssh_custom_auth Event
Fired when the class is doing a custom authentication.
Syntax
class SFTPClientSSHCustomAuthEventParams(object): @property def packet() -> str: ... @packet.setter def packet(value) -> None: ... # In class SFTPClient: @property def on_ssh_custom_auth() -> Callable[[SFTPClientSSHCustomAuthEventParams], None]: ... @on_ssh_custom_auth.setter def on_ssh_custom_auth(event_hook: Callable[[SFTPClientSSHCustomAuthEventParams], None]) -> None: ...
Remarks
on_ssh_custom_auth is fired during the user authentication stage of the Secure Shell (SSH) logon process if ssh_auth_mode is set to amCustom. Packet contains the last raw 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 SFTPClientSSHKeyboardInteractiveEventParams(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 SFTPClient: @property def on_ssh_keyboard_interactive() -> Callable[[SFTPClientSSHKeyboardInteractiveEventParams], None]: ... @on_ssh_keyboard_interactive.setter def on_ssh_keyboard_interactive(event_hook: Callable[[SFTPClientSSHKeyboardInteractiveEventParams], None]) -> None: ...
Remarks
on_ssh_keyboard_interactive is fired during the user authentication stage of the Secure Shell (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 SFTPClientSSHServerAuthenticationEventParams(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 SFTPClient: @property def on_ssh_server_authentication() -> Callable[[SFTPClientSSHServerAuthenticationEventParams], None]: ... @on_ssh_server_authentication.setter def on_ssh_server_authentication(event_hook: Callable[[SFTPClientSSHServerAuthenticationEventParams], None]) -> None: ...
Remarks
This event is fired when the client can decide whether or not to continue with the connection process. If the public key is known to be a valid key for the Secure Shell (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: 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. The following values are supported:
- 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 applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".
CertIssuer is the issuer of the certificate. This is applicable only when KeyAlgorithm is "x509v3-sign-rsa" or "x509v3-sign-dss".
Status is reserved for future use.
on_ssh_status Event
Fired to track the progress of the secure connection.
Syntax
class SFTPClientSSHStatusEventParams(object): @property def message() -> str: ... # In class SFTPClient: @property def on_ssh_status() -> Callable[[SFTPClientSSHStatusEventParams], None]: ... @on_ssh_status.setter def on_ssh_status(event_hook: Callable[[SFTPClientSSHStatusEventParams], 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 or uploading.
Syntax
class SFTPClientStartTransferEventParams(object): @property def direction() -> int: ... @property def local_file() -> str: ... @property def remote_file() -> str: ... # In class SFTPClient: @property def on_start_transfer() -> Callable[[SFTPClientStartTransferEventParams], None]: ... @on_start_transfer.setter def on_start_transfer(event_hook: Callable[[SFTPClientStartTransferEventParams], None]) -> None: ...
Remarks
The on_start_transfer event fires when a data interface connection is created. This occurs when the file starts transferring 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 or upload.
Syntax
class SFTPClientTransferEventParams(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 SFTPClient: @property def on_transfer() -> Callable[[SFTPClientTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[SFTPClientTransferEventParams], 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.
SFTPClient Config Settings
The class accepts one or more of the following configuration settings. Configuration 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.SFTPClient Config Settings
The default value is False.
The server must support the check-file extension.
The class supports the following hash algorithms (in order of preference): sha256,sha224,sha384,sha512,sha1,md5. The server may choose to use any value from this list. No action is needed to configure the algorithm, the class will automatically use the same algorithm that the server users.
If the extension is unsupported or a mismatch in hashes is detected, the class fails with an error. If the hashes match the value, True is returned.
try {
String flag = sftp.Config("CheckFileHash");
// flag will be equal to "True"
}
catch (Exception e) {
// mismatch
}
Set remote_file to the path of the source file. Optionally set start_byte to indicate from where in the source file to start reading.
Then set CopyRemoteData to a semicolon (;) delimited listed of Name=Value pairs. In this list, DestFile must be set to the path of the destination file. Length may be set to the number of bytes to read. WriteOffset may be set to the location in the destination file from where to start writing.
sftp.RemoteFile = "/my/source/file.txt";
sftp.Overwrite = true;
sftp.StartByte = 6;
sftp.Config("CopyRemoteData=DestFile=/my/destination/file.txt;Length=5;WriteOffset=14");
Set remote_file to the path of the source file, then set CopyRemoteFile to the path of the destination file. overwrite controls whether an existing file will be overwritten.
sftp.Overwrite = true;
sftp.RemoteFile = "/my/source/file.txt";
sftp.Config("CopyRemoteFile=" + "/my/destination/file.txt");
Note: The server must understand either the "statvfs@openssh.com" or "space-available" extension for this operation to succeed.
If it is desired to retrieve the attributes of the symbolic link itself, set GetSymlinkAttrs to True before querying file_attributes.
When uploading or downloading, this value will be compared to ServerEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.
The value supplied to this setting must be quoted. For example:
component.Config("LocalEOL=\"" + myEOLSequence + "\"");
Where myEOLSequence is a Cr, Lf, or CrLf character sequence.
Conversion will only happen when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.
Note: Setting this value to True will increase the amount of data that are logged.
Most servers that use smaller values will use a maximum SSH packet size of 16KB (16384). To most efficiently communicate with such servers, MaxFileData size should be set to 14745.
Note: Values larger than 64,000 (65,536) may not be respected by some servers (such as OpenSSH) and will result in unexpected behavior. If specifying a value, it is recommended to set a value less than or equal to 65,536.
The default value is 32,768.
string resolvedPath = component.Config("ReadLink=/home/test/mysymlink.txt");
When uploading or downloading, this value will be compared to LocalEOL. If ServerEOL and LocalEOL are different, the line endings in the file being transferred will be converted to the line endings used by the destination. Line endings will be converted to the value in LocalEOL when downloading. Line endings will be converted to the value in ServerEOL when uploading. If ServerEOL and LocalEOL are the same, no conversion takes place.
The value supplied to this setting must be quoted. For example:
component.Config("ServerEOL=\"" + myEOLSequence + "\"");
Where myEOLSequence is a Cr, Lf, or CrLf character sequence.
Conversion will happen only when TransferMode is set to 1 (ASCII) and ServerEOL and LocalEOL are different.
When this value is set to 1 (ASCII) the class will use the values specified in LocalEOL and ServerEOL to convert line endings as appropriate.
Note: When this value is set to 1 (ASCII) and ProtocolVersion is set to 4 or higher the class will automatically determine the value for ServerEOL if the server supports the newline protocol extension.
This configuration setting can be used in conjunction with the start_byte property to download a specific range of data from the current remote_file.
Set this to False to not send the packet. This will cause PreserveFileTime to not work and prevent PercentDone in on_transfer from being calculated.
The default is True.
SSHClient Config Settings
If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the class will internally buffer data waiting to fire on_ssh_channel_data until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time on_ssh_channel_data fires.
ChannelDataEOL and MaxChannelDataLength must be set together or unexpected behavior could occur.
This configuration setting is valid only when queried inside on_ssh_channel_data, MaxChannelDataLength > 0, and ChannelDataEOL is nonempty.
Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example.
Value | Description |
0 (Disabled - default) | No communication with Pageant is attempted. |
1 (Enabled) | Pageant authentication is used if available. If Pageant is not running, or does not contain the expected key, no error is thrown. |
2 (Required) | Only Pageant authentication is used. If Pageant is not running, or does not contain the expected key, an error is thrown. |
Example 1. Enabling Pageant:
component.Config("EnablePageantAuth=1");
component.SSHUser = "sshuser";
component.SSHLogon("localhost", 22);
Note: This functionality is available only on Windows.
Note: Even if the client asks for delegation, the server/KDC might not grant it, and authentication will still succeed.
Example. Setting the Threshold to 500 MB:
SSHComponent.Config("KeyRenegotiationThreshold=524288000")
0 (None) | No messages are logged. |
1 (Info - Default) | Informational events such as Secure Shell (SSH) handshake messages are logged. |
2 (Verbose) | Detailed data such as individual packet information are logged. |
3 (Debug) | Debug data including all relevant sent and received bytes are logged. |
If MaxChannelDataLength is greater than 0 and ChannelDataEOL is a nonempty string, the class will internally buffer data waiting to fire on_ssh_channel_data until either MaxChannelDataLength is reached or ChannelDataEOL is found, whichever comes first. Query ChannelDataEOLFound to know which condition was met. The buffer is reset any time on_ssh_channel_data fires.
ChannelDataEOL and MaxChannelDataLength must be set together or unexpected behavior could occur.
Note: This value may be changed during the connection, but the window size can only be increased, not decreased.
component.Config("NegotiatedStrictKex")
This provides an easy way to automatically reply to prompts with the password if one is presented by the server. The password will be autofilled in the Response parameter of the on_ssh_keyboard_interactive event in the case of a match.
The following special characters are supported for pattern matching:
? | Any single character. |
* | Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct). |
[,-] | A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]). |
\ | The slash is ignored and exact matching is performed on the next character. |
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:
Character | Escape Sequence |
? | [?] |
* | [*] |
[ | [[] |
\ | [\] |
For example, to match the value [Something].txt, specify the pattern [[]Something].txt.
The default value is 0, meaning this setting is not used.
component.Config("SignedSSHCert=ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...");
The algorithm such as ssh-rsa-cert-v01@openssh.com in the previous string is used as part of the authentication process. To use a different algorithm, simply change this value. For instance, all of the following are acceptable with the same signed public key:
- ssh-rsa-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
- rsa-sha2-256-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
- rsa-sha2-512-cert-v01@openssh.com AAAAB3NzaC1yc2EAAAADAQABAAAB...
component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB...");
SSHClient.Config("SSHAcceptServerHostKeyFingerprint=0a:1b:2c:3d");
If the server's fingerprint matches one of the values supplied, the class will accept the host key.
- MD5
- SHA1
- SHA256 (default)
The default value is 0, meaning no keep alives will be sent.
Note: The SSHREVERSETUNNEL class uses a default value of 30.
- curve25519-sha256
- curve25519-sha256@libssh.org
- diffie-hellman-group1-sha1
- diffie-hellman-group14-sha1
- diffie-hellman-group14-sha256
- diffie-hellman-group16-sha512
- diffie-hellman-group18-sha512
- diffie-hellman-group-exchange-sha256
- diffie-hellman-group-exchange-sha1
- ecdh-sha2-nistp256
- ecdh-sha2-nistp384
- ecdh-sha2-nistp521
- gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-group16-sha512-toWM5Slw5Ew8Mqkay+al2g==
- gss-nistp256-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-curve25519-sha256-toWM5Slw5Ew8Mqkay+al2g==
- gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==
- gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==
Example 3. Renegotiating SSH Keys:
SSHClient.Config("SSHKeyRenegotiate")
- hmac-sha1
- hmac-md5
- hmac-sha1-96
- hmac-md5-96
- hmac-sha2-256
- hmac-sha2-256-96
- hmac-sha2-512
- hmac-sha2-512-96
- hmac-ripemd160
- hmac-ripemd160-96
- hmac-sha2-256-etm@openssh.com
- hmac-sha2-512-etm@openssh.com
- hmac-sha2-256-96-etm@openssh.com
- hmac-sha2-512-96-etm@openssh.com
- umac-64@openssh.com
- umac-64-etm@openssh.com
- umac-128@openssh.com
- umac-128-etm@openssh.com
The setting should be a comma-separated list of algorithms. At runtime, the class will evaluate the specified algorithms, and if the algorithm is applicable to the certificate specified in ssh_cert, it will be used. If the algorithm is not applicable, the class will evaluate the next algorithm. Possible values are as follows:
- ssh-rsa
- rsa-sha2-256
- rsa-sha2-512
- ssh-dss
- ecdsa-sha2-nistp256
- ecdsa-sha2-nistp384
- ecdsa-sha2-nistp521
- ssh-ed25519
- x509v3-sign-rsa
- x509v3-sign-dss
The default value in Windows is ssh-rsa,rsa-sha2-256,rsa-sha2-512,ssh-dss,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,ssh-ed25519.
rsa-sha2-256 and rsa-sha2-512 notes
The class will query the server for supported algorithms when connecting. If the server indicates support for rsa-sha2-256 or rsa-sha2-512 and the algorithm is present in the list defined by this setting (as in the default value), that algorithm will be used instead of ssh-rsa even when ssh-rsa appears first in the list.
For the rsa-sha2-256 and rsa-sha2-512 algorithms to be automatically preferred, the server must support the ext-info-c mechanism. In practice, older servers do not support this, and in that case, ssh-rsa will be used because it appears first in the list. Newer servers do support this mechanism, and in that case, rsa-sha2-256 or rsa-sha2-512 will be used even though it appears after ssh-rsa.
This behavior has been carefully designed to provide maximum compatibility while automatically using more secure algorithms when connecting to servers that support them.
*SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-*
Because both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the class provides options to further control the behavior in different scenarios. Possible values for this setting are as follows:
0 | Disabled. Strict key exchange is not supported in the class. |
1 (default) | Enabled, but not enforced. This setting enables strict key exchange, but if the remote host does not support strict key exchange the connection is still allowed to continue. |
2 | Enabled, but will reject affected algorithms if the remote host does not support strict key exchange. If the remote host supports strict key exchange, all algorithms may be used. If the remote host does not support strict key exchange, the connection will continue only if the selected encryption and message authentication code (MAC) algorithms are not affected by the Terrapin attack. |
3 | Required. If the remote host does not support strict key exchange, the connection will fail. |
When True (default), the class will wait for a response to the channel close message until the responses have been received, the server closes the connection, or timeout seconds is reached.
When False, the class will still send the channel close messages, but it will not wait for a response and will proceed to close the connection.
When set to True, the class will initiate the disconnection sequence by sending SSH_MSG_DISCONNECT, but it will not close the connection and instead will wait for the server to close the connection. Setting this to True may be beneficial in circumstances in which many connections are being established, to avoid port exhaustion when sockets are in a TIME_WAIT state. Allowing the server to close the connection avoids the TIME_WAIT state of socket on the client machine.
When set to False (default), the client will close the connection. It is recommended to use this value unless there is a specific need to change it.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to True tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
SFTPClient Errors
SFTPClient Errors
118 | Firewall error. Error description contains detailed information. |
1102 | The server's SFTP draft version is unsupported. |
1103 | SFTP command failed. Error description contains detailed information. |
1104 | Server does not support renaming. |
1105 | Received invalid response from server. Error description contains detailed information. |
1106 | Cannot resolve path: path does not exist. |
1107 | You must set local_file/remote_file before attempting to download/upload. |
1108 | Cannot download file: local_file exists and overwrite is set to False. |
1109 | CheckFileHash failed because of hash value mismatch. |
SSHClient Errors
1001 | Server has disconnected. |
1002 | Protocol version unsupported or other issue with version string. |
1003 | Cannot negotiate algorithms. |
1005 | Selected algorithm unsupported. |
1006 | Cannot set keys. |
1010 | Unexpected algorithm. |
1011 | Cannot create exchange hash. |
1012 | Cannot make key. |
1013 | Cannot sign data. |
1014 | Cannot encrypt packet. |
1015 | Cannot decrypt packet. |
1016 | Cannot decompress packet. |
1020 | Failure to open channel. |
1021 | Invalid channel Id. |
1022 | Invalid channel data. |
1023 | Invalid channel message. |
1024 | SSH message unimplemented. |
1027 | Server message unsupported. |
1030 | Server's host key was rejected. The host key may be accepted within the on_ssh_server_authentication event or using the ssh_accept_server_host_key property. |
1031 | Cannot verify server's host key. |
1032 | Authentication failed. Check description for details. |
1033 | Channel request failed. |
1034 | Diffie-Hellman exchange failed. |
1036 | SSH connection failed. |
1037 | SSH reconnect limit reached. |
1038 | Elliptic curve Diffie-Hellman exchange failed. |
1039 | SSH keep-alive limit reached. |
1098 | Request failure. |
1130 | Would block error. |
1133 | Would block, reason: key reExchange. |
The class may also return one of the following error codes, which are inherited from other classes.
TCPClient Errors
100 | You cannot change the remote_port at this time. A connection is in progress. |
101 | You cannot change the remote_host (Server) at this time. A connection is in progress. |
102 | The remote_host address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the local_port at this time. A connection is in progress. |
107 | You cannot change the local_host at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | remote_port cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the class is active. |
135 | Operation would block. |
201 | Timeout. |
211 | Action impossible in control's present state. |
212 | Action impossible while not connected. |
213 | Action impossible while listening. |
301 | Timeout. |
302 | Could not open file. |
434 | Unable to convert string to selected CodePage. |
1105 | Already connecting. If you want to reconnect, close the current connection first. |
1117 | You need to connect first. |
1119 | You cannot change the LocalHost at this time. A connection is in progress. |
1120 | Connection dropped by remote host. |
TCP/IP Errors
10004 | [10004] Interrupted system call. |
10009 | [10009] Bad file number. |
10013 | [10013] Access denied. |
10014 | [10014] Bad address. |
10022 | [10022] Invalid argument. |
10024 | [10024] Too many open files. |
10035 | [10035] Operation would block. |
10036 | [10036] Operation now in progress. |
10037 | [10037] Operation already in progress. |
10038 | [10038] Socket operation on nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot assign requested address. |
10050 | [10050] Network is down. |
10051 | [10051] Network is unreachable. |
10052 | [10052] Net dropped connection or reset. |
10053 | [10053] Software caused connection abort. |
10054 | [10054] Connection reset by peer. |
10055 | [10055] No buffer space available. |
10056 | [10056] Socket is already connected. |
10057 | [10057] Socket is not connected. |
10058 | [10058] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is not empty |
10067 | [10067] Too many processes. |
10068 | [10068] Too many users. |
10069 | [10069] Disc Quota Exceeded. |
10070 | [10070] Stale NFS file handle. |
10071 | [10071] Too many levels of remote in path. |
10091 | [10091] Network subsystem is unavailable. |
10092 | [10092] WINSOCK DLL Version out of range. |
10093 | [10093] Winsock is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |