# Struct ipworkssftp::SFTPClient The SFTPClient struct can be used to transfer files to and from secure file transfer protocol (SFTP) servers. ## Syntax ```text ipworkssftp::SFTPClient ``` ## Remarks The SFTPClient struct is the Secure Shell (SSH)-enabled equivalent of the IPWorks FTP struct. The [ssh_host](#ssh_host-property-sftpclient-struct) and [ssh_port](#ssh_port-property-sftpclient-struct) properties specify which Secure Shell (SSH) server to use. The [ssh_user](#ssh_user-property-sftpclient-struct) and [ssh_password](#ssh_password-property-sftpclient-struct) properties allow the client to authenticate itself with the server. The [on_ssh_server_authentication](#on_ssh_server_authentication-event-sftpclient-struct) event or ssh_accept_server_host_key property allow you to check the server identity. Finally, the [on_ssh_status](#on_ssh_status-event-sftpclient-struct) event provides information about the SSH handshake. The SFTPClient struct implements a standard SSH file transfer client. The first step in using the struct is specifying the [ssh_host](#ssh_host-property-sftpclient-struct), [ssh_user](#ssh_user-property-sftpclient-struct), and [ssh_password](#ssh_password-property-sftpclient-struct). The file to upload to or download from is given by the [remote_file](#remote_file-property-sftpclient-struct) property. The file to download to or upload from is specified by [local_file](#local_file-property-sftpclient-struct). The current path in the server is specified by the [remote_path](#remote_path-property-sftpclient-struct) property. If [local_file](#local_file-property-sftpclient-struct) is set to something other than an empty string, then files are received in [local_file](#local_file-property-sftpclient-struct); otherwise, the data are received through the [on_transfer](#on_transfer-event-sftpclient-struct) event. [on_start_transfer](#on_start_transfer-event-sftpclient-struct) and [on_end_transfer](#on_end_transfer-event-sftpclient-struct) are fired at the beginning and end of transmission. Directory listings are received through the [on_dir_list](#on_dir_list-event-sftpclient-struct) event. ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksSFTP. Due to this, the SFTPClient struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of SFTPClient when you have finished using the instance. ## Property List *The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [connected](#connected-property-sftpclient-struct) | Whether the struct is connected. | | [dir_list_count](#dir_list_count-property-sftpclient-struct) | The number of records in the DirList arrays. | | [dir_list_entry](#dir_list_entry-property-sftpclient-struct) | This property contains the raw entry as received from the server. | | [dir_list_file_name](#dir_list_file_name-property-sftpclient-struct) | This property shows the file name in the last directory listing. | | [dir_list_file_size](#dir_list_file_size-property-sftpclient-struct) | This property shows the file size in the last directory listing. | | [dir_list_file_time](#dir_list_file_time-property-sftpclient-struct) | This property shows the file time in the last directory listing. | | [dir_list_is_dir](#dir_list_is_dir-property-sftpclient-struct) | This property specifies whether entries in the last directory listing are directories. | | [dir_list_is_symlink](#dir_list_is_symlink-property-sftpclient-struct) | This property indicates whether the entry is a symbolic link. | | [file_access_time](#file_access_time-property-sftpclient-struct) | Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed. | | [file_acl](#file_acl-property-sftpclient-struct) | Contains a string containing an access control list (ACL). | | [file_allocation_size](#file_allocation_size-property-sftpclient-struct) | Specifies the size, in bytes, that this file consumes on disk. | | [file_attribute_bits](#file_attribute_bits-property-sftpclient-struct) | AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. | | [file_attribute_bits_valid](#file_attribute_bits_valid-property-sftpclient-struct) | AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. | | [file_creation_time](#file_creation_time-property-sftpclient-struct) | Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created. | | [file_type](#file_type-property-sftpclient-struct) | The type of file. | | [file_group_id](#file_group_id-property-sftpclient-struct) | Specifies the Id of the group that has access rights this file. | | [file_is_dir](#file_is_dir-property-sftpclient-struct) | Specifies whether or not the file represented by these attributes is a directory. | | [file_is_symlink](#file_is_symlink-property-sftpclient-struct) | Specifies whether or not the file or directory represented by these attributes is a symbolic link. | | [file_modified_time](#file_modified_time-property-sftpclient-struct) | Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified. | | [file_owner_id](#file_owner_id-property-sftpclient-struct) | Specifies the user Id of this file's owner. | | [file_permissions](#file_permissions-property-sftpclient-struct) | Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask. | | [file_permissions_octal](#file_permissions_octal-property-sftpclient-struct) | Includes an octal string containing the a POSIX-compatible file permission bitmask. | | [file_size](#file_size-property-sftpclient-struct) | Specifies the total size, in bytes, of this file. | | [firewall_auto_detect](#firewall_auto_detect-property-sftpclient-struct) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_type](#firewall_type-property-sftpclient-struct) | The type of firewall to connect through. | | [firewall_host](#firewall_host-property-sftpclient-struct) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property-sftpclient-struct) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property-sftpclient-struct) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_user](#firewall_user-property-sftpclient-struct) | A username if authentication is to be used when connecting through a firewall. | | [idle](#idle-property-sftpclient-struct) | The current status of the struct. | | [local_file](#local_file-property-sftpclient-struct) | The path to a local file for upload or download. | | [local_host](#local_host-property-sftpclient-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [local_port](#local_port-property-sftpclient-struct) | The TCP port in the local host where the struct binds. | | [overwrite](#overwrite-property-sftpclient-struct) | The value indicating whether or not the struct should overwrite files during transfer. | | [remote_file](#remote_file-property-sftpclient-struct) | The name of the remote file for uploading or downloading. | | [remote_path](#remote_path-property-sftpclient-struct) | The current path in the secure file transfer protocol (SFTP) server. | | [ssh_accept_server_host_key_effective_date](#ssh_accept_server_host_key_effective_date-property-sftpclient-struct) | The date on which this certificate becomes valid. | | [ssh_accept_server_host_key_expiration_date](#ssh_accept_server_host_key_expiration_date-property-sftpclient-struct) | The date on which the certificate expires. | | [ssh_accept_server_host_key_extended_key_usage](#ssh_accept_server_host_key_extended_key_usage-property-sftpclient-struct) | A comma-delimited list of extended key usage identifiers. | | [ssh_accept_server_host_key_fingerprint](#ssh_accept_server_host_key_fingerprint-property-sftpclient-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssh_accept_server_host_key_fingerprint_sha1](#ssh_accept_server_host_key_fingerprint_sha1-property-sftpclient-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssh_accept_server_host_key_fingerprint_sha256](#ssh_accept_server_host_key_fingerprint_sha256-property-sftpclient-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssh_accept_server_host_key_issuer](#ssh_accept_server_host_key_issuer-property-sftpclient-struct) | The issuer of the certificate. | | [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sftpclient-struct) | The private key of the certificate (if available). | | [ssh_accept_server_host_key_private_key_available](#ssh_accept_server_host_key_private_key_available-property-sftpclient-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssh_accept_server_host_key_private_key_container](#ssh_accept_server_host_key_private_key_container-property-sftpclient-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssh_accept_server_host_key_public_key](#ssh_accept_server_host_key_public_key-property-sftpclient-struct) | The public key of the certificate. | | [ssh_accept_server_host_key_public_key_algorithm](#ssh_accept_server_host_key_public_key_algorithm-property-sftpclient-struct) | The textual description of the certificate's public key algorithm. | | [ssh_accept_server_host_key_public_key_length](#ssh_accept_server_host_key_public_key_length-property-sftpclient-struct) | The length of the certificate's public key (in bits). | | [ssh_accept_server_host_key_serial_number](#ssh_accept_server_host_key_serial_number-property-sftpclient-struct) | The serial number of the certificate encoded as a string. | | [ssh_accept_server_host_key_signature_algorithm](#ssh_accept_server_host_key_signature_algorithm-property-sftpclient-struct) | The text description of the certificate's signature algorithm. | | [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sftpclient-struct) | The name of the certificate store for the client certificate. | | [ssh_accept_server_host_key_store_password](#ssh_accept_server_host_key_store_password-property-sftpclient-struct) | 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](#ssh_accept_server_host_key_store_type-property-sftpclient-struct) | The type of certificate store for this certificate. | | [ssh_accept_server_host_key_subject_alt_names](#ssh_accept_server_host_key_subject_alt_names-property-sftpclient-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssh_accept_server_host_key_thumbprint_md5](#ssh_accept_server_host_key_thumbprint_md5-property-sftpclient-struct) | The MD5 hash of the certificate. | | [ssh_accept_server_host_key_thumbprint_sha1](#ssh_accept_server_host_key_thumbprint_sha1-property-sftpclient-struct) | The SHA-1 hash of the certificate. | | [ssh_accept_server_host_key_thumbprint_sha256](#ssh_accept_server_host_key_thumbprint_sha256-property-sftpclient-struct) | The SHA-256 hash of the certificate. | | [ssh_accept_server_host_key_usage](#ssh_accept_server_host_key_usage-property-sftpclient-struct) | The text description of UsageFlags . | | [ssh_accept_server_host_key_usage_flags](#ssh_accept_server_host_key_usage_flags-property-sftpclient-struct) | The flags that show intended use for the certificate. | | [ssh_accept_server_host_key_version](#ssh_accept_server_host_key_version-property-sftpclient-struct) | The certificate's version number. | | [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sftpclient-struct) | The subject of the certificate used for client authentication. | | [ssh_accept_server_host_key_encoded](#ssh_accept_server_host_key_encoded-property-sftpclient-struct) | The certificate (PEM/Base64 encoded). | | [ssh_auth_mode](#ssh_auth_mode-property-sftpclient-struct) | The authentication method to be used with the struct when calling SSHLogon . | | [ssh_cert_effective_date](#ssh_cert_effective_date-property-sftpclient-struct) | The date on which this certificate becomes valid. | | [ssh_cert_expiration_date](#ssh_cert_expiration_date-property-sftpclient-struct) | The date on which the certificate expires. | | [ssh_cert_extended_key_usage](#ssh_cert_extended_key_usage-property-sftpclient-struct) | A comma-delimited list of extended key usage identifiers. | | [ssh_cert_fingerprint](#ssh_cert_fingerprint-property-sftpclient-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssh_cert_fingerprint_sha1](#ssh_cert_fingerprint_sha1-property-sftpclient-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssh_cert_fingerprint_sha256](#ssh_cert_fingerprint_sha256-property-sftpclient-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssh_cert_issuer](#ssh_cert_issuer-property-sftpclient-struct) | The issuer of the certificate. | | [ssh_cert_private_key](#ssh_cert_private_key-property-sftpclient-struct) | The private key of the certificate (if available). | | [ssh_cert_private_key_available](#ssh_cert_private_key_available-property-sftpclient-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssh_cert_private_key_container](#ssh_cert_private_key_container-property-sftpclient-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssh_cert_public_key](#ssh_cert_public_key-property-sftpclient-struct) | The public key of the certificate. | | [ssh_cert_public_key_algorithm](#ssh_cert_public_key_algorithm-property-sftpclient-struct) | The textual description of the certificate's public key algorithm. | | [ssh_cert_public_key_length](#ssh_cert_public_key_length-property-sftpclient-struct) | The length of the certificate's public key (in bits). | | [ssh_cert_serial_number](#ssh_cert_serial_number-property-sftpclient-struct) | The serial number of the certificate encoded as a string. | | [ssh_cert_signature_algorithm](#ssh_cert_signature_algorithm-property-sftpclient-struct) | The text description of the certificate's signature algorithm. | | [ssh_cert_store](#ssh_cert_store-property-sftpclient-struct) | The name of the certificate store for the client certificate. | | [ssh_cert_store_password](#ssh_cert_store_password-property-sftpclient-struct) | 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](#ssh_cert_store_type-property-sftpclient-struct) | The type of certificate store for this certificate. | | [ssh_cert_subject_alt_names](#ssh_cert_subject_alt_names-property-sftpclient-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssh_cert_thumbprint_md5](#ssh_cert_thumbprint_md5-property-sftpclient-struct) | The MD5 hash of the certificate. | | [ssh_cert_thumbprint_sha1](#ssh_cert_thumbprint_sha1-property-sftpclient-struct) | The SHA-1 hash of the certificate. | | [ssh_cert_thumbprint_sha256](#ssh_cert_thumbprint_sha256-property-sftpclient-struct) | The SHA-256 hash of the certificate. | | [ssh_cert_usage](#ssh_cert_usage-property-sftpclient-struct) | The text description of UsageFlags . | | [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sftpclient-struct) | The flags that show intended use for the certificate. | | [ssh_cert_version](#ssh_cert_version-property-sftpclient-struct) | The certificate's version number. | | [ssh_cert_subject](#ssh_cert_subject-property-sftpclient-struct) | The subject of the certificate used for client authentication. | | [ssh_cert_encoded](#ssh_cert_encoded-property-sftpclient-struct) | The certificate (PEM/Base64 encoded). | | [ssh_compression_algorithms](#ssh_compression_algorithms-property-sftpclient-struct) | The comma-separated list containing all allowable compression algorithms. | | [ssh_encryption_algorithms](#ssh_encryption_algorithms-property-sftpclient-struct) | The comma-separated list containing all allowable encryption algorithms. | | [ssh_host](#ssh_host-property-sftpclient-struct) | The address of the Secure Shell (SSH) host. | | [ssh_password](#ssh_password-property-sftpclient-struct) | The password for Secure Shell (SSH) password-based authentication. | | [ssh_port](#ssh_port-property-sftpclient-struct) | The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22. | | [ssh_user](#ssh_user-property-sftpclient-struct) | The username for Secure Shell (SSH) authentication. | | [start_byte](#start_byte-property-sftpclient-struct) | The offset in bytes at which to begin the upload or download. | | [timeout](#timeout-property-sftpclient-struct) | The timeout for the struct. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [append](#append-method-sftpclient-struct) | Appends data from LocalFile to a remote file RemoteFile on a secure file transfer protocol (SFTP) server. | | [change_remote_path](#change_remote_path-method-sftpclient-struct) | Changes the current path on the server. | | [check_file_exists](#check_file_exists-method-sftpclient-struct) | Returns True if the file specified by RemoteFile exists on the remote server. | | [config](#config-method-sftpclient-struct) | Sets or retrieves a configuration setting. | | [connect](#connect-method-sftpclient-struct) | Connects to the Secure Shell (SSH) host. | | [copy_remote_data](#copy_remote_data-method-sftpclient-struct) | Copies a range of bytes from one remote file to another directly on the secure file transfer protocol (SFTP) server. | | [copy_remote_file](#copy_remote_file-method-sftpclient-struct) | Copies a remote file directly on the secure file transfer protocol (SFTP) server. | | [create_file](#create_file-method-sftpclient-struct) | Creates a file on the secure file transfer protocol (SFTP) server. | | [decode_packet](#decode_packet-method-sftpclient-struct) | Decodes a hex-encoded Secure Shell (SSH) packet. | | [delete_file](#delete_file-method-sftpclient-struct) | Deletes a file specified by FileName from a secure file transfer protocol (SFTP) server. | | [disconnect](#disconnect-method-sftpclient-struct) | Disconnects from the server without first logging off. | | [do_events](#do_events-method-sftpclient-struct) | This method processes events from the internal message queue. | | [download](#download-method-sftpclient-struct) | Downloads a RemoteFile from a secure file transfer protocol (SFTP) server. | | [download_range](#download_range-method-sftpclient-struct) | Facilitates the partial downloading of a remote file from a secure file transfer protocol (SFTP) server. | | [encode_packet](#encode_packet-method-sftpclient-struct) | Hex encodes a Secure Shell (SSH) packet. | | [get_ssh_param](#get_ssh_param-method-sftpclient-struct) | Reads a field from a Secure Shell (SSH) packet's payload. | | [get_ssh_param_bytes](#get_ssh_param_bytes-method-sftpclient-struct) | Reads a field from a Secure Shell (SSH) packet's payload. | | [interrupt](#interrupt-method-sftpclient-struct) | This method interrupts the current method. | | [list_directory](#list_directory-method-sftpclient-struct) | Lists the current directory specified by RemotePath on a secure file transfer protocol (SFTP) server. | | [make_directory](#make_directory-method-sftpclient-struct) | Creates a directory on a secure file transfer protocol (SFTP) server. | | [query_file_attributes](#query_file_attributes-method-sftpclient-struct) | Queries the server for the attributes of RemoteFile . | | [queue_file](#queue_file-method-sftpclient-struct) | Adds a file to the transfer queue. | | [remove_directory](#remove_directory-method-sftpclient-struct) | Removes a directory specified by DirName from a secure file transfer protocol (SFTP) server. | | [rename_file](#rename_file-method-sftpclient-struct) | Changes the name of RemoteFile to NewName . | | [reset](#reset-method-sftpclient-struct) | This method will reset the struct. | | [reset_queue](#reset_queue-method-sftpclient-struct) | Resets the queue of files to be transferred. | | [set_ssh_param](#set_ssh_param-method-sftpclient-struct) | Writes a field to the end of a payload. | | [ssh_logoff](#ssh_logoff-method-sftpclient-struct) | Logs off from the Secure Shell (SSH) server. | | [ssh_logon](#ssh_logon-method-sftpclient-struct) | Logs on to the SSHHost using the current SSHUser and SSHPassword . | | [update_file_attributes](#update_file_attributes-method-sftpclient-struct) | Instructs the struct to send the FileAttributes to the server. | | [upload](#upload-method-sftpclient-struct) | Uploads a file specified by LocalFile to a secure file transfer protocol (SFTP) server. | | [upload_range](#upload_range-method-sftpclient-struct) | 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 struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [on_connected](#on_connected-event-sftpclient-struct) | Fired immediately after a connection completes (or fails). | | [on_connection_status](#on_connection_status-event-sftpclient-struct) | Fired to indicate changes in the connection state. | | [on_dir_list](#on_dir_list-event-sftpclient-struct) | Fired when a directory entry is received. | | [on_disconnected](#on_disconnected-event-sftpclient-struct) | Fired when a connection is closed. | | [on_end_transfer](#on_end_transfer-event-sftpclient-struct) | Fired when a file completes downloading or uploading. | | [on_error](#on_error-event-sftpclient-struct) | Fired when errors occur during data delivery. | | [on_log](#on_log-event-sftpclient-struct) | Fired once for each log message. | | [on_ssh_custom_auth](#on_ssh_custom_auth-event-sftpclient-struct) | Fired when the struct is doing a custom authentication. | | [on_ssh_keyboard_interactive](#on_ssh_keyboard_interactive-event-sftpclient-struct) | Fired when the struct receives a request for user input from the server. | | [on_ssh_server_authentication](#on_ssh_server_authentication-event-sftpclient-struct) | Fired after the server presents its public key to the client. | | [on_ssh_status](#on_ssh_status-event-sftpclient-struct) | Fired to track the progress of the secure connection. | | [on_start_transfer](#on_start_transfer-event-sftpclient-struct) | Fired when a file starts downloading or uploading. | | [on_transfer](#on_transfer-event-sftpclient-struct) | Fired during file download or upload. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AllowBackslashInName](#AllowBackslashInName) | Whether backslashes are allowed in folder and file names. | | [AsyncTransfer](#AsyncTransfer) | Controls whether simultaneous requests are made to read or write files. | | [AttrAccessTime](#AttrAccessTime) | Can be queried for the AccessTime file attribute during the DirList event. | | [AttrCreationTime](#AttrCreationTime) | Can be queried for the CreationTime file attribute during the DirList event. | | [AttrFileType](#AttrFileType) | Can be queried for the FileType file attribute during the DirList event. | | [AttrGroupId](#AttrGroupId) | Can be queried for the GroupId file attribute during the DirList event. | | [AttrLinkCount](#AttrLinkCount) | Can be queried for the LinkCount file attribute during the DirList event. | | [AttrOwnerId](#AttrOwnerId) | Can be queried for the OwnerId file attribute during the DirList event. | | [AttrPermission](#AttrPermission) | Can be queried for the Permissions file attribute during the DirList event. | | [CheckFileHash](#CheckFileHash) | Compares a server-computed hash with a hash calculated locally. | | [DisableRealPath](#DisableRealPath) | Controls whether or not the SSH_FXP_REALPATH request is sent. | | [ExcludeFileMask](#ExcludeFileMask) | Specifies a file mask for excluding files in directory listings. | | [ExecFallbackCommand](#ExecFallbackCommand) | Specifies the fallback command to execute if the struct fails to start the SFTP subsystem. | | [FileMaskDelimiter](#FileMaskDelimiter) | Specifies a delimiter to use for setting multiple file masks in the RemoteFile property. | | [FiletimeFormat](#FiletimeFormat) | Specifies the format to use when returning filetime strings. | | [ForceMakeDirectory](#ForceMakeDirectory) | Controls whether calls to make a directory always attempt to create the directory on the server. | | [FreeSpace](#FreeSpace) | The free space on the remote server in bytes. | | [GetSpaceInfo](#GetSpaceInfo) | Queries the server for drive usage information. | | [GetSymlinkAttrs](#GetSymlinkAttrs) | Whether to get the attributes of the symbolic link, or the resource pointed to by the link. | | [IgnoreFileMaskCasing](#IgnoreFileMaskCasing) | Controls whether or not the file mask is case sensitive. | | [LocalEOL](#LocalEOL) | When TransferMode is set, this specifies the line ending for the local system. | | [LogSFTPFileData](#LogSFTPFileData) | Whether SFTP file data is present in Debug logs. | | [MaskSensitiveData](#MaskSensitiveData) | Masks passwords in logs. | | [MaxFileData](#MaxFileData) | Specifies the maximum payload size of an SFTP packet. | | [MaxOutstandingPackets](#MaxOutstandingPackets) | Sets the maximum number of simultaneous read or write requests allowed. | | [NegotiatedProtocolVersion](#NegotiatedProtocolVersion) | The negotiated SFTP version. | | [NormalizeRemotePath](#NormalizeRemotePath) | Whether to normalize the RemotePath. | | [PreserveFileTime](#PreserveFileTime) | Preserves the file's timestamps during transfer. | | [ProtocolVersion](#ProtocolVersion) | The highest allowable SFTP version to use. | | [ReadLink](#ReadLink) | This settings returns the target of a specified symbolic link. | | [RealTimeUpload](#RealTimeUpload) | Enables real time uploading. | | [RealTimeUploadAgeLimit](#RealTimeUploadAgeLimit) | The age limit in seconds when using RealTimeUpload. | | [ServerEOL](#ServerEOL) | When TransferMode is set, this specifies the line ending for the remote system. | | [SimultaneousTransferLimit](#SimultaneousTransferLimit) | The maximum number of simultaneous file transfers. | | [TotalSpace](#TotalSpace) | The total space on the remote server in bytes. | | [TransferMode](#TransferMode) | The transfer mode (ASCII or Binary). | | [TransferredDataLimit](#TransferredDataLimit) | Specifies the maximum number of bytes to download from the remote file. | | [UseFxpStat](#UseFxpStat) | Whether SSH_FXP_STAT is sent. | | [UseServerFileTime](#UseServerFileTime) | Controls if the file time returned from the server is converted to local time or not. | | [UseServerFileTime](#UseServerFileTime) | Controls if the file time returned from the server is converted to local time or not. | | [ChannelDataEOL\[ChannelId\]](#ChannelDataEOL[ChannelId]) | Used to break the incoming data stream into chunks. | | [ChannelDataEOLFound\[ChannelId\]](#ChannelDataEOLFound[ChannelId]) | Determines if ChannelDataEOL was found. | | [ClientSSHVersionString](#ClientSSHVersionString) | The SSH version string used by the struct. | | [ConnectAndLogin](#ConnectAndLogin) | Whether the struct performs a full SSH login. | | [DoNotRepeatAuthMethods](#DoNotRepeatAuthMethods) | Whether the struct will repeat authentication methods during multifactor authentication. | | [EnablePageantAuth](#EnablePageantAuth) | Whether to use a key stored in Pageant to perform client authentication. | | [KerberosDelegation](#KerberosDelegation) | If true, asks for credentials with delegation enabled during authentication. | | [KerberosRealm](#KerberosRealm) | The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication. | | [KerberosSPN](#KerberosSPN) | The Kerberos Service Principal Name of the SSH host. | | [KeyRenegotiationThreshold](#KeyRenegotiationThreshold) | Sets the threshold for the SSH Key Renegotiation. | | [LogLevel](#LogLevel) | Specifies the level of detail that is logged. | | [MaxChannelDataLength\[ChannelId\]](#MaxChannelDataLength[ChannelId]) | The maximum amount of data to accumulate when no ChannelDataEOL is found. | | [MaxPacketSize](#MaxPacketSize) | The maximum packet size of the channel, in bytes. | | [MaxWindowSize](#MaxWindowSize) | The maximum window size allowed for the channel, in bytes. | | [NegotiatedStrictKex](#NegotiatedStrictKex) | Returns whether strict key exchange was negotiated to be used. | | [PasswordPrompt](#PasswordPrompt) | The text of the password prompt used in keyboard-interactive authentication. | | [PreferredDHGroupBits](#PreferredDHGroupBits) | The size (in bits) of the preferred modulus (p) to request from the server. | | [RecordLength](#RecordLength) | The length of received data records. | | [ServerSSHVersionString](#ServerSSHVersionString) | The remote host's SSH version string. | | [SignedSSHCert](#SignedSSHCert) | The CA signed client public key used when authenticating. | | [SSHAcceptAnyServerHostKey](#SSHAcceptAnyServerHostKey) | If set the struct will accept any key presented by the server. | | [SSHAcceptServerCAKey](#SSHAcceptServerCAKey) | The CA public key that signed the server's host key. | | [SSHAcceptServerHostKeyFingerPrint](#SSHAcceptServerHostKeyFingerPrint) | The fingerprint(s) of the server host keys to accept. | | [SSHFingerprintEncoding](#SSHFingerprintEncoding) | Specifies the encoding used when displaying the SSH host key fingerprint. | | [SSHFingerprintHashAlgorithm](#SSHFingerprintHashAlgorithm) | The algorithm used to calculate the fingerprint. | | [SSHFingerprintMD5](#SSHFingerprintMD5) | The server hostkey's MD5 fingerprint. | | [SSHFingerprintSHA1](#SSHFingerprintSHA1) | The server hostkey's SHA1 fingerprint. | | [SSHFingerprintSHA256](#SSHFingerprintSHA256) | The server hostkey's SHA256 fingerprint. | | [SSHKeepAliveCountMax](#SSHKeepAliveCountMax) | The maximum number of keep alive packets to send without a response. | | [SSHKeepAliveInterval](#SSHKeepAliveInterval) | The interval between keep alive packets. | | [SSHKeyExchangeAlgorithms](#SSHKeyExchangeAlgorithms) | Specifies the supported key exchange algorithms. | | [SSHKeyRenegotiate](#SSHKeyRenegotiate) | Causes the struct to renegotiate the SSH keys. | | [SSHMacAlgorithms](#SSHMacAlgorithms) | Specifies the supported Mac algorithms. | | [SSHPubKeyAuthSigAlgorithms](#SSHPubKeyAuthSigAlgorithms) | Specifies the enabled signature algorithms that may be used when attempting public key authentication. | | [SSHPublicKeyAlgorithms](#SSHPublicKeyAlgorithms) | Specifies the supported public key algorithms for the server's public key. | | [SSHVersionPattern](#SSHVersionPattern) | The pattern used to match the remote host's version string. | | [TryAllAvailableAuthMethods](#TryAllAvailableAuthMethods) | If set to true, the struct will try all available authentication methods. | | [UseStrictKeyExchange](#UseStrictKeyExchange) | Specifies how strict key exchange is supported. | | [WaitForChannelClose](#WaitForChannelClose) | Whether to wait for channels to be closed before disconnected. | | [WaitForServerDisconnect](#WaitForServerDisconnect) | Whether to wait for the server to close the connection. | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the struct whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the struct binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # connected property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Whether the struct is connected. ## Syntax *Rust Syntax* ```text fn connected(&self ) -> Result ``` ## Default Value false ## Remarks This property is used to determine whether or not the struct is connected to the remote host. Use the [connect](#connect-method-sftpclient-struct) and [disconnect](#disconnect-method-sftpclient-struct) methods to manage the connection. This property is read-only. ## Data Type bool # dir_list_count property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The number of records in the DirList arrays. ## Syntax *Rust Syntax* ```text fn dir_list_count(&self ) -> Result ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [dir_list_entry](#dir_list_entry-property-sftpclient-struct) - [dir_list_file_name](#dir_list_file_name-property-sftpclient-struct) - [dir_list_file_size](#dir_list_file_size-property-sftpclient-struct) - [dir_list_file_time](#dir_list_file_time-property-sftpclient-struct) - [dir_list_is_dir](#dir_list_is_dir-property-sftpclient-struct) - [dir_list_is_symlink](#dir_list_is_symlink-property-sftpclient-struct) The array indices start at *0* and end at *dir_list_count - 1*. This property is read-only. ## Data Type i32 # dir_list_entry property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This property contains the raw entry as received from the server. ## Syntax *Rust Syntax* ```text fn dir_list_entry(&self , EntryIndex : i32) -> Result ``` ## Default Value "" ## Remarks This property contains the raw entry as received from the server. It is the complete unparsed entry in the directory listing. The *EntryIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DirListCount](#dir_list_count-property-sftpclient-struct) property. This property is read-only. ## Data Type String # dir_list_file_name property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This property shows the file name in the last directory listing. ## Syntax *Rust Syntax* ```text fn dir_list_file_name(&self , EntryIndex : i32) -> Result ``` ## 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](#dir_list_is_dir-property-sftpclient-struct) property. The *EntryIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DirListCount](#dir_list_count-property-sftpclient-struct) property. This property is read-only. ## Data Type String # dir_list_file_size property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This property shows the file size in the last directory listing. ## Syntax *Rust Syntax* ```text fn dir_list_file_size(&self , EntryIndex : i32) -> Result ``` ## Default Value 0 ## Remarks This property shows the file size in the last directory listing. The *EntryIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DirListCount](#dir_list_count-property-sftpclient-struct) property. This property is read-only. ## Data Type i64 # dir_list_file_time property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This property shows the file time in the last directory listing. ## Syntax *Rust Syntax* ```text fn dir_list_file_time(&self , EntryIndex : i32) -> Result ``` ## Default Value "" ## Remarks This property shows the file time in the last directory listing. This contains the date/time stamp in which the file was created. NOTE: In Unix systems, the date is given in two types of formats: If the date is in the past 12 months, the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given. The *EntryIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DirListCount](#dir_list_count-property-sftpclient-struct) property. This property is read-only. ## Data Type String # dir_list_is_dir property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This property specifies whether entries in the last directory listing are directories. ## Syntax *Rust Syntax* ```text fn dir_list_is_dir(&self , EntryIndex : i32) -> Result ``` ## 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](#dir_list_file_name-property-sftpclient-struct) is a file or a directory. The *EntryIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DirListCount](#dir_list_count-property-sftpclient-struct) property. This property is read-only. ## Data Type bool # dir_list_is_symlink property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This property indicates whether the entry is a symbolic link. ## Syntax *Rust Syntax* ```text fn dir_list_is_symlink(&self , EntryIndex : i32) -> Result ``` ## 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](#dir_list_is_dir-property-sftpclient-struct) 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](#file_is_dir-property-sftpclient-struct) property. The *EntryIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [DirListCount](#dir_list_count-property-sftpclient-struct) property. This property is read-only. ## Data Type bool # file_access_time property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed. ## Syntax *Rust Syntax* ```text fn file_access_time(&self ) -> Result fn set_file_access_time(&self, value : i64) -> Option ``` ## Default Value 0 ## Remarks Contains the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was last accessed. ## Data Type i64 # file_acl property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Contains a string containing an access control list (ACL). ## Syntax *Rust Syntax* ```text fn file_acl(&self ) -> Result fn set_file_acl(&self, value : &str) -> Option fn set_file_acl_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Contains a string containing an access control list (ACL). ## Data Type String # file_allocation_size property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Specifies the size, in bytes, that this file consumes on disk. ## Syntax *Rust Syntax* ```text fn file_allocation_size(&self ) -> Result ``` ## Default Value 0 ## Remarks Specifies the size, in bytes, that this file consumes on disk. This property is read-only. ## Data Type i64 # file_attribute_bits property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn file_attribute_bits(&self ) -> Result ``` ## Default Value 0 ## Remarks [file_attribute_bits](#file_attribute_bits-property-sftpclient-struct) and [file_attribute_bits_valid](#file_attribute_bits_valid-property-sftpclient-struct) 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](#file_attribute_bits_valid-property-sftpclient-struct) must be ignored in [file_attribute_bits](#file_attribute_bits-property-sftpclient-struct). 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. ## Data Type i32 # file_attribute_bits_valid property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) AttributeBits and AttributeBitsValid each contain a bitmask representing attributes of the file on the secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn file_attribute_bits_valid(&self ) -> Result ``` ## Default Value 0 ## Remarks [file_attribute_bits](#file_attribute_bits-property-sftpclient-struct) and [file_attribute_bits_valid](#file_attribute_bits_valid-property-sftpclient-struct) 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](#file_attribute_bits_valid-property-sftpclient-struct) must be ignored in [file_attribute_bits](#file_attribute_bits-property-sftpclient-struct). 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. ## Data Type i32 # file_creation_time property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created. ## Syntax *Rust Syntax* ```text fn file_creation_time(&self ) -> Result fn set_file_creation_time(&self, value : i64) -> Option ``` ## Default Value 0 ## Remarks Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, when this file was created. ## Data Type i64 # file_type property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The type of file. ## Syntax *Rust Syntax* ```text fn file_type(&self ) -> Result ``` ## Possible Values ```text 1 // Regular2 // Directory3 // SymLink4 // Special5 // Unknown6 // Socket7 // CharDevice8 // BlockDevice9 // FIFO ``` ## Default Value 0 ## Remarks The type of file. [file_file_type](#SFTPClient_p_FileFileType) 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. ## Data Type i32 # file_group_id property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Specifies the Id of the group that has access rights this file. ## Syntax *Rust Syntax* ```text fn file_group_id(&self ) -> Result fn set_file_group_id(&self, value : &str) -> Option fn set_file_group_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Specifies the Id of the group that has access rights this file. ## Data Type String # file_is_dir property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Specifies whether or not the file represented by these attributes is a directory. ## Syntax *Rust Syntax* ```text fn file_is_dir(&self ) -> Result ``` ## Default Value false ## Remarks Specifies whether or not the file represented by these attributes is a directory. This property is read-only. ## Data Type bool # file_is_symlink property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Specifies whether or not the file or directory represented by these attributes is a symbolic link. ## Syntax *Rust Syntax* ```text fn file_is_symlink(&self ) -> Result ``` ## 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. ## Data Type bool # file_modified_time property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified. ## Syntax *Rust Syntax* ```text fn file_modified_time(&self ) -> Result fn set_file_modified_time(&self, value : i64) -> Option ``` ## Default Value 0 ## Remarks Specifies the number of milliseconds since 12:00:00 AM, January 1, 1970, that this file was last modified. ## Data Type i64 # file_owner_id property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Specifies the user Id of this file's owner. ## Syntax *Rust Syntax* ```text fn file_owner_id(&self ) -> Result fn set_file_owner_id(&self, value : &str) -> Option fn set_file_owner_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Specifies the user Id of this file's owner. ## Data Type String # file_permissions property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Includes a 32-bit integer containing the a POSIX-compatible file permission bitmask. ## Syntax *Rust Syntax* ```text fn file_permissions(&self ) -> Result fn set_file_permissions(&self, value : i32) -> Option ``` ## 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. ## Data Type i32 # file_permissions_octal property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Includes an octal string containing the a POSIX-compatible file permission bitmask. ## Syntax *Rust Syntax* ```text fn file_permissions_octal(&self ) -> Result fn set_file_permissions_octal(&self, value : &str) -> Option fn set_file_permissions_octal_ref(&self, value : &String) -> Option ``` ## 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. ## Data Type String # file_size property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Specifies the total size, in bytes, of this file. ## Syntax *Rust Syntax* ```text fn file_size(&self ) -> Result ``` ## Default Value 0 ## Remarks Specifies the total size, in bytes, of this file. This property is read-only. ## Data Type i64 # firewall_auto_detect property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Whether to automatically detect and use firewall system settings, if available. ## Syntax *Rust Syntax* ```text fn firewall_auto_detect(&self ) -> Result fn set_firewall_auto_detect(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type bool # firewall_type property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The type of firewall to connect through. ## Syntax *Rust Syntax* ```text fn firewall_type(&self ) -> Result fn set_firewall_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // Tunnel2 // SOCKS43 // SOCKS510 // SOCKS4A ``` ## 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](#firewall_port-property-sftpclient-struct) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property-sftpclient-struct) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property-sftpclient-struct) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property-sftpclient-struct) is set to 1080. | ## Data Type i32 # firewall_host property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The name or IP address of the firewall (optional). ## Syntax *Rust Syntax* ```text fn firewall_host(&self ) -> Result fn set_firewall_host(&self, value : &str) -> Option fn set_firewall_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property-sftpclient-struct) 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 struct fails with an error. ## Data Type String # firewall_password property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) A password if authentication is to be used when connecting through the firewall. ## Syntax *Rust Syntax* ```text fn firewall_password(&self ) -> Result fn set_firewall_password(&self, value : &str) -> Option fn set_firewall_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property-sftpclient-struct) is specified, the [firewall_user](#firewall_user-property-sftpclient-struct) and [firewall_password](#firewall_password-property-sftpclient-struct) properties are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. ## Data Type String # firewall_port property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax *Rust Syntax* ```text fn firewall_port(&self ) -> Result fn set_firewall_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property-sftpclient-struct). See the description of the [firewall_host](#firewall_host-property-sftpclient-struct) property for details. NOTE: This property is set automatically when [firewall_firewall_type](#SFTPClient_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_firewall_type](#SFTPClient_p_FirewallFirewallType) property for details. ## Data Type i32 # firewall_user property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) A username if authentication is to be used when connecting through a firewall. ## Syntax *Rust Syntax* ```text fn firewall_user(&self ) -> Result fn set_firewall_user(&self, value : &str) -> Option fn set_firewall_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property-sftpclient-struct) is specified, this property and the [firewall_password](#firewall_password-property-sftpclient-struct) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error. ## Data Type String # idle property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The current status of the struct. ## Syntax *Rust Syntax* ```text fn idle(&self ) -> Result ``` ## 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. ## Data Type bool # local_file property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The path to a local file for upload or download. ## Syntax *Rust Syntax* ```text fn local_file(&self ) -> Result fn set_local_file(&self, value : &str) -> Option fn set_local_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The local_file property is used by the [upload](#upload-method-sftpclient-struct) and [download](#download-method-sftpclient-struct) methods. The file will be overwritten only if the [overwrite](#overwrite-property-sftpclient-struct) property is set to True. **Example. Setting LocalFile:** ```text SFTPControl.Localfile = "C:\localfile.txt" SFTPControl.RemoteFile = "remotefile.txt" SFTPControl.Download() SFTPControl.Localfile = "C:\localfile2.txt" SFTPControl.RemoteFile = "folder/remotefile2.txt" SFTPControl.Download() ``` ## Data Type String # local_host property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Rust Syntax* ```text fn local_host(&self ) -> Result fn set_local_host(&self, value : &str) -> Option fn set_local_host_ref(&self, value : &String) -> Option ``` ## 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 struct initiate connections (or accept in the case of server structs) 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 struct 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. ## Data Type String # local_port property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The TCP port in the local host where the struct binds. ## Syntax *Rust Syntax* ```text fn local_port(&self ) -> Result fn set_local_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property must be set before a connection is attempted. It instructs the struct 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. ## Data Type i32 # overwrite property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The value indicating whether or not the struct should overwrite files during transfer. ## Syntax *Rust Syntax* ```text fn overwrite(&self ) -> Result fn set_overwrite(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property is a value indicating whether or not the struct should overwrite [local_file](#local_file-property-sftpclient-struct) when downloading and [remote_file](#remote_file-property-sftpclient-struct) when uploading. If overwrite is False, an error will be thrown whenever [local_file](#local_file-property-sftpclient-struct) exists before a download operation. ## Data Type bool # remote_file property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The name of the remote file for uploading or downloading. ## Syntax *Rust Syntax* ```text fn remote_file(&self ) -> Result fn set_remote_file(&self, value : &str) -> Option fn set_remote_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The remote_file is either an absolute file path or a relative path based on [remote_path](#remote_path-property-sftpclient-struct). A number of methods use remote_file as an argument. **Example 1. Setting RemoteFile:** ```text 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](#list_directory-method-sftpclient-struct). **Example 2. Using RemoteFile as a File Mask:** ```text 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. ## Data Type String # remote_path property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The current path in the secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn remote_path(&self ) -> Result ``` ## Default Value "" ## Remarks The remote_path shows the current working directory on the SFTP server. The [change_remote_path](#change_remote_path-method-sftpclient-struct) 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:** ```text sftp1.SSHLogon("sftp.server.net", 22); sftp1.ChangeRemotePath("/home/user"); ``` This property is read-only. ## Data Type String # ssh_accept_server_host_key_effective_date property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_effective_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # ssh_accept_server_host_key_expiration_date property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_expiration_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # ssh_accept_server_host_key_extended_key_usage property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_extended_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # ssh_accept_server_host_key_fingerprint property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_fingerprint(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # ssh_accept_server_host_key_fingerprint_sha1 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_fingerprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # ssh_accept_server_host_key_fingerprint_sha256 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_fingerprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # ssh_accept_server_host_key_issuer property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_issuer(&self ) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # ssh_accept_server_host_key_private_key property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_private_key(&self ) -> Result ``` ## 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](#ssh_accept_server_host_key_private_key-property-sftpclient-struct) may be available but not exportable. In this case, [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sftpclient-struct) returns an empty string. This property is read-only. ## Data Type String # ssh_accept_server_host_key_private_key_available property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sftpclient-struct) is available for the selected certificate. If [ssh_accept_server_host_key_private_key_available](#ssh_accept_server_host_key_private_key_available-property-sftpclient-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # ssh_accept_server_host_key_private_key_container property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssh_accept_server_host_key_private_key](#ssh_accept_server_host_key_private_key-property-sftpclient-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ssh_accept_server_host_key_public_key property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # ssh_accept_server_host_key_public_key_algorithm property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_public_key_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssh_accept_server_host_key_public_key_length property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssh_accept_server_host_key_serial_number property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_serial_number(&self ) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # ssh_accept_server_host_key_signature_algorithm property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_signature_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssh_accept_server_host_key_store property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_store(&self ) -> Result, IPWorksSFTPError> fn set_ssh_accept_server_host_key_store(&self, value : Vec) -> Option fn set_ssh_accept_server_host_key_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssh_accept_server_host_key_store_type](#ssh_accept_server_host_key_store_type-property-sftpclient-struct) property denotes the type of the certificate store specified by [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sftpclient-struct). If the store is password-protected, specify the password in [ssh_accept_server_host_key_store_password](#ssh_accept_server_host_key_store_password-property-sftpclient-struct). [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sftpclient-struct) is used in conjunction with the [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sftpclient-struct) property to specify client certificates. If [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sftpclient-struct) has a value, and [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sftpclient-struct) or [ssh_accept_server_host_key_encoded](#ssh_accept_server_host_key_encoded-property-sftpclient-struct) is set, a search for a certificate is initiated. Please see the [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sftpclient-struct) 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). ## Data Type Vec # ssh_accept_server_host_key_store_password property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_store_password(&self ) -> Result fn set_ssh_accept_server_host_key_store_password(&self, value : &str) -> Option fn set_ssh_accept_server_host_key_store_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # ssh_accept_server_host_key_store_type property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_store_type(&self ) -> Result fn set_ssh_accept_server_host_key_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssh_accept_server_host_key_store_type](#ssh_accept_server_host_key_store_type-property-sftpclient-struct), the full path of the PKCS#11 DLL as the [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sftpclient-struct), and the PIN as the [ssh_accept_server_host_key_store_password](#ssh_accept_server_host_key_store_password-property-sftpclient-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sftpclient-struct) and set [ssh_accept_server_host_key_store_password](#ssh_accept_server_host_key_store_password-property-sftpclient-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | ## Data Type i32 # ssh_accept_server_host_key_subject_alt_names property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ssh_accept_server_host_key_thumbprint_md5 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_thumbprint_md5(&self ) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssh_accept_server_host_key_thumbprint_sha1 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_thumbprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssh_accept_server_host_key_thumbprint_sha256 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_thumbprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssh_accept_server_host_key_usage property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssh_accept_server_host_key_usage_flags](#ssh_accept_server_host_key_usage_flags-property-sftpclient-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # ssh_accept_server_host_key_usage_flags property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssh_accept_server_host_key_usage_flags](#ssh_accept_server_host_key_usage_flags-property-sftpclient-struct) 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](#ssh_accept_server_host_key_usage-property-sftpclient-struct) property for a text representation of [ssh_accept_server_host_key_usage_flags](#ssh_accept_server_host_key_usage_flags-property-sftpclient-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssh_accept_server_host_key_version property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ssh_accept_server_host_key_subject property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_subject(&self ) -> Result fn set_ssh_accept_server_host_key_subject(&self, value : &str) -> Option fn set_ssh_accept_server_host_key_subject_ref(&self, value : &String) -> Option ``` ## 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=example@email.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. ## Data Type String # ssh_accept_server_host_key_encoded property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssh_accept_server_host_key_encoded(&self ) -> Result, IPWorksSFTPError> fn set_ssh_accept_server_host_key_encoded(&self, value : Vec) -> Option fn set_ssh_accept_server_host_key_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sftpclient-struct) and [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sftpclient-struct) properties also may be used to specify a certificate. When [ssh_accept_server_host_key_encoded](#ssh_accept_server_host_key_encoded-property-sftpclient-struct) is set, a search is initiated in the current [ssh_accept_server_host_key_store](#ssh_accept_server_host_key_store-property-sftpclient-struct) for the private key of the certificate. If the key is found, [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sftpclient-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssh_accept_server_host_key_subject](#ssh_accept_server_host_key_subject-property-sftpclient-struct) is set to an empty string. ## Data Type Vec # ssh_auth_mode property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The authentication method to be used with the struct when calling SSHLogon . ## Syntax *Rust Syntax* ```text fn ssh_auth_mode(&self ) -> Result fn set_ssh_auth_mode(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // MultiFactor2 // Password3 // PublicKey4 // KeyboardInteractive5 // GSSAPIWithMic6 // GSSAPIKeyex99 // Custom ``` ## 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](#ssh_logon-method-sftpclient-struct), the struct 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](#ssh_host-property-sftpclient-struct) containing the [ssh_user](#ssh_user-property-sftpclient-struct). The server will respond containing a list of methods by which that user may be authenticated. The struct 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 struct supports the following authentication methods: | | | | --- | --- | | amNone (0) | No authentication will be performed. The current [ssh_user](#ssh_user-property-sftpclient-struct) value is ignored, and the connection will be logged as anonymous. | | amMultiFactor (1) | This allows the struct to attempt a multistep authentication process. The struct 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 struct will continue to send authentication data until the server acknowledges authentication success. If the server rejects an authentication step, the struct fails with an error. | | amPassword (2) | The struct will use the values of [ssh_user](#ssh_user-property-sftpclient-struct) and [ssh_password](#ssh_password-property-sftpclient-struct) to authenticate the user. | | amPublicKey (3) | The struct will use the values of [ssh_user](#ssh_user-property-sftpclient-struct) 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 struct will fire the [on_ssh_keyboard_interactive](#on_ssh_keyboard_interactive-event-sftpclient-struct) event containing instructions on how to complete the authentication step. NOTE: amKeyboardInteractive is not supported in SSHTunnel. | | amGSSAPIWithMic (5) | This allows the struct to attempt Kerberos authentication using the GSSAPI-WITH-MIC scheme. The client will try Kerberos authentication using the value of [ssh_user](#ssh_user-property-sftpclient-struct) (single sign-on), or if [ssh_password](#ssh_password-property-sftpclient-struct) 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 struct to attempt Kerberos authentication using the GSSAPIKeyex scheme. The client will try Kerberos authentication using the value of [ssh_user](#ssh_user-property-sftpclient-struct) (single sign-on), or if [ssh_password](#ssh_password-property-sftpclient-struct) 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 struct caller to take over the authentication process completely. When amCustom is set, the struct will fire the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sftpclient-struct) event as necessary to complete the authentication process. | **Example 1. User/Password Authentication:** ```text Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) ``` **Example 2. Public Key Authentication:** ```text Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22) ``` ## Data Type i32 # ssh_cert_effective_date property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssh_cert_effective_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # ssh_cert_expiration_date property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssh_cert_expiration_date(&self ) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # ssh_cert_extended_key_usage property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssh_cert_extended_key_usage(&self ) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # ssh_cert_fingerprint property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # ssh_cert_fingerprint_sha1 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # ssh_cert_fingerprint_sha256 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_fingerprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # ssh_cert_issuer property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_issuer(&self ) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # ssh_cert_private_key property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key(&self ) -> Result ``` ## 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](#ssh_cert_private_key-property-sftpclient-struct) may be available but not exportable. In this case, [ssh_cert_private_key](#ssh_cert_private_key-property-sftpclient-struct) returns an empty string. This property is read-only. ## Data Type String # ssh_cert_private_key_available property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssh_cert_private_key](#ssh_cert_private_key-property-sftpclient-struct) is available for the selected certificate. If [ssh_cert_private_key_available](#ssh_cert_private_key_available-property-sftpclient-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # ssh_cert_private_key_container property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssh_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssh_cert_private_key](#ssh_cert_private_key-property-sftpclient-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # ssh_cert_public_key property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key(&self ) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # ssh_cert_public_key_algorithm property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssh_cert_public_key_length property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssh_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssh_cert_serial_number property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssh_cert_serial_number(&self ) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # ssh_cert_signature_algorithm property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssh_cert_signature_algorithm(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # ssh_cert_store property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_store(&self ) -> Result, IPWorksSFTPError> fn set_ssh_cert_store(&self, value : Vec) -> Option fn set_ssh_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssh_cert_store_type](#ssh_cert_store_type-property-sftpclient-struct) property denotes the type of the certificate store specified by [ssh_cert_store](#ssh_cert_store-property-sftpclient-struct). If the store is password-protected, specify the password in [ssh_cert_store_password](#ssh_cert_store_password-property-sftpclient-struct). [ssh_cert_store](#ssh_cert_store-property-sftpclient-struct) is used in conjunction with the [ssh_cert_subject](#ssh_cert_subject-property-sftpclient-struct) property to specify client certificates. If [ssh_cert_store](#ssh_cert_store-property-sftpclient-struct) has a value, and [ssh_cert_subject](#ssh_cert_subject-property-sftpclient-struct) or [ssh_cert_encoded](#ssh_cert_encoded-property-sftpclient-struct) is set, a search for a certificate is initiated. Please see the [ssh_cert_subject](#ssh_cert_subject-property-sftpclient-struct) 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). ## Data Type Vec # ssh_cert_store_password property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax *Rust Syntax* ```text fn ssh_cert_store_password(&self ) -> Result fn set_ssh_cert_store_password(&self, value : &str) -> Option fn set_ssh_cert_store_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # ssh_cert_store_type property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_store_type(&self ) -> Result fn set_ssh_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The struct supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the struct will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssh_cert_store_type](#ssh_cert_store_type-property-sftpclient-struct), the full path of the PKCS#11 DLL as the [ssh_cert_store](#ssh_cert_store-property-sftpclient-struct), and the PIN as the [ssh_cert_store_password](#ssh_cert_store_password-property-sftpclient-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssh_cert_store](#ssh_cert_store-property-sftpclient-struct) and set [ssh_cert_store_password](#ssh_cert_store_password-property-sftpclient-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | ## Data Type i32 # ssh_cert_subject_alt_names property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # ssh_cert_thumbprint_md5 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_md5(&self ) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssh_cert_thumbprint_sha1 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_sha1(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssh_cert_thumbprint_sha256 property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_thumbprint_sha256(&self ) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # ssh_cert_usage property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssh_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sftpclient-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # ssh_cert_usage_flags property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssh_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sftpclient-struct) 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](#ssh_cert_usage-property-sftpclient-struct) property for a text representation of [ssh_cert_usage_flags](#ssh_cert_usage_flags-property-sftpclient-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssh_cert_version property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssh_cert_version(&self ) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # ssh_cert_subject property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssh_cert_subject(&self ) -> Result fn set_ssh_cert_subject(&self, value : &str) -> Option fn set_ssh_cert_subject_ref(&self, value : &String) -> Option ``` ## 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=example@email.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. ## Data Type String # ssh_cert_encoded property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssh_cert_encoded(&self ) -> Result, IPWorksSFTPError> fn set_ssh_cert_encoded(&self, value : Vec) -> Option fn set_ssh_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssh_cert_store](#ssh_cert_store-property-sftpclient-struct) and [ssh_cert_subject](#ssh_cert_subject-property-sftpclient-struct) properties also may be used to specify a certificate. When [ssh_cert_encoded](#ssh_cert_encoded-property-sftpclient-struct) is set, a search is initiated in the current [ssh_cert_store](#ssh_cert_store-property-sftpclient-struct) for the private key of the certificate. If the key is found, [ssh_cert_subject](#ssh_cert_subject-property-sftpclient-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssh_cert_subject](#ssh_cert_subject-property-sftpclient-struct) is set to an empty string. ## Data Type Vec # ssh_compression_algorithms property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The comma-separated list containing all allowable compression algorithms. ## Syntax *Rust Syntax* ```text fn ssh_compression_algorithms(&self ) -> Result fn set_ssh_compression_algorithms(&self, value : &str) -> Option fn set_ssh_compression_algorithms_ref(&self, value : &String) -> Option ``` ## 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 struct 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 struct: - zlib - zlib@openssh.com - none ## Data Type String # ssh_encryption_algorithms property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The comma-separated list containing all allowable encryption algorithms. ## Syntax *Rust Syntax* ```text fn ssh_encryption_algorithms(&self ) -> Result fn set_ssh_encryption_algorithms(&self, value : &str) -> Option fn set_ssh_encryption_algorithms_ref(&self, value : &String) -> Option ``` ## Default Value "aes256-ctr,aes192-ctr,aes128-ctr,3des-ctr,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 struct 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 struct: - aes256-ctr - aes256-cbc - aes192-ctr - aes192-cbc - aes128-ctr - aes128-cbc - 3des-ctr - 3des-cbc - cast128-cbc - blowfish-cbc - arcfour - arcfour128 - arcfour256 - aes256-gcm@openssh.com - aes128-gcm@openssh.com - chacha20-poly1305@openssh.com ## Data Type String # ssh_host property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The address of the Secure Shell (SSH) host. ## Syntax *Rust Syntax* ```text fn ssh_host(&self ) -> Result fn set_ssh_host(&self, value : &str) -> Option fn set_ssh_host_ref(&self, value : &String) -> Option ``` ## 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. ## Data Type String # ssh_password property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The password for Secure Shell (SSH) password-based authentication. ## Syntax *Rust Syntax* ```text fn ssh_password(&self ) -> Result fn set_ssh_password(&self, value : &str) -> Option fn set_ssh_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks ssh_password specifies the password that is used to authenticate the client to the SSH server. ## Data Type String # ssh_port property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The port on the Secure Shell (SSH) server where the SSH service is running; by default, 22. ## Syntax *Rust Syntax* ```text fn ssh_port(&self ) -> Result fn set_ssh_port(&self, value : i32) -> Option ``` ## 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. ## Data Type i32 # ssh_user property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The username for Secure Shell (SSH) authentication. ## Syntax *Rust Syntax* ```text fn ssh_user(&self ) -> Result fn set_ssh_user(&self, value : &str) -> Option fn set_ssh_user_ref(&self, value : &String) -> Option ``` ## 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:** ```text Control.SSHAuthMode = SftpSSHAuthModes.amPassword Control.SSHUser = "username" Control.SSHPassword = "password" Control.SSHLogon("server", 22) ``` **Example 2. Public Key Authentication:** ```text Control.SSHAuthMode = SftpSSHAuthModes.amPublicKey Control.SSHUser = "username" Control.SSHCertStoreType = SSHCertStoreTypes.cstPFXFile; Control.SSHCertStore = "cert.pfx"; Control.SSHCertStorePassword = "certpassword"; Control.SSHCertSubject = "*"; Control.SSHLogon("server", 22) ``` ## Data Type String # start_byte property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The offset in bytes at which to begin the upload or download. ## Syntax *Rust Syntax* ```text fn start_byte(&self ) -> Result fn set_start_byte(&self, value : i64) -> Option ``` ## Default Value 0 ## Remarks The start_byte property is used by the [upload](#upload-method-sftpclient-struct) and [download](#download-method-sftpclient-struct) 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](#append-method-sftpclient-struct). When downloading, this property can be used in conjunction with the [TransferredDataLimit](#TransferredDataLimit) configuration setting to download only a specific range of data from the current [remote_file](#remote_file-property-sftpclient-struct). ## Data Type i64 # timeout property ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The timeout for the struct. ## Syntax *Rust Syntax* ```text fn timeout(&self ) -> Result fn set_timeout(&self, value : i32) -> Option ``` ## 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 struct will wait for the operation to complete before returning control. The struct will use [do_events](#do_events-method-sftpclient-struct) 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 struct 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. ## Data Type i32 # append method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Appends data from LocalFile to a remote file RemoteFile on a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn append(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method is similar to the [upload](#upload-method-sftpclient-struct) method, but the local file specified by [local_file](#local_file-property-sftpclient-struct) is appended to [remote_file](#remote_file-property-sftpclient-struct) on the server as opposed to replacing it as with the [upload](#upload-method-sftpclient-struct) method. [remote_file](#remote_file-property-sftpclient-struct) is either an absolute path on the server or a path relative to [remote_path](#remote_path-property-sftpclient-struct). 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Changes the current path on the server. ## Syntax *Rust Syntax* ```text fn change_remote_path(&self, remote_path : &str) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method changes the current path on the server to the specified *RemotePath*. When called, the struct 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: ```csharp 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: ```csharp //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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Returns True if the file specified by RemoteFile exists on the remote server. ## Syntax *Rust Syntax* ```text fn check_file_exists(&self) -> Result ``` ## 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](#remote_file-property-sftpclient-struct) before calling this method. If no session is in place, the value of this property will always be *false*. # config method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-sftpclient-struct) for the struct. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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](#config-settings-sftpclient-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # connect method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Connects to the Secure Shell (SSH) host. ## Syntax *Rust Syntax* ```text fn connect(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks By default, this method establishes a connection with the [ssh_host](#ssh_host-property-sftpclient-struct) and performs a full SSH login (equivalent to calling the [ssh_logon](#ssh_logon-method-sftpclient-struct) method with the current [ssh_host](#ssh_host-property-sftpclient-struct) and [ssh_port](#ssh_port-property-sftpclient-struct)). This behavior is controlled by the [ConnectAndLogin](#ConnectAndLogin) configuration setting, which defaults to *true*. When set to *false*, this method will only establish the TCP connection with the [ssh_host](#ssh_host-property-sftpclient-struct) without logging in. This 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. To complete the SSH login afterward, call [ssh_logon](#ssh_logon-method-sftpclient-struct) with the same [ssh_host](#ssh_host-property-sftpclient-struct) and [ssh_port](#ssh_port-property-sftpclient-struct) that were used to connect. # copy_remote_data method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Copies a range of bytes from one remote file to another directly on the secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn copy_remote_data(&self, dest_file : &str, length : i64, write_offset : i64) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method uses the *copy-data* extension to copy data from the remote file specified by [remote_file](#remote_file-property-sftpclient-struct) to the destination file specified by *DestFile*. The server must support the *copy-data* extension. Set [start_byte](#start_byte-property-sftpclient-struct) to indicate where in the source file to start reading. The *Length* parameter indicates the number of bytes to read, and the *WriteOffset* parameter indicates where in the destination file to start writing. [remote_file](#remote_file-property-sftpclient-struct) may be an absolute path on the server or a path relative to [remote_path](#remote_path-property-sftpclient-struct). *DestFile* may also be absolute or relative to [remote_path](#remote_path-property-sftpclient-struct). If a Secure Shell (SSH) session is not in place, one is automatically created by the component first. ```csharp sftp.RemoteFile = "/my/source/file.txt"; sftp.StartByte = 6; sftp.CopyRemoteData("/my/destination/file.txt", 5, 14); ``` # copy_remote_file method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Copies a remote file directly on the secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn copy_remote_file(&self, dest_file : &str) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method uses the *copy-file* extension to copy the remote file specified by [remote_file](#remote_file-property-sftpclient-struct) to the destination file specified by *DestFile*. The server must support the *copy-file* extension. [remote_file](#remote_file-property-sftpclient-struct) may be an absolute path on the server or a path relative to [remote_path](#remote_path-property-sftpclient-struct). *DestFile* may also be absolute or relative to [remote_path](#remote_path-property-sftpclient-struct). [overwrite](#overwrite-property-sftpclient-struct) controls whether an existing destination file will be overwritten. If a Secure Shell (SSH) session is not in place, one is automatically created by the component first. ```csharp sftp.Overwrite = true; sftp.RemoteFile = "/my/source/file.txt"; sftp.CopyRemoteFile("/my/destination/file.txt"); ``` # create_file method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Creates a file on the secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn create_file(&self, file_name : &str) -> Result<(), IPWorksSFTPError> ``` ## 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](#upload-method-sftpclient-struct) instead. # decode_packet method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Decodes a hex-encoded Secure Shell (SSH) packet. ## Syntax *Rust Syntax* ```text fn decode_packet(&self, encoded_packet : &str) -> Result, IPWorksSFTPError> ``` ## Remarks This method is used to decode an SSH packet created by [encode_packet](#encode_packet-method-sftpclient-struct). NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sftpclient-struct) event. # delete_file method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Deletes a file specified by FileName from a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn delete_file(&self, file_name : &str) -> Result<(), IPWorksSFTPError> ``` ## 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](#remote_path-property-sftpclient-struct). If a Secure Shell (SSH) session is not in place, one is automatically created by the component first. # disconnect method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Disconnects from the server without first logging off. ## Syntax *Rust Syntax* ```text fn disconnect(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method immediately disconnects from the server without first logging off. In most cases, the [ssh_logoff](#ssh_logoff-method-sftpclient-struct) 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This method processes events from the internal message queue. ## Syntax *Rust Syntax* ```text fn do_events(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # download method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Downloads a RemoteFile from a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn download(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks The remote file specified by [remote_file](#remote_file-property-sftpclient-struct) is downloaded to the local file specified by [local_file](#local_file-property-sftpclient-struct), or it is retrieved through the [on_transfer](#on_transfer-event-sftpclient-struct) event, if the [local_file](#local_file-property-sftpclient-struct) property is "" (empty string). [remote_file](#remote_file-property-sftpclient-struct) is either an absolute path on the server or is a path relative to [remote_path](#remote_path-property-sftpclient-struct). If a Secure Shell (SSH) session is not in place, one is automatically created by the component first. **Example. Download a File:** ```text 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Facilitates the partial downloading of a remote file from a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn download_range(&self, path : &str, file_name : &str, start_byte : i64, count : i32, buffer : &mut [u8]) -> Result ``` ## 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Hex encodes a Secure Shell (SSH) packet. ## Syntax *Rust Syntax* ```text fn encode_packet(&self, packet : &[u8]) -> Result ``` ## Remarks This method is used to encode a raw SSH packet created by [set_ssh_param](#set_ssh_param-method-sftpclient-struct). NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sftpclient-struct) event. # get_ssh_param method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Reads a field from a Secure Shell (SSH) packet's payload. ## Syntax *Rust Syntax* ```text fn get_ssh_param(&self, payload : &[u8], field : &str) -> Result ``` ## 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](#set_ssh_param-method-sftpclient-struct). 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](#set_ssh_param-method-sftpclient-struct). NOTE: This method is applicable only for reading and creating Secure Shell (SSH) packets for use within the [on_ssh_custom_auth](#on_ssh_custom_auth-event-sftpclient-struct) event. # get_ssh_param_bytes method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Reads a field from a Secure Shell (SSH) packet's payload. ## Syntax *Rust Syntax* ```text fn get_ssh_param_bytes(&self, payload : &[u8], field : &str) -> Result, IPWorksSFTPError> ``` ## Remarks This method is the same as calling [get_ssh_param](#get_ssh_param-method-sftpclient-struct), 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](#on_ssh_custom_auth-event-sftpclient-struct) event. # interrupt method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This method interrupts the current method. ## Syntax *Rust Syntax* ```text fn interrupt(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks If there is no method in progress, interrupt simply returns, doing nothing. # list_directory method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Lists the current directory specified by RemotePath on a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn list_directory(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks A listing is requested for the directory (or file mask) specified in [remote_file](#remote_file-property-sftpclient-struct). [remote_file](#remote_file-property-sftpclient-struct) is either an absolute path on the server or is a path relative to [remote_path](#remote_path-property-sftpclient-struct). The file listing is received through the [on_dir_list](#on_dir_list-event-sftpclient-struct) event. If a Secure Shell (SSH) session is not in place, one is automatically created by the component first. # make_directory method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Creates a directory on a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn make_directory(&self, new_dir : &str) -> Result<(), IPWorksSFTPError> ``` ## 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](#remote_path-property-sftpclient-struct). If a Secure Shell (SSH) session is not in place, one is automatically created by the component first. # query_file_attributes method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Queries the server for the attributes of RemoteFile . ## Syntax *Rust Syntax* ```text fn query_file_attributes(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method queries the server for attributes of [remote_file](#remote_file-property-sftpclient-struct). 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](#update_file_attributes-method-sftpclient-struct). # queue_file method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Adds a file to the transfer queue. ## Syntax *Rust Syntax* ```text fn queue_file(&self, local_file : &str, remote_file : &str) -> Result<(), IPWorksSFTPError> ``` ## 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 struct to allow for multiple simultaneous file transfers. To simply transfer a file without using this method, you need only to set [local_file](#local_file-property-sftpclient-struct) and [remote_file](#remote_file-property-sftpclient-struct) and to call [upload](#upload-method-sftpclient-struct) or [download](#download-method-sftpclient-struct), 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](#upload-method-sftpclient-struct) or [download](#download-method-sftpclient-struct) method is called. If multiple files are queued, the files will be transferred simultaneously. The [SimultaneousTransferLimit](#SimultaneousTransferLimit) setting controls the maximum number of simultaneous transfers. The [upload](#upload-method-sftpclient-struct) or [download](#download-method-sftpclient-struct) 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](#reset_queue-method-sftpclient-struct). This will not affect current transfers. To cancel an individual file transfer, set the *Cancel* parameter of the [on_transfer](#on_transfer-event-sftpclient-struct) event to True. The rest of the queue will continue to process as normal. The [interrupt](#interrupt-method-sftpclient-struct) method may be called to immediately stop all current transfers. In the event of a file-specific error, the [on_error](#on_error-event-sftpclient-struct) 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Removes a directory specified by DirName from a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn remove_directory(&self, dir_name : &str) -> Result<(), IPWorksSFTPError> ``` ## 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](#remote_path-property-sftpclient-struct). If a Secure Shell (SSH) session is not in place, one is automatically created by the component first. # rename_file method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Changes the name of RemoteFile to NewName . ## Syntax *Rust Syntax* ```text fn rename_file(&self, new_name : &str) -> Result<(), IPWorksSFTPError> ``` ## Remarks The name of the remote file or the folder specified by [remote_file](#remote_file-property-sftpclient-struct) is changed to *NewName*. [remote_file](#remote_file-property-sftpclient-struct) and *NewName* are either absolute paths on the server or a path relative to [remote_path](#remote_path-property-sftpclient-struct). If a Secure Shell (SSH) session is not in place, one is automatically created by the component first. # reset method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) This method will reset the struct. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method will reset the struct's properties to their default values. # reset_queue method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Resets the queue of files to be transferred. ## Syntax *Rust Syntax* ```text fn reset_queue(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks This method will remove all files from the transfer queue. Calling this method will clear all files that were queued by [queue_file](#queue_file-method-sftpclient-struct). Calling this method will not affect current transfers. # set_ssh_param method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Writes a field to the end of a payload. ## Syntax *Rust Syntax* ```text fn set_ssh_param(&self, payload : &[u8], field_type : &str, field_value : &str) -> Result, IPWorksSFTPError> ``` ## 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](#on_ssh_custom_auth-event-sftpclient-struct) event. # ssh_logoff method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Logs off from the Secure Shell (SSH) server. ## Syntax *Rust Syntax* ```text fn ssh_logoff(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks Logs off from the SSH server. If that fails, the connection is terminated by the local host. # ssh_logon method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Logs on to the SSHHost using the current SSHUser and SSHPassword . ## Syntax *Rust Syntax* ```text fn ssh_logon(&self, ssh_host : &str, ssh_port : i32) -> Result<(), IPWorksSFTPError> ``` ## Remarks Logs on to the Secure Shell (SSH) server using the current [ssh_user](#ssh_user-property-sftpclient-struct) and [ssh_password](#ssh_password-property-sftpclient-struct). This will perform the SSH handshake and authentication. **Example. Logging On:** ```text SSHClient.SSHUser = "username" SSHClient.SSHPassword = "password" SSHClient.SSHLogon("sshHost", sshPort) ``` # update_file_attributes method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Instructs the struct to send the FileAttributes to the server. ## Syntax *Rust Syntax* ```text fn update_file_attributes(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks When update_file_attributes is called, the struct will send the values of the following properties to the server: - [file_access_time](#file_access_time-property-sftpclient-struct) - [file_acl](#file_acl-property-sftpclient-struct) - [file_allocation_size](#file_allocation_size-property-sftpclient-struct) - [file_attribute_bits](#file_attribute_bits-property-sftpclient-struct) - [file_attribute_bits_valid](#file_attribute_bits_valid-property-sftpclient-struct) - [file_creation_time](#file_creation_time-property-sftpclient-struct) - [file_type](#file_type-property-sftpclient-struct) - [file_group_id](#file_group_id-property-sftpclient-struct) - [file_is_dir](#file_is_dir-property-sftpclient-struct) - [file_modified_time](#file_modified_time-property-sftpclient-struct) - [file_owner_id](#file_owner_id-property-sftpclient-struct) - [file_permissions](#file_permissions-property-sftpclient-struct) - [file_size](#file_size-property-sftpclient-struct) # upload method ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Uploads a file specified by LocalFile to a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn upload(&self) -> Result<(), IPWorksSFTPError> ``` ## Remarks The local file specified by [local_file](#local_file-property-sftpclient-struct) is uploaded to the remote file specified by [remote_file](#remote_file-property-sftpclient-struct). [remote_file](#remote_file-property-sftpclient-struct) is either an absolute path on the server or a path relative to [remote_path](#remote_path-property-sftpclient-struct). 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](#append-method-sftpclient-struct) method. **Example. Upload a File:** ```text 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Inserts data into a remote file on a secure file transfer protocol (SFTP) server. ## Syntax *Rust Syntax* ```text fn upload_range(&self, path : &str, file_name : &str, start_byte : i64, count : i32, buffer : &[u8]) -> Result<(), IPWorksSFTPError> ``` ## 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired immediately after a connection completes (or fails). ## Syntax *Rust Syntax* ```text // SFTPClientConnectedEventArgs carries the SFTPClient Connected event's parameters. pub struct SFTPClientConnectedEventArgs { fn status_code(&self) -> i32 fn description(&self) -> &String } // SFTPClientConnectedEvent defines the signature of the SFTPClient Connected event's handler function. pub trait SFTPClientConnectedEvent { fn on_connected(&self, sender : SFTPClient, e : &mut SFTPClientConnectedEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_connected(&self) -> &'a dyn SFTPClientConnectedEvent; pub fn set_on_connected(&mut self, value : &'a dyn SFTPClientConnectedEvent); ... } ``` ## Remarks If the connection is made normally, *status_code* is 0 and *description* is "OK". If the connection fails, *status_code* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *description* contains a description of this code. The value of *status_code* is equal to the value of the error. Please refer to the [Error Codes](#trappable-errors-sftpclient-struct) section for more information. # on_connection_status event ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired to indicate changes in the connection state. ## Syntax *Rust Syntax* ```text // SFTPClientConnectionStatusEventArgs carries the SFTPClient ConnectionStatus event's parameters. pub struct SFTPClientConnectionStatusEventArgs { fn connection_event(&self) -> &String fn status_code(&self) -> i32 fn description(&self) -> &String } // SFTPClientConnectionStatusEvent defines the signature of the SFTPClient ConnectionStatus event's handler function. pub trait SFTPClientConnectionStatusEvent { fn on_connection_status(&self, sender : SFTPClient, e : &mut SFTPClientConnectionStatusEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_connection_status(&self) -> &'a dyn SFTPClientConnectionStatusEvent; pub fn set_on_connection_status(&mut self, value : &'a dyn SFTPClientConnectionStatusEvent); ... } ``` ## 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 *connection_event* 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. | *status_code* has the error code returned by the Transmission Control Protocol (TCP)/IP stack. *description* contains a description of this code. The value of *status_code* is equal to the value of the error. # on_dir_list event ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired when a directory entry is received. ## Syntax *Rust Syntax* ```text // SFTPClientDirListEventArgs carries the SFTPClient DirList event's parameters. pub struct SFTPClientDirListEventArgs { fn dir_entry(&self) -> &String fn file_name(&self) -> &String fn is_dir(&self) -> bool fn file_size(&self) -> i64 fn file_time(&self) -> &String fn is_symlink(&self) -> bool } // SFTPClientDirListEvent defines the signature of the SFTPClient DirList event's handler function. pub trait SFTPClientDirListEvent { fn on_dir_list(&self, sender : SFTPClient, e : &mut SFTPClientDirListEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_dir_list(&self) -> &'a dyn SFTPClientDirListEvent; pub fn set_on_dir_list(&mut self, value : &'a dyn SFTPClientDirListEvent); ... } ``` ## Remarks The on_dir_list events are fired when a directory listing is received as a response to a [list_directory](#list_directory-method-sftpclient-struct). The [on_start_transfer](#on_start_transfer-event-sftpclient-struct) and [on_end_transfer](#on_end_transfer-event-sftpclient-struct) events mark the beginning and end of the event stream. The *DirEntry* parameter contains the filename when [list_directory](#list_directory-method-sftpclient-struct) is called. The struct tries to fill out the *FileName*, *IsDir*, *FileSize*, and *FileTime* parameters when calling the [list_directory](#list_directory-method-sftpclient-struct) method. The format of the *FileTime* parameter returned by the struct can be controlled through the [FileTimeFormat](#FileTimeFormat) configuration setting. If no format is specified, the struct 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](#remote_file-property-sftpclient-struct) and query the [file_is_dir](#file_is_dir-property-sftpclient-struct) property. # on_disconnected event ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired when a connection is closed. ## Syntax *Rust Syntax* ```text // SFTPClientDisconnectedEventArgs carries the SFTPClient Disconnected event's parameters. pub struct SFTPClientDisconnectedEventArgs { fn status_code(&self) -> i32 fn description(&self) -> &String } // SFTPClientDisconnectedEvent defines the signature of the SFTPClient Disconnected event's handler function. pub trait SFTPClientDisconnectedEvent { fn on_disconnected(&self, sender : SFTPClient, e : &mut SFTPClientDisconnectedEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_disconnected(&self) -> &'a dyn SFTPClientDisconnectedEvent; pub fn set_on_disconnected(&mut self, value : &'a dyn SFTPClientDisconnectedEvent); ... } ``` ## Remarks If the connection is broken normally, *status_code* is 0 and *description* is "OK". If the connection is broken for any other reason, *status_code* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *description* contains a description of this code. The value of *status_code* is equal to the value of the TCP/IP error. Please refer to the [Error Codes](#trappable-errors-sftpclient-struct) section for more information. # on_end_transfer event ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired when a file completes downloading or uploading. ## Syntax *Rust Syntax* ```text // SFTPClientEndTransferEventArgs carries the SFTPClient EndTransfer event's parameters. pub struct SFTPClientEndTransferEventArgs { fn direction(&self) -> i32 fn local_file(&self) -> &String fn remote_file(&self) -> &String } // SFTPClientEndTransferEvent defines the signature of the SFTPClient EndTransfer event's handler function. pub trait SFTPClientEndTransferEvent { fn on_end_transfer(&self, sender : SFTPClient, e : &mut SFTPClientEndTransferEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_end_transfer(&self) -> &'a dyn SFTPClientEndTransferEvent; pub fn set_on_end_transfer(&mut self, value : &'a dyn SFTPClientEndTransferEvent); ... } ``` ## 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired when errors occur during data delivery. ## Syntax *Rust Syntax* ```text // SFTPClientErrorEventArgs carries the SFTPClient Error event's parameters. pub struct SFTPClientErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String fn local_file(&self) -> &String fn remote_file(&self) -> &String } // SFTPClientErrorEvent defines the signature of the SFTPClient Error event's handler function. pub trait SFTPClientErrorEvent { fn on_error(&self, sender : SFTPClient, e : &mut SFTPClientErrorEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_error(&self) -> &'a dyn SFTPClientErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn SFTPClientErrorEvent); ... } ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the struct 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](#trappable-errors-sftpclient-struct) section. *LocalFile* identifies the local file. *RemoteFile* is the remote file. # on_log event ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired once for each log message. ## Syntax *Rust Syntax* ```text // SFTPClientLogEventArgs carries the SFTPClient Log event's parameters. pub struct SFTPClientLogEventArgs { fn log_level(&self) -> i32 fn message(&self) -> &String fn log_type(&self) -> &String } // SFTPClientLogEvent defines the signature of the SFTPClient Log event's handler function. pub trait SFTPClientLogEvent { fn on_log(&self, sender : SFTPClient, e : &mut SFTPClientLogEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_log(&self) -> &'a dyn SFTPClientLogEvent; pub fn set_on_log(&mut self, value : &'a dyn SFTPClientLogEvent); ... } ``` ## Remarks Fired once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired when the struct is doing a custom authentication. ## Syntax *Rust Syntax* ```text // SFTPClientSSHCustomAuthEventArgs carries the SFTPClient SSHCustomAuth event's parameters. pub struct SFTPClientSSHCustomAuthEventArgs { fn packet(&self) -> &String fn set_packet(&self, value : &str) fn set_packet_ref(&self, value : &String) } // SFTPClientSSHCustomAuthEvent defines the signature of the SFTPClient SSHCustomAuth event's handler function. pub trait SFTPClientSSHCustomAuthEvent { fn on_ssh_custom_auth(&self, sender : SFTPClient, e : &mut SFTPClientSSHCustomAuthEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_ssh_custom_auth(&self) -> &'a dyn SFTPClientSSHCustomAuthEvent; pub fn set_on_ssh_custom_auth(&mut self, value : &'a dyn SFTPClientSSHCustomAuthEvent); ... } ``` ## Remarks on_ssh_custom_auth is fired during the user authentication stage of the Secure Shell (SSH) logon process if [ssh_auth_mode](#ssh_auth_mode-property-sftpclient-struct) 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](#decode_packet-method-sftpclient-struct) and then use the [get_ssh_param](#get_ssh_param-method-sftpclient-struct) and [get_ssh_param_bytes](#get_ssh_param_bytes-method-sftpclient-struct) methods. To create a packet, use the [set_ssh_param](#set_ssh_param-method-sftpclient-struct) method and then call [encode_packet](#encode_packet-method-sftpclient-struct) to obtain a HEX-encoded value and assign this to the *Packet* parameter. # on_ssh_keyboard_interactive event ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired when the struct receives a request for user input from the server. ## Syntax *Rust Syntax* ```text // SFTPClientSSHKeyboardInteractiveEventArgs carries the SFTPClient SSHKeyboardInteractive event's parameters. pub struct SFTPClientSSHKeyboardInteractiveEventArgs { fn name(&self) -> &String fn instructions(&self) -> &String fn prompt(&self) -> &String fn response(&self) -> &String fn set_response(&self, value : &str) fn set_response_ref(&self, value : &String) fn echo_response(&self) -> bool } // SFTPClientSSHKeyboardInteractiveEvent defines the signature of the SFTPClient SSHKeyboardInteractive event's handler function. pub trait SFTPClientSSHKeyboardInteractiveEvent { fn on_ssh_keyboard_interactive(&self, sender : SFTPClient, e : &mut SFTPClientSSHKeyboardInteractiveEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_ssh_keyboard_interactive(&self) -> &'a dyn SFTPClientSSHKeyboardInteractiveEvent; pub fn set_on_ssh_keyboard_interactive(&mut self, value : &'a dyn SFTPClientSSHKeyboardInteractiveEvent); ... } ``` ## Remarks on_ssh_keyboard_interactive is fired during the user authentication stage of the Secure Shell (SSH) logon process. During authentication, the struct will request a list of available authentication methods for the [ssh_user](#ssh_user-property-sftpclient-struct). For example, if the [ssh_host](#ssh_host-property-sftpclient-struct) responds with "keyboard-interactive", the struct 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 struct will fire the on_ssh_keyboard_interactive event once for each prompt. # on_ssh_server_authentication event ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired after the server presents its public key to the client. ## Syntax *Rust Syntax* ```text // SFTPClientSSHServerAuthenticationEventArgs carries the SFTPClient SSHServerAuthentication event's parameters. pub struct SFTPClientSSHServerAuthenticationEventArgs { fn host_key(&self) -> &[u8] fn fingerprint(&self) -> &String fn key_algorithm(&self) -> &String fn cert_subject(&self) -> &String fn cert_issuer(&self) -> &String fn status(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // SFTPClientSSHServerAuthenticationEvent defines the signature of the SFTPClient SSHServerAuthentication event's handler function. pub trait SFTPClientSSHServerAuthenticationEvent { fn on_ssh_server_authentication(&self, sender : SFTPClient, e : &mut SFTPClientSSHServerAuthenticationEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_ssh_server_authentication(&self) -> &'a dyn SFTPClientSSHServerAuthenticationEvent; pub fn set_on_ssh_server_authentication(&mut self, value : &'a dyn SFTPClientSSHServerAuthenticationEvent); ... } ``` ## 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](#SSHFingerprintHashAlgorithm). To configure the encoding format used when displaying this value, see [SSHFingerprintEncoding](#SSHFingerprintEncoding). *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 To limit the accepted host key algorithms, refer to [SSHPublicKeyAlgorithms](#SSHPublicKeyAlgorithms). *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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired to track the progress of the secure connection. ## Syntax *Rust Syntax* ```text // SFTPClientSSHStatusEventArgs carries the SFTPClient SSHStatus event's parameters. pub struct SFTPClientSSHStatusEventArgs { fn message(&self) -> &String } // SFTPClientSSHStatusEvent defines the signature of the SFTPClient SSHStatus event's handler function. pub trait SFTPClientSSHStatusEvent { fn on_ssh_status(&self, sender : SFTPClient, e : &mut SFTPClientSSHStatusEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_ssh_status(&self) -> &'a dyn SFTPClientSSHStatusEvent; pub fn set_on_ssh_status(&mut self, value : &'a dyn SFTPClientSSHStatusEvent); ... } ``` ## Remarks The event is fired for informational and logging purposes only. Used to track the progress of the connection. # on_start_transfer event ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired when a file starts downloading or uploading. ## Syntax *Rust Syntax* ```text // SFTPClientStartTransferEventArgs carries the SFTPClient StartTransfer event's parameters. pub struct SFTPClientStartTransferEventArgs { fn direction(&self) -> i32 fn local_file(&self) -> &String fn remote_file(&self) -> &String } // SFTPClientStartTransferEvent defines the signature of the SFTPClient StartTransfer event's handler function. pub trait SFTPClientStartTransferEvent { fn on_start_transfer(&self, sender : SFTPClient, e : &mut SFTPClientStartTransferEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_start_transfer(&self) -> &'a dyn SFTPClientStartTransferEvent; pub fn set_on_start_transfer(&mut self, value : &'a dyn SFTPClientStartTransferEvent); ... } ``` ## 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 ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) Fired during file download or upload. ## Syntax *Rust Syntax* ```text // SFTPClientTransferEventArgs carries the SFTPClient Transfer event's parameters. pub struct SFTPClientTransferEventArgs { fn direction(&self) -> i32 fn local_file(&self) -> &String fn remote_file(&self) -> &String fn bytes_transferred(&self) -> i64 fn percent_done(&self) -> i32 fn text(&self) -> &[u8] fn cancel(&self) -> bool fn set_cancel(&self, value : bool) } // SFTPClientTransferEvent defines the signature of the SFTPClient Transfer event's handler function. pub trait SFTPClientTransferEvent { fn on_transfer(&self, sender : SFTPClient, e : &mut SFTPClientTransferEventArgs); } impl <'a> SFTPClient<'a> { pub fn on_transfer(&self) -> &'a dyn SFTPClientTransferEvent; pub fn set_on_transfer(&mut self, value : &'a dyn SFTPClientTransferEvent); ... } ``` ## 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. # Config Settings ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) The struct 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 struct, access to these *internal properties* is provided through the [config](#config-method-sftpclient-struct) method. ### SFTPClient Config Settings **AllowBackslashInName**: Whether backslashes are allowed in folder and file names.By default the backslash character is treated as a path separator and is not allowed in file and folder names. When this configuration setting is set to True, backslashes "\" are allowed in file and folder names and are not supported as path separators. The default value is False. **AsyncTransfer**: Controls whether simultaneous requests are made to read or write files.When set to True, the struct will make several requests to read or write data before waiting for a response from the server. The maximum number of these requests that can be made is controlled by [MaxOutstandingPackets](#MaxOutstandingPackets). The default is True. **AttrAccessTime**: Can be queried for the AccessTime file attribute during the DirList event.During [on_dir_list](#on_dir_list-event-sftpclient-struct), this configuration setting can be queried to retrieve the value of the AccessTime file attribute if it is present in the response from the server. **AttrCreationTime**: Can be queried for the CreationTime file attribute during the DirList event.During [on_dir_list](#on_dir_list-event-sftpclient-struct), this configuration setting can be queried to retrieve the value of the CreationTime file attribute if it is present in the response from the server. **AttrFileType**: Can be queried for the FileType file attribute during the DirList event.During [on_dir_list](#on_dir_list-event-sftpclient-struct), this configuration setting can be queried to retrieve the value of the FileType file attribute if it is present in the response from the server. **AttrGroupId**: Can be queried for the GroupId file attribute during the DirList event.During [on_dir_list](#on_dir_list-event-sftpclient-struct), this configuration setting can be queried to retrieve the value of the GroupId file attribute if it is present in the response from the server. **AttrLinkCount**: Can be queried for the LinkCount file attribute during the DirList event.During [on_dir_list](#on_dir_list-event-sftpclient-struct), this configuration setting can be queried to retrieve the value of the LinkCount file attribute if it is present in the response from the server. **AttrOwnerId**: Can be queried for the OwnerId file attribute during the DirList event.During [on_dir_list](#on_dir_list-event-sftpclient-struct), this configuration setting can be queried to retrieve the value of the OwnerId file attribute if it is present in the response from the server. **AttrPermission**: Can be queried for the Permissions file attribute during the DirList event.During [on_dir_list](#on_dir_list-event-sftpclient-struct), this configuration setting can be queried to retrieve the value of the Permissions file attribute if it is present in the response from the server. **CheckFileHash**: Compares a server-computed hash with a hash calculated locally.This setting may be queried to compare a hash of the file specified by [remote_file](#remote_file-property-sftpclient-struct) with the hash calculated by the server. When queried, the struct will ask the server to calculate a hash of the file. It will then compute a hash locally and compare the values to confirm that the content that exists in the file specified by [remote_file](#remote_file-property-sftpclient-struct) is the same as the file specified by [local_file](#local_file-property-sftpclient-struct). The server must support the *check-file* extension. The struct 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 struct will automatically use the same algorithm that the server users. If the extension is unsupported or a mismatch in hashes is detected, the struct fails with an error. If the hashes match the value, *True* is returned. ```csharp try { String flag = sftp.Config("CheckFileHash"); // flag will be equal to "True" } catch (Exception e) { // mismatch } ``` **DisableRealPath**: Controls whether or not the SSH_FXP_REALPATH request is sent.This configuration setting can be used to skip sending the SSH_FXP_REALPATH request, which asks the server to canonicalize the value in RemotePath to an absolute path. The default value is False, which will cause the component to send the request normally. If set to True, the component will not send the SSH_FXP_REALPATH packet and will use the value in RemotePath directly. **ExcludeFileMask**: Specifies a file mask for excluding files in directory listings.This configuration setting specifies one or more file masks to be excluded during a directory listing. When using multiple masks, any files that match one or more of the masks will not be listed. For example, setting ExcludeFileMask to "*.txt", RemoteFile to "", and calling [list_directory](#list_directory-method-sftpclient-struct) will list all files except those ending in .txt. **ExecFallbackCommand**: Specifies the fallback command to execute if the component fails to start the SFTP subsystem.This configuration setting specifies the fallback command to execute if the struct fails to start the SFTP subsystem. By default, this config is set to the following commands: *test -x /usr/lib/sftp-server && exec /usr/lib/sftp-server\ntest -x /usr/local/lib/sftp-server && exec /usr/local/lib/sftp-server\nexec sftp-server* When initiating a connection to an SFTP server, the struct will always attempt to start the SFTP subsystem for the given connection. However, in the event the SFTP subsystem cannot be started successfully for any reason, this command (or set of commands) will be executed on the server in an attempt to start the SFTP server. If necessary, this config may be set to another command or an empty string. An empty string indicates there should be no fallback command executed, and the struct will throw an exception assuming the SFTP subsystem cannot be started. **FileMaskDelimiter**: Specifies a delimiter to use for setting multiple file masks in the RemoteFile property.If specified, the RemoteFile property will be split into separate masks based on the chosen delimiter. The default is "", which will cause the RemoteFile property to be treated as a single value. When using multiple masks, any files that match one or more of the masks will be listed. For example, setting FileMaskDelimiter to "," and setting RemoteFile to "*.txt, *.csv" will list all files ending in .txt or .csv. **FiletimeFormat**: Specifies the format to use when returning filetime strings.If specified, the struct will use this value to format the filetime string returned through the [on_dir_list](#on_dir_list-event-sftpclient-struct) event. By default, the struct will format the date as "MM/dd/yyyy HH:mm:ss". **ForceMakeDirectory**: Controls whether calls to make a directory always attempt to create the directory on the server.By default (false), when [make_directory](#make_directory-method-sftpclient-struct) is called, the struct will first check if a file or directory already exists at the specified path. If an entry exists, the operation will succeed without sending a directory creation request to the server. When this configuration setting is set to True, the struct will always send the directory creation request to the server regardless of whether the path already exists. This allows the server to determine the outcome of the operation. This is useful in cases where a file may exist at the specified path. In such cases, many servers will return an error when attempting to create a directory with the same name, allowing the application to detect the conflict. **FreeSpace**: The free space on the remote server in bytes.This property is populated after calling the [GetSpaceInfo](#GetSpaceInfo) configuration setting. This holds the total free space available on the drive on the remote server in bytes. **GetSpaceInfo**: Queries the server for drive usage information.This configuration setting queries the server for the total space and free space available on the remote drive. When querying this setting, the struct will immediately request the information from the server. After calling this setting the [TotalSpace](#TotalSpace) and [FreeSpace](#FreeSpace) configuration settings will be populated. NOTE: The server must understand either the "statvfs@openssh.com" or "space-available" extension for this operation to succeed. **GetSymlinkAttrs**: Whether to get the attributes of the symbolic link, or the resource pointed to by the link.When file_attributes is queried, the struct will retrieve information about the [remote_file](#remote_file-property-sftpclient-struct). This configuration setting controls the behavior when [remote_file](#remote_file-property-sftpclient-struct) refers to a symbolic link on the server. By default the information returned by file_attributes is that of the actual file pointed to by the symbolic link, not the symbolic link itself. If it is desired to retrieve the attributes of the symbolic link itself, set [GetSymlinkAttrs](#GetSymlinkAttrs) to *True* before querying file_attributes. **IgnoreFileMaskCasing**: Controls whether or not the file mask is case sensitive.This configuration setting applies to the file mask value specified by the [remote_file](#remote_file-property-sftpclient-struct) property. The default value is True. If set to False, the file mask will be case sensitive. **LocalEOL**: When TransferMode is set, this specifies the line ending for the local system.This configuration setting is applicable only when [TransferMode](#TransferMode) is set to 1 (ASCII). The default value is a CrLf character sequence. When uploading or downloading, this value will be compared to [ServerEOL](#ServerEOL). If [ServerEOL](#ServerEOL) and [LocalEOL](#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](#LocalEOL) when downloading. Line endings will be converted to the value in [ServerEOL](#ServerEOL) when uploading. If [ServerEOL](#ServerEOL) and [LocalEOL](#LocalEOL) are the same, no conversion takes place. The value supplied to this setting must be quoted. For example: ```text component.Config("LocalEOL=\"" + myEOLSequence + "\""); ``` Where myEOLSequence is a Cr, Lf, or CrLf character sequence. Conversion will only happen when [TransferMode](#TransferMode) is set to 1 (ASCII) and [ServerEOL](#ServerEOL) and [LocalEOL](#LocalEOL) are different. **LogSFTPFileData**: Whether SFTP file data is present in Debug logs.This configuration setting controls whether file data is logged when [LogLevel](#LogLevel) is set to *3* (Debug). When False (default), the file data being transferred is not included. Set this value to True to include all traffic include file data. NOTE: Setting this value to True will increase the amount of data that are logged. **MaskSensitiveData**: Masks passwords in logs.The default value is True. When set to True, the struct will mask passwords that otherwise would appear in its logs. **MaxFileData**: Specifies the maximum payload size of an SFTP packet.Although the Secure Shell (SSH) specification requires servers and clients to support SSH packets of at least 32,000 bytes, some server implementations limit the packet size to smaller values. MaxFileData provides a means by which the user can specify the maximum amount of data that can be put into a Secure File Transfer Protocol (SFTP) packet so that the struct can communicate effectively with these servers. If you are having difficulty when uploading to a server, try setting MaxFileData size to a value smaller than 32,000. 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. **MaxOutstandingPackets**: Sets the maximum number of simultaneous read or write requests allowed.This configuration setting sets the number of simultaneous read or write requests allowed. This configuration setting applies only when [AsyncTransfer](#AsyncTransfer) is True. The default is *32*. **NegotiatedProtocolVersion**: The negotiated SFTP version.This configuration setting returns the negotiated version of SFTP. Query this to ensure that the correct version was negotiated. This configuration setting is read only. **NormalizeRemotePath**: Whether to normalize the RemotePath.When set to True, the component will normalize the value in RemotePath by appending a forward slash (/) if one is not already present. "." and ".." are special cases and will not be affected. The default is True. **PreserveFileTime**: Preserves the file's timestamps during transfer.If set to True, the struct will preserve the file's timestamps during transfer. This is applicable to both uploads and downloads. The default value is False. **ProtocolVersion**: The highest allowable SFTP version to use.This configuration setting governs the highest allowable SFTP version to use when negotiating the version with the server. The default value is 3 because this is the most common version. The struct supports values from 3 to 6. It is recommended to use the default value of 3 unless there is a specific reason a higher version is needed. **ReadLink**: This settings returns the target of a specified symbolic link.This configuration setting returns the target of the specified symbolic link. To use the setting, pass the remote path and file name of the symbolic link. For example: ```csharp string resolvedPath = component.Config("ReadLink=/home/test/mysymlink.txt"); ``` **RealTimeUpload**: Enables real time uploading.When this value is set to True, the struct will upload the data in the file specified by [local_file](#local_file-property-sftpclient-struct) and continue monitoring [local_file](#local_file-property-sftpclient-struct) for additional data to upload until no new data are found for [RealTimeUploadAgeLimit](#RealTimeUploadAgeLimit) seconds. This allows you to start uploading a file immediately after the file is created and continue uploading as data is written to the file. The default value is False. **RealTimeUploadAgeLimit**: The age limit in seconds when using RealTimeUpload.This value is applicable only when [RealTimeUpload](#RealTimeUpload) is set to True. This specifies the number of seconds for which the struct will monitor [local_file](#local_file-property-sftpclient-struct) for new data to upload. If this limit is reached and no new data are found in [local_file](#local_file-property-sftpclient-struct), the upload will complete. The default value is 1. **ServerEOL**: When TransferMode is set, this specifies the line ending for the remote system.This configuration setting is applicable only when [TransferMode](#TransferMode) is set to 1 (ASCII). The default value is a CrLf character sequence. When uploading or downloading, this value will be compared to [LocalEOL](#LocalEOL). If [ServerEOL](#ServerEOL) and [LocalEOL](#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](#LocalEOL) when downloading. Line endings will be converted to the value in [ServerEOL](#ServerEOL) when uploading. If [ServerEOL](#ServerEOL) and [LocalEOL](#LocalEOL) are the same, no conversion takes place. The value supplied to this setting must be quoted. For example: ```text component.Config("ServerEOL=\"" + myEOLSequence + "\""); ``` Where myEOLSequence is a Cr, Lf, or CrLf character sequence. Conversion will happen only when [TransferMode](#TransferMode) is set to 1 (ASCII) and [ServerEOL](#ServerEOL) and [LocalEOL](#LocalEOL) are different. **SimultaneousTransferLimit**: The maximum number of simultaneous file transfers.This configuration setting specifies the maximum number of simultaneous file transfers. This is used when processing files added to the transfer queue by [queue_file](#queue_file-method-sftpclient-struct). The default value is 5. **TotalSpace**: The total space on the remote server in bytes.This property is populated after calling the [GetSpaceInfo](#GetSpaceInfo) configuration setting. This holds the total space on the drive on the remote server in bytes. **TransferMode**: The transfer mode (ASCII or Binary).The value 0 represents binary and the value 1 represents ASCII. If the value is 0 (default), the initial server mode will be used. When this value is set to 1 (ASCII) the struct will use the values specified in [LocalEOL](#LocalEOL) and [ServerEOL](#ServerEOL) to convert line endings as appropriate. NOTE: When this value is set to 1 (ASCII) and [ProtocolVersion](#ProtocolVersion) is set to 4 or higher the struct will automatically determine the value for [ServerEOL](#ServerEOL) if the server supports the *newline* protocol extension. **TransferredDataLimit**: Specifies the maximum number of bytes to download from the remote file.This configuration setting specifies the maximum number of bytes that should be downloaded from the current [remote_file](#remote_file-property-sftpclient-struct) when [download](#download-method-sftpclient-struct) is called. The struct will stop downloading data if it reaches the specified limit, or if there are no more data to download. This configuration setting can be used in conjunction with the [start_byte](#start_byte-property-sftpclient-struct) property to download a specific range of data from the current [remote_file](#remote_file-property-sftpclient-struct). **UseFxpStat**: Whether SSH_FXP_STAT is sent.For certain operations the struct will send SSH_FXP_STAT to get a file's attributes. Some servers do not support this packet and will return an error. Set this to *false* to not send the packet. This will cause [PreserveFileTime](#PreserveFileTime) to not work and prevent *PercentDone* in [on_transfer](#on_transfer-event-sftpclient-struct) from being calculated. The default is *true*. **UseServerFileTime**: Controls if the file time returned from the server is converted to local time or not.If this configuration setting is set to False, the component will return the filetime as the system's local time; otherwise, it will return with the time as it is reported by the server. Controls if the file time returned from the server is converted to local time or not.If this configuration setting is set to False, the component will return the filetime as the system's local time; otherwise, it will return with the time as it is reported by the server. The default is *false*. **UseServerFileTime**: Controls if the file time returned from the server is converted to local time or not.If this configuration setting is set to False, the component will return the filetime as the system's local time; otherwise, it will return with the time as it is reported by the server. Controls if the file time returned from the server is converted to local time or not.If this configuration setting is set to False, the component will return the filetime as the system's local time; otherwise, it will return with the time as it is reported by the server. The default is *false*. ### SSHClient Config Settings **ChannelDataEOL[ChannelId]**: Used to break the incoming data stream into chunks.By *default* [MaxChannelDataLength](#MaxChannelDataLength) is *0* and [ChannelDataEOL](#ChannelDataEOL) is an empty string. on_ssh_channel_data fires whenever an SSH_MSG_CHANNEL_DATA packet is received. If [MaxChannelDataLength](#MaxChannelDataLength) is greater than *0* and [ChannelDataEOL](#ChannelDataEOL) is a nonempty string, the struct will internally buffer data waiting to fire on_ssh_channel_data until either [MaxChannelDataLength](#MaxChannelDataLength) is reached or [ChannelDataEOL](#ChannelDataEOL) is found, whichever comes first. Query [ChannelDataEOLFound](#ChannelDataEOLFound) to know which condition was met. The buffer is reset any time on_ssh_channel_data fires. [ChannelDataEOL](#ChannelDataEOL) and [MaxChannelDataLength](#MaxChannelDataLength) *must* be set together or unexpected behavior could occur. **ChannelDataEOLFound[ChannelId]**: Determines if ChannelDataEOL was found.If *true*,then [ChannelDataEOL](#ChannelDataEOL) was found. If *false*, then [MaxChannelDataLength](#MaxChannelDataLength) was reached. This configuration setting is valid only when queried inside on_ssh_channel_data, [MaxChannelDataLength](#MaxChannelDataLength) > 0, and [ChannelDataEOL](#ChannelDataEOL) is nonempty. **ClientSSHVersionString**: The SSH version string used by the struct.This configuration setting specifies the Secure Shell (SSH) version string used by the struct. The default value is "SSH-2.0-IPWorks SSH Client 2024". Most SSH servers expect the SSH version string to have the expected format "SSH-protocol version-software version". See above for an example. **ConnectAndLogin**: Whether the struct performs a full SSH login.The default value is *true*. When enabled, calling the [connect](#connect-method-sftpclient-struct) method establishes the TCP connection and performs a full SSH login. When set to *false*, calling [connect](#connect-method-sftpclient-struct) will only establish the underlying TCP connection; the SSH login will not be performed. This may be useful in cases in which it is desirable to separate the connection and logon operations; for instance, confirming a host is available before authenticating with it. When [ConnectAndLogin](#ConnectAndLogin) is *false*, call [ssh_logon](#ssh_logon-method-sftpclient-struct) with the same [ssh_host](#ssh_host-property-sftpclient-struct) and [ssh_port](#ssh_port-property-sftpclient-struct) used to connect in order to complete the SSH login over the existing connection. Note that [ssh_logon](#ssh_logon-method-sftpclient-struct) always performs a full SSH login regardless of the value of this configuration setting. **DoNotRepeatAuthMethods**: Whether the struct will repeat authentication methods during multifactor authentication.The default value is *true*. When set to *false*, the struct will repeat authentication methods that have already been completed during multifactor authentication. **EnablePageantAuth**: Whether to use a key stored in Pageant to perform client authentication.This configuration setting controls whether Pageant authentication is disabled, enabled, or required. When enabled or required, the struct attempts to communicate with PuTTY's ssh-agent, called "Pageant", over shared memory to perform public key authentication. Possible values and the corresponding behavior is described as follows: | 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:** ```text component.Config("EnablePageantAuth=1"); component.SSHUser = "sshuser"; component.SSHLogon("localhost", 22); ``` NOTE: This functionality is available only on Windows. **KerberosDelegation**: If true, asks for credentials with delegation enabled during authentication.The default value is "True". If set to "False", the client will not ask for credentials delegation support during authentication. NOTE: Even if the client asks for delegation, the server/KDC might not grant it, and authentication will still succeed. **KerberosRealm**: The fully qualified domain name of the Kerberos Realm to use for GSSAPI authentication.This property may be set to the fully qualified (DNS) name of the kerberos realm (or Windows Active Directory domain name) to use during GSSAPI authentication. This can be used to force authentication with a given realm if the client and server machines are not part of the same domain. **KerberosSPN**: The Kerberos Service Principal Name of the SSH host.This property can be set to specify the Service Principal Name (SPN) associated with the SSH service on the remote host. This will usually be in the form "host/fqdn.of.sshhost[@REALM]". If not specified, the struct will assume the SPN is based on the value of the [ssh_host](#ssh_host-property-sftpclient-struct) property and the kerberos realm used for authentication. **KeyRenegotiationThreshold**: Sets the threshold for the SSH Key Renegotiation.This property allows you to specify the threshold, in the number of bytes, for the Secure Shell (SSH) key renegotiation. The default value for this property is set to 1 GB. **Example. Setting the Threshold to 500 MB:** ```text SSHComponent.Config("KeyRenegotiationThreshold=524288000") ``` **LogLevel**: Specifies the level of detail that is logged.This configuration setting controls the level of detail that is logged through the [on_log](#on_log-event-sftpclient-struct) event. 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. | **MaxChannelDataLength[ChannelId]**: The maximum amount of data to accumulate when no ChannelDataEOL is found.By *default* [MaxChannelDataLength](#MaxChannelDataLength) is *0* and [ChannelDataEOL](#ChannelDataEOL) is an empty string. on_ssh_channel_data fires whenever an SSH_MSG_CHANNEL_DATA packet is received. If [MaxChannelDataLength](#MaxChannelDataLength) is greater than *0* and [ChannelDataEOL](#ChannelDataEOL) is a nonempty string, the struct will internally buffer data waiting to fire on_ssh_channel_data until either [MaxChannelDataLength](#MaxChannelDataLength) is reached or [ChannelDataEOL](#ChannelDataEOL) is found, whichever comes first. Query [ChannelDataEOLFound](#ChannelDataEOLFound) to know which condition was met. The buffer is reset any time on_ssh_channel_data fires. [ChannelDataEOL](#ChannelDataEOL) and [MaxChannelDataLength](#MaxChannelDataLength) *must* be set together or unexpected behavior could occur. **MaxPacketSize**: The maximum packet size of the channel, in bytes.This configuration setting specifies the maximum size of an individual data packet, in bytes, that can be sent to the sender. **MaxWindowSize**: The maximum window size allowed for the channel, in bytes.This configuration setting specifies how many bytes of channel data can be sent to the sender of this message without adjusting the window. NOTE: This value may be changed during the connection, but the window size can only be increased, not decreased. **NegotiatedStrictKex**: Returns whether strict key exchange was negotiated to be used.This configuration setting specifies whether strict key exchange (strict kex) was negotiated during the SSH handshake. If strict kex is being used, then this will return *"True"*. If strict kex is not being used, then this will return *"False"*. ```text component.Config("NegotiatedStrictKex") ``` **PasswordPrompt**: The text of the password prompt used in keyboard-interactive authentication.This configuration setting optionally specifies a pattern to be matched to the prompt received from the server during keyboard-interactive authentication. If a matching prompt is detected the struct automatically responds to the prompt with the password specified by [ssh_password](#ssh_password-property-sftpclient-struct). 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](#on_ssh_keyboard_interactive-event-sftpclient-struct) 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. **PreferredDHGroupBits**: The size (in bits) of the preferred modulus (p) to request from the server.This configuration setting may be when using the diffie-hellman-group-exchange-sha1 or diffie-hellman-group-exchange-sha256 key exchange algorithms to control the preferred size, in bits, of the modulus (p) prime number to request from the server. Acceptable values are between 1024 and 8192. **RecordLength**: The length of received data records.If set to a positive value, this configuration setting defines the length of data records to be received. The struct will accumulate data until RecordLength is reached and only then will it fire the on_data_in event with data of length RecordLength. This allows data to be received as records of known length. This value can be changed at any time, including within the on_data_in event. The default value is 0, meaning this setting is not used. **ServerSSHVersionString**: The remote host's SSH version string.This configuration setting will return the remote host's SSH version string, which can help when identifying problematic servers. This configuration setting is read-only. **SignedSSHCert**: The CA signed client public key used when authenticating.When authenticating via public key authentication, this setting may be set to the certificate authority (CA) signed client's public key. This is useful when the server has been configured to trust client keys signed by a particular CA. For instance: ```text 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...* **SSHAcceptAnyServerHostKey**: If set the struct will accept any key presented by the server.The default value is "False". Set this to "True" to accept any key presented by the server. **SSHAcceptServerCAKey**: The CA public key that signed the server's host key.If the server's host key was signed by a CA, this configuration setting may be used to specify the CA's public key. If specified, the struct will trust any server's host key that was signed by the CA. For instance: ```text component.Config("SSHAcceptServerCAKey=ssh-rsa AAAAB3NzaC1yc2EAAAADAQAB..."); ``` **SSHAcceptServerHostKeyFingerPrint**: The fingerprint(s) of the server host keys to accept.This configuration setting specifies one or more fingerprints that should be accepted as the servers host key. Each fingerprint should be represented using the hash algorithm and encoding format defined by the [SSHFingerprintHashAlgorithm](#SSHFingerprintHashAlgorithm) and [SSHFingerprintEncoding](#SSHFingerprintEncoding) configs, respectively. By default, this config should be specified as the comma-separated list of hex-encoded SHA256 hashes of possible server host keys. **Example:** ```text // Assuming default values. Hex-encoded, SHA256 hash of the expected host key SSHClient.Config("SSHAcceptServerHostKeyFingerPrint=61:2d:89:9c:55:67:5e:ca:22:86:fc:f6:07:59:67:e0:c7:77:08:1f:cc:d9:93:f3:f9:63:21:15:3e:0c:a2:1b"); // Base64-encoded, SHA256 hash of the expected host key SSHClient.Config("SSHFingerprintEncoding=1"); SSHClient.Config("SSHAcceptServerHostKeyFingerPrint=n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg="); ``` If the server's fingerprint matches one of the values supplied, the struct will accept the host key. **SSHFingerprintEncoding**: Specifies the encoding used when displaying the SSH host key fingerprint.This setting determines how the SSH host key fingerprint is displayed after it has been computed using the algorithm specified by [SSHFingerprintHashAlgorithm](#SSHFingerprintHashAlgorithm). Possible values are: - *0* (Hex Encoded) - *1* (Base64 Encoded - Default) For example, when set to *0*, the Fingerprint parameter in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sftpclient-struct) will be formatted like: *0a:1b:2c:3d*. When set to *1*, the Fingerprint parameter in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sftpclient-struct) will be formatted like: ```plaintext n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg= ``` . Note that this config is also applicable when querying the [SSHFingerprintMD5](#SSHFingerprintMD5), [SSHFingerprintSHA1](#SSHFingerprintSHA1), or [SSHFingerprintSHA256](#SSHFingerprintSHA256) configuration settings. Additionally, note that this config is also applicable if specifying the host key fingerprint via [SSHAcceptServerHostKeyFingerPrint](#SSHAcceptServerHostKeyFingerPrint). The value specified via [SSHAcceptServerHostKeyFingerPrint](#SSHAcceptServerHostKeyFingerPrint) should be specified according to the format or encoding specified by this configuration setting. **SSHFingerprintHashAlgorithm**: The algorithm used to calculate the fingerprint.This configuration setting controls which hash algorithm is used to calculate the hostkey's fingerprint, displayed when [on_ssh_server_authentication](#on_ssh_server_authentication-event-sftpclient-struct) fires. Valid values are as follows: - *MD5* - *SHA1* - *SHA256* (default) **SSHFingerprintMD5**: The server hostkey's MD5 fingerprint.This configuration setting may be queried in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sftpclient-struct) to get the server hostkey's MD5 fingerprint. **SSHFingerprintSHA1**: The server hostkey's SHA1 fingerprint.This configuration setting may be queried in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sftpclient-struct) to get the server hostkey's SHA-1 fingerprint. **SSHFingerprintSHA256**: The server hostkey's SHA256 fingerprint.This configuration setting may be queried in [on_ssh_server_authentication](#on_ssh_server_authentication-event-sftpclient-struct) to get the server hostkey's SHA-256 fingerprint. **SSHKeepAliveCountMax**: The maximum number of keep alive packets to send without a response.This configuration setting specifies the maximum number of keep-alive packets to send when no response is received. Normally a response to a keep-alive packet is received right away. If no response is received, the struct will continue to send keep-alive packets until [SSHKeepAliveCountMax](#SSHKeepAliveCountMax) is reached. If this is reached, the struct will assume the connection is broken and disconnect. The default value is 5. **SSHKeepAliveInterval**: The interval between keep alive packets.This configuration setting specifies the number of seconds between keep alive packets. If set to a positive value, the struct will send a SSH keep-alive packet after [KeepAliveInterval](#KeepAliveInterval) seconds of inactivity. This configuration setting takes effect only when there is no activity; if any data are sent or received over the connection, it will reset the timer. The default value is 0, meaning no keep alives will be sent. NOTE: The SSHREVERSETUNNEL struct uses a default value of 30. **SSHKeyExchangeAlgorithms**: Specifies the supported key exchange algorithms.This configuration setting may be used to specify the list of supported key exchange algorithms used during Secure Shell (SSH) negotiation. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows: - 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 - gss-group16-sha512 - gss-nistp256-sha256 - gss-curve25519-sha256 - gss-group14-sha1 - gss-gex-sha1 - mlkem768x25519-sha256 The default value is *curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group-exchange-sha256,diffie-hellman-group14-sha256,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,ecdh-sha2-nistp256,ecdh-sha2-nistp384,ecdh-sha2-nistp521,mlkem768x25519-sha256,diffie-hellman-group-exchange-sha1,diffie-hellman-group14-sha1,diffie-hellman-group1-sha1,gss-group14-sha256,gss-group16-sha512,gss-nistp256-sha256,gss-curve25519-sha256,gss-group14-sha1,gss-gex-sha1*. **SSHKeyRenegotiate**: Causes the component to renegotiate the SSH keys.Once this configuration setting is queried, the component will renegotiate the SSH keys with the remote host. **Example 3. Renegotiating SSH Keys:** ```text SSHClient.Config("SSHKeyRenegotiate") ``` **SSHMacAlgorithms**: Specifies the supported Mac algorithms.This configuration setting may be used to specify an alternate list of supported Mac algorithms used during SSH negotiation. This also specifies the order in which the Mac algorithms are preferred. The value should contain a comma-separated list of algorithms. Supported algorithms are as follows: - 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 default value is *hmac-sha2-256,hmac-sha2-512,hmac-sha1,hmac-md5,hmac-ripemd160,hmac-sha1-96,hmac-md5-96,hmac-sha2-256-96,hmac-sha2-512-96,hmac-ripemd160-96,hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-64@openssh.com,umac-64-etm@openssh.com,umac-128@openssh.com,umac-128-etm@openssh.com*. **SSHPubKeyAuthSigAlgorithms**: Specifies the enabled signature algorithms that may be used when attempting public key authentication.This setting specifies a list of signature algorithms that may be used when authenticating to the server using public key authentication. This applies only when public key authentication is performed by the client. The setting should be a comma-separated list of algorithms. At runtime, the struct 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 struct 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 struct 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. **SSHPublicKeyAlgorithms**: Specifies the supported public key algorithms for the server's public key. This configuration setting specifies the allowed public key algorithms for the server's public key. This list controls only the public key algorithm used when authenticating the server's public key. This list has no bearing on the public key algorithms that can be used by the client when performing public key authentication to the server. The default value is *ssh-ed25519,ecdsa-sha2-nistp256,ecdsa-sha2-nistp384,ecdsa-sha2-nistp521,rsa-sha2-256,rsa-sha2-512,ssh-rsa,ssh-dss,x509v3-sign-rsa,x509v3-sign-dss*. **SSHVersionPattern**: The pattern used to match the remote host's version string.This configuration setting specifies the pattern used to accept or deny the remote host's SSH version string. It takes a comma-delimited list of patterns to match. The default value is "*SSH-1.99-*,*SSH-2.0-*" and will accept connections from SSH 1.99 and 2.0 hosts. As an example, the following value would accept connections for SSH 1.99, 2.0, and 2.99 hosts. ```text *SSH-1.99-*,*SSH-2.0-*,*SSH-2.99-* ``` **TryAllAvailableAuthMethods**: If set to true, the struct will try all available authentication methods.The default value is *false*. When set to *true*, the struct will try to authenticate using all methods that it has credentials for and the server supports. **UseStrictKeyExchange**: Specifies how strict key exchange is supported.This configuration setting controls whether strict key exchange (strict kex) is enabled to mitigate the Terrapin attack. When enabled, the struct will indicate support for strict key exchange by automatically including the pseudo-algorithm *kex-strict-c-v00@openssh.com* for client structs and *kex-strict-s-v00@openssh.com* for server structs in the list of supported key exchange algorithms. Because both client and server must implement strict key exchange to effectively mitigate the Terrapin attack, the struct 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 struct. | | 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. | **WaitForChannelClose**: Whether to wait for channels to be closed before disconnected.This configuration setting controls whether the struct will wait for a server response to the SSH_MSG_CHANNEL_CLOSE when disconnecting. When the struct disconnects, it will first attempt to close all open channels by sending a SSH_MSG_CHANNEL_CLOSE for each channel. This configuration setting controls whether the struct will wait for a server response after sending the messages. When *True* (default), the struct will wait for a response to the channel close message until the responses have been received, the server closes the connection, or [timeout](#timeout-property-sftpclient-struct) seconds is reached. When *False*, the struct will still send the channel close messages, but it will not wait for a response and will proceed to close the connection. **WaitForServerDisconnect**: Whether to wait for the server to close the connection.This configuration setting controls whether to wait for the server to close the connection when [ssh_logoff](#ssh_logoff-method-sftpclient-struct) is called. When set to *True*, the struct 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. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [timeout](#timeout-property-sftpclient-struct) for establishing a connection and transmitting/receiving data. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-sftpclient-struct) setting 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 value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [local_host](#local_host-property-sftpclient-struct) setting 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). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by [local_port](#local_port-property-sftpclient-struct) after the connection is established. [local_port](#local_port-property-sftpclient-struct) cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string. If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset. If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property-sftpclient-struct) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). 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 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | 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 | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - 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. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct 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](platforms.md) section. # Trappable Errors ([SFTPClient](#struct-ipworkssftpsftpclient) Struct) ### 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](#local_file-property-sftpclient-struct)/[remote_file](#remote_file-property-sftpclient-struct) before attempting to download/upload. | | 1108 | Cannot download file: [local_file](#local_file-property-sftpclient-struct) exists and [overwrite](#overwrite-property-sftpclient-struct) is set to False. | | 1109 | [CheckFileHash](#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](#on_ssh_server_authentication-event-sftpclient-struct) 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](#local_port-property-sftpclient-struct) at this time. A connection is in progress. | | 107 | You cannot change the [local_host](#local_host-property-sftpclient-struct) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#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 struct 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). |